Once a customer has satisfied all prerequisite verification steps, call this endpoint to generate a KYC link and submit them for review. KYC links are primarily intended for business customers — SpherePay recommends completing individual KYC directly through the API. The response returns a time-limited URL that you redirect the customer to for any remaining identity checks handled by the verification provider.Documentation Index
Fetch the complete documentation index at: https://docs.spherepay.co/llms.txt
Use this file to discover all available pages before exploring further.
Before calling this endpoint, ensure the customer has completed all steps listed in the
required array of their verificationProfiles[].criteria object. Submitting a customer with outstanding criteria will result in an error.Prerequisites
The following steps must be completed before submitting for review:- All required documents uploaded (e.g. government-issued ID)
- Liveness check completed (for individual customers)
- Terms of Service accepted
verificationProfiles[].criteria.required.
Endpoint
Authentication
All requests require a Bearer token in theAuthorization header.
Path parameters
The unique customer ID, prefixed with
customer_ (e.g. customer_f31121c389624d3697cbf3ea8830b7a4).Request body
This endpoint does not require a request body.Response fields
A time-limited URL that you redirect the customer to in order to complete any remaining verification steps with the identity provider.
ISO 8601 timestamp after which the URL is no longer valid. Generate a new link if it expires before the customer completes the flow.
What happens next
After the customer completes the verification flow at the returned URL, SpherePay will process the results and update the customer’sverificationProfiles[].status. Poll GET /v2/customer/ or listen for webhook events to detect when the status transitions to approved or rejected.
| Status | Meaning |
|---|---|
pending | Submission received, review in progress. |
approved | Customer passed KYC/KYB and is eligible for transfers. |
rejected | Verification was declined. Contact SpherePay support for next steps. |
Error codes
| Status | Code | Description |
|---|---|---|
400 | address/invalid | The customer record is incomplete or in an invalid state for submission. |
404 | resource/not-found | No customer exists with the given ID. |
422 | validation/failed | The customer has outstanding required criteria that must be resolved first. |