Skip to main content
GET
/
api
/
v1
/
session
/
{session_id}
Get session details
curl --request GET \
  --url https://api.algoreg.com/api/v1/session/{session_id} \
  --header 'Authorization: Bearer <token>'
{
  "session": {
      "external_id": "",
      "scenario_ref": "your_scenario_ref",
      "scenario_id": 7,
      "scenario_revision_id": 1,
      "date_start": "2018-08-03T12:31:34Z",
      "consent_date": "2018-08-03T12:31:38Z",
      "date_end": "2018-08-03T12:33:09Z",
      "language": "English (United States)",
      "state": "completed"
  },
  "onboarding_customer": {
      "external_id": "",
      "firstname": "customer_firstname",
      "lastname": "customer_lastname",
      "phone": "00352621621621",
      "birthdate": "1970-01-01",
      "address": "Address",
      "zip": "ZipCode",
      "country": "FR",
      "city": "Cityname"
  },
  "decisions": [
    {
      "id": 510,
      "comment": "All good",
      "date": "2023-06-07T13:59:03Z",
      "last": true,
      "label": "PASS",
      "type": "POSITIVE"
    },
  ]
}

Response

Content-Type: application/json
ParameterTypeDescription
sessionobjectSession details, see “session” reference
onboarding_customerobjectCustomer details, see “onboarding_customer” reference
decisionsarrayArray of decisions, see “decision” reference
ParameterTypeDescription
external_idstringExternal ID
scenario_refstringScenario reference
scenario_idintegerScenario ID
scenario_revision_idintegerScenario revision ID
date_startstringSession start date
consent_datestringSession consent date
date_endstringSession end date
languagestringSession language
statestringSession state
ParameterTypeDescription
external_idstringExternal ID
firstnamestringCustomer firstname
lastnamestringCustomer lastname
phonestringCustomer phone number
birthdatestringCustomer birthdate
addressstringCustomer address
zipstringCustomer zip code
countrystringCustomer country
citystringCustomer city
ParameterTypeDescription
idnumberDecision ID
commentstringDecision comment
datestringDecision date
laststringDecision last
labelstringDecision label
typestringDecision type
{
  "session": {
      "external_id": "",
      "scenario_ref": "your_scenario_ref",
      "scenario_id": 7,
      "scenario_revision_id": 1,
      "date_start": "2018-08-03T12:31:34Z",
      "consent_date": "2018-08-03T12:31:38Z",
      "date_end": "2018-08-03T12:33:09Z",
      "language": "English (United States)",
      "state": "completed"
  },
  "onboarding_customer": {
      "external_id": "",
      "firstname": "customer_firstname",
      "lastname": "customer_lastname",
      "phone": "00352621621621",
      "birthdate": "1970-01-01",
      "address": "Address",
      "zip": "ZipCode",
      "country": "FR",
      "city": "Cityname"
  },
  "decisions": [
    {
      "id": 510,
      "comment": "All good",
      "date": "2023-06-07T13:59:03Z",
      "last": true,
      "label": "PASS",
      "type": "POSITIVE"
    },
  ]
}
I