Biometric Verification API (1.0)

Download OpenAPI specification:Download

This API allows initiating preconfigured biometric verification flows and downloading the complete set of evidence generated during the process.

Two main operations are available:

  • Start a biometric verification experience based on a predefined configuration
  • Download the generated evidence (documents, media, audit data) in a ZIP file

The verification flow may include:

  • Identity document upload
  • Identity document verification
  • Facial matching
  • Consent acceptance
  • Different types of electronic signing

Authentication is required via OAuth2 using Bearer tokens obtained through the Client Credentials flow.

Biometric Operations

Endpoints for Orchestrating Secure Biometric Verification Flows

This section provides the core functionality to initiate, manage, and retrieve biometric verification processes within a secure and auditable framework. Designed for high-trust environments (e.g., banking, government, healthcare)

Start biometric verification circuit

Initiates a new biometric verification circuit with document verification and signing process.

The circuit may include:

  • Document upload and verification
  • Biometric verification
  • Facial matching
  • Electronic signing process

Authentication: Bearer Token required (obtained via OAuth2 client credentials flow)

SecurityBearerAuth
Request
path Parameters
channel
required
string

Unique client identifier provided by DANAconnect

Example: xxxx-xxxxx-45555-55555
Request Body schema: application/json

Biometric circuit initiation request

id
string

Unique identifier for the request

required
object (PersonalSignerDTO)

Signer details

required
Array of objects (Doc)

List of PDF documents to sign

Responses
200

Biometric circuit successfully initiated

400

Bad Request - Possible error messages:

401

Unauthorized - invalid or missing authentication token

500

Internal server error

post/api/v1/biometric/start_circuit/{channel}
Request samples
application/json

CircuitInitExample

{
  • "id": "5",
  • "signer": {
    },
  • "docs": [
    ]
}
Response samples
application/json

CircuitInitSuccess

{}

Download the generated evidence

Downloads a ZIP file containing all documents and evidence associated with a completed biometric circuit.

The ZIP file may include:

  • Signed documents
  • Biometric verification evidence
  • Process metadata

Authentication: Bearer Token required (obtained via OAuth2 client credentials flow)

SecurityBearerAuth
Request
path Parameters
channel
required
string

Unique client identifier provided by DANAconnect

Example: xxxx-xxxxx-45555-55555
circuit
required
string

Unique circuit identifier obtained when starting the circuit

Example: 12ceb3ec-7b76-5555-b263-xx222
Responses
200

ZIP file with all circuit documents

400

Bad request - invalid parameters or missing required fields

401

Unauthorized - invalid or missing authentication token

404

Circuit not found or not completed

500

Internal server error

get/api/v1/biometric/document_circuit/{channel}/circuit/{circuit}
Request samples

Oauth2 Get Token

OAuth2 authentication endpoints

Get OAuth2 access token

Use the Client Credentials flow to obtain an access token. This requires Basic Authentication, where the client_id is used as the username and the client_secret as the password.

SecuritybasicAuth
Request
Request Body schema: application/x-www-form-urlencoded

OAuth2 token request parameters

grant_type
required
string

OAuth2 grant type. Only 'client_credentials' is supported

Value: "client_credentials"
Responses
200

Successfully obtained access token

400

Bad request - missing or invalid parameters

401

Unauthorized - invalid client credentials

500

Internal server error

post/oauth2/token
Request samples
application/x-www-form-urlencoded

ClientCredentialsExample

grant_type=client_credentials
Response samples
application/json

TokenResponseExample

{
  • "access_token": "ttNotNf7lJyPxDwRlZ0J1I-6htOMMWjyhs6tE1NNiHY--eM8ArXUxjnM",
  • "token_type": "Bearer",
  • "expires_in": 1799
}