Skip to main content
Version: 1.3.0

cidaas ID Validator API

ID Validator Services​

The cidaas ID validator API Documentation consists of five sections:

  1. Invocation to initialize a case and start the identity validation.

  2. Settings that allows to setup different identification scenarios and flows.

  3. Result of the identification performed.

  4. Cards that the ID validator support

  5. Docs signed by the user in the identification and signature process

Note: The second section to configure the ID validator can be also done using the cidaas admin portal.

id validator settings help you control how an id validation flow gets processed.

The id validator settings can be marked as a template by setting a template_name.

Flow type: A flow type defines which steps need to be performed during the validation and thereby enables ensuring that all requirements are met, for instance,

  1. Perform eIDAS compliant autoident
  2. Perform eIDAS autoident and sign agreements with qualified signature
  3. Perform a card scan only
  4. Perform autoident based on an id card e.g. driving license, passport etc

Allowed cards define which identity documents and even more specifically which versions of the identity documents are allowed to be used for end-user verification.

The invocation of id validator initializes the id verification for the user who has been already created using an accessToken containing a sub (unique identifier of the user) for configured id validation settings. It initializes the identification flow based on applied id validation settings by redirecting to the id validator user interface.

The section, result helps retrieve the case result for a particular case id.

Authentication​

Security Scheme Type:

openIdConnect

OpenID Connect URL:

https://domain/.well-known/openid-configuration