Configuration Options

FeaturenameDescriptionHow to use
Gather Additional DataThe app can be configured to collect additional data that is not stored on the chip of the eID cards. These data fields are then gathered either via OCR (if the document is supported and the OCR feature is activated) or the user is asked to enter the fields manually. The list of possible fields can be found in the REST API for the respective feature.Configure via API, please refer to LINK, parameter configuration -> document -> fields
Allowed documentsBesides reading out the eID chip of German ID cards, additional documents can be processed. A growing number of ID documents can be read out via OCR. For a list of the currently supported documents please refer to section Document Identifier Other ID Documents. To make sure you only get the documents you want to be processed, you have to include documents when initialising the service.Configure via API, please refer to LINK, parameter configuration -> document -> documentIncludes
Photo uploadIn case you only need to read out eID cards and do not want to take pictures of the document or any other documents, you can disable the photo upload.Configure via API, please refer to LINK, parameter configuration -> document -> fotoUpload
User entryIf the user of the app should not be able to enter or change (OCR) data fields, this can be prevented by disabling manual field entries.Configure via API, please refer to LINK, parameter configuration -> document -> userEntry
OCRWhen OCR should be performed on photos taken in the onsite process, it must be enabled.Configure via API, please refer to LINK, Parameter -> ocr
Identifying two individuals right after anotherFor certain business processes it is useful to identify two individuals at once. In this case, the app is started with two mobile sessions and processes them one after another. In the AUTHADA backend, these sessions are independently opened and do not know of each other. Please note the session time outs described in the API documentation of the backend.  Start two session to get two mobileTokens. Then create a QRcode or deeplink using the following scheme: <mobileToken1>:<customerName1>, <mobileToken2>:<customerName2>

WebhookA webhook can be used to inform you of a finished identification process. For instance, you can use this webhook to ask the user to  proceed with the process in your application using server-sent events. With EventMode enabled, you will also be informed about several other steps of the AUTAHDA process.Link to API
DeeplinkA return link can be shown to the user within our app, in case the user started the app via deeplink. The link should point to a website or app, where the user can continue the process on your side.Configure via API, please refer to LINK, Parameter -> deeplink
enterDefectFieldsFor older ID cards or electronic resident permits (issued until fourth quarter 2014) certain data fields are empty or not included at all. This affects the data fields birth name and nationality.
The AUTHADA onsite service offers the possibility to gather these fields via text recognition and user input during the process. This requires the parameter enterDefectFields to be set to true. Per default this field is defined as false. An object “defects” will then be added to the resulting data set.
Configure via API