Details

Details lets you access the verification response of a given session

get
Document details

https://residency-api.synaps.io/v2/residency/details
Get associated Session-Id details
Request
Response
Request
Headers
Api-Key
required
string
Synaps application Api-Key
Session-Id
required
string
Initialized Session-Id
Response
200: OK
{
"session_id": "ca9fc5fd-421d-6990-6f84-15c3b67b"
}

API Response

Field

Type

Description

valid

boolean

Document validity

true - valid

false - invalid

firstname

string

Legal firstname

lastname

string

Legal lastname

address

string

Address

city

string

City

country

string

Country

issuing_date

string

Issuing Date of proof of residency

Date Format (YYYY-MM-DD)

document_type

string

Document Type

BANK_STATEMENT

UTILITY_BILL

history

array of history object

Array of history containing all previous verification and reason of invalidity

session_id

string

Session ID of the proof of residency verification

state

string

PENDING - Residency in review

VALIDATED - Residency valid

REJECTED - Residency rejected

NOT_STARTED - Residency not yet submitted

file

string

Synaps Signed Link of the Residency File (expires 15min after request)

history object

Field

Type

Description

notice_date

date

Date of verification

state

string

PENDING - Residency in review

VALIDATED - Residency valid

REJECTED - Residency rejected

NOT_STARTED - Residency not yet submitted

review

string

Empty if VALIDATED

Review message explaining the reason of verification incompletion