Sessions

Init Session

POST https://individual-api.synaps.io/v3/session/init

Initialize a new session to start a new verification process

Query Parameters

Name	Type	Description
alias	string	Custom alias that will be available in session list

Headers

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

200 Session initialized successfully

{
    "session_id": "3d11eb00-ac73-1ba8-35aa-703797ce",
    "sandbox": false
}

400 Invalid Api Key

{
    "api_code": "APPS_UNKNOWN_KEY",
    "message": "App invalid key"
}

API Response

session_id	string	Session-Id just created
sandbox	boolean	true if the session is a sandbox session false if the session is a normal session

Session Info

GET https://individual-api.synaps.io/v3/session/info

Get information about an initially created session

Headers

Name	Type	Description
Client-Id	string	Synaps app Client-Id
Session-Id	string	Session-Id that you want retrieve info
Api-Key	string	Synaps app Api-Key

200 Session Information

{
    "session_id": "938856e8-f2ab-fe7d-7cbe-324a2b4f",
    "status": "PENDING",
    "alias": "my session alias",
    "sandbox": false
}

OR

{
    "session_id": "938856e8-f2ab-fe7d-7cbe-324a2b4f",
    "status": "VERIFIED",
    "alias": "my session alias",
    "sandbox": false
}

OR

{
    "session_id": "938856e8-f2ab-fe7d-7cbe-324a2b4f",
    "status": "CANCELLED",
    "alias": "my session alias",
    "sandbox": false
}

400 Invalid Session-Id

{
    "api_code": "SESSION_UNKNOWN",
    "message": "Unknown session"
}

List Sessions with alias

GET https://individual-api.synaps.io/v3/session/alias

List sessions with their alias

Query Parameters

Name	Type	Description
alias	string	Filter response by alias

Headers

Name	Type	Description
Api-Key*	string	Synaps application Api-Key

200: OK Array of sessions

[{
    SessionID string `json:"session_id"`
    Status    string `json:"status"`
    Alias     string `json:"alias"`
}]

List Sessions

GET https://individual-api.synaps.io/v3/session/list/:state

List sessions with their state and alias if needed

Path Parameters

Name	Type	Description
state	string	PENDING - When all the steps of the verification flow are not completed yet FINISHED - When all the steps of the verification are completed and VALIDATED CANCELLED - When a session is cancelled

Query Parameters

Name	Type	Description
alias	string	Filter response by alias

Headers

Name	Type	Description
Api-Key	string	Synaps application Api-Key

200 Array of sessions

[{
    SessionID string `json:"session_id"`
    Alias     string `json:"alias"`
    Status    string `json:"status"`
}]