Skip to main content
POST
/
simulator
/
customer-kyb
Simulate Customer KYB
curl --request POST \
  --url https://api.conduit.financial/simulator/customer-kyb \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>' \
  --data '
{
  "id": "cus_2ofTA13AD0xBtbEvBl20aEb1hEu",
  "countryCode": "USA"
}
'
{
  "errors": [
    {
      "detail": "<string>",
      "code": "<string>"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Includes an API key in the HTTP headers to authenticate the client.

​
X-API-Secret
string
header
required

Includes an API secret in the HTTP headers to authenticate the client.

Body

application/json
​
id
required

A valid Customer ID

Pattern: ^cus_[a-zA-Z0-9]{27}$
Example:

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

​
countryCode
string
required

ISO 3166-1 alpha-3 country code

Example:

"USA"

Response

Input validation error

​
errors
object[]
required