API Documentation
Offramps API
Offramps API
  • Guides
    • Getting Started
  • API Reference
    • Authentication
    • Agreements
      • Agreements#Show
    • Users
      • Users#Create
      • Users#Show
      • Users#Index
    • KYC Sessions
      • KYC#Create
    • Payment Details
      • PaymentDetails#Create
      • PaymentDetails#Index
      • PaymentDetails#Show
      • PaymentDetails#Validate
      • PaymentDetails#Deactivate
      • Rail Availability
      • Required Fields For Local Currency Payouts
      • Required Fields For Swift Currency Payouts
    • Quotes
      • How to make a payment
      • Quotes#Create
      • Quotes#Show
      • Quotes#Execute
      • Quote#Rate
    • Offramps
      • Offramps#Index
      • Offramps#Create
      • Offramps#Update
      • Offramps#Show
      • Limitations
    • Webhooks
      • KYC Webhook
      • Offramp Webhook
      • Payment Detail Webhook
      • Webhook Signatures
    • Errors
    • Conversions
      • Conversions#Create
  • Sandbox Only
    • Sandbox Special Moves
Powered by GitBook
On this page
  1. API Reference

KYC Sessions

Creating a KYC Session provides a URL through which your user can identify themselves with our KYC partner.

The KYC Status Lifecycle

not_started - Verification URL has not yet been opened.

intiated - Verification URL has been opened but not yet completed.

pending_assessment - Verification has been completed but no checks have been performed.

prechecks_completed - Preliminary checks have been completed.

application_queued - Verification attempt is now waiting full review.

awaiting_manual_review - Verification attempt is awaiting manual review by the Cheq team.

retry_required - A new verification URL needs to be requested for the user to provide additional information.

approved - User has successfully passed verification.

failed - User has failed verification and cannot use the platform.

PreviousUsers#IndexNextKYC#Create