Creates a Debtor resource.
This endpoint creates a debtor. A debtor holds the personal and contact information for a debtor_number and is required before collection orders can be synced for that debtor via POST /v3/collection_orders/sync.
When a debtor already exists for the given debtor_number, the endpoint responds with 422 - use PATCH /v3/debtors/{debtor_number} to update it instead.
The debtor's contact information is also propagated to collection orders that are already running for this debtor.
### 1. Identification
| Field | Description | Usage |
|-------|-------------|-------|
| debtor_number | Identifier for the debtor, e.g. a customer number | required |
### 2. personal
| Field | Description | Usage |
|-------|-------------|-------|
| personal.first_name | First name of the debtor | optional |
| personal.last_name | Last name of the debtor | required |
| personal.company_name | Name of the debtor's business | optional |
| personal.personal_identification_number | National identification number of the debtor (e.g. BSN, social security number) | optional |
| personal.date_of_birth | Date of birth (format: YYYY-MM-DD) | optional |
| personal.gender | Gender of the debtor. M = male, F = female | optional |
| personal.language | Language preference of the debtor (e.g. nl, de, fr, en) | optional |
### 3. contact
| Field | Description | Usage |
|-------|-------------|-------|
| contact.email / contact.secondary_email | Email addresses of the debtor | optional |
| contact.phone_number / contact.secondary_phone_number / contact.mobile_number | Telephone numbers of the debtor | optional |
### 4. address and secondary_address
Both objects take the same fields; the secondary address is informational and not used for letters.
| Field | Description | Usage |
|-------|-------------|-------|
| street_name | Street name | optional |
| house_number | House number | optional |
| zip_code | Postal code | optional |
| city | City | optional |
| country | Country | optional |
### 5. Payment and messaging
| Field | Description | Usage |
|-------|-------------|-------|
| iban | Bank account of the debtor | optional |
| block_messaging.email, block_messaging.sms, block_messaging.letter, block_messaging.call, block_messaging.home_visit | Blocks the corresponding messaging channel for this debtor | optional |
curl -X POST "/v3/debtors" \
-H "Authorization: Bearer $POM_API_DOCUMENTATION_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"debtor_number": "123456",
"iban": "NL02ABNA0123456789"
}'Authorization
AuthorizationstringheaderrequiredOAuth 2.0 client credentials Grant
Body
The new Debtor resource
debtor_numberstringrequiredpersonalDebtorPersonalInput-debtor.write | nullcontactDebtorContactInput-debtor.write | nulladdressDebtorAddressInput-debtor.write | nullsecondary_addressDebtorAddressInput-debtor.write | nullibanstring | nullblock_messagingDebtorBlockMessagingInput-debtor.write | null
Response
Debtor resource created
debtor_numberstring | nullpersonalDebtorPersonalOutput-debtor.read | nullcontactDebtorContactOutput-debtor.read | nulladdressDebtorAddressOutput-debtor.read | nullsecondary_addressDebtorAddressOutput-debtor.read | nullibanstring | nullblock_messagingDebtorBlockMessagingOutput-debtor.read | null
{
"debtor_number": "string",
"personal": {
"first_name": "string",
"last_name": "string",
"company_name": "string",
"personal_identification_number": "string",
"date_of_birth": "string",
"gender": "string",
"language": "string"
},
"contact": {
"email": "string",
"secondary_email": "string",
"phone_number": "string",
"secondary_phone_number": "string",
"mobile_number": "string"
},
"address": {
"street_name": "string",
"house_number": "string",
"zip_code": "string",
"city": "string",
"country": "string"
},
"secondary_address": {
"street_name": "string",
"house_number": "string",
"zip_code": "string",
"city": "string",
"country": "string"
},
"iban": "string",
"block_messaging": {
"email": true,
"sms": true,
"letter": true,
"call": true,
"home_visit": true
}
}