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.
OAuth2 Client Credentials flow. Authenticate your client application using registered credentials to obtain a JWT access token. Token endpoint: https://biometric.{domain_environment}.com/oauth2/token. Replace {domain_environment} according to your environment: use integrationlayer for the sandbox environment and danaconnect for the production environment.
Security Scheme Type | OAuth2 |
---|---|
clientCredentials OAuth Flow | Token URL: https://biometric.{domain_environment}.com/oauth2/token Scopes: |
JWT Bearer Token authentication. After obtaining an OAuth2 token, include it in the Authorization header as: 'Bearer
Security Scheme Type | HTTP |
---|---|
HTTP Authorization Scheme | bearer |
Bearer format | "JWT" |
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)
channel required | string Example: xxxx-xxxxx-45555-55555 Unique client identifier provided by DANAconnect |
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 |
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)
channel required | string Example: xxxx-xxxxx-45555-55555 Unique client identifier provided by DANAconnect |
circuit required | string Example: 12ceb3ec-7b76-5555-b263-xx222 Unique circuit identifier obtained when starting the circuit |
const channel = 'YOUR_channel_PARAMETER'; const circuit = 'YOUR_circuit_PARAMETER'; const resp = await fetch( `https://biometric.integrationlayer.com/api/v1/biometric/document_circuit/${channel}/circuit/${circuit}`, { method: 'GET', headers: { Authorization: 'Bearer <YOUR_JWT_HERE>' } } ); const data = await resp.text(); console.log(data);
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.
OAuth2 token request parameters
grant_type required | string Value: "client_credentials" OAuth2 grant type. Only 'client_credentials' is supported |
ClientCredentialsExample
grant_type=client_credentials
TokenResponseExample
{- "access_token": "ttNotNf7lJyPxDwRlZ0J1I-6htOMMWjyhs6tE1NNiHY--eM8ArXUxjnM",
- "token_type": "Bearer",
- "expires_in": 1799
}