Skip to navigation

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-platformenumOptional

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.
clientIdstringRequired
The customer source client id the app is built for.
mobileNumberstringRequired
Mobile number in international format.
hasAcceptedTermsAndConditionsbooleanRequired

Must be true.

referralCodestringOptional<=64 characters
Optional referral code, linked to the customer when a new customer is created.
platformDetailsmap from strings to anyOptional
Optional app and device details, stored when a new customer is created.

Response

The code was sent and the verification session is open.
verificationIdstringformat: "uuid"
Send this with the code to complete registration.
expiresAtdatetime
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