Create a test customer (sandbox only)

Generates a fully populated fake customer and submits it through KYC automatically. Use kycOutcome to control the resulting KYC status without any manual review. Throws 403 in production.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Type of test customer to create.

Allowed:
string
enum
Defaults to US

ISO 3166-1 alpha-2 country code. Determines locale-accurate address, phone, and tax ID generation. Defaults to US.

string

First name override (INDIVIDUAL only). Ignored for REJECTED/UNDER_REVIEW outcomes.

string

Last name override (INDIVIDUAL only). Ignored for REJECTED/UNDER_REVIEW outcomes.

string

Business name override (BUSINESS only). Used as both legalName and tradeName.

string
enum
Defaults to APPROVED

Desired KYC outcome. Sandbox will automatically reach this state without human interaction.

Allowed:
capabilities
array of strings

Payment capabilities to enable. Defaults to ['USD', 'OTHER'].

capabilities
Allowed:
Responses
201

Test customer created and KYC submitted.

403

Forbidden in production.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!