public

Create a KYC case

Creates a new KYC case for screening and returns a case ID along with an embeddable case URL.

post/v1/kyc-cases

Request

  • Base URL: https://api.withentropy.ai
  • URL: https://api.withentropy.ai/v1/kyc-cases
  • Auth: API key in header x-api-key

Request body

externalIdstring required

External identifier from your system

Example request

{
  "person": {
    "name": "John Doe",
    "dateOfBirth": "1990-01-15",
    "country": "United States",
    "countryOfResidence": "United States",
    "address": "123 Main Street, New York",
    "nationality": "American",
    "customData": {
      "fatherName": "Ahmed Hassan"
    }
  },
  "externalId": "customer_123",
  "customData": {
    "complyAdvantageId": "ca_12345"
  }
}

Response

KYC case created successfully

idstring required

Unique identifier for the created KYC case

caseUrlstring required

URL to view the case that can be embedded

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "caseUrl": "https://platform.getremo.ai/dashboard/kyc-case/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Changes

No recorded changes to this operation across all 1 revision of this API.