KYC via Link
This guide walks you through onboarding customers using the Customer KYC Link.
Introduction
To initiate the KYC process via link, generate a KYC link and redirect the customer to the hosted KYC page to complete the verification process. This method is ideal for rapid integration and is best suited for integrators who prefer using SpherePay's native KYC experience.
Before you begin
Ensure you have:
- A SpherePay API key — see Authentication
- The customer's email address and phone number to create their profile
KYC Link Flow
KYC via Link
The KYC link redirects the customer to a hosted page where they complete the full verification process — document upload, face liveness, and OTP — without any additional API calls on your side. To create a KYC link, use the Create KYC Link endpoint.
Onboarding a Customer step by step using KYC Link
The following steps will guide you through the process of onboarding a customer step by step using KYC Link.
1. Create a Customer
To create a customer, you can use the Create Customer endpoint.
POSThttps://api.spherepay.co/v2/customer
Request Example
{
"type": "individual",
"email": "jane.doe@example.com",
"phone": "+14155551234",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"postalCode": "string",
"state": "string",
"country": "string"
}
}2. Accepting Terms of Service
After a customer has been created, you can generate a TOS link to redirect the customer to the Terms of Service and Privacy Policy. To generate a TOS link, you can use the Generate TOS Link endpoint
POSThttps://api.spherepay.co/v2/customer/{id}/tos-link
Once the link is generated, you can redirect the customer to the link to complete the onboarding process. The customer is expected to accept the Terms and Conditions, and Privacy Policy before proceeding.
3. Generate a KYC Link
In parallel with the TOS step, generate a KYC link to collect the customer's identity information. To generate a KYC link, you can use the Generate KYC Link endpoint.
POSThttps://api.spherepay.co/v2/customer/{id}/kyc-link
Once the link is generated, redirect the customer to the page to complete the KYC process. The hosted experience handles document upload, face liveness verification, and OTP verification in one flow.
Bank account registration
During the KYC flow, the customer may register a bank account. It will remain in pending status until their identity is fully verified and the profile reaches approved.
4. Check Customer Status
After the customer has completed the KYC process, poll Get Customer until status in verificationProfiles reaches approved.
https://api.spherepay.co/v2/customer/{id}
Approved Response Example
{
"id": "customer_4914a2f6226e42cc8d207ead9573b29f",
"type": "individual",
"verificationProfiles": [
{
"name": "kyc_profile_a",
"status": "approved",
"criteria": {
"complete": [
"email_address",
"phone_number",
"residential_address",
"tax_identification_number",
"terms_of_service",
"email_verification",
"phone_verification",
"identity_document",
"liveness_check",
"identity_verification",
"kyc_a_approval"
],
"pending": [],
"required": [],
"errors": []
}
}
]
}When required is empty and status is approved, the customer is fully onboarded and ready to transfer.
What's Next
With the customer onboarded, register their payment methods before initiating a transfer.
Register Payment Methods
Create a Transfer
Make Routine Transfers Easier with Onramper Accounts & Offloader Wallets
Last updated on