Session

post
Init Session
https://identity-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://identity-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"
}
API Response
Field
Type
Description
session_id
string
Session Id
status
string
PENDING - Session is waiting for information or verification
VERIFIED - Session has been verified
CANCELLED - Session has been cancelled
last_updated
date
Date and time of the last updated status
for this session
post
Cancel Session
https://identity-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
Session cancelled successfully
{
    "api_code": "SESSION_CANCELED",
    "message": "Verification session successfully canceled"
}
400: Bad Request
Invalid Session-Id
{
    "api_code": "SESSION_UNKNOWN",
    "message": "Unknown session"
}
get
List Sessions
https://identity-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
​

AML - Previous

AML Check

Next - Identity Standalone

Submit Document

Last updated 4 months ago

Field	`Type`	Description
session_id	`string`	Session Id
status	`string`	`PENDING` - Session is waiting for information or verification `VERIFIED` - Session has been verified `CANCELLED` - Session has been cancelled
last_updated	`date`	Date and time of the last updated status for this session

Session

postInit Session

getSession Info

postCancel Session

getList Sessions

post
Init Session

get
Session Info

post
Cancel Session

get
List Sessions