Developer center
Identification API
For vendors, development teams and integration partners. Every API links to its service, context and evidence.
POST /identify
Resolve identity within an authorized population.
Illustrative request schema
| Field | Type | Requirement |
|---|---|---|
requestId | string | Required in this draft model; a reference, not biometric data. |
tenantRef | string | Required in this draft model; a reference, not biometric data. |
purpose | string | Required in this draft model; a reference, not biometric data. |
deviceRef | string | Required in this draft model; a reference, not biometric data. |
captureRef | string | Required in this draft model; a reference, not biometric data. |
populationRef | string | Required in this draft model; a reference, not biometric data. |
Simulation & samples
Local simulation - no network requestsv0.4.0-draft
No approved live Sandbox/UAT endpoint is supplied. Do not enter personal or biometric data.
Request
Illustrative response
200{
"requestId": "demo-request-001",
"traceId": "demo-trace-001",
"service": "identify",
"modelStatus": "ILLUSTRATIVE_ONLY",
"identityResult": "IDENTIFIED",
"subjectRef": "demo-patient-001",
"authorizationDecision": "NOT_EVALUATED",
"evidenceRef": "demo-evidence-001"
}HTTP samples - not an SDK
The example.invalid host is not a production endpoint. Samples require approved authentication and mTLS configuration.
Exceptions & retries
| HTTP | Illustrative code | Recommended handling |
|---|---|---|
| 422 | CAPTURE_QUALITY_LOW | Capture quality is insufficient; guide a retry. |
| 422 | PRESENTATION_REJECTED | Stop the session and use the policy-approved alternative. |
| 409 | SESSION_EXPIRED | Create a fresh session; do not replay old capture. |
| 403 | DEVICE_UNTRUSTED | Reject the session and request a device review. |
| 403 | SCOPE_NOT_ALLOWED | Check client, organization and purpose authorization. |
| 429 | RATE_LIMITED | Honor Retry-After and bound retry attempts. |
| 503 | PROCESSING_UNAVAILABLE | Do not infer success; invoke the alternative workflow. |