Skip to main content

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.

Verify an OTP code that was previously sent to a customer’s email address or phone number via the Send Verification Code endpoint. A successful response confirms that the customer controls the specified contact channel and advances their KYC verification criteria. If the code is expired or incorrect, send a new code and prompt the customer to try again.

Endpoint

POST https://api.spherepay.co/v2/customer/{id}/otp-verify

Authentication

All requests must include a Bearer token in the Authorization header.
Authorization: Bearer <token>

Path parameters

id
string
required
The ID of the customer whose OTP code you are verifying.

Request parameters

type
string
required
The contact channel the code was sent to. Must match the type used in the corresponding send request.Accepted values: "email" | "phone"
code
string
required
The OTP code entered by the customer. Between 1 and 10 characters.
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "email",
    "code": "123456"
  }'

Response fields

customerId
string
The ID of the customer whose contact was verified.
verifiedAt
string
ISO 8601 timestamp indicating when the verification was confirmed.
{
  "customerId": "customer_f31121c389624d3697cbf3ea8830b7a4",
  "verifiedAt": "2026-03-09T20:46:31.305Z"
}
Last modified on May 12, 2026