Start customer registration
Sends a one-time code by SMS to the mobile number and opens a short-lived verification session. No customer is created until the session is completed. The response is the same whether or not the number already belongs to a customer.
Headers
x-app-platform
Sent by the mobile apps. Case-insensitive, and optional. Only ios and android are accepted; any other value is rejected with 400. White-label signup restrictions apply to every new number, whether or not this header is sent.
Allowed values:
Request
This endpoint expects an object.
clientId
The customer source client id the app is built for.
mobileNumber
Mobile number in international format.
hasAcceptedTermsAndConditions
Must be true.
referralCode
Optional referral code, linked to the customer when a new customer is created.
platformDetails
Optional app and device details, stored when a new customer is created.
Response
The code was sent and the verification session is open.
verificationId
Send this with the code to complete registration.
expiresAt
The session and code stop working at this time.
Errors
400
Bad Request Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
