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:
The verification flow may include:
Authentication is required via OAuth2 using Bearer tokens obtained through the Client Credentials flow.
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)
Initiates a new biometric verification circuit with document verification and signing process.
The circuit may include:
Authentication: Bearer Token required (obtained via OAuth2 client credentials flow)
Biometric circuit initiation request
Biometric circuit successfully initiated
Bad Request - Possible error messages:
Unauthorized - invalid or missing authentication token
Internal server error
CircuitInitExample
{- "id": "5",
- "signer": {
- "name": "Test DANAconnect",
- "email": "test@example.com",
- "nif": "12345678A"
}, - "docs": [
- {
- "name": "documenttosign.pdf",
- "size": 0,
- "content": "IKPj4Kc3RhcnR4cmVmCjYwNTI4CiUlRU9G"
}
]
}CircuitInitSuccess
{- "circuitId": "12ceb3ec-7b76-5555-b263-xx222",
}Downloads a ZIP file containing all documents and evidence associated with a completed biometric circuit.
The ZIP file may include:
Authentication: Bearer Token required (obtained via OAuth2 client credentials flow)
ZIP file with all circuit documents
Bad request - invalid parameters or missing required fields
Unauthorized - invalid or missing authentication token
Circuit not found or not completed
Internal server error
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.
Successfully obtained access token
Bad request - missing or invalid parameters
Unauthorized - invalid client credentials
Internal server error
ClientCredentialsExample
grant_type=client_credentialsTokenResponseExample
{- "access_token": "ttNotNf7lJyPxDwRlZ0J1I-6htOMMWjyhs6tE1NNiHY--eM8ArXUxjnM",
- "token_type": "Bearer",
- "expires_in": 1799
}