Skip to main content
GET
/
locations
/
{locationId}
/
check-ins
Get Current and Past Check-Ins
curl --request GET \
  --url https://app.essentry.com/api/v2/locations/{locationId}/check-ins \
  --header 'Authorization: Bearer <token>'
{
  "checkIns": [
    {
      "id": 123,
      "state": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "birthdate": "<string>",
      "companyName": "<string>",
      "language": "CS",
      "arrivedAt": "2023-11-07T05:31:56Z",
      "leftAt": "2023-11-07T05:31:56Z",
      "legitimation": {
        "sourceId": "<string>",
        "startsAt": "2023-11-07T05:31:56Z",
        "endsAt": "2023-11-07T05:31:56Z",
        "guest": {
          "firstName": "<string>",
          "lastName": "<string>",
          "birthdate": "<string>"
        }
      },
      "trustedId": {
        "documentNumber": "<string>",
        "document": "EXISTED",
        "selfie": "MATCHED",
        "liveness": "PASSED",
        "invitationMatch": {
          "wasManuallyReviewed": true,
          "firstName": "EXACT",
          "lastName": "EXACT",
          "birthdate": "EXACT"
        },
        "images": {
          "faceImageUrl": "<string>",
          "identityDocumentImageUrl": "<string>"
        }
      },
      "accessControl": {
        "credential": {
          "cardNumberKiosk": "<string>",
          "cardNumberReception": "<string>",
          "cardNumberAccessControlSystem": "<string>"
        },
        "access": {
          "startsAt": "2023-11-07T05:31:56Z",
          "endsAt": "2023-11-07T05:31:56Z"
        },
        "pin": "<string>"
      },
      "customFields": {}
    }
  ],
  "pageInfo": {
    "totalCount": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

locationId
integer
required

Query Parameters

leftAfter
string<date-time>
required
leftBefore
string<date-time>
updatedSince
string<date-time>
limit
integer
default:20

Pagination - How many results to return

Required range: x <= 50
offset
integer
default:0

Pagination - How many results to skip

Response

200 - application/json

The request has succeeded.

checkIns
object[]
required
pageInfo
object
required