Create/Connect a User
Create/Connect a User
All requests to the /v2/users/* endpoints must include both the client_id
and api_key as detailed in the
Authentication document.
Create and verify a user to your application.
Creating/Connecting Users
The process of creating a user or connecting an existing user to your application is the same and requires the same steps as listed below.
Creating users happens through the /v2/users/create endpoint. Once hit, a dots user will be created if one does not exist based on phone number. This user must then be verified through a one-time code sent over text-message. This code can be requested through the /v2/users/send_verification_token endpoint and then verified through the /v2/users/verify_user endpoint.
Method
Call the create endpoint
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| string | ✔️ | User’s email address | |
| country_code | string | ✔️ | User’s phone number country code without the plus sign (‘1’ for the US) |
| phone_number | string | ✔️ | User’s phone number as a string containing only digits |
| first_name | string | ✔️ | User’s first name as a string |
| last_name | string | ✔️ | User’s last name as a string |
| username | string | User’s username on your platform. If the username is taken or left blank a random username will be generated |
2. Request a verification token by calling the send_verification_token endpoint
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| verification_id | string | ✔️ | User’s verification id from the previous call |
3. Submit the verification token by calling the verify_user endpoint
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| verification_id | string | ✔️ | User’s dots id from the previous call |
| verification_token | string | ✔️ | Verification token sent to the user’s phone number |