Verify Phone Number

post
Send verification code

https://phone-api.synaps.io/v2/phone/send
Send verification code by SMS or Call
Request
Response
Request
Headers
Session-Id
required
string
Initialized Session-Id
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
{
"session_id": "ca9fc5fd-421d-6990-6f84-15c3b67b"
}
400: Bad Request
Invalid Country
{
"api_code": "PHONE_COUNTRY_CODE_INVALID",
"message": "Invalid country code"
}

API Response

Field

Type

Description

session_id

string

Session-Id of the phone verification

post
Confirm Phone Number

https://phone-api.synaps.io/v2/phone/confirm
Confirm phone number using previously sent authentication code
Request
Response
Request
Headers
Session-Id
required
string
Initialized Session-Id
Form Data Parameters
code
required
string
authentication code
Response
200: OK
Success
{
"api_code": "PHONE_VERIFIED",
"message": "Phone number verified successfully",
}
400: Bad Request
Invalid Country
{
"api_code": "PHONE_COUNTRY_CODE_INVALID",
"message": "Invalid country code"
}