---
title: "Start a guided live id document check with the AI."
method: POST
path: "/v2/check-live-id-document/{configId}"
tags: ["AI check operations"]
---

# Start a guided live id document check with the AI.

`POST /v2/check-live-id-document/{configId}`

## Request

- Base URL: `https://api.irisnet.de`
- URL: `https://api.irisnet.de/v2/check-live-id-document/{configId}`
- Auth: API key in header `LICENSE-KEY`

The synchronous response (_LiveDocumentCheckResponseData_ schema) contains an eventId, possibly a token and an URL to send the enduser to. The actual result (_CheckResult_ schema) of the document check is sent to the provided _callbackUrl_ after the AI has finished processing.

## Path parameters

- `configId` string, uuid, required

## Request body

- LiveDocumentCheckRequestData: Data containing neccessary information to handle the enduser live check.
  - `callback` Callback, required: Callback options to send a response to.
    - `callbackUrl` string, uri, required: Define a URL where a response should be sent.
    - `headers` object: Define headers to send to the URL.
  - `statusUrl` string, uri: The URL to send the intermediate status requests to. If not set, no intermediate status requests will be sent.
  - `endUserRedirectUrl` string, uri: If set the enduser is being redirected to this URL after the check is finished.
  - `tokenValidityInSeconds` integer: The validity duration of a started ident process in seconds. Defaults to 3600 seconds = 60 minutes.
  - `documentHolderId` string: The documentHolderId from a previous successful live identification.
  - `minimumAcceptedAge` integer: The minimum age in years accepted for a check, if applicable. Defaults to 18 if not specified.

## Response `202`

Input accepted: Send enduser to endUserIdentUrl and wait for status/callback.

- LiveDocumentCheckResponseData: Response object containing necessary information to start the enduser live document check on the client side.
  - `eventId` string: unique id of this live document check
  - `identToken` string: token to secure the live document check, might be null since already incorporated into endUserIdentUrl
  - `endUserIdentUrl` string, uri: URL to send the enduser to, to start the live document check

## Other responses

- `402`: Not enough credits.

---

[API](https://skmtc.dev/irisnet/apis/irisnet-api.md) - [All operations](https://skmtc.dev/irisnet/apis/irisnet-api/llms.txt) - [OpenAPI document](https://skmtc.dev/irisnet/apis/irisnet-api/revisions/185759e28101?raw)