Skip to main content
Advance a sandbox customer
This endpoint works only against https://api.sandbox.spherepay.co. It reports a simulated verification outcome for a customer, because sandbox never calls the verification providers. approved approves every verification profile the customer has (A, and C and D where they apply), so the customer can use every route those profiles open; rejected rejects them all. Pass profile to advance one profile: A (kyc_profile_a, kyb_profile_a), or approve C or D (kyc_profile_c, kyc_profile_d, kyb_profile_c, kyb_profile_d) while the others stay as they are. Customers onboarded through the hosted KYC link are advanced the same way. Advancing to the current outcome changes nothing, and a rejected customer cannot be approved (422).

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
outcome
enum<string>
required

The verification outcome the provider reports for the customer.

Available options:
approved,
rejected
Example:

"approved"

profile
enum<string>

Advance only this profile: A (kyc_profile_a, kyb_profile_a), or approve C or D (kyc_profile_c, kyc_profile_d, kyb_profile_c, kyb_profile_d) while the others stay as they are. Use the kyc_ names for individuals and the kyb_ names for businesses; a business C or D also covers its representatives. Omit it to advance every profile the customer has.

Available options:
kyc_profile_a,
kyb_profile_a,
kyc_profile_c,
kyb_profile_c,
kyc_profile_d,
kyb_profile_d
Example:

"kyc_profile_a"

Response

Response containing information about an individual customer.

createdAt
string
required

ISO 8601 formatted customer creation timestamp

Example:

"2026-03-09T20:46:31.305Z"

enabledVerificationProfiles
enum<string>[] | null
required

Which verification profile families this customer may onboard through. Set explicitly at creation — from the request when supplied, otherwise a snapshot of the application's families at that moment — and thereafter changed only by an explicit update, so it does not follow later changes to the application. Always a subset of the application's families. Distinct from verificationProfiles, which reports the evaluated profiles and their statuses.

Available options:
a,
b,
c,
d
Example:
id
string
required

Customer ID

Example:

"customer_f31121c389624d3697cbf3ea8830b7a4"

tosStatus
enum<string>
required

Customer Terms of Service acceptance status (incomplete | pending | approved).

Available options:
incomplete,
pending,
approved
Example:

"incomplete"

type
enum<string>
required

Customer type

Available options:
individual
Example:

"individual"

updatedAt
string
required

ISO 8601 formatted customer update timestamp

Example:

"2026-03-09T20:46:31.305Z"

verificationProfiles
object[]
required

The evaluated verification profiles for this customer and their statuses — what the customer is being assessed against right now, as opposed to enabledVerificationProfiles, which says which families they are permitted to use. Array of verification profiles. For individual customers, this will include kyc_profile_a. For business customers, this will include kyb_profile_a. See KYC Flow for individuals or KYB Flow for businesses. See Verification Profile for individual status definitions and criteria breakdown or Verification Profile for business status definitions and criteria breakdown.

Example:
dateOfBirth
string

The customer's date of birth in YYYY-MM-DD format (individual customers only).

Example:

"1990-01-15"

email
string

Customer email address

Example:

"jane.smith@example.com"

firstName
string

Customer first name (individual customers only)

Example:

"Jane"

lastName
string

Customer last name (individual customers only)

Example:

"Smith"

meta
object
personalInformation
object

Personal information for an individual customer, echoed back from the most recent submission. The tax identification number is omitted from responses for privacy.

phone
string

Customer phone number

Example:

"+14155550123"

statusDetails
object

Additional context on why the customer's verification reached its current status.

Example:
Last modified on November 16, 2026