URL Expired

The URL for this request expired after 30 days.

Serializer for starting phone number verification.

phone_number

string

required

length ≤ 50

subdomain

string

required

length ≤ 255

invite_token

string

length ≤ 64

content-type

string

enum

Defaults to application/json

Generated from available request content types

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Allowed:

application/json``application/x-www-form-urlencoded``multipart/form-data

`` 200 Verification started successfully

object

Serializer for token response.

token

string

required

phone_number

string

required

status

string

required

person

object | null

Serializer for Person model.

id

string

required

preferred_name

string

required

length ≤ 255

The preferred name for this person

email_address

string | null

Email address for this person

phone_number

string

required

role

string

enum

• CLIENT - Client
• CO_CLIENT - Co-Client
• FAMILY_MEMBER - Family Member
• ACCOUNTANT - Accountant
• ATTORNEY - Attorney
• OTHER - Other

CLIENT``CO_CLIENT``FAMILY_MEMBER``ACCOUNTANT``ATTORNEY``OTHER

allows_email

boolean

Whether this person allows email communication

`` 400 Invalid phone number or subdomain

Base URL

https://api.flextract.dev/api/verify/start/

xxxxxxxxxx

curl --request POST \

--url https://api.flextract.dev/api/verify/start/ \

--header 'accept: application/json' \

--header 'content-type: application/json'

xxxxxxxxxx

{

"token": "abcdef1234567890",

"phone_number": "+111111111",

"status": "verified",

"person": {

"id": "abc123",

"preferred_name": "John Doe",

"email_address": "john@example.com",

"role": "CLIENT",

"allows_email": true

}

}