Verify Phone Number

post
Send verification code

https://workflow-api.synaps.io/v2/workflow/phone/send
Send verification code by SMS or Call
Request
Response
Request
Headers
Session-Id
required
string
Initialized Session-Id
Query Parameters
step_id
required
string
Step ID of the phone verification step
Form Data Parameters
method
required
string
verification method call - by call sms - by text message
phone_number
required
string
Phone Number
country_code
required
string
Phone Country Code (cf. Country Calling Code Page) (e.g. for France send +33 as country_code value)
Response
200: OK
Success

API Response

Field

Type

Description

session_id

string

Session-Id of the phone verification

post
Confirm Phone Number

https://workflow-api.synaps.io/v2/workflow/phone/confirm
Confirm phone number using previously sent authentication code
Request
Response
Request
Headers
Session-Id
required
string
Initialized Session-Id
Query Parameters
step_id
required
string
Step ID of the phone verification step
Form Data Parameters
code
required
string
authentication code
Response
200: OK