Skip to main content
POST
Simulate KYB status
Simulation endpoints are available only outside production. For user-targeted requests, omit user_id when using a valid API key or session cookie; otherwise supply user_id. A supplied ID must match the authenticated user. Invalid credentials are rejected, and both credentials must identify the same user when supplied together. Signed API keys require their normal request-signature headers. Every user is automatically KYB-approved in development and staging; simulated applicant statuses do not change this admission policy.

Headers

X-Api-Key
string | null

Optional API key. Identifies the target user when user_id is omitted; signed keys also require request-signature headers.

Body

application/json

Non-production KYB state to apply to a test account.

Non-production KYB state change for a test account.

status
enum<string>
required

KYB status value to apply in a non-production simulation.

Available options:
approved,
rejected,
pending
user_id
string<uuid> | null

Required only when no API key or session is supplied. Must match authenticated identity.

Response

Simulated KYB status updated

data
object
required

Result returned after applying a non-production KYB state.

status
enum<string>
required
Available options:
success