v1

latestOpenAPI 3.0.32026-07-24164965.8 KB

api

Verify SMS OTP

Headless checkouts only. This is a non-standard endpoint for headless integrations where the merchant drives phone verification server-to-server. In a typical hosted checkout the customer completes phone verification themselves and this endpoint must not be used.

Verifies a one-time password the customer received by SMS for the given contract. Returns whether the code was valid; on success the phone number is marked as verified.

post/api/checkout/v1/otp/verify/

Request body

external_contract_uuidstring uuid required

The external contract UUID of the application to verify the OTP for

verification_codestring required

The one-time code the customer received by SMS

Response

verifiedboolean required

Whether the supplied code was valid

external_contract_uuidstring uuid required

The external contract UUID that was processed

reasonstring

Reason the code was not accepted (e.g. 'invalid'); empty when verified