> For the complete documentation index, see [llms.txt](https://docs.complycube.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.complycube.com/documentation/api-reference/core-resources/checks.md).

# Checks

Checks are verification services that allow you to perform identity, AML, fraud, and compliance checks against your clients.

**Checks** enable you to run various types of verifications against your clients. You can perform the following types of checks:

1. [Standard AML Screening](https://docs.complycube.com/documentation/product-guides/watchlist-pep-and-adverse-media/aml-screening-check.md)
2. [Extensive AML Screening](https://docs.complycube.com/documentation/product-guides/watchlist-pep-and-adverse-media/aml-screening-check.md)
3. [Document Check](https://docs.complycube.com/documentation/product-guides/identity-verification/document-check.md)
4. [Identity Check](https://docs.complycube.com/documentation/product-guides/identity-verification/document-check.md)
5. [Enhanced Identity Check](https://docs.complycube.com/documentation/product-guides/biometric-and-liveness-verification/enhanced-identity-check.md)
6. [Proof of Address Check](https://docs.complycube.com/documentation/product-guides/kyc-automation-services/proof-of-address-check.md)
7. [Multi-Bureau Check](https://docs.complycube.com/documentation/product-guides/identity-verification/multi-bureau-check.md)
8. [eID Check](https://docs.complycube.com/documentation/product-guides/identity-verification/eid-check.md)
9. [SSN Check](https://docs.complycube.com/documentation/product-guides/identity-verification/ssn-check.md)
10. [Age Estimation Check](https://docs.complycube.com/documentation/product-guides/biometric-and-liveness-verification/age-estimation-check.md)
11. [Identity Fraud Check](https://docs.complycube.com/documentation/product-guides/identity-verification/identity-fraud-check.md)
12. [Driving License Check](https://docs.complycube.com/documentation/product-guides/identity-verification/driving-license-check.md)
13. [Device Intelligence Check](https://docs.complycube.com/documentation/product-guides/digital-fraud-intelligence/device-intelligence-check.md)
14. [Email Intelligence Check](https://docs.complycube.com/documentation/product-guides/digital-fraud-intelligence/email-intelligence-check.md)
15. [Mobile Intelligence Check](https://docs.complycube.com/documentation/product-guides/digital-fraud-intelligence/mobile-intelligence-check.md)
16. [Face Authentication Check](https://docs.complycube.com/documentation/product-guides/biometric-and-liveness-verification/face-authentication-check.md)

The checks API allows you to create, update, validate, and retrieve checks. You can retrieve a specific check as well as a list of all your client's checks.

{% hint style="info" %}
All checks are **asynchronous**.
{% endhint %}

### The Check object

| Attribute          | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`               | string  | The unique identifier for a check.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `clientId`         | string  | The ID of the client associated with this check.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `enableMonitoring` | boolean | Determines whether continuous monitoring is enabled. When not provided, it defaults to **false**.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `documentId`       | string  | The ID of the document. This is expected when the type of check is `document_check`, `identity_check`, `enhanced_identity_check`, `proof_of_address_check`, or `driving_license_check`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `addressId`        | string  | The ID of the address. This is expected when the check type is `multi_bureau_check` or `identity_fraud_check`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `livePhotoId`      | string  | The ID of the live photo. This is expected when the type of check is `identity_check`, `age_estimation_check`, or `face_authentication_check`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `liveVideoId`      | string  | The ID of the live video. This is expected when the type of check is `enhanced_identity_check`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `entityName`       | string  | The full name of the client. This will be auto-generated.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `type`             | string  | <p>The type of check. Valid values include:</p><ol><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/aml-screening-check.md"><code>standard\_screening\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/aml-screening-check.md"><code>extensive\_screening\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/document-check.md"><code>document\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/identity-check.md"><code>identity\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/enhanced-identity-check.md"><code>enhanced\_identity\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/proof-of-address-check.md"><code>proof\_of\_address\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/multi-bureau-check.md"><code>multi\_bureau\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/eid-check.md"><code>eid\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/ssn-check.md"><code>ssn\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/age-estimation-check.md"><code>age\_estimation\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/identity-fraud-check.md"><code>identity\_fraud\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/driving-license-check.md"><code>driving\_license\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/device-intelligence-check.md"><code>device\_intelligence\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/email-intelligence-check.md"><code>email\_intelligence\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/mobile-intelligence-check.md"><code>mobile\_intelligence\_check</code></a></li><li><a href="https://docs.complycube.com/documentation/api-reference/check-types/face-authentication-check.md"><code>face\_authentication\_check</code></a></li></ol> |
| `options`          | object  | The advanced optional configuration associated with the check. Also, see the **options** object defined under each `type` of check.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `clientConsent`    | boolean | Where required, you must collect the client's consent before creating a check.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `status`           | string  | <p>The status of the check. As checks are asynchronous, their status will change as their state transitions. Values can be:</p><ol><li><code>pending</code> - the status on initiation.</li><li><code>complete</code> - the status upon completion.</li><li><code>failed</code> - the status if a check fails.</li></ol>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `result`           | object  | The result of the check. This will only have a value when a check is complete. The content will depend on the type of check.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `createdAt`        | string  | The date and time when the check was created.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `updatedAt`        | string  | The date and time when the check was completed.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |

### Structured Date format

In many cases, an attribute within a check's `result` object will contain an attribute with a structured date value.

{% tabs %}
{% tab title="Attributes" %}

| Attribute    | Type   | Description                               |
| ------------ | ------ | ----------------------------------------- |
| `day`        | number | The day of the month. Value range `1-31`. |
| `month`      | number | The month. Value range `1-12`.            |
| `year`       | number | The year, in `YYYY` format.               |
| {% endtab %} |        |                                           |

{% tab title="Sample Object" %}

```json
{
    ...
    "expirationDate":{
        "day": 1,
        "month": 12,
        "year": 2020
    }
    ...
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.complycube.com/documentation/api-reference/core-resources/checks.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
