Skip to main content

Report a KYC outcome

POST 
/v1/cardholders/:cardholder_id/kyc

Records the result of an identity check you performed and updates the cardholder's kyc_status.

You run the verification; we record the result. The request is an attestation that says who verified the person, when, how, and what the result was. Because this is a compliance record, provider and verified_at are required.

Reporting approved allows cards to be issued. If you report a new result for a cardholder who was already verified, the new attestation replaces the previous one as the current result. Both records are still kept and can be read.

When you also send the identity and documents​

Usually, you only send the attestation. The identity documents stay with you and your verification provider.

Some processors do their own identity checks and need the person's details and documents before opening an account. For those programs, you can send that information here:

  • identity contains the required identity fields.
  • documents contains the document images.

If the program requires this evidence and you don't provide it, creating an account is rejected with kyc_identity_required. The attestation is still recorded normally.

This is the only API request that accepts files, so it has a larger request size limit. It's designed for up to three documents, with each file up to 20 MiB, base64 encoded.

Documents are stored encrypted outside the main database. We don't return the files later. The documents field in responses only contains metadata, with no URL or file content.

Request​

Responses​

The recorded attestation.