Skip to main content
If your platform already verifies your users, share that data with Crossmint so they skip in-flow verification and are ready to cash out. This guide covers passing that data and confirming the user is verified. For how verification works in depth, see KYC & Compliance. This guide is for platforms that run their own ID and liveness checks. If you do not, let Crossmint verify the user instead: create the order, and when payment.status is requires-kyc, show the verification flow with the credentials in payment.preparation.kyc. The steps are the same as in Embed the KYC Step in Your App, which uses an onramp order as its example.
The user KYC API must be enabled for your project. If calls fail with an error containing is not configured to support the users KYC endpoints, contact sales to enable it.

Register and Verify the User

Each call uses a userId: locator, where <USER_ID> is a unique identifier you choose for the user and reuse across the calls below.
User KYC verification flow: record privacy policy, create user with KYC data, trigger verification, poll until verified
1

Record privacy policy acceptance

Before sharing any user KYC data with Crossmint, the user must accept Crossmint’s Privacy Policy in your app. Consent must be collected with an explicit checkbox and specific wording — see Register User Data for the exact consent-collection requirements. Only once the user has accepted, record their consent:
2

Create the user with KYC data

Send the user’s details along with the KYC data you already hold.
The booleans in the response show which sections were stored.verificationHistory records when your platform completed its own checks: idVerificationTimestamp is when the user passed your ID check, and livenessVerificationTimestamp is when they passed your liveness check. Send the real times from your identity provider.Whether you send verificationHistory depends on how your project is set up for KYC data sharing, and Crossmint sets this when it enables the KYC API:
  • A project set up to rely on your checks requires it. Without it, the request fails with This project is configured to require the "verificationHistory" object when providing KYC data.
  • Any other project rejects it with This project is not configured to support the "verificationHistory" object.
If you get either error, ask Crossmint which setup your project has.
US residents: include kycData.phoneNumber (required), and provide identity via SSN in kycData.identityDocument (no document upload is needed for standard offramp). The dueDiligence object is not required for standard US offramp in most states — include it only where required (see Data Requirements).
3

Trigger verification

Trigger verification so Crossmint runs its compliance checks against the data you provided.
The response returns the eligibility status per product, starting at pending-review.
4

Poll until verified

Verification is asynchronous. Poll until the offramp eligibility reads verified. Only a verified user can create an order. Saving a payment method does not require verification.If the status reads requires-data with a document listed in missingDocuments, Crossmint’s compliance team has requested an additional document — upload it via the Upload Document API and re-trigger verification. See additional document requests.
The exact fields required vary by region. See the Identity data requirements for the full list, and the Identity quickstart for uploading documents when a region requires them.
The account holder name on the user’s saved bank account must match this verified identity. Offramp supports first-party payouts only.

Next Steps

Manage Payment Methods

Save the verified user’s bank account

Quickstart

Build the full flow