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
  • Creating a KYC Session
  • Create KYC session
  1. API Reference
  2. KYC Sessions

KYC#Create

Creating a KYC Session

Example Request

curl https://{{base_url}}/users/USER_ID/kycs
-X POST \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-type: application/json"

Endpoint Information

Create KYC session

POST https://{{base_url}}/users/:user_id/kycs

Create a KYC session for a user.

Path Parameters

Name
Type
Description

user_id*

UUID

The ID of the user in for whom you want a KYC session.

{
   kyc: {
      user_id: "a25a4274-8f50-4579-b476-8f35b297d4ad",
      url: "https://sumsub.com/idensic/l/#/sbx_VvK9E9P2A23xQPoA"
   }
}

PreviousKYC SessionsNextPayment Details

Last updated 4 months ago