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.

Send a one-time password (OTP) to a customer’s registered email address or phone number as part of contact verification during the KYC flow. After the code is sent, prompt the customer to enter it and then call the Verify OTP Code endpoint to confirm the contact detail. OTP codes expire at the time indicated by expiresAt in the response — if the code has expired before the customer submits it, call this endpoint again to send a new one.

Endpoint

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

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 to send the verification code to.

Request parameters

type
string
required
The contact channel to send the OTP to.Accepted values: "email" | "phone"
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "email"
  }'

Response fields

customerId
string
The ID of the customer the OTP was sent to.
expiresAt
string
ISO 8601 timestamp indicating when the OTP expires. Send a new code if the customer has not verified before this time.
{
  "customerId": "customer_f31121c389624d3697cbf3ea8830b7a4",
  "expiresAt": "2026-03-09T20:46:31.305Z"
}
Last modified on May 12, 2026