Skip to main content
GET
http://api.gu1.ai
/
api
/
kyc
/
face-match
/
verifications
/
{id}
Get Face Match Verification
curl --request GET \
  --url http://api.gu1.ai/api/kyc/face-match/verifications/{id} \
  --header 'Authorization: Bearer <token>'

Overview

Returns one Face Match verification by its id (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.

Request

Endpoint

GET https://api.gu1.ai/api/kyc/face-match/verifications/:id

Path Parameters

id
string
required
UUID of the Face Match verification (same as verificationId from POST or list).

Headers

{
  "Authorization": "Bearer YOUR_API_KEY"
}
Include X-Organization-Id if your account is scoped by organization.

Response

Success (200 OK)

Single verification object:
FieldTypeDescription
idstringVerification UUID.
organizationIdstringOrganization that owns the record.
entityIdstring | nullPerson entity ID if provided in the request.
statusstringapproved | declined | in_review | failed.
matchbooleanWhether faces were considered a match.
scorenumber | nullSimilarity score 0–100 (null when status is failed).
requestIdstring | nullInternal request ID (support).
vendorDatastring | nullClient reference from the request.
errorMessagestring | nullGeneric error message when status is failed.
triggeredByUserIdstring | nullUser who called the API.
createdAtstringISO timestamp.
documentStoragePathstring | nullStorage path for document image (audit).
selfieStoragePathstring | nullStorage path for selfie image (audit).
storageProviderstring | nulls3 or local.
thresholdnumber | nullScore threshold used for this verification (from org settings at the time).

Error Responses

CodeHTTPDescription
NOT_FOUND404Verification ID does not exist or belongs to another organization.
UNAUTHORIZED401Missing or invalid API key or organization context.

Example

const id = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';
const response = await fetch(`https://api.gu1.ai/api/kyc/face-match/verifications/${id}`, {
  headers: { 'Authorization': 'Bearer YOUR_API_KEY' },
});
const verification = await response.json();

Next Steps