Skip to main content
POST
CLI

Authorizations

Authorization
string
header
required

API Key in Bearer format (e.g., Bearer sk_test_...)

Headers

X-API-Key
string

API key

Body

application/json
type
enum<string>
required

Customer type

Available options:
INDIVIDUAL,
BUSINESS
Example:

"INDIVIDUAL"

countryCode
string
required

Country code (ISO 3166-1 alpha-2)

Example:

"US"

email
string
required

Customer email address. Must be unique within the organization. If a customer with this email already exists, the existing customer will be used.

Example:

"customer@example.com"

name
string
required

Customer name

Example:

"John Doe"

customerId
string

Existing customer ID (optional)

Example:

"cus_abc123"

fillOnBehalf
boolean
default:false

When true, indicates the organization will fill out the verification on behalf of the customer. No reminder emails will be sent.

redirectUrl
string

URL to redirect the user to after verification is completed. When provided, the user will be automatically redirected to this URL after successfully completing the verification flow.

Example:

"https://app.example.com/kyc-complete"

Response

verification
object
required