IRirisnet
AI check operations

Start a guided live id document check with the AI.

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.

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

Path parameters

configIdstring uuid required

The configuration id from the Basic Configuration operations.

Request body

statusUrlstring uri

The URL to send the intermediate status requests to. If not set, no intermediate status requests will be sent.

endUserRedirectUrlstring uri

If set the enduser is being redirected to this URL after the check is finished.

tokenValidityInSecondsinteger

The validity duration of a started ident process in seconds. Defaults to 3600 seconds = 60 minutes.

documentHolderIdstring

The documentHolderId from a previous successful live identification.

minimumAcceptedAgeinteger

The minimum age in years accepted for a check, if applicable. Defaults to 18 if not specified.

Example request

{
  "callback": {
    "callbackUrl": "http://www.example.com/callback?video",
    "headers": {
      "Authorization": "Basic Rm9yemEgTmFwb2xpLCBzZW1wcmUh"
    }
  }
}

Response

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

eventIdstring

unique id of this live document check

identTokenstring

token to secure the live document check, might be null since already incorporated into endUserIdentUrl

endUserIdentUrlstring uri

URL to send the enduser to, to start the live document check

Changes

No recorded changes to this operation across all 1 revision of this API.