ManagedClients

Create a represented client.

Changed on

Obtain authority wording and version from GET /managed-clients/capability. One Idempotency-Key (1–255 non-whitespace characters) is required. Identical normalized retries return the same ID. A changed payload returns 422 IdempotencyConflict. Duplicate external references return 422 ExternalClientIdConflict. Missing or outdated authority acceptance returns 422 AuthorityRequired. An operation in progress returns 409 OperationInProgress with Retry-After: 2. Unsupported properties are rejected. Malformed JSON or model-binding failures return framework ValidationProblemDetails.

post/managed-clients

Request

  • Base URL
    https://collectionpartner-api.debitura.com
  • URL
    https://collectionpartner-api.debitura.com/managed-clients
  • Auth
    API key in header XApiKey

Headers

Idempotency-Keystring required

Exactly one key, 1–255 non-whitespace characters.

Request body

companyNamestring nullable required

Required company name, at most 200 characters after trimming.

addressstring nullable required

Required street address, at most 500 characters after trimming.

citystring nullable required

Required city, at most 200 characters after trimming.

countryAlpha2string nullable required

Required two-letter country code, for example GB. Case-insensitive.

zipCodestring nullable

Optional postal code, at most 50 characters after trimming.

statestring nullable

Optional company state or region, at most 200 characters after trimming.

companyRegistrationNumberstring nullable

Optional company registration number, at most 50 characters after trimming.

vatNumberstring nullable

Optional VAT number, at most 50 characters after trimming.

externalClientIdstring nullable

Optional case-sensitive reference unique to your partner account, at most 200 characters.

authorityAcceptedboolean required

Must be true to confirm authority under the current wording.

authorityVersionstring nullable required

Current authority version from GET /managed-clients/capability.

Response

OK

idstring uuid

Changes