Retrieving check results
Fetch a check again by its checkId to show the outcome in your back office or request a report.
Every check call returns a checkId. Store it with your own record so you can fetch the result again later, for example to show it in your back office or to request a report.
Fetch a check#
GET /api/v1/checks/{checkId} returns the check if it was made with your account's keys. Any other id returns 404, including checks that belong to another account.
curl -sS -X GET 'https://api.trustverify.co.uk/api/v1/checks/chk_123' \
-H "Authorization: Bearer $TRUSTVERIFY_API_KEY"| Field | Meaning |
|---|---|
type | The kind of check, such as kyc, kyb, aml or fraud. |
status | The outcome, such as passed, review or failed. |
riskLevel | The risk level, or unknown when the check did not set one. |
environment | test for test keys (demo data only), live for live keys. |
result | The stored result of the original call, in the same shape that call returned. |
For a PDF of the result, see Reports and evidence bundles.