Synaps

Session

Represent a KYC or KYB session for a given user.

POST/v4/session/init

Init a new session

This endpoint allows you to initalize a new session for a given user. You should store the session_id in your database for each of your user.

  • Name
    Api-Key
    Type
    string
    Description

    The API key used for authentication.

Body

  • Name
    OPTIONAL
    EXPERIMENTAL
    metadata
    Type
    object
    Description

    A map of string and value limited to 5 keys of 255 characters.

  • Name
    OPTIONAL
    alias
    Type
    string
    Description

    An alias that let you identify the user in your system.

POST
https://api.synaps.io/v4/session/init
curl --location --request POST 'https://api.synaps.io/v4/session/init' \
--header 'Api-Key: YOUR_API_KEY'

Response

  • Name
    session_id
    Type
    string
    Description

    The session id to use for the next steps.

  • Name
    sandbox
    Type
    boolean
    Description

    Whether the session is in sandbox mode or not.

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