Skip to main content
POST
/
start-verification
Start Phone Number Verification
curl --request POST \
  --url https://app.closerx.ai/api/start-verification/ \
  --header 'Company-Name: <company-name>' \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "phone_number": "string",
  "friendly_name": "string",
  "sid": "string",
  "auth": "string"
}
'
{
  "sid": 99,
  "phone_number": "+919999008776",
  "validation_code": "838171",
  "call_sid": "<string>"
}

Authorizations

​
api_key
string
header
required

Headers

​
Company-Name
string
required

Schema name for multi-tenancy

Body

application/json
​
phone_number
string
required

Phone number to be verified

Example:

"+919999008776"

​
friendly_name
string
required

Label to identify the phone number

Example:

"TEST"

​
sid
string
required

Twilio Account SID

​
auth
string
required

Twilio Auth Token

Response

Verification initiated successfully

​
sid
integer

Internal system ID for the verification task

Example:

99

​
phone_number
string

Phone number that was verified

Example:

"+919999008776"

​
validation_code
string

The generated code for caller ID validation

Example:

"838171"

​
call_sid
string

Twilio call SID generated for the verification process