Verification State

To check the verification state of a session, a callable endpoint /state is available in residency endpoints

get
Verification state

https://residency-api.synaps.io/v2/residency/state
Get information about ongoing proof of residency verification
Request
Response
Request
Headers
Session-Id
required
string
Session-Id that you want retrieve info
Api-Key
required
string
Synaps application Api-Key
Response
200: OK
Session information
{
"state": "PENDING"
}
400: Bad Request
Invalid Session-Id
{
"api_code": "SESSION_UNKNOWN",
"message": "Unknown session"
}

API Response

Field

Type

Description

session_id

string

Session Id

state

string

PENDING - Residency in review

VALIDATED - Residency valid

REJECTED - Residency rejected

NOT_STARTED - Residency not yet submitted