Skip to content
/
Verify OTP Code

Verify OTP Code

Request

Verifies the OTP code sent to the customer's email address. Upon successful verification, the customer's email is marked as verified. OTP codes are single-use and expire after a set time period. Rate limited to 4 verification attempts per minute per customer.

Security
HMACAuth
Bodyapplication/jsonrequired
identityReferencestring, [ 1 .. 255 ] characters(Identity Reference)^[A-Za-z0-9-]+$required

Identity reference of an existing customer created through our platform

Example:"c-13344"
emailstring, (email)required

The customer's email address

Example:"[email protected]"
codestring, = 4 charactersrequired

The OTP code received via email. Must be 4 characters.

Example:"4205"

Verify the OTP code received via email

curl -i -X POST \
  https://docs.banxa.com/_mock/products/native-api/openapi/eapi/v0/verifications/otp/verify \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "identityReference": "customer-12345",
    "email": "[email protected]",
    "code": "1234"
  }'

Responses

OTP verified successfully. Customer email is now verified.

Headers
X-RateLimit-Limitinteger

Maximum number of verification attempts allowed per minute

Example:4
X-RateLimit-Remaininginteger

Number of verification attempts remaining in current window

Example:3
Bodyapplication/json
messagestringrequired

Success message indicating verification was successful.

Example:"Success"
Response
{
  "message": "Success"
}
© Banxa 2026