When you need a customer's current verification result on demand, look it up by email or phone. This complements webhooks: use webhooks as the primary signal, and retrieval for reconciliation, retries, or when you cannot host a webhook receiver.
Look up a customer
From your backend, send your credentials and the customer's email or phone. Email is matched first, then phone, scoped to your client.
http
POST https://api.sentinel.example.com/customers/status/clientAuth
Field
Type
Description
clientUuidrequired
string
Your client identifier.
clientSecretrequired
string
Your client secret. Server-side only.
email
string
Required if phoneNumber is absent. Matched first.
phoneNumber
string
Required if email is absent. Matched if email is not provided or not found.
optimizedDownload
boolean
When true, trims image payloads to reduce response size. Defaults to false.
A match returns 200 with the result. No match returns 404 with { "message": "Row not found" }. Invalid credentials and validation errors follow the conventions on Authentication.
The result
The data object holds the customer's identity fields, the liveness result, and each submitted document with its face-match and OCR data. Documents that were not submitted are null.
The submitted document, or null if not submitted. See document fields below.
createdAt, updatedAt
string (ISO)
Record timestamps.
Document fields
Field
Type
Description
passportNumber / emiratesIdNumber
string
The document number.
dateOfIssue, dateOfExpiry
string
Document validity dates.
authority
string
Issuing authority.
countryOfIssue
string
Issuing country.
idMatch
boolean
Whether the live face matched the document portrait.
idScore
number
Face-match confidence.
idClassificationPassed
boolean
Whether the document classification passed.
frontImage, backImage, idImage
string
Document images as base64 data URIs.
ocrPassport / ocrEmiratesId
object
Fields read from the document by OCR.
Passports additionally include passportType and placeOfIssue, and the exact fields vary by document type. The screening outcome is reflected in status; raw sanctions data is not part of this response. The response may also include internal fields, such as database identifiers and pointers, that you can safely ignore.
Treat the result as sensitive
It contains personal data and document images. Serve requests over HTTPS, do not log the payload, and store only what your compliance program requires. To reduce response size, set optimizedDownload to true, or use the without-images endpoint below.
Without images
For status and data without any image payloads, use the lighter endpoint. It takes the same identifiers and returns the same shape, with the image fields returned as null.
http
POST https://api.sentinel.example.com/customers/statusWithoutImages/clientAuth
To page through your customers with their documents, use the list endpoint. Images are omitted, and each customer carries an expiredIds array naming any documents that have expired.
http
POST https://api.sentinel.example.com/customers/listWithDoc/clientAuth
Field
Type
Description
clientUuidrequired
string
Your client identifier.
clientSecretrequired
string
Your client secret. Server-side only.
page
number
Page number. Defaults to 1.
entriesPerPage
number
One of 10, 50, or 100. Defaults to 50.
sortBy
string
One of name, phoneNumber, nationality, gender, status, updatedAt. Defaults to updatedAt.
Correct a customer's email or phone with the contact endpoint. Identify the customer by customerUuid and pass the fields to change. A value already in use by another customer returns 409.
http
POST https://api.sentinel.example.com/customers/contact/clientAuth