POST /kyc-documents/{id}/rejection

Rejects a KYC document and changes the status to rejected. The review time and reviewer information is also updated.

Note: Use this operation for manual overrides.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
message String No

KYC document rejection message.

type String Yes

Reason the document is rejected.

Valid values:

  • "name-mismatch"
  • "document-not-open"
  • "underage-person"
  • "issue-date-missing"
  • "other"
  • "tampered-document"
  • "document-invalid"
  • "document-not-matching"
  • "dob-mismatch"
  • "old-address-on-id"
  • "third-party-or-mismatch"
  • "subtype-missing"
  • "document-expired"
  • "critical-info-missing"
  • "document-duplicate"
  • "document-unreadable"
  • "expiration-date-missing"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.