DEdebitura
Clients

Submit KYC verification for a client

Changed on

Submits KYC/AML director verification data for an existing client. Multiple submissions are allowed; the latest record is used for verification checks. When sendChatNotification is true (default), a system message is posted on all active cases for this client to notify the collection partner.

post/clients/{externalTenantId}/kyc-verification

Request

  • Base URL
    https://referral-api.debitura.com
  • URL
    https://referral-api.debitura.com/clients/{externalTenantId}/kyc-verification
  • Auth
    API key in header XApiKey

Path parameters

externalTenantIdstring required

Query parameters

sendChatNotificationboolean

Headers

Idempotency-Keystring

Optional non-empty, non-whitespace idempotency key (max 255 characters) for safely retrying this request. If a previous request used the same key with an identical body, the original terminal response is replayed verbatim. Reusing the key with a different body returns 422 with businessErrors[0].type: "IdempotencyConflict". Field-level 400 validation errors are not stored, so you may fix the request and retry with the same key.

Request body

directorFullNamestring required
directorHomeAddressstring required
directorDateOfBirthstring date required

Response

KYC verification submitted

directorFullNamestring nullable
directorHomeAddressstring nullable
directorDateOfBirthstring date
dateCreatedstring date-time
verificationStatus'Processing' | 'Completed' | 'null' nullable

Partner/staff-set review status (Processing/Completed) for this submission. Null = not yet reviewed. Note: distinct from the sibling ClientResponse.KycStatus field, which describes whether KYC data has been submitted at all.

verificationStatusUpdatedAtstring date-time nullable

When VerificationStatus was last set. Null until set.

Changes

  • 7b3700202decRevision changes
    • breaking

      the response property became nullable for the status (media type: text/plain)

    • breaking

      the response property became nullable for the status (media type: application/json)

    • breaking

      the response property became nullable for the status (media type: text/json)

    • warning

      added the new undefined enum value to the response property for the response status (media type: text/plain)

    • warning

      added the new undefined enum value to the response property for the response status (media type: application/json)

    • warning

      added the new undefined enum value to the response property for the response status (media type: text/json)

  • 98a930b13785Revision changes
    • breaking

      for the header request parameter Idempotency-Key, the minLength was increased from 0 to 1