Skip to main content
GET
http://api.gu1.ai
/
api
/
kyc
/
id-verification
/
verifications
Get ID Verification (List, Single, Images)
curl --request GET \
  --url http://api.gu1.ai/api/kyc/id-verification/verifications \
  --header 'Authorization: Bearer <token>'

Overview

After submitting document images via POST ID Verification, each request is stored for audit. You can:
  1. List verifications (with optional filters: entityId, withoutEntity, status, pagination).
  2. Get a single verification by ID (same UUID as verificationId in the POST response).
  3. Stream stored images (document front/back) when the verification has storage paths.
All endpoints are scoped to your organization. No third-party provider names appear in responses.

1. List verifications

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

Query parameters

ParameterTypeDescription
entityIdstring (UUID)Optional. Filter by person entity.
withoutEntitybooleanIf true, only verifications with no associated entity.
statusstringOptional. approved | declined | failed.
limitnumberMax items (default 50, max 100).
offsetnumberPagination offset.

Response (200 OK)

{
  "verifications": [
    {
      "id": "uuid",
      "organizationId": "uuid",
      "entityId": "uuid | null",
      "status": "approved",
      "requestId": "string | null",
      "vendorData": "string | null",
      "errorMessage": "string | null",
      "warnings": ["string"],
      "extractedData": { },
      "createdAt": "ISO8601",
      "documentFrontStoragePath": "string | null",
      "documentBackStoragePath": "string | null",
      "storageProvider": "s3 | local | null"
    }
  ],
  "pagination": { "limit", "offset", "total" }
}

2. Get a single verification

GET https://api.gu1.ai/api/kyc/id-verification/verifications/:id
Returns one audit record by ID. Use the verificationId from the POST response or from the list.

Path parameters

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

Response (200 OK)

Same object shape as one item in the list above. 404 if not found or not in your organization.

3. Get stored document images

When a verification has documentFrontStoragePath or documentBackStoragePath, you can stream the image bytes:
GET https://api.gu1.ai/api/kyc/id-verification/verifications/:id/document-front-image
GET https://api.gu1.ai/api/kyc/id-verification/verifications/:id/document-back-image

Path parameters

id
string
required
UUID of the verification.

Response

  • 200: Image body (e.g. Content-Type: image/jpeg).
  • 404: Verification not found or that image was not stored.

Headers

For all requests:
Authorization: Bearer YOUR_API_KEY
Include X-Organization-Id if your account is organization-scoped.

Error responses

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

Example

const response = await fetch(
  'https://api.gu1.ai/api/kyc/id-verification/verifications?limit=20',
  { headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
);
const { verifications, pagination } = await response.json();

Next Steps