GET /processes/{id}¶
Endpoint¶
GET /processes/{id}
Headers¶
biometrid-credential: YOUR_CREDENTIAL_ID
Content-Type: application/json
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Process ID |
cURL Example¶
curl -X GET "https://api.biometrid.com/processes/process_abc123" \
-H "biometrid-credential: YOUR_CREDENTIAL_ID" \
-H "Content-Type: application/json"
Response (200 OK)¶
The response returns a JSON object containing the complete state of the process, including a chronological list of executed steps, data payloads, and audit events.
Response Body¶
{
"data": {
"id": "6773c8fd6ee61a6b82b3adb1",
"flow": {
"id": "676e66243d67440360f7d08b",
"name": "Life Proof 2026",
"steps": [],
"settings": []
},
"data": [
{
"type": "step",
"status": true,
"payload": {
"identifier": "...",
"name": "...",
"date_of_birth": "..."
},
"info": {
"retry": 0
},
"provider": {},
"error": {},
"stepId": "6760b2471e525c36dd1235e9",
"action": "form",
"triggerId": "...",
"createdAt": "2026-02-27T10:23:34.256Z",
"deviceType": "mobile"
},
{
"type": "step",
"status": true,
"payload": {
"back": "...",
"front": "...",
"doctype": "idcard",
"livePhoto": false
},
"info": {
"retry": 0
},
"provider": {
"result": {
"fields": {
"issuing_country": "PRT",
"nationality": "Portugal",
"name": "...",
"surname": "...",
"doc_number": "...",
"birth_date": "../../....",
"gender": ".",
"expiry_date": "../../...",
"mrz": "...",
"id_number": "...",
"tax_number": "...",
"social_security_number": "...",
"health_number": "...",
"parents": "... * ...",
"height": "... cm",
"age": "...",
"country": "PT"
},
"images": {
"front": "https://api.biometrid.com/files/processes/1111111111111111111111",
"back": "https://api.biometrid.com/files/processes/1111111111111111111111",
"photo": "https://api.biometrid.com/files/processes/1111111111111111111111",
"signature": "https://api.biometrid.com/files/processes/1111111111111111111111"
},
"validations": {
"expiry_date": "GOOD",
"match_nationality": "GOOD",
"match_doc_number": "GOOD",
"match_id_number": "GOOD",
"match_gender": "GOOD",
"match_surname": "GOOD",
"match_name": "GOOD",
"match_birth_date": "GOOD",
"match_expiration_date": "GOOD",
"integrity_expiry_date": "GOOD",
"integrity_birth_date": "GOOD",
"integrity_doc_number": "GOOD",
"integrity_id_number": "GOOD",
"integrity_tax_number": "GOOD",
"mrz": "GOOD",
"text": "GOOD",
"docType": "GOOD",
"imageQA": "GOOD"
},
"chosenMap": "idcard_pt",
"imageQA": {
"front": {
"focus": "GOOD",
"glares": "GOOD",
"portrait": "GOOD",
"bounds": "GOOD",
"perspective": "GOOD",
"resolution": "GOOD"
},
"back": {
"focus": "GOOD",
"glares": "GOOD",
"bounds": "GOOD",
"perspective": "GOOD",
"resolution": "GOOD"
}
}
},
"status": true
},
"stepId": "69a168deeb52df302601a199",
"action": "document-ocr",
"createdAt": "2026-02-27T10:23:56.809Z",
"deviceType": "desktop"
},
{
"type": "step",
"status": true,
"payload": {
"template": "...",
"reference": "...",
"photo": "https://api.biometrid.com/files/processes/1111111111111111111111"
},
"info": {
"retry": 0
},
"provider": {
"status": true,
"result": {
"livenessStatus": 0,
"scanResultBlob": "..."
}
},
"stepId": "69b1949c8c14296f1a190808",
"action": "face-liveness-3d",
"createdAt": "2026-02-27T10:24:02.809Z",
"deviceType": "desktop"
},
{
"type": "step",
"status": true,
"payload": {
"template2": "https://api.biometrid.com/files/processes/1111111111111111111111",
"template1": "https://api.biometrid.com/files/processes/1111111111111111111111",
"livePhoto": false
},
"info": {
"retry": 0
},
"provider": {
"result": {
"score": 0.6365
},
"status": true
},
"stepId": "69a168f3187c44e78a073d13",
"action": "face-compare-2d2d",
"createdAt": "2026-02-27T10:24:11.533Z",
"deviceType": "desktop"
},
{
"type": "step",
"status": true,
"payload": {
"phone": {
"country": "PT",
"number": "..."
},
"otpCode": "0000"
},
"config": {
"otpCode": "0000",
"otpDate": "2026-02-27T10:24:21.859Z",
"numberAttemptsCode": 1,
"numberAttemptsSend": 1,
"otpConfirmed": true
},
"stepId": "69a168fd7dbe23e9f5c273e0",
"action": "otp",
"createdAt": "2026-02-27T10:24:21.858Z",
"deviceType": "desktop"
}
],
"events": [
{
"type": "process-created",
"createdAt": "2026-02-27T10:23:30.688Z",
"deviceType": "desktop",
"operatingSystem": "Windows",
"browser": "Edge"
},
{
"type": "payload-submitted",
"stepId": "698b4af041b337f055f944a1",
"stepName": "Form",
"createdAt": "2026-02-27T10:23:34.256Z",
"deviceType": "desktop",
"operatingSystem": "Windows",
"browser": "Edge"
},
{
"type": "process-updated",
"stepId": "698b4af041b337f055f944a1",
"stepName": "Form",
"createdAt": "2026-02-27T10:23:34.715Z",
"deviceType": "desktop",
"operatingSystem": "Windows",
"browser": "Edge"
},
{
"type": "payload-submitted",
"stepId": "69a168deeb52df302601a199",
"stepName": "Document Validation",
"createdAt": "2026-02-27T10:23:56.809Z",
"deviceType": "desktop",
"operatingSystem": "Windows",
"browser": "Edge"
},
{
"type": "process-updated",
"stepId": "69a168deeb52df302601a199",
"stepName": "Document Validation",
"createdAt": "2026-02-27T10:23:58.824Z",
"deviceType": "desktop",
"operatingSystem": "Windows",
"browser": "Edge"
},
{
"type": "payload-submitted",
"stepId": "69b1949c8c14296f1a190808",
"stepName": "Face Liveness 3d",
"createdAt": "2026-02-27T10:24:11.533Z",
"deviceType": "desktop",
"operatingSystem": "Windows",
"browser": "Edge"
},
{
"type": "process-updated",
"stepId": "69b1949c8c14296f1a190808",
"stepName": "Face Liveness 3d",
"createdAt": "2026-02-27T10:24:13.103Z",
"deviceType": "desktop",
"operatingSystem": "Windows",
"browser": "Edge"
},
{
"type": "payload-submitted",
"stepId": "69a168f3187c44e78a073d13",
"stepName": "Face Compare 2d2d",
"createdAt": "2026-02-27T10:24:11.533Z",
"deviceType": "desktop",
"operatingSystem": "Windows",
"browser": "Edge"
},
{
"type": "process-updated",
"stepId": "69a168f3187c44e78a073d13",
"stepName": "Face Compare 2d2d",
"createdAt": "2026-02-27T10:24:13.103Z",
"deviceType": "desktop",
"operatingSystem": "Windows",
"browser": "Edge"
},
{
"type": "payload-submitted",
"stepId": "69a168fd7dbe23e9f5c273e0",
"stepName": "One time password",
"createdAt": "2026-02-27T10:24:21.858Z",
"deviceType": "desktop",
"operatingSystem": "Windows",
"browser": "Edge"
},
{
"type": "payload-submitted",
"stepId": "69a168fd7dbe23e9f5c273e0",
"stepName": "One time password",
"createdAt": "2026-02-27T10:24:35.269Z",
"deviceType": "desktop",
"operatingSystem": "Windows",
"browser": "Edge"
},
{
"type": "process-updated",
"stepId": "69a168fd7dbe23e9f5c273e0",
"stepName": "One time password",
"createdAt": "2026-02-27T10:24:35.492Z",
"deviceType": "desktop",
"operatingSystem": "Windows",
"browser": "Edge"
},
{
"type": "status-updated",
"status": "finished",
"createdAt": "2026-02-27T10:24:35.492Z",
"deviceType": "desktop",
"operatingSystem": "Windows",
"browser": "Edge"
}
],
"negativeFinish": true,
"status": "finished",
"version": "3.3.1",
"appVersion": "3.1.1",
"lang": "pt-PT",
"appId": "...",
"credentialId": "...",
"evidence": {
"fileUrl": "https://api.biometrid.com/files/processes/1111111111111111111111",
"createdAt": ""
},
"createdAt": "2024-12-31T10:35:41.216Z",
"updatedAt": "2025-01-07T17:03:31.468Z"
},
"meta": {
"message": "Successful get process",
"code": "BIOPMPCS003"
},
"status": true
}
Field Definitions¶
Process Object (data)¶
| Field | Type | Description |
|---|---|---|
id |
string | The unique identifier of the process. |
flow |
object | Contains the flow upon process creation. |
data |
array | An array of Step objects representing the history of interactions. |
events |
array | An audit log of all events and state changes recorded during the process. |
status |
string | The current state of the process. |
version |
string | API version used during the process. |
appVersion |
string | SDK/client version used during the process. |
lang |
string | The language code used during the process (e.g., pt-PT). |
appId |
string | Application ID that initiated the process. |
credentialId |
string | Credential ID used for authentication. |
createdAt |
date | The timestamp when the process was initialized. |
updatedAt |
date | The timestamp of the last update to the process. |
Step Object (data.data[])¶
This array contains all steps completed or attempted by the user.
| Field | Type | Description |
|---|---|---|
stepId |
string | Unique identifier for the specific step instance. |
type |
string | The nature of the entry (usually step). |
action |
string | The type of task performed: form, otp, document-ocr, etc. |
status |
boolean | Indicates whether the step was successfully validated. |
payload |
object | The actual data collected (e.g., form fields, OCR results). |
info |
object | Metadata related to the execution (e.g., retry count, uploaded status). |
config |
object | Configuration or internal validation flags used during the step (e.g., otpConfirmed). |
error |
object | Error details if the step processing failed. |
triggerId |
string | null | ID of the trigger that routed this step. |
createdAt |
date | Timestamp when the step payload was submitted. |
deviceType |
string | The platform used to complete the step (desktop, mobile). |
Event Object (data.events[])¶
| Field | Type | Description |
|---|---|---|
type |
string | The event category (e.g., process-created, process-updated, status-updated). |
stepId |
string | (Optional) The ID of the step associated with this event. |
stepName |
string | (Optional) The friendly name of the step. |
createdAt |
date | The timestamp when the event occurred. |
deviceType |
string | Device used when the event occurred. |
operatingSystem |
string | Operating system detected. |
browser |
string | Browser detected. |
Meta Object (meta)¶
| Field | Type | Description |
|---|---|---|
message |
string | A human-readable description of the result. |
code |
string | Internal system code for the response (e.g., BIOPMPCS003). |
Step Examples: document-ocr¶
The document-ocr step returns different fields depending on the document type and provider. Below are some examples.
{
"type": "step",
"action": "document-ocr",
"status": true,
"payload": {
"front": "...",
"back": "...",
"doctype": "idcard",
"livePhoto": false
},
"info": { "retry": 0 },
"provider": {
"status": true,
"result": {
"fields": {
"issuing_country": "PRT",
"nationality": "Portugal",
"name": "...",
"surname": "...",
"doc_number": "...",
"birth_date": "../../....",
"age": "...",
"gender": "F",
"expiry_date": "../../....",
"country": "PT"
},
"additionalFields": {
// may differ card/country
"remainderterm": "0",
"issuing_state_name": "Portugal",
"mrz_strings": "...",
"years_since_issue": "...",
"age_at_issue": "...",
"place_of_birth": "...",
"address": "...",
"social_security_number": "...",
"tax_number": "...",
"health_number": "...",
"place_of_issue": "...",
"date_of_issue": "../../....",
"permit_dl_class": "...",
"special_notes": "...",
"card_access_number": "...",
"height": "... cm"
},
"images": {
"front": "https://api.biometrid.com/files/processes/1111111111111111111111",
"back": "https://api.biometrid.com/files/processes/1111111111111111111111",
"photo": "https://api.biometrid.com/files/processes/1111111111111111111111",
"signature": "https://api.biometrid.com/files/processes/1111111111111111111111"
},
"validations": {
// may differ card/country
"expiry_date": "GOOD",
"match_nationality": "GOOD",
"match_doc_number": "GOOD",
"match_id_number": "GOOD",
"match_gender": "GOOD",
"match_surname": "GOOD",
"match_name": "GOOD",
"match_birth_date": "GOOD",
"match_expiration_date": "GOOD",
"integrity_expiry_date": "GOOD",
"integrity_birth_date": "GOOD",
"integrity_doc_number": "GOOD",
"integrity_id_number": "GOOD",
"integrity_tax_number": "GOOD",
"mrz": "GOOD",
"text": "GOOD",
"docType": "GOOD",
"imageQA": "GOOD"
},
"chosenMap": "default",
"imageQA": {
"front": {
"focus": "GOOD",
"glares": "GOOD",
"portrait": "GOOD",
"bounds": "GOOD",
"perspective": "GOOD",
"resolution": "GOOD"
},
"back": {
"focus": "GOOD",
"glares": "GOOD",
"bounds": "GOOD",
"perspective": "GOOD",
"resolution": "GOOD"
}
}
}
},
"stepId": "...",
"createdAt": "2026-02-27T10:23:56.809Z",
"deviceType": "desktop"
}
{
"type": "step",
"action": "document-ocr",
"status": true,
"payload": {
"front": "...",
"back": "...",
"doctype": "idcard",
"livePhoto": false
},
"info": { "retry": 0 },
"provider": {
"status": true,
"result": {
"fields": {
"issuing_country": "PRT",
"nationality": "...",
"name": "...",
"surname": "...",
"doc_number": "...",
"birth_date": "../../....",
"gender": "F",
"expiry_date": "../../...",
"mrz": "...",
"id_number": "...",
"tax_number": "...",
"social_security_number": "...",
"health_number": "...",
"parents": "... * ...",
"height": "... cm",
"age": "...",
"country": "PT"
},
"images": {
"front": "https://api.biometrid.com/files/processes/1111111111111111111111",
"back": "https://api.biometrid.com/files/processes/1111111111111111111111",
"photo": "https://api.biometrid.com/files/processes/1111111111111111111111",
"signature": "https://api.biometrid.com/files/processes/1111111111111111111111"
},
"validations": {
"expiry_date": "GOOD",
"match_nationality": "GOOD",
"match_doc_number": "GOOD",
"match_id_number": "GOOD",
"match_gender": "GOOD",
"match_surname": "GOOD",
"match_name": "GOOD",
"match_birth_date": "GOOD",
"match_expiration_date": "GOOD",
"integrity_expiry_date": "GOOD",
"integrity_birth_date": "GOOD",
"integrity_doc_number": "GOOD",
"integrity_id_number": "GOOD",
"integrity_tax_number": "GOOD",
"mrz": "GOOD",
"text": "GOOD",
"docType": "GOOD",
"imageQA": "GOOD"
},
"chosenMap": "idcard_pt",
"imageQA": {
"front": {
"focus": "GOOD",
"glares": "GOOD",
"portrait": "GOOD",
"bounds": "GOOD",
"perspective": "GOOD",
"resolution": "GOOD"
},
"back": {
"focus": "GOOD",
"glares": "GOOD",
"bounds": "GOOD",
"perspective": "GOOD",
"resolution": "GOOD"
}
}
}
},
"stepId": "...",
"createdAt": "2026-02-27T10:23:56.809Z",
"deviceType": "desktop"
}
{
"type": "step",
"action": "document-ocr",
"status": true,
"payload": {
"front": "...",
"doctype": "passport",
"livePhoto": false
},
"info": { "retry": 0 },
"provider": {
"status": true,
"result": {
"fields": {
"issuing_country": "PRT",
"nationality": "...",
"name": "...",
"surname": "...",
"doc_number": "...",
"birth_date": "../../....",
"gender": "F",
"expiry_date": "../../....",
"mrz": "...",
"id_number": "...",
"height": "... cm",
"age": "...",
"authority": "...",
"country": "PT"
},
"images": {
"front": "https://api.biometrid.com/files/processes/1111111111111111111111",
"photo": "https://api.biometrid.com/files/processes/1111111111111111111111",
"signature": "https://api.biometrid.com/files/processes/1111111111111111111111"
},
"validations": {
"expiry_date": "GOOD",
"match_doc_number": "GOOD",
"match_id_number": "GOOD",
"match_gender": "GOOD",
"match_surname": "GOOD",
"match_name": "GOOD",
"match_birth_date": "GOOD",
"match_expiration_date": "GOOD",
"integrity_expiry_date": "GOOD",
"integrity_birth_date": "GOOD",
"integrity_doc_number": "GOOD",
"integrity_id_number": "GOOD",
"mrz": "GOOD",
"text": "GOOD",
"docType": "GOOD",
"imageQA": "GOOD"
},
"chosenMap": "passport_pt",
"imageQA": {
"front": {
"focus": "GOOD",
"glares": "GOOD",
"portrait": "GOOD",
"bounds": "GOOD",
"perspective": "GOOD",
"resolution": "GOOD"
}
}
}
},
"stepId": "...",
"createdAt": "2026-02-27T10:23:56.809Z",
"deviceType": "desktop"
}
{
"type": "step",
"action": "document-ocr",
"status": true,
"payload": {
"front": "...",
"back": "...",
"doctype": "residence",
"livePhoto": false
},
"info": { "retry": 0 },
"provider": {
"status": true,
"result": {
"fields": {
"issuing_country": "PRT",
"nationality": "...",
"name": "...",
"surname": "...",
"doc_number": "...",
"birth_date": "../../....",
"gender": "F",
"expiry_date": "../../...",
"mrz": "...",
"age": "...",
"country": "PT"
},
"images": {
"front": "https://api.biometrid.com/files/processes/1111111111111111111111",
"back": "https://api.biometrid.com/files/processes/1111111111111111111111",
"photo": "https://api.biometrid.com/files/processes/1111111111111111111111"
},
"validations": {
"expiry_date": "GOOD",
"match_nationality": "GOOD",
"match_doc_number": "GOOD",
"match_gender": "GOOD",
"match_surname": "GOOD",
"match_name": "GOOD",
"match_birth_date": "GOOD",
"match_expiration_date": "GOOD",
"integrity_expiry_date": "GOOD",
"integrity_birth_date": "GOOD",
"integrity_doc_number": "GOOD",
"mrz": "GOOD",
"text": "GOOD",
"docType": "GOOD",
"imageQA": "GOOD"
},
"chosenMap": "residence_card_pt",
"imageQA": {
"front": {
"focus": "GOOD",
"glares": "GOOD",
"portrait": "GOOD",
"bounds": "GOOD",
"perspective": "GOOD",
"resolution": "GOOD"
},
"back": {
"focus": "GOOD",
"glares": "GOOD",
"bounds": "GOOD",
"perspective": "GOOD",
"resolution": "GOOD"
}
}
}
},
"stepId": "...",
"createdAt": "2026-02-27T10:23:56.809Z",
"deviceType": "desktop"
}