Verify Send
The verify-send endpoint is used to initiate the ownership verification process for a user's communication channel (email or phone number). It triggers the delivery of a code that must then be submitted via the /auth/verify endpoint.
POST /auth/verify-send
Requests a verification code for a specific user authority.
Request
POST /auth/verify-send
Headers:
{
"Host": "api.bringyour.com",
"Content-Type": "application/json"
}Body:
{
"user_auth": "string",
"use_numeric": false
}Fields
| Field | Type | Description |
|---|---|---|
user_auth | string | Required. The email address or phone number to verify. |
use_numeric | boolean | Optional. If true, a 6-digit numeric code is generated instead of the default 8-character alphanumeric code. |
Response
200 Success
Status: 200 OK
Content-Type: application/json
{
"user_auth": "string"
}Fields
| Field | Type | Description |
|---|---|---|
user_auth | string | The identifier to which the code was successfully sent. |
Example
HTTP Request
POST /auth/verify-send HTTP/1.1
Host: api.bringyour.com
Content-Type: application/json
{
"user_auth": "user@example.com",
"use_numeric": true
}Successful HTTP Response
{
"user_auth": "user@example.com"
}