Sessions

post
Init Session

https://corporate-api.synaps.io/v2/session/init
Initialize a new session to start a new verification process
Request
Response
Request
Headers
Api-Key
required
string
Synaps application Api-Key
Query Parameters
alias
optional
string
Custom alias that will be available in session list
Response
200: OK
Session initialized successfully
{
"session_id": "3d11eb00-ac73-1ba8-35aa-703797ce",
"sandbox": false
}
400: Bad Request
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

get
Session Info

https://corporate-api.synaps.io/v2/session/info
Get information about an initially created session
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
{
"session_id": "938856e8-f2ab-fe7d-7cbe-324a2b4f",
"status": "PENDING",
"last_updated": "2020-06-22T14:23:55.533595Z"
}
400: Bad Request
Invalid Session-Id
{
"api_code": "SESSION_UNKNOWN",
"message": "Unknown session"
}

post
Cancel Session

https://corporate-api.synaps.io/v2/session/cancel
Cancel a session that has no intention to be used. It will avoid unexpected billing operation.
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
‚Äč

get
List Sessions

https://corporate-api.synaps.io/v2/session/list/:state
List sessions with their alias
Request
Response
Request
Path Parameters
state
required
string
PENDING - Pending sessions FINISHED - Finished sessions CANCELLED - Cancelled sessions
Headers
Api-Key
required
string
Synaps application Api-Key
Response
200: OK
[
{
"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": "test@test.io"
}
]