Request Code
POST {{URL}}/v1/account
Make a POST call to this endpoint to request a registration code. In your call, add your phone number and base64-encoded certificate string. You can receive your code via either SMS or voice call.
Request Parameters
| Name | Description |
|---|---|
cc
|
Required
.
The numerical country code for the phone number you are registering. |
phone_number
|
Required
.
The phone number you are registering, without the country code or plus symbol (
+
).
|
method
|
Required
.
The method of receiving your registration code. Options:
VOICE
,
SMS
|
cert
|
Required
.
The Base64-encoded certificate. |
pin
|
Optional
.
Existing 6-digit PIN — This is only required when two-factor verification is enabled on this account. |
Response
Depending on the response received, the registration procedure can be considered complete or require another step to complete. If successful, you receive one of the following HTTP status codes. Follow the instructions that match the response you received:
-
201 Created— The account already exists. You are already registered, so you do not need to do anything else. -
202 Accepted— The account does not exist. Depending on the method selected in the request, check your SMS or voice number for the registration code. This response will include a returned payload that contains thevnamedecoded from thecertparameter for you to confirm the right display name is being set. If correct, proceed to Completing Your Account Registration to complete registration.
If any errors are returned, refer to Error and Status Messages for more information.
Request Body
{"cc"=>"<Country Code>", "phone_number"=>"<Phone Number>", "method"=>"< sms | voice >", "cert"=>"<Valid Cert from Business Manager>", "pin"=>"<Two-Step Verification PIN"}
HEADERS
| Key | Datatype | Required | Description |
| Content-Type | string | | |
| Authorization | string | | |
RESPONSES
status: Created
{"meta":{"api_status":"stable","version":"v2.45.1"}}