Skip to main content

Test Robot

If you use the Test Robot to drive automated, fully-mocked identifications in the test environment, the endpoint used to start the mock flow changes when migrating from the legacy VideoIdent (VI) integration to DocIDV.

note

The Test Robot in fully-automated mode is supported only for VideoIdent (VI) upgrades. It is not supported when upgrading from AutoIdent (AI) to DocIDV, as fully-automated Test Robot mode is not currently supported on AutoIdent.

Manual mode is unchanged

For Manual mode (using the X-MANUALTEST prefix) on both VideoIdent and AutoIdent, no changes are required when upgrading to DocIDV. Existing manual Test Robot flows continue to work as before — see the Testing guide for details.

What has changed

In the legacy VI flow, automated tests were driven by chaining the standard identification endpoints, finishing with Start identification followed by Request Video Chat:

  • POST Start identification (/api/v1/{customer}/identifications/{transaction-number}/start)
  • POST Request Video Chat (/api/v1/{customer}/identifications/{transaction-number}/requestVideoChat)

With DocIDV, both calls are replaced by a single dedicated Test Robot endpoint that triggers the mock identification end-to-end:

POST {{TESTROBOTHOST}}/api/v1/startMockIdentification

For the test environment, {{TESTROBOTHOST}} is https://testrobot.test.idnow.de.

note

This endpoint currently only supports fully-automated identification for the agent-assisted flow. The identification token passed in the request body must be associated with an identification created with firstname or lastname set to X-AUTOTEST-{test scenario}.

Endpoint mapping

Legacy (VI)DocIDV
POST Start identification (start)POST {{TESTROBOTHOST}}/api/v1/startMockIdentification
POST Request Video Chat (requestVideoChat)(merged into the call above)

Request

Headers:

Content-Type: application/json

Request body:

FieldTypeRequiredDescription
mobilestringNoMobile number of the user provided during identification. Only if your config allow user to change it during identification. Example: 015125201203.
tokenstringYesThe IdentID associated with the identification. Follows the syntax ABC-DEFGH.
shortnamestringYesThe shortname your company received from IDnow during account setup, used in the API URL of your requests.

Example

curl -i --location -g 'https://testrobot.test.idnow.de/api/v1/startMockIdentification' \
--header 'Content-Type: application/json' \
--data '{
"mobile": "015125201203",
"token": "ABC-DEFGH",
"shortname": "yourshortname"
}'

Migration steps

  1. Replace any test automation that calls POST Start identification followed by POST Request Video Chat with a single call to POST {{TESTROBOTHOST}}/api/v1/startMockIdentification.
  2. Update the request body to use mobile, token, and shortname as shown above.
  3. Ensure the identification referenced by token is created with firstname or lastname set to X-AUTOTEST-{test scenario} (see Testing for the list of supported scenarios).
  4. After calling the new endpoint, both the user and the agent steps run automatically on the IDnow side. The result is delivered through your configured channel (e.g. webhook) — no further interaction is required.

See the full Testing guide for details on test scenarios and prefixes.