search

Integration Guide

WhiteLabel Integration Overview

hashtag
KYC Process Overview

hashtag
1. Create Customer Profile

  • Use the Create User (Get KYC URL) endpoint to register the customer in our system.

  • This will return a widget URL, which the user must access to complete OTP validation.

  • If the user is already created, pass the customerId in the Create User (Get KYC URL) endpoint to fetch the widget url again.

hashtag
2. Check User Status

  • Use the Get KYC Status endpoint to track the user’s progress from OTP verification to KYC completion.

  • User can complete OTP verification by logging in through the Create User (Get KYC URL) link.

  • The status will change from LOGIN_REQUIRED to OTP_COMPLETED upon successful OTP verification.

  • KYC Webhook will be sent for each state transition.

hashtag
3. Complete KYC Process

  • The user can proceed with KYC verification directly via the Create User (Get KYC URL) link or client can share the details via KYC sharing endpoint as per the use case.

hashtag
Sharing KYC Details (If Needed or when Not Using Onramp UI for KYC)

Note: This option is not available for India due to compliance rules.

hashtag
1. Check KYC Requirements

hashtag
2. Submit KYC Data (If Applicable)

  • If personal details (e.g., ID number) are required, submit them via the KYC Submit Detail endpoint.

hashtag
3. Upload Supporting Documents (If Applicable)

Once all data is submitted, you will receive an IN_REVIEW webhook for that user. You can also check the status using the Get KYC Status endpoint.

For a full list of KYC status transitions, refer to: Get KYC Status

Note: If you plan to use the kycSharing API (for building your own UI), please confirm and share the list of countries you will be using it for.

hashtag
Transactions Endpoints

After completing KYC, clients can proceed with transactions. Client may also check the User Limitendpoint to verify transaction limits before initiating transactions.

hashtag
Checking User Transaction Limits

  • Clients can use the User Limit endpoint to check the transaction limits for a smoother flow.

  • This endpoint returns the current onramp, offramp, and swap monthly limits used by the user.

  • It also indicates whether additional KYC verification (isNextKycVerificationRequired) is required.

hashtag
Using WhiteLabel Onramp Endpoint

For an onramp use case, follow these steps:

  1. Fetch the quote using Quote endpoint.

  2. Create a transaction using the Create transaction endpoint.

  3. Poll the Bank Details endpoint to fetch fiat payment instructions to display to the user.

  4. Once the user completes the payment, wait for a ONRAMP Webhook update or poll the status using the Get transaction API.

hashtag
Using WhiteLabel Offramp Endpoint

For an offramp use case, follow these steps:

  1. Fetch the quote using Quote endpoint.

  2. Create a fiatAccountId by passing bank account details using the Add Fiat Account API. Alternatively, use the widget by fetching the Bank Widget Url

  3. Create a transaction using the offramp Create transaction endpoint, passing the toAmount, rate from the quote, and fiatAccountId from the addFiatAccount API.

  4. Once the user completes the payment, wait for a OFFRAMP Webhook update or poll the status using the Get transaction endpoint.

hashtag
WhiteLabel Support Endpoint

If a user encounters any issues at any point, client can raise a support ticket using the WhiteLabel support endpoints:

  1. Create a Support Ticket - Use the create ticket endpoint to submit an issue. Create Support Ticket

  2. Fetch Ticket Status - Retrieve the status of a specific support ticket using the Get Support Ticket endpoint.

  3. Fetch All Tickets - To get a list of all support tickets, use the Get all Support Tickets endpoint.

hashtag
Setting Up Webhook URL

Clients can set up a webhook (only POST URLs are allowed) to receive real-time notifications via the API, enabling instant updates on user/order status transitions.

For details on how to set or update your webhook URL, refer to: Webhook Setup and Set/Update Webhook URL

hashtag
Notes

  • Webhooks are recommended over API polling for real-time updates. However, you can use the get status API every 5-10 minutes for better flow.

  • If you plan to use the kyc sharing API (for building your own KYC UI), please confirm and share the list of countries you will be using it for with onramp team.

  • OTP validation is mandatory in our UI.

  • If using onramp widget url for OTP validation only the, pass the closeAfterLogin as true in requestBody of Create User (Get KYC URL)

NextIntegration Flowchart

Last updated