Users

A user is an individual who belongs to your account, identified by email. Create a user before you generate a payment link for them.

Identity verification is a separate, optional step. Nothing in this section requires it and the payment endpoints do not check it. Reach for KYC Verification when your compliance policy calls for verifying a user, and the KYC Verification Guide for the end-to-end flow.

Why these paths start with /kyc: these endpoints live under /api/v1/kyc/users for historical reasons, from when creating a user and verifying them were a single flow. The prefix carries no meaning today - a user created here is a plain user record, verified or not.

In this section

EndpointWhat it does
POST /kyc/usersCreate one user, or return the existing one with the same email
POST /kyc/users/bulkCreate up to 500 users in one call, with per-item results
PATCH /kyc/users/USER_IDUpdate a user's name or email
PATCH /kyc/users/USER_ID/verification-modeSwitch between managed KYC and external attestation
POST /kyc/users/USER_ID/activateReactivate a deactivated user
POST /kyc/users/USER_ID/deactivateSoft-delete a user
GET /kyc/listsList users with their verification state, paginated and filterable