---
title: "Get Enrollment Session"
method: GET
path: "/biometrics/1/enrollment/sessions"
tags: ["connectivity", "biometrics", "enrollment-session"]
---

# Get Enrollment Session

`GET /biometrics/1/enrollment/sessions`

## Request

- Base URL: `https://api.infobip.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.infobip.com/biometrics/1/enrollment/sessions`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `Authorization`
  - HTTP basic
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.infobip.com/auth/1/oauth2/token`

This function is used to retrieve a session by `sessionId` received in the [Create Enrollment Session](#platform-connectivity/biometrics/create-biometrics-enrollment-session) response.

## Headers

- `X-Session-Id` string, required

## Response `200`

OK

- 8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9GetSessionResponse: JSON containing execution results and details about the retrieved session.
  - `session` 8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9GenericSession: Session object.
    - `scenarioName` string, required: Request a specific scenario within the application.
    - `locationInfo` 8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9LocationInfo, required: End user location information.
      - `country` string, required: End user country needed for processing documents. Format [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
      - `language` string: End user language. Will be used within the UI when completing scenario steps. Format: [ISO 639-1](http://www.lingoes.net/en/translator/langcode.htm).
    - `partnerReference` string: Your (usually unique) identifier of the end user performing the scenario. Will be sent together with the rest of the information via the webhook.
    - `webhook` 8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9WebhookInfo, required: Webhook that will be called with the information about the request status. The webhook will be called with a POST method that contains all the info in JSON format. Check webhook endpoint for more details.
      - `url` string, uri, required: Your webhook URL onto which the request is received.
      - `type` 'ON_END' | 'ON_STATUS_CHANGE': Defines what kind of requests you want to receive on a webhook. `ON_END` - only final status at the end, `ON_STATUS_CHANGE` - any change in the scenario.
    - `successUrl` string: End user will be sent to this URL after the selected scenario has been successfully completed.
    - `cancelUrl` string: End user will be sent to this URL if they cancel the scenario.
    - `retainData` boolean: Indicates whether Infobip should store and retain data. This value overrides value in account configuration.
    - `status` 'CREATED' | 'ACTIVE' | 'SUCCESS' | 'EXPIRED' | 'CANCELED': Current session status.
    - `id` string: Unique session identifier.
    - `applicationType` string: Application type identifier.
    - `createdAt` string, date-time: Session creation date and time. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
    - `validUntil` string, date-time: Session validity date and time. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)