Verification Profile
Reference for verification profile statuses, criteria arrays, and required fields for individual customer onboarding.
Introduction
A verification profile is a record of the requirements SpherePay needs to approve an individual customer for transfers. It is returned as part of the verificationProfiles array when you call Get Customer.
Most integrations will see a single profile in the verificationProfiles array. A customer is ready to transfer when that profile's status reaches approved. Additional profiles may appear if your integration requires extended capabilities — if you see unexpected profile names, contact your SpherePay representative.
Multiple verification profiles
Different profiles unlock different transfer capabilities. Contact your SpherePay representative to understand which profile applies to your integration.
Verification Status
The status field on a verification profile has four possible values:
| Status | Description | Can Initiate Transfers? |
|---|---|---|
incomplete | The verification profile is incomplete. The customer has not yet completed all the verification requirements. This is the initial state of a verification profile. | No |
pending | The verification profile is pending. The customer has completed all the verification requirements and is waiting for approval. This is the state when the verification profile is being reviewed by SpherePay. | No |
approved | The verification profile is approved. The customer has completed all the verification requirements and is approved. This is the state when the verification profile is approved by SpherePay. | Yes |
rejected | The verification profile is rejected. The customer has not completed all the verification requirements and is rejected. This is the state when the verification profile is rejected by SpherePay. | No |
Status Lifecycle
A verification profile moves through states in the following order:
incomplete → pending → approved
↘
rejected- A customer starts as
incomplete. Thecriteria.requiredarray lists all outstanding requirements. - Once all requirements are fulfilled and
submit-verificationis called, the profile moves topending. - SpherePay completes the review and transitions the profile to either
approvedorrejected.
Verification Criteria
Each verification profile contains a criteria object with four arrays that describe the current state of each requirement:
| Criteria Array | Description |
|---|---|
complete | Requirements that have been fulfilled. No further action needed. |
pending | Requirements currently being processed by SpherePay. The customer must wait. |
required | Requirements that must be completed before the profile can be approved. The customer must act on these items. |
errors | Requirements with validation errors. The customer must correct these before resubmitting. |
To submit for approval, all items in required must be resolved. Once only identity_verification and kyc_a_approval remain in required (these are fulfilled by SpherePay after submission), the customer can call the Submit Verification endpoint.
Verification Profile Fields
Here's a brief explanation on each of the items in the verification profile.
| Item | Action required |
|---|---|
| terms_of_service | Customer is required to accept the terms of service by clicking the link provided in the response of Generate TOS Link Endpoint |
| email_address | Customer is required to provide an email address upon customer creation or update. |
| email_verification | Customer is required to verify their email address via OTP Verify Endpoint |
| phone_number | Customer is required to provide a phone number upon customer creation or update. |
| phone_verification | Customer is required to verify their phone number via OTP Verify Endpoint |
| residential_address | Customer is required to provide a residential address upon customer creation or update. |
| identity_document | Customer is required to upload an identity document for verification via Upload Document Endpoint |
| tax_identification_number | Customer is required to provide a tax identification number upon customer creation or update. |
| liveness_check | Customer is required to pass the liveness check via Face Verification Link Endpoint |
Handling Rejected Customers
A rejected status means the verification could not be approved based on the submitted information. Customers with a rejected profile cannot initiate or receive transfers.
If a customer is incorrectly rejected or requires re-review, contact support@spherepay.co with the customer_id.
Last updated on