Sessions

Init Session

POST https://corporate-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 Client-Id
Api-Key	string	Synaps application 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

Field	Type	Description
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://corporate-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: OK 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: Bad Request Invalid Session-Id

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

List Sessions with alias

GET https://corporate-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"`
    Alias     string `json:"alias"`
}]

List Sessions

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

List sessions with their alias

Path Parameters

Name	Type	Description
state	string	PENDING - Pending sessions FINISHED - Finished sessions CANCELLED - Cancelled sessions

Headers

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

200

[
    {
        "session_id": "24c7892a-c484-6037-3f10-c7170524",
        "alias": "John Doe"
    },
    {
        "session_id": "d66f1417-0ef3-658a-b44b-85d6799c",
        "alias": "Jane Doe"
    },
    {
        "session_id": "7b3b481e-27bb-75a7-c8e3-e0944e05",
        "alias": "Michael Bloom"
    },
    {
        "session_id": "3d6990cd-e08f-e4bc-9fab-f44311b0",
        "alias": "[e-mail]"
    }
]