Sign in

v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
Checks

List all checks

Returns a list of all checks created in your Dotfile workspace.

See also

Learn more about Checks
Learn more about Filtering, Sorting and Pagination

get/v1/checks

Query parameters

individual_idstring

Filter items by the individual_id.{operator} field.
You can use the eq and not_eq operators, the eq operator being the default.

company_idstring

Filter items by the company_id.{operator} field.
You can use the eq and not_eq operators, the eq operator being the default.

status'in_progress' | 'need_review' | 'processing' | 'approved' | 'rejected' | 'expired'

Filter items by the status.{operator} field.
You can use the eq and not_eq operators, the eq operator being the default.

type'id_verification' | 'id_document' | 'aml' | 'company_monitoring' | 'document' | 'ekyc' | 'electronic_signature' | 'fraud_database' | 'online_reputation'

Filter items by the type.{operator} field.
You can use the eq and not_eq operators, the eq operator being the default.

exclude_internalboolean

Exclude checks that are marked as internal.
Default is false

include_not_relevantboolean

Include checks from individuals marked as not relevant.
Default is false

created_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the created_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

updated_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the updated_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

last_activity_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the last_activity_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

sortstring

Use this parameter to sort query results.
If not specified, sorted in ascending order with values of field updated_at.
Available fields are created_at, last_activity_at and updated_at.

pagenumber

Query response is paginated.
Use this parameter to choose which page you want to display.
Page index starts at 1 (the default).

limitnumber

Query response is paginated.
Use this parameter to choose the number of items per page.
Limit defaults to 20, maximum value is 100.

Response

List of checks created in the workspace

ℹ️ Click to see full payload

Example response

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "individual_id": "5e1a2886-de4b-4c98-ae73-aee8cf7d044f",
      "company_id": null,
      "is_internal": false,
      "status": "in_progress",
      "type": "id_verification",
      "subtype": null,
      "created_at": "2025-07-25T16:08:26.962Z",
      "updated_at": "2025-07-25T16:08:26.962Z",
      "last_activity_at": "2025-07-25T16:08:26.962Z"
    },
    {
      "id": "88ef7487-a863-459f-a738-d94ecc3e7d61",
      "individual_id": null,
      "company_id": "11676e8d-0200-46d3-81f6-c11f340669a2",
      "is_internal": true,
      "status": "need_review",
      "type": "document",
      "subtype": "document_type:bank_details",
      "document_type_key": "bank_details",
      "created_at": "2025-07-25T16:08:26.962Z",
      "updated_at": "2025-07-25T16:08:26.962Z",
      "last_activity_at": "2025-07-25T16:08:26.962Z"
    }
  ],
  "pagination": {
    "count": 42
  }
}