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, SpherePay automatically processes the verification and moves the profile to
pending. - 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 by the integrator or customer. Once all actionable requirements are complete, SpherePay processes the verification automatically.
Verification Profile Fields
Here's a brief explanation on each of the items in the verification profile.
| Item | Action required |
|---|---|
| email_address | Provide an email address when creating or updating the customer. |
| phone_number | Provide a phone number when creating or updating the customer. |
| residential_address | Provide a residential address when creating or updating the customer. |
| identity_document | Upload a government-issued identity document via Upload Document. See Document Guideline for accepted formats. |
| tax_identification_number | Provide a tax identification number when creating or updating the customer. See Tax ID Numbers by Country for accepted types. |
| liveness_report_document | Upload a liveness report document via Upload Document. |
| terms_of_service | Accept the terms of service via the link returned by Generate TOS Link. Enhanced requirement — only required for some integrations. |
| email_verification | Verify the email address via OTP Send and OTP Verify. Enhanced requirement — only required for some integrations. |
| phone_verification | Verify the phone number via OTP Send and OTP Verify. Enhanced requirement — only required for some integrations. |
| liveness_check | Complete face liveness verification via the link returned by Face Verification Link. Enhanced requirement — only required for some integrations. |
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 customerId.
Last updated on