Skip to main content
GET
/
v1
/
entities
/
{entity_token}
/
checks
List entity checks
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/entities/{entity_token}/checks \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "token": "chk_5n8p3q1r",
      "entity_token": "<string>",
      "type_code": "<string>",
      "provider": "WorldCheck",
      "result_data": {},
      "alerts_generated": 123,
      "waive_reason": "<string>",
      "retry_count": 0,
      "valid_until": "2023-11-07T05:31:56Z",
      "executed_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "request_id": "req_9k4m2n1p3q",
    "page": {
      "cursor": "<string>",
      "has_more": true
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.zenoo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Project-scoped API key for server-to-server authentication. Obtain keys from the Zenoo dashboard under Project Settings > API Keys. Staging and production environments use separate keys.

Path Parameters

​
entity_token
string
required

Entity token.

Query Parameters

​
cursor
string

Pagination cursor from a previous response. Pass to fetch the next page.

​
limit
integer
default:25

Maximum number of items to return per page.

Required range: 1 <= x <= 100
​
status
enum<string>

Filter by check status.

Available options:
Pending,
Queued,
In Progress,
Awaiting Document,
Awaiting Client,
Complete,
Failed,
Waived,
Cancelled,
Reused,
Retry Scheduled
​
category
enum<string>

Filter by check category.

Available options:
Identity,
Screening,
Company,
Financial,
EDD

Response

List of checks for the entity.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

​
data
object[]

Response payload. Type varies by endpoint.

​
meta
object