> ## Documentation Index > Fetch the complete documentation index at: https://docs.paywise.de/llms.txt > Use this file to discover all available pages before exploring further. # Update debtor > The reusable debtors of your company. List, retrieve, create, and PATCH. A supplied owned collection (addresses, bank accounts, communication channels, legal representatives) replaces that collection completely; omitted collections stay unchanged. A case's debtor is the case's own snapshot (published as `MandateDebtor` without an id) and is not a reusable debtor: it is neither listed nor readable here. ## OpenAPI ````yaml /api-docs/case-management-api/openapi.json patch /v2/debtors/{id}/ openapi: 3.0.3 info: description: >- Submit orders and manage their complete lifecycle through the current API at the `/v2/` HTTP path. title: paywise Case Management API version: current servers: - description: Production environment url: https://api.paywise.de - description: Sandbox environment url: https://api-sandbox.paywise.de security: [] tags: - description: Submit orders and manage them until acceptance. name: Orders - description: Stable claim resources and their current relationships. name: Claims - description: 'Accepted cases: state, published history and documents.' name: Mandates - description: Debtor master data reused across orders. name: Debtors - description: Payments reported by you and booked by paywise. name: Payments - description: Files attached to claims and other resources. name: Documents - description: Collective statements (Sammelabrechnungen). name: Statements - description: Per-case statements (Aktenabrechnungen). name: Single mandate statements - description: Webhook endpoints and their signing secrets. name: Webhooks - description: Delivery log and redelivery of webhook events. name: Webhook deliveries - description: Ordered feed of the events webhooks deliver. name: Events - description: Reference catalog of legal forms. name: Legal forms - description: The authenticated credential and its context. name: Info - description: Rate-limit headroom of the credential. name: Usage - description: Availability of the API. name: Health externalDocs: url: https://docs.paywise.de/api-docs/case-management-api/introduction paths: /v2/debtors/{id}/: patch: tags: - Debtors summary: Update debtor description: |- The reusable debtors of your company. List, retrieve, create, and PATCH. A supplied owned collection (addresses, bank accounts, communication channels, legal representatives) replaces that collection completely; omitted collections stay unchanged. A case's debtor is the case's own snapshot (published as `MandateDebtor` without an id) and is not a reusable debtor: it is neither listed nor readable here. operationId: update-debtor parameters: - description: >- Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID. in: header name: X-On-Behalf-Of-Company schema: format: uuid type: string - description: UUID of the debtor in this request. in: path name: id required: true schema: format: uuid type: string - description: >- Apply the change only while the current `ETag` matches one of the supplied validators (or `*`); otherwise the request fails with `412 precondition_failed` and nothing is written. in: header name: If-Match required: false schema: type: string requestBody: content: application/json: examples: debtor-aggregate-patch: value: communication_channels: - type: email value: billing@example.test - type: mobile_phone value: '+4915123456789' your_reference: CUSTOMER-1001-UPDATED schema: $ref: '#/components/schemas/PatchedDebtorWriteRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DebtorDetail' description: '' headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string ETag: description: >- Strong validator of this representation. Send it back as `If-None-Match` to skip an unchanged re-read (304) or as `If-Match` on PATCH/PUT/DELETE to fail with 412 when the resource changed. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '400': content: application/json: examples: validation-error: value: code: validation_error detail: The request contains invalid data. errors: - code: invalid field: claims[0].due_date message: Due date must not precede the document date. schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '401': content: application/json: examples: authentication-error: value: code: not_authenticated detail: Authentication credentials were not provided. schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '404': content: application/json: examples: not-found-error: value: code: not_found detail: The requested resource was not found. schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '409': content: application/json: examples: conflict-error: value: code: conflict detail: The resource changed state and cannot accept this command. schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '412': content: application/json: schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '429': content: application/json: schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string Retry-After: description: Integer seconds to wait before retrying a throttled request. schema: minimum: 1 type: integer X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Standard error response. headers: Cache-Control: description: >- Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`. schema: type: string X-Paywise-Environment: description: Environment that produced the response. schema: enum: - production - sandbox type: string X-Paywise-Request-Id: description: >- Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored. schema: format: uuid type: string security: - caseBearerAuth: [] - partnerBearerAuth: [] components: schemas: PatchedDebtorWriteRequest: description: Metadata and events are create-and-read only. properties: acting_as: allOf: - $ref: '#/components/schemas/ActingAsEnum' description: >- Whether the debtor incurred the obligation as a consumer or in a business capacity. When changing it, update person, organization, and legal_form together to form a valid identity. addresses: description: >- Postal addresses for the debtor. Supplied arrays replace the entire collection; [] clears it and omission leaves it unchanged. Include an existing child id to retain that entry. A non-empty list must have exactly one primary address; an order requires at least one complete address before finalization. Maximum 5 entries. items: $ref: '#/components/schemas/AddressWriteRequest' maxItems: 5 type: array bank_accounts: description: >- Known bank accounts for the debtor. Supplied arrays replace the entire collection; [] clears it and omission leaves it unchanged. Include an existing child id to retain that entry. Duplicate IBANs are rejected. Maximum 10 entries. items: $ref: '#/components/schemas/BankAccountWriteRequest' maxItems: 10 type: array communication_channels: description: >- Email addresses and telephone numbers for the debtor. Supplied arrays replace the entire collection; [] clears it and omission leaves it unchanged. Include an existing child id to retain that entry. Duplicate type/value pairs are rejected. Maximum 10 entries. items: $ref: '#/components/schemas/CommunicationChannelWriteRequest' maxItems: 10 type: array legal_form: description: >- Optional permanent code from GET /v2/legal-forms/. Null or an empty string clears it; consumers cannot supply a code. A supplied catalog group determines the permitted identity. Omission preserves the current value. nullable: true type: string legal_representatives: description: >- Legal representatives for the debtor. Supplied arrays replace the entire collection; [] clears it and omission leaves it unchanged. Include an existing child id to retain that entry. Representative nesting is limited to two levels. Maximum 10 entries. items: $ref: '#/components/schemas/LegalRepresentativeWriteRequest' maxItems: 10 type: array organization: allOf: - $ref: '#/components/schemas/OrganizationPatchRequest' description: >- Organization identity for business legal forms outside the privatperson and einzelkaufmann groups. Supplied properties update the current organization; omission leaves it unchanged and null removes it. The resulting debtor must retain a valid identity. nullable: true person: allOf: - $ref: '#/components/schemas/PersonPatchRequest' description: >- Natural-person identity for consumers and business legal forms in the privatperson or einzelkaufmann group. Supplied properties update the current person; omission leaves it unchanged and null removes it. The resulting debtor must retain a valid identity. nullable: true your_reference: description: Your reference for this debtor. Blank is stored as null. maxLength: 255 nullable: true type: string type: object DebtorDetail: properties: acting_as: allOf: - $ref: '#/components/schemas/ActingAsEnum' description: >- Whether the debtor incurred the obligation as a consumer or in a business capacity. * `consumer` - consumer * `business` - business readOnly: true addresses: description: >- Postal addresses associated with the debtor. API submissions are limited to 5 entries. items: $ref: '#/components/schemas/AddressRead' readOnly: true type: array bank_accounts: description: >- Known bank accounts belonging to the debtor. API submissions are limited to 10 entries. items: $ref: '#/components/schemas/BankAccountRead' readOnly: true type: array communication_channels: description: >- Email addresses and telephone numbers for the debtor. API submissions are limited to 10 entries. items: $ref: '#/components/schemas/CommunicationChannelRead' readOnly: true type: array created_at: description: Time at which the debtor was created. format: date-time readOnly: true type: string events: description: Stored contextual events associated with this resource. items: $ref: '#/components/schemas/LegacyEventRead' readOnly: true type: array id: description: Stable identifier of this debtor. format: uuid readOnly: true type: string legal_form: description: >- Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers. nullable: true readOnly: true type: string legal_representatives: description: >- People or organizations legally representing the debtor. API submissions are limited to 10 entries. items: $ref: '#/components/schemas/LegalRepresentativeRead' readOnly: true type: array metadata: description: Stored metadata entries; duplicate types remain separate entries. items: $ref: '#/components/schemas/LegacyMetadataRead' readOnly: true type: array organization: allOf: - $ref: '#/components/schemas/OrganizationRead' description: Organization identity for a business debtor. nullable: true readOnly: true person: allOf: - $ref: '#/components/schemas/PersonRead' description: Natural-person identity for a consumer or sole proprietor. nullable: true readOnly: true updated_at: description: Time at which the debtor was last updated. format: date-time readOnly: true type: string your_reference: description: Your reference for this debtor. nullable: true readOnly: true type: string required: - acting_as - addresses - bank_accounts - communication_channels - created_at - events - id - legal_form - legal_representatives - metadata - organization - person - updated_at - your_reference type: object Error: properties: code: description: Machine-readable error category. type: string detail: description: Short human-readable summary of the error. type: string errors: description: Field-level validation errors, when applicable. items: $ref: '#/components/schemas/ErrorItem' type: array required: - detail - code type: object ActingAsEnum: description: |- * `consumer` - consumer * `business` - business enum: - consumer - business type: string AddressWriteRequest: description: >- Unknown and read-only request fields are rejected with a validation error instead of being silently ignored. properties: city: description: City or locality of the address. maxLength: 100 minLength: 1 type: string country: allOf: - $ref: '#/components/schemas/CountryEnum' description: |- Country as a two-letter ISO 3166-1 alpha-2 code. * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BE` - Belgium * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BQ` - Bonaire, Sint Eustatius and Saba * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `CV` - Cabo Verde * `KH` - Cambodia * `CM` - Cameroon * `CA` - Canada * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo (the Democratic Republic of the) * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Côte d'Ivoire * `HR` - Croatia * `CU` - Cuba * `CW` - Curaçao * `CY` - Cyprus * `CZ` - Czechia * `DK` - Denmark * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `EE` - Estonia * `SZ` - Eswatini * `ET` - Ethiopia * `FK` - Falkland Islands (Malvinas) * `FO` - Faroe Islands * `FJ` - Fiji * `FI` - Finland * `FR` - France * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `DE` - Germany * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and McDonald Islands * `VA` - Holy See * `HN` - Honduras * `HK` - Hong Kong * `HU` - Hungary * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IE` - Ireland * `IM` - Isle of Man * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `XK` - Kosovo * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Laos * `LV` - Latvia * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `LI` - Liechtenstein * `LT` - Lithuania * `LU` - Luxembourg * `MO` - Macao * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MT` - Malta * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia * `MD` - Moldova * `MC` - Monaco * `MN` - Mongolia * `ME` - Montenegro * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NL` - Netherlands * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `KP` - North Korea * `MK` - North Macedonia * `MP` - Northern Mariana Islands * `NO` - Norway * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestine, State of * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PL` - Poland * `PT` - Portugal * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Réunion * `RO` - Romania * `RU` - Russia * `RW` - Rwanda * `BL` - Saint Barthélemy * `SH` - Saint Helena, Ascension and Tristan da Cunha * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `MF` - Saint Martin (French part) * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `SM` - San Marino * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `RS` - Serbia * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SX` - Sint Maarten (Dutch part) * `SK` - Slovakia * `SI` - Slovenia * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `KR` - South Korea * `SS` - South Sudan * `ES` - Spain * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SE` - Sweden * `CH` - Switzerland * `SY` - Syria * `TW` - Taiwan * `TJ` - Tajikistan * `TZ` - Tanzania * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Türkiye * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `GB` - United Kingdom * `UM` - United States Minor Outlying Islands * `US` - United States of America * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VE` - Venezuela * `VN` - Vietnam * `VG` - Virgin Islands (British) * `VI` - Virgin Islands (U.S.) * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe id: description: >- Existing address identifier to retain when replacing its collection. Omit for a new entry; supplied identifiers must belong to this parent and occur only once. format: uuid type: string postal_code: description: Postal code of the address. maxLength: 100 minLength: 1 type: string primary: description: >- Whether this is the debtor's primary postal address. A single address defaults to primary when omitted; with multiple addresses, supply this flag on each and set exactly one to true. type: boolean street: description: Street and house number. maxLength: 255 minLength: 1 type: string required: - city - country - postal_code - street type: object BankAccountWriteRequest: description: >- Unknown and read-only request fields are rejected with a validation error instead of being silently ignored. properties: account_holder: default: '' description: Name of the bank-account holder. maxLength: 255 type: string bic: description: >- BIC/SWIFT code; required for non-German IBANs and checked for compatibility with the IBAN country. maxLength: 11 minLength: 1 nullable: true type: string iban: description: IBAN of the debtor's bank account. maxLength: 34 minLength: 1 type: string id: description: >- Existing bank account identifier to retain when replacing its collection. Omit for a new entry; supplied identifiers must belong to this parent and occur only once. format: uuid type: string required: - iban type: object CommunicationChannelWriteRequest: description: >- Unknown and read-only request fields are rejected with a validation error instead of being silently ignored. properties: id: description: >- Existing communication channel identifier to retain when replacing its collection. Omit for a new entry; supplied identifiers must belong to this parent and occur only once. format: uuid type: string type: allOf: - $ref: '#/components/schemas/CommunicationChannelWriteTypeEnum' description: |- Kind of contact channel. * `email` - email * `phone` - phone * `mobile_phone` - mobile_phone value: description: >- Email address for email channels, or a telephone number for phone and mobile_phone channels. Telephone numbers are normalized and validated as E.164; international format such as +4915123456789 is recommended. maxLength: 255 minLength: 1 type: string required: - type - value type: object LegalRepresentativeWriteRequest: anyOf: - properties: organization: description: >- This alternative carries no organization; omit it or set it to null. enum: - null nullable: true person: allOf: - $ref: '#/components/schemas/PersonWriteRequest' description: Required person identity for this alternative. required: - person title: Person identity - properties: organization: allOf: - $ref: '#/components/schemas/OrganizationWriteRequest' description: Required organization identity for this alternative. person: description: This alternative carries no person; omit it or set it to null. enum: - null nullable: true required: - organization title: Organization identity description: >- Unknown and read-only request fields are rejected with a validation error instead of being silently ignored. properties: id: description: >- Existing representative identifier to retain when replacing its collection. Omit for a new entry; supplied identifiers must belong to this parent and occur only once. format: uuid type: string legal_form: description: Legal form of an organization representative. nullable: true type: string legal_representatives: description: >- Second-level representatives of this representative. At most two representative levels are supported. When supplied on an existing representative, this array replaces its nested collection; [] clears it and omission preserves it. Maximum 10 entries. items: $ref: '#/components/schemas/LegalRepresentativeLevelTwoWriteRequest' maxItems: 10 type: array organization: allOf: - $ref: '#/components/schemas/OrganizationWriteRequest' description: >- Organization identity of the representative. Supply exactly one of person or organization; an organization requires name. nullable: true person: allOf: - $ref: '#/components/schemas/PersonWriteRequest' description: >- Natural-person identity of the representative. Supply exactly one of person or organization; a person requires salutation, first_name, and last_name. nullable: true role: allOf: - $ref: '#/components/schemas/RoleEnum' description: |- Legal or organizational role of the representative. * `managing_director` - managing_director * `director` - director * `board_member` - board_member * `chairperson` - chairperson * `general_partner` - general_partner * `shareholder` - shareholder * `owner` - owner * `authorized_signatory` - authorized_signatory * `partner` - partner * `legal_guardian` - legal_guardian * `other` - other required: - role type: object OrganizationPatchRequest: description: >- Partial update of an existing organization. Omitted properties stay unchanged; an empty object is rejected. Creating a new organization during PATCH requires name. minProperties: 1 properties: commercial_register: description: Register court or authority holding the registration. maxLength: 255 nullable: true type: string commercial_registration_number: description: >- Commercial, cooperative, partnership, or association register number (HRA, HRB, GnR, PR, VR; Austrian FN). Free text for foreign legal forms. maxLength: 255 nullable: true type: string name: description: Registered or trading name of the organization. maxLength: 255 minLength: 1 type: string type: object PersonPatchRequest: description: >- Partial update of an existing person. Omitted properties stay unchanged; an empty object is rejected. Creating a new consumer person during PATCH requires first_name and last_name; salutation is optional. minProperties: 1 properties: birth_date: description: Date of birth (YYYY-MM-DD) used to identify the natural person. format: date nullable: true type: string first_name: description: Given name of the natural person. maxLength: 255 minLength: 1 type: string last_name: description: Family name of the natural person. maxLength: 255 minLength: 1 type: string salutation: anyOf: - $ref: '#/components/schemas/SalutationEnum' - enum: - '' type: string description: >- Salutation of the natural person. Consumers may omit it or supply null or an empty string. * `mr` - mr * `ms` - ms * `mx` - mx nullable: true type: object AddressRead: properties: city: description: City or locality of the address. readOnly: true type: string country: description: Country as a two-letter ISO 3166-1 code. readOnly: true type: string id: description: Stable identifier of this address. format: uuid readOnly: true type: string postal_code: description: Postal code of the address. readOnly: true type: string primary: description: Whether this is the debtor's primary postal address. readOnly: true type: boolean street: description: Street and house number. readOnly: true type: string required: - city - country - id - postal_code - primary - street type: object BankAccountRead: properties: account_holder: description: Name of the bank-account holder. readOnly: true type: string bic: description: BIC/SWIFT code of the bank account. nullable: true readOnly: true type: string iban: description: IBAN of the debtor's bank account. readOnly: true type: string id: description: Stable identifier of this bank account. format: uuid readOnly: true type: string required: - account_holder - bic - iban - id type: object CommunicationChannelRead: properties: id: description: Stable identifier of this communication channel. format: uuid readOnly: true type: string type: description: Kind of contact channel. readOnly: true type: string value: description: Email address or telephone number for the selected channel. readOnly: true type: string required: - id - type - value type: object LegacyEventRead: description: Stored events may likewise use retired or internal type values. properties: description: description: Optional description of the event. nullable: true readOnly: true type: string location: description: Optional location associated with the event. nullable: true readOnly: true type: string occurence: description: >- Time at which the event occurred; the historical field spelling is intentional. format: date-time readOnly: true type: string title: description: Human-readable title of the event. readOnly: true type: string type: description: >- Stored event type; historical values may be outside today's input enum. readOnly: true type: string your_reference: description: Your optional reference for the event. nullable: true readOnly: true type: string required: - description - location - occurence - title - type - your_reference type: object LegalRepresentativeRead: properties: id: description: Stable identifier of this legal representative. format: uuid readOnly: true type: string legal_form: description: Legal form of an organization representative. nullable: true readOnly: true type: string legal_representatives: description: >- Second-level people or organizations legally representing this representative. API submissions are limited to 10 entries at the second and final representative level. items: $ref: '#/components/schemas/LegalRepresentativeLevelTwoRead' readOnly: true type: array organization: allOf: - $ref: '#/components/schemas/OrganizationRead' description: Organization identity of the representative. nullable: true readOnly: true person: allOf: - $ref: '#/components/schemas/PersonRead' description: Natural-person identity of the representative. nullable: true readOnly: true role: allOf: - $ref: '#/components/schemas/RoleEnum' description: Legal or organizational role of the representative. readOnly: true required: - id - legal_form - legal_representatives - organization - person - role type: object LegacyMetadataRead: description: Stored types may predate today's resource-specific input choices. properties: type: description: >- Stored metadata type; historical values may be outside today's input enum. readOnly: true type: string value: description: Stored metadata value. readOnly: true type: string required: - type - value type: object OrganizationRead: properties: commercial_register: description: Register court or authority holding the registration. nullable: true readOnly: true type: string commercial_registration_number: description: Commercial, association, or partnership register number. nullable: true readOnly: true type: string name: description: Registered or trading name of the organization. readOnly: true type: string required: - commercial_register - commercial_registration_number - name type: object PersonRead: properties: birth_date: description: Date of birth used to identify the natural person. format: date nullable: true readOnly: true type: string first_name: description: Given name of the natural person. readOnly: true type: string last_name: description: Family name of the natural person. readOnly: true type: string salutation: allOf: - $ref: '#/components/schemas/SalutationEnum' description: >- Salutation of the natural person; null if no supported salutation is stored. nullable: true readOnly: true required: - birth_date - first_name - last_name - salutation type: object ErrorItem: properties: code: description: Machine-readable field error code. type: string field: description: >- Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path. nullable: true type: string message: description: Human-readable explanation of the field error. type: string required: - field - code - message type: object CountryEnum: description: |- * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BE` - Belgium * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BQ` - Bonaire, Sint Eustatius and Saba * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `CV` - Cabo Verde * `KH` - Cambodia * `CM` - Cameroon * `CA` - Canada * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo (the Democratic Republic of the) * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Côte d'Ivoire * `HR` - Croatia * `CU` - Cuba * `CW` - Curaçao * `CY` - Cyprus * `CZ` - Czechia * `DK` - Denmark * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `EE` - Estonia * `SZ` - Eswatini * `ET` - Ethiopia * `FK` - Falkland Islands (Malvinas) * `FO` - Faroe Islands * `FJ` - Fiji * `FI` - Finland * `FR` - France * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `DE` - Germany * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and McDonald Islands * `VA` - Holy See * `HN` - Honduras * `HK` - Hong Kong * `HU` - Hungary * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IE` - Ireland * `IM` - Isle of Man * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `XK` - Kosovo * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Laos * `LV` - Latvia * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `LI` - Liechtenstein * `LT` - Lithuania * `LU` - Luxembourg * `MO` - Macao * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MT` - Malta * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia * `MD` - Moldova * `MC` - Monaco * `MN` - Mongolia * `ME` - Montenegro * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NL` - Netherlands * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `KP` - North Korea * `MK` - North Macedonia * `MP` - Northern Mariana Islands * `NO` - Norway * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestine, State of * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PL` - Poland * `PT` - Portugal * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Réunion * `RO` - Romania * `RU` - Russia * `RW` - Rwanda * `BL` - Saint Barthélemy * `SH` - Saint Helena, Ascension and Tristan da Cunha * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `MF` - Saint Martin (French part) * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `SM` - San Marino * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `RS` - Serbia * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SX` - Sint Maarten (Dutch part) * `SK` - Slovakia * `SI` - Slovenia * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `KR` - South Korea * `SS` - South Sudan * `ES` - Spain * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SE` - Sweden * `CH` - Switzerland * `SY` - Syria * `TW` - Taiwan * `TJ` - Tajikistan * `TZ` - Tanzania * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Türkiye * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `GB` - United Kingdom * `UM` - United States Minor Outlying Islands * `US` - United States of America * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VE` - Venezuela * `VN` - Vietnam * `VG` - Virgin Islands (British) * `VI` - Virgin Islands (U.S.) * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - CV - KH - CM - CA - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - SZ - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - XK - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - KP - MK - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - KR - SS - ES - LK - SD - SR - SJ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - UM - US - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW type: string CommunicationChannelWriteTypeEnum: description: |- * `email` - email * `phone` - phone * `mobile_phone` - mobile_phone enum: - email - phone - mobile_phone type: string PersonWriteRequest: description: An empty object `{}` is rejected — omit the member instead. properties: birth_date: description: >- Date of birth used to identify the natural person; cannot be in the future. format: date nullable: true type: string first_name: description: Given name of the natural person. maxLength: 255 minLength: 1 type: string last_name: description: Family name of the natural person. maxLength: 255 minLength: 1 type: string salutation: allOf: - $ref: '#/components/schemas/SalutationEnum' description: |- Salutation of the natural person. * `mr` - mr * `ms` - ms * `mx` - mx required: - first_name - last_name - salutation type: object OrganizationWriteRequest: description: An empty object `{}` is rejected — omit the member instead. properties: commercial_register: description: Register court or authority holding the registration. maxLength: 255 nullable: true type: string commercial_registration_number: description: >- Register number beginning with HRA, HRB, VR, or PR, followed by one to nine digits and an optional letter; for example, HRB 12345. Whitespace and letter case are normalized. maxLength: 255 nullable: true type: string name: description: Registered or trading name of the organization. maxLength: 255 minLength: 1 type: string required: - name type: object LegalRepresentativeLevelTwoWriteRequest: anyOf: - properties: organization: description: >- This alternative carries no organization; omit it or set it to null. enum: - null nullable: true person: allOf: - $ref: '#/components/schemas/PersonWriteRequest' description: Required person identity for this alternative. required: - person title: Person identity - properties: organization: allOf: - $ref: '#/components/schemas/OrganizationWriteRequest' description: Required organization identity for this alternative. person: description: This alternative carries no person; omit it or set it to null. enum: - null nullable: true required: - organization title: Organization identity description: >- Unknown and read-only request fields are rejected with a validation error instead of being silently ignored. properties: id: description: >- Existing representative identifier to retain when replacing its collection. Omit for a new entry; supplied identifiers must belong to this parent and occur only once. format: uuid type: string legal_form: description: Legal form of an organization representative. nullable: true type: string organization: allOf: - $ref: '#/components/schemas/OrganizationWriteRequest' description: >- Organization identity of the representative. Supply exactly one of person or organization; an organization requires name. nullable: true person: allOf: - $ref: '#/components/schemas/PersonWriteRequest' description: >- Natural-person identity of the representative. Supply exactly one of person or organization; a person requires salutation, first_name, and last_name. nullable: true role: allOf: - $ref: '#/components/schemas/RoleEnum' description: |- Legal or organizational role of the representative. * `managing_director` - managing_director * `director` - director * `board_member` - board_member * `chairperson` - chairperson * `general_partner` - general_partner * `shareholder` - shareholder * `owner` - owner * `authorized_signatory` - authorized_signatory * `partner` - partner * `legal_guardian` - legal_guardian * `other` - other required: - role type: object RoleEnum: enum: - managing_director - director - board_member - chairperson - general_partner - shareholder - owner - authorized_signatory - partner - legal_guardian - other type: string SalutationEnum: enum: - mr - ms - mx type: string LegalRepresentativeLevelTwoRead: properties: id: description: Stable identifier of this legal representative. format: uuid readOnly: true type: string legal_form: description: Legal form of an organization representative. nullable: true readOnly: true type: string organization: allOf: - $ref: '#/components/schemas/OrganizationRead' description: Organization identity of the representative. nullable: true readOnly: true person: allOf: - $ref: '#/components/schemas/PersonRead' description: Natural-person identity of the representative. nullable: true readOnly: true role: allOf: - $ref: '#/components/schemas/RoleEnum' description: Legal or organizational role of the representative. readOnly: true required: - id - legal_form - organization - person - role type: object securitySchemes: caseBearerAuth: description: >- Company-bound Case Management API key — the standard credential for this API. scheme: bearer type: http partnerBearerAuth: description: >- Partner API key acting for one entitled company; every Case request must then also carry the X-On-Behalf-Of-Company header. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.