Individual - Session Overview

GET 
/v4/individual/session/:session_id

Respond with the status of the session and all steps id's that compose it. If you want to fetch specific step data you will need to use the step details enpoints.

Request

Path Parameters

session_id stringrequired

Responses

200

200 response

application/json

Schema

Schema

appobjectrequired
idstringrequired
Example: 12312312314
namestringrequired
Example: Synaps Demo App
sessionobjectrequired

aliasstringrequired

Example: MY_SESSION_ALIAS

idstringrequired

Example: e0d87ad0-3549-4727-8972-7016226f793c

sandboxbooleanrequired

Example: false

statusstringrequired

Possible values: [APPROVED, REJECTED, PENDING_VERIFICATION]

stepsobject[]required

Array [

idstring

Example: 5c30e5c3-ed4b-41e8-8b83-879e1d8120bf

statusstringrequired

Example: APPROVED

typestringrequired

Example: CORPORATE_OFFICER

]

Example (from schema)

{
  "app": {
    "id": "12312312314",
    "name": "Synaps Demo App"
  },
  "session": {
    "alias": "MY_SESSION_ALIAS",
    "id": "e0d87ad0-3549-4727-8972-7016226f793c",
    "sandbox": false,
    "status": "APPROVED",
    "steps": [
      {
        "id": "5c30e5c3-ed4b-41e8-8b83-879e1d8120bf",
        "status": "APPROVED",
        "type": "CORPORATE_OFFICER"
      }
    ]
  }
}

400

400 response

application/json

Schema

Schema

codeint32
Example: 1100220
messagestring
Example: An error occured

Example (from schema)

{
  "code": 1100220,
  "message": "An error occured"
}

401

401 response

application/json

Schema

Schema

codeint32
Example: 1100220
messagestring
Example: An error occured

Example (from schema)

{
  "code": 1100220,
  "message": "An error occured"
}

404

404 response

application/json

Schema

Schema

codeint32
Example: 1100220
messagestring
Example: An error occured

Example (from schema)

{
  "code": 1100220,
  "message": "An error occured"
}

500

500 response

application/json

Schema

Schema

codeint32
Example: 1100220
messagestring
Example: An error occured

Example (from schema)

{
  "code": 1100220,
  "message": "An error occured"
}