Phone

Send verification code

POST https://individual-api.synaps.io/v3/phone/send

Send verification code by SMS or Call

Query Parameters

Name	Type	Description
step_id	string	Step ID of the phone verification step

Headers

Name	Type	Description
Session-Id	string	Initialized Session-Id

Request Body

Name	Type	Description
method	string	verification method call - by call sms - by text message
phone_number	string	Phone Number
country_code	string	Phone Country Code (cf. Country Calling Code Page) (e.g. for France send +33 as country_code value)

200 Success

API Response

Field	Type	Description
session_id	string	Session-Id of the phone verification

Confirm Phone Number

POST https://individual-api.synaps.io/v3/phone/confirm

Confirm phone number using previously sent authentication code

Query Parameters

Name	Type	Description
step_id	string	Step ID of the phone verification step

Headers

Name	Type	Description
Session-Id	string	Initialized Session-Id

Request Body

Name	Type	Description
code	string	authentication code

200

Get phone verification details

GET https://individual-api.synaps.io/v3/phone/details

All information about phone verification details

Query Parameters

Name	Type	Description
step_id	string	step_id of the phone verification step

Headers

Name	Type	Description
Session-Id	string	Synaps Session-Id
Api-Key	string	Synaps Api-Key
Client-Id	string	Synaps Client-Id

200

{
    "verification": {
        "phone_country": "33",
        "phone_number": "0683928392",
        "carrier": {
            "type": "mobile",
            "name": "SOCIETE FRANCAISE DU RADIOTELEPHONE (SFR)"
        },
        "attempts": [
            {
                "method": "sms",
                "time": "2021-08-02 15:04:05"
            }
        ],
        "state": "VALIDATED"
    },
    "type": "PHONE"
}

API Response

PhoneVerificationResponse | Object

Field	Type	Description
phone_country	string	country calling code (see country calling codes reference)
phone_number	string	phone number
carrier	PhoneVerificationCarrier | Object	phone network carrier
attempts	PhoneVerificationAttempts | Array	Attempts info
state	string	Verification state VALIDATED NOT_STARTED PENDING FINAL_REJECTED

PhoneVerificationCarrier | Object

Field	Type	Description
phone_country	string	country calling code (see country calling codes reference)
phone_number	string	phone number

PhoneVerificationAttempts | Array

Field	Type	Description
date	string	attempt date (YYYY-MM-DD HH:ii:ss)
method	string	Verification method sms call