Corporate - Session Overview

GET 
/v4/corporate/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 corporate step details or individual session overview for individual (CORPORATE_OFFICER for example).

Request

Path Parameters

session_id stringrequired

Responses

200

200 response

application/json

Schema

Schema

app

object

required

id stringrequired

name stringrequired

session

object

required

alias stringrequired

id stringrequired

sandbox booleanrequired

status stringrequired

Possible values: [APPROVED, REJECTED, PENDING]

steps

object[]

required

Array [

id string

status stringrequired

type stringrequired

]

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

code int32
message string

Example (from schema)

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

401

401 response

application/json

Schema

Schema

code int32
message string

Example (from schema)

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

404

404 response

application/json

Schema

Schema

code int32
message string

Example (from schema)

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

500

500 response

application/json

Schema

Schema

code int32
message string

Example (from schema)

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

Loading...