Get Face Match Verification
Face Match
Get Face Match Verification
Retrieve a single Face Match audit record by ID β in the gu1 KYC API for identity verification flows, with examples for get face match verification use cases.
GET
Get Face Match Verification
Overview
Returns one Face Match verification by itsid (the same UUID returned as verificationId in the POST Face Match response or in the list endpoint). Use it to fetch full details of a past verification for audit, support, or detail views.
Key points:
- Scoped to your organization; returns 404 if the ID does not exist or belongs to another org.
- Same fields as each item in the list:
id,entityId,status,match,score,threshold,createdAt, and optional image paths.
To download stored document and selfie bytes, use Get Face Match images (
/document-image and /selfie-image).Request
Endpoint
Path Parameters
UUID of the Face Match verification (same as
verificationId from POST or list).Headers
X-Organization-Id if your account is scoped by organization.
Response
Success (200 OK)
Single verification object:| Field | Type | Description |
|---|---|---|
id | string | Verification UUID. |
organizationId | string | Organization that owns the record. |
entityId | string | null | Person entity ID if provided in the request. |
status | string | approved | declined | in_review | failed. |
match | boolean | Whether faces were considered a match. |
score | number | null | Similarity score 0β100 (null when status is failed). |
requestId | string | null | Internal request ID (support). |
vendorData | string | null | Client reference from the request. |
errorMessage | string | null | Error message when status is failed. |
triggeredByUserId | string | null | User who called the API. |
createdAt | string | ISO timestamp. |
documentStoragePath | string | null | Storage path for document image (audit). |
selfieStoragePath | string | null | Storage path for selfie image (audit). |
storageProvider | string | null | s3 or local. |
threshold | number | null | Score threshold used for this verification (from org settings at the time). |
Error Responses
| Code | HTTP | Description |
|---|---|---|
NOT_FOUND | 404 | Verification ID does not exist or belongs to another organization. |
UNAUTHORIZED | 401 | Missing or invalid API key or organization context. |
Example
Next Steps
Face Match (POST)
Verify document + selfie in one call
List Validations
List KYC validations by entity