> This is part 1 of 6 of the full documentation (pages 1–100 of 519).
> The content is paginated: fetch every part to see all of it.
> Next part: https://docs.caf.io/llms-full.txt/1
> Page index: https://docs.caf.io/llms.txt

# 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
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

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

```
GET https://docs.caf.io/index.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.

---

# Caf Dev Hub

Bem vindo ao Caf Dev Hub. Explore nossos guias, documentações de API e SDK e comece.

#### Integrating with Certta

Everything you need to know for a successful integration

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:green;"><strong>Product guides</strong></mark></td><td>Familiarize yourself with Certta’s products for documents, biometrics, and background checks</td><td><a href="https://3713459844-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk3vdEbBCIiBvZGG8skrv%2Fuploads%2FCHJbEFhN1hvWZktc3SlB%2Fmini-1.jpg?alt=media&amp;token=4fca508b-3b13-47ed-9270-d2d76837e47a">mini-1.jpg</a></td><td><a href="/caf-docs">Overview</a></td></tr><tr><td><mark style="color:green;"><strong>Certta API</strong></mark></td><td>Explore Certta API to start your integration journey</td><td><a href="https://3713459844-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk3vdEbBCIiBvZGG8skrv%2Fuploads%2FIHCZQ1AAuUphPmgx1HwT%2Fmini-3.jpg?alt=media&amp;token=1ad7339f-c3ed-4bc8-a8aa-aa4ddbcfabb8">mini-3.jpg</a></td><td><a href="/caf-api">Overview</a></td></tr><tr><td><mark style="color:green;"><strong>Certta SDK</strong></mark></td><td>Implement quickly and easily using the Certta SDK</td><td><a href="https://3713459844-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk3vdEbBCIiBvZGG8skrv%2Fuploads%2F7vBwOokE9JB6xhqQBsg2%2Fmini-2.jpg?alt=media&amp;token=b7e3624f-f08a-47ae-b927-dc126712652c">mini-2.jpg</a></td><td><a href="https://docs.caf.io/caf-sdk/">🇺🇸 English</a></td></tr></tbody></table>


# Overview

Certta's product guides provide in-depth information about our products and solutions.

These guides offer a technical overview of our verification solutions, explaining how they work and how they can benefit your business.


# User Onboarding

### What is Caf. User Onboarding?

Caf. Onboarding aims to ensure the best possible user experience while maintaining security, with the goal of reduce dropouts and identify fraudsters and bad actors in accordance with our clients' rules and needs.

Our onboarding flows are customizable and automated for validations of Persons and Companies. Through Selfie Capture, Basic Registration Data, and Front and Back Document Photos, Caf. clients can benefit from agility, security in verifying the persons and/or company's identity, as well as increased accuracy in the onboarding processes of end customers for Caf. customers.

Furthermore, we employ artificial intelligence for Document Typing, OCR, Proof of Life, and Data Sources for the Background Check process, all in the effort to enhance the experience for both the Caf. client and the end user.

### Key benefits

1. **Flexible workflows:** meet your unique business needs with a simple, drag-and-drop, no-code, visual design environment.
2. **Maximize conversions:** improve approval rates without compromising security to grow the business.
3. **Improve user experience:** eliminate unnecessary friction, reduce false positives and create happy and loyal customers.

### Starting with Caf. User Onboarding

You can find a quick start guide at [Onboarding Journey](/caf-docs/quick-start-guides/onboarding-journey).

{% hint style="warning" %}
At this moment we still have part of the journey divided between **Brazil flow** and **Global flow**. We will make clear here the differences and how to perform each one.
{% endhint %}


# ID Document Verification

### What is Caf. ID Document Verification?

Verify identity documents effectively worldwide, improve agility and decrease friction in onboarding new users. Accept more customers with Caf. AI-driven verification solution and world-class global coverage while identifying fake or tampered documents instantly. Integrated manual review improves new customer conversion while delivering actionable insights.

### Key benefits

1. **User experience:** ensure the best possible customer experience when validating documents and identities.
2. **Seamless, frictionless flow:** add security tools to the flow and validate identity without creating friction for users.
3. **Fully customizable:** create flows tailored to your specific business needs, helping you to grow the business efficiently.


# Know Your Customer - KYC

### What is Caf. KYC?

In a world where trust and compliance are paramount, our KYC (Know Your Customer) solution stands as a pioneering force, leveraging advanced technology with unmatched data coverage and customizable search rules to drive customer growth and simplify complex regulatory requirements such as KYC, AML and PEP. Accurately identify risky users and make smarter decisions.

### Key benefits

1. **Adaptable to your business rules:** monitor important data about individuals to comply with laws and regulations, such as KYC rules, identification of PEPs/AML.
2. **Automated and personalized flow:** rule flows are customized and, after being configured, follow the configured pattern, streamlining and optimizing the approval or disapproval process.
3. **Integrable with different data sources:** integrate your flow with numerous databases, public or private, for more specific data and more efficient results.


# Know Your Business - KYB

### What is Caf. KYB?

In a world where trust and compliance are paramount, our KYB (Know Your Business) solution stands as a pioneering force, revolutionizing how businesses assess their potential partners. Leveraging a dynamic synergy of multiple data sources, cutting-edge technology, and intuitive design, our solution transforms the due diligence landscape.

### Key benefits

1. **Comprehensive company verification:** seamlessly amalgamate diverse data sources to effortlessly identify and verify the authenticity of companies. Eliminate uncertainties and reduce risks by ensuring that you only engage with legitimate and trustworthy businesses.
2. **Transparency into Ultimate Beneficial Ownership (UBO):** illuminate the corporate landscape by uncovering the individuals who stand behind the curtain. Our solution reveals Ultimate Beneficial Owners (UBOs), providing a holistic view of the business ecosystem.
3. **Streamlined KYC.IDV workflow:** experience the power of efficiency with an integrated workflow that conducts KYC (Know Your Customer) and IDV (Identity Verification) checks on individuals associated with the business. Our solution brings together critical compliance steps in a single process, expediting client onboarding.

You can find a quick start guide on how to perform a KYB Onboarding at [Onboarding Journey](/caf-docs/quick-start-guides/onboarding-journey).

**Only for global clients:** how to conduct a company search through API at [Company Search through API](/caf-docs/quick-start-guides/company-search-through-api) and through Trust Platform at [Company](/caf-docs/user-guide/trust-platform/company).


# Account Takeover Prevention

### What is Caf. Account Takeover Prevention?

Caf's Account Takeover Prevention has the main purpose of analyzing whether a user is who he says he is, preventing account takeover attacks (ATO) through Smart Auth, a multi-factor authentication product.

Our solution can perform dozens of under-the-hood analyses (depending on the client's settings) to allow or deny an authentication attempt.

You can find a Overview at [Smart Auth Overview](/caf-docs/user-guide/smart-auth).

### Key benefits

1. **Real-time detection:** We use advanced technology for agile detection and immediate action to mitigate fraud risks.
2. **Risk-based authentication:** Ability to create custom authentication rules based on access context and risk level.
3. **Long-term protection :** Continuous monitoring to ensure security throughout the endless customer journey.

### Starting with Caf. Smart Auth

You can learn more about this solution at: [Smart Auth Overview](/caf-docs/user-guide/smart-auth).


# Organizations

Manage members, access, and security for your organization in Organizations.

**Organizations** is the Certta admin console for identity and access management. Super Admins use it to configure the organization profile, manage people (members, administrators, roles, and groups), and set up security features such as SSO and SCIM provisioning.

Each organization is accessed at its own subdomain, for example `https://certta.sso.caf.io`. **Members** sign in at that URL with **Sign in with SSO** when SSO is enabled. **Super Admins** open the admin console at `https://certta.sso.caf.io/admin-login` using email and password.

***

## Access requirements

| Requirement                | Description                                                                                               |
| -------------------------- | --------------------------------------------------------------------------------------------------------- |
| **Super Admin**            | Full access to all areas described below.                                                                 |
| **Member**                 | Can sign in and use linked Certta products according to group assignments. Cannot open the admin console. |
| **Organization subdomain** | The hostname alias identifies your tenant (for example, `certta` in `https://certta.sso.caf.io`).         |

***

## Navigation overview

The admin sidebar includes four main areas:

| Area             | Purpose                                                                                  |
| ---------------- | ---------------------------------------------------------------------------------------- |
| **Dashboard**    | Overview of members, groups, linked accounts, and roles, plus shortcuts to SSO and SCIM. |
| **Organization** | Organization status, login URL, identifier, and linked Certta accounts.                  |
| **People**       | Members, administrators, roles, and groups.                                              |
| **Security**     | SSO, attribute mapping, group assignment rules, and SCIM tokens.                         |

***

## Dashboard

The dashboard shows organization-wide counts and the status of SSO and SCIM provisioning.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-9d3d34c5db700bc4dd98aab1e666eb391cf5ccd6%2Fdashboard.jpg?alt=media" alt="Organizations - Dashboard"></div>

| Stat                | Description                                        |
| ------------------- | -------------------------------------------------- |
| **Members**         | Total members in the organization.                 |
| **Groups**          | Groups used to bundle role and tenant assignments. |
| **Linked accounts** | Certta products linked to this organization.       |
| **Roles**           | Custom roles defined for fine-grained permissions. |

Use the SSO and SCIM cards to jump directly to the corresponding **Security** tabs.

***

## Organization

Configure organization-level settings: active status, display name, login URL, organization ID, and linked accounts.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-f61553b04b18d09698bc9a0735ce4752bd7052d1%2Forganization.jpg?alt=media" alt="Organizations - Organization settings"></div>

| Field                   | Description                                                        |
| ----------------------- | ------------------------------------------------------------------ |
| **Organization active** | When disabled, new logins are blocked; existing data is preserved. |
| **Login URL**           | URL members use to sign in (subdomain-based).                      |
| **Organization ID**     | Internal identifier for APIs and support.                          |
| **Linked accounts**     | Certta products connected to this organization.                    |

***

## People

The **People** screen has four tabs: **Members**, **Administrators**, **Roles**, and **Groups**.

### Members

View and manage organization members. Search and filter by status, and deactivate accounts.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-14ff7096136bbb7d9e6c9ca4c2f9c38acece0617%2Fpeople-members.jpg?alt=media" alt="Organizations - Members"></div>

### Administrators

Super Admins who can manage the organization. View the list of administrators with access to the admin console.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-316eba4e3e7f624939d4bf50255ba7d063581134%2Fpeople-admins.jpg?alt=media" alt="Organizations - Administrators"></div>

### Roles

Define named sets of **scopes** (permissions). Roles are attached to groups; members inherit access through group membership.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-62635a680c590854201e07c6d17bb1d094421711%2Fpeople-roles.jpg?alt=media" alt="Organizations - Roles"></div>

| Column          | Description                                                            |
| --------------- | ---------------------------------------------------------------------- |
| **Role**        | Display name of the custom role.                                       |
| **Description** | Optional summary of the role purpose.                                  |
| **Permissions** | Count of scopes assigned to the role.                                  |
| **Groups**      | Number of groups that reference this role in their access assignments. |

#### Create a role

1. Open **People** → **Roles**.
2. Select **Create role**.
3. Enter a **Name** and optional **Description**.
4. Under **Permissions**, select one or more scopes (use the filter to search by identifier).
5. Select **Save role**.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-935228cc2d334d035968d2dedc3d4f89f4dc41ae%2Fpeople-create-role.jpg?alt=media" alt="Organizations - Create role"></div>

{% hint style="info" %}
Roles are not assigned to members directly. Attach a role to a **group** under **Accesses** so every member of that group inherits the role on the selected linked accounts.
{% endhint %}

### Groups

Bundle **role + tenant** assignments and attach members. Groups are the primary unit for access control across linked Certta products.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-32e743a44f5beb4e9234064bddc6248e39cebbc4%2Fpeople-groups.jpg?alt=media" alt="Organizations - Groups"></div>

| Column          | Description                                                           |
| --------------- | --------------------------------------------------------------------- |
| **Name**        | Group display name.                                                   |
| **Description** | Optional summary of the group's purpose.                              |
| **Members**     | Count of members attached to the group.                               |
| **Assignments** | Count of role + linked-account access rules configured for the group. |

#### Create a group

1. Open **People** → **Groups**.
2. Select **Create group**.
3. Enter a **Group name** and optional **Description**.
4. Select **Create Group** — you are redirected to the group detail page.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-9cc90fb7857dce3664b7500c12996444495a0b36%2Fpeople-create-group.jpg?alt=media" alt="Organizations - Create group"></div>

#### Group detail — Members and Accesses

Each group has two tabs:

| Tab          | Purpose                                                                     |
| ------------ | --------------------------------------------------------------------------- |
| **Members**  | View and add organization members to the group.                             |
| **Accesses** | Assign **roles** to **linked accounts** (all accounts or specific tenants). |

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-7ea87e82c544ba7945f7f93b3dd009eca029a70e%2Fpeople-group-detail.jpg?alt=media" alt="Organizations - Group detail members"></div>

Open the **Accesses** tab to manage which roles the group grants and on which linked accounts:

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-9b1570f0ca7fb61bcd5fb596ff5043fdffb49c11%2Fpeople-group-access.jpg?alt=media" alt="Organizations - Group accesses"></div>

Select **Add accesses** to attach a role:

1. Choose a **Role** from the list of roles defined in **People** → **Roles**.
2. Under **Where to apply**, pick **All accounts** or **Specific accounts**.
3. For specific accounts, select one or more linked accounts from the list.
4. Select **Add accesses**.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-5760f5899fec662cfa1453a418734f327895785b%2Fpeople-group-add-access.jpg?alt=media" alt="Organizations - Add group access"></div>

{% hint style="warning" %}
Create **roles** and **groups** before configuring **Security** → **Group assignment rules**. SSO rules target existing groups — they do not create groups automatically.
{% endhint %}

***

## Security

Open **Security** in the sidebar (labeled **Authentication** in the page header). Four tabs cover federation and provisioning.

### SSO

Enable SAML or OIDC, copy Service Provider values for your identity provider, and save provider configuration.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-0c77d58efd3441d27989810a1fca73a8ea378112%2Fsecurity-sso.jpg?alt=media" alt="Organizations - SSO configuration"></div>

See the [SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations) and provider-specific guides for step-by-step setup.

### Attribute mapping

Map identity provider claims to member fields used during SSO sign-in.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-9ae81fd46e4979aaf8649503142ddd92e0543b5a%2Fsecurity-attribute-mapping.jpg?alt=media" alt="Organizations - Attribute mapping"></div>

### Group assignment rules

Assign members to groups automatically based on IdP attributes (for example, directory groups or department).

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-bf9a41ab122120a5af5b6a40a43a5c06e0e904e9%2Fsecurity-assignment-rules.jpg?alt=media" alt="Organizations - Group assignment rules"></div>

### SCIM

Generate a bearer token and SCIM base URL for automated user provisioning from your identity provider.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-2da17f5ca4c4fbacce838f14c8bfc0797d767e9d%2Fsecurity-scim.jpg?alt=media" alt="Organizations - SCIM provisioning"></div>

See the [SCIM Provisioning Guide](/caf-docs/user-guide/organizations/scim-provisioning) for setup steps, supported operations, and how SCIM interacts with SSO.

***

## Related documentation

* [SSO Configuration](/caf-docs/user-guide/organizations/sso-configurations)
* [SCIM Provisioning](/caf-docs/user-guide/organizations/scim-provisioning)
* [Microsoft Entra ID (SAML)](/caf-docs/user-guide/organizations/sso-configurations/microsoft-entra-id)
* [Microsoft Entra ID (OIDC)](/caf-docs/user-guide/organizations/sso-configurations/generic)
* [Okta (SAML / OIDC)](/caf-docs/user-guide/organizations/sso-configurations/okta)
* [Auth0 (SAML / OIDC)](/caf-docs/user-guide/organizations/sso-configurations/auth0)
* [Google Workspace (SAML)](/caf-docs/user-guide/organizations/sso-configurations/google)
* [Generic Provider (SAML / OIDC)](/caf-docs/user-guide/organizations/sso-configurations/generic)


# SSO Configuration

Configure Single Sign-On (SSO) in the Organizations admin console.

The **Authentication** screen lets you configure Single Sign-On for your organization. With SSO enabled, members sign in with corporate credentials from your identity provider instead of a separate Organizations password.

{% hint style="warning" %}
**Important:** Organizations supports **Service Provider-initiated (SP-initiated)** login only. Members open your organization URL (for example, `https://certta.sso.caf.io`) and choose **Sign in with SSO**. Identity Provider-initiated (IdP-initiated) login — opening Organizations directly from the provider portal — is not supported.
{% endhint %}

***

## Who uses SSO

| Role            | Sign-in URL                                   | Method                                                     |
| --------------- | --------------------------------------------- | ---------------------------------------------------------- |
| **Super Admin** | `https://{your-alias}.sso.caf.io/admin-login` | Email and password — does **not** use **Sign in with SSO** |
| **Member**      | `https://{your-alias}.sso.caf.io`             | **Sign in with SSO** when SSO status is **Active**         |

Configure SSO in the admin console as a Super Admin. Validate the member experience in a separate browser session at the organization URL.

***

## Supported Providers

Organizations integrates with identity providers that support `SAML 2.0` or `OpenID Connect` (`OIDC`).

| Provider                      | Protocol        | Documentation                                                                                                                                                                       |
| ----------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Microsoft Entra ID (Azure AD) | `SAML` / `OIDC` | [SAML guide](/caf-docs/user-guide/organizations/sso-configurations/microsoft-entra-id) · [OIDC via Generic Provider](/caf-docs/user-guide/organizations/sso-configurations/generic) |
| Okta                          | `SAML` / `OIDC` | [Configure Okta](/caf-docs/user-guide/organizations/sso-configurations/okta)                                                                                                        |
| Auth0                         | `SAML` / `OIDC` | [Configure Auth0](/caf-docs/user-guide/organizations/sso-configurations/auth0)                                                                                                      |
| Google Workspace              | `SAML`          | [Configure Google Workspace](/caf-docs/user-guide/organizations/sso-configurations/google)                                                                                          |

For other providers, use the [Generic Provider Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations/generic).

***

## How SSO authentication works

Organizations uses a federation broker between your identity provider and the member sign-in experience. When you copy **Entity ID**, **ACS URL**, or **Redirect URI** from the **SSO** tab, you register **broker endpoints** in your corporate IdP — not the organization login URL.

```mermaid
sequenceDiagram
    participant Member
    participant Org as Organizations<br/>{alias}.sso.caf.io
    participant Broker as Federation broker
    participant IdP as Corporate IdP

    Member->>Org: Open organization URL
    Member->>Org: Sign in with SSO
    Org->>Broker: /api/auth/sso/authorize
    Broker->>IdP: Redirect to corporate login
    IdP->>Broker: SAML assertion or OIDC tokens
    Broker->>Org: /api/auth/sso/callback
    Org->>Member: Active session
```

| Step | What happens                                                                                                                                                   |
| ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1    | The member opens `https://{alias}.sso.caf.io` and selects **Sign in with SSO**.                                                                                |
| 2    | Organizations redirects the browser to the federation broker with your organization's IdP configuration.                                                       |
| 3    | The member authenticates at the corporate IdP (Okta, Entra ID, Auth0, Google Workspace, etc.).                                                                 |
| 4    | The IdP responds to the **ACS URL** (SAML) or **Redirect URI** (OIDC) shown in **Properties** — these point to the broker, not to your organization subdomain. |
| 5    | The broker completes the exchange and Organizations creates the member session.                                                                                |

{% hint style="info" %}
**SP metadata** (Entity ID, ACS URL, Redirect URI) is available in **Properties** before you save SSO configuration. Copy these values first, then configure your IdP application.
{% endhint %}

For SCIM-based provisioning, see the [SCIM Provisioning Guide](/caf-docs/user-guide/organizations/scim-provisioning).

***

## Recommended setup order

Follow this sequence for a complete SSO rollout:

1. **People** → **Groups** — create organization groups and attach **roles** and **linked account** access. Group assignment rules target these groups. See [Create a role](/caf-docs/user-guide/organizations#roles) and [Create a group](/caf-docs/user-guide/organizations#groups) in the Organizations overview.
2. **Security** → **SSO** — copy **Properties** (SP metadata) and configure your IdP application using a [provider guide](#supported-providers).
3. **Security** → **SSO** — save provider settings and confirm status **Active**.
4. **Security** → **Attribute mapping** — map IdP claims (defaults listed in [Step 3](#step-3-configure-attribute-mapping)).
5. **Security** → **Group rules** — define rules **only when SCIM is not active** (see [Member provisioning](#member-provisioning)).
6. **Security** → **SCIM** — optional; generate a token if your IdP must provision users before login ([SCIM Provisioning Guide](/caf-docs/user-guide/organizations/scim-provisioning)).
7. Test **member** login at `https://{alias}.sso.caf.io` in a private browser window.

***

## Authentication Protocols

{% tabs %}
{% tab title="SAML" %}
**Security Assertion Markup Language**

* `XML`-based protocol for exchanging authentication data
* Common in corporate environments
* Configure the provider using **Entity ID** and **ACS URL** from Organizations, then paste the provider **Metadata URL** or **Metadata XML** in Organizations
  {% endtab %}

{% tab title="OIDC" %}
**OpenID Connect**

* Modern protocol based on `OAuth 2.0`
* Uses `JWT` tokens for authentication
* Configure **Client ID**, **Client Secret**, **Issuer URL**, and **Authorization scopes** from your provider
  {% endtab %}
  {% endtabs %}

***

## Prerequisites

* **Super Admin** access in the Organizations admin console
* Administrator access to your identity provider
* Provider compatible with `SAML 2.0` or `OpenID Connect` / `OAuth 2.0`
* **Groups created** in **People** → **Groups** when you plan to use group assignment rules

***

## Step 1: Open Authentication Settings

1. Sign in to the admin console as a **Super Admin** at `https://{your-alias}.sso.caf.io/admin-login` using your email and password.
2. In the sidebar, open **Security**.
3. Select the **SSO** tab.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-0c77d58efd3441d27989810a1fca73a8ea378112%2Fsecurity-sso.jpg?alt=media" alt="Organizations - Authentication SSO tab"></div>

***

## Step 2: Enable SSO and Configure the Provider

1. Turn on **SSO enabled**.
2. Select the identity provider protocol (**SAML 2.0** or **OpenID Connect (OIDC)**).
3. Copy the **Service Provider (SP)** values shown in **Properties** and register them in your identity provider (see provider guides below).
4. Enter the provider settings returned by your IdP.
5. Select **Save**.

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

### SAML — SP values to copy into your IdP

| Organizations field | Use in provider as                       | Action |
| ------------------- | ---------------------------------------- | ------ |
| **Entity ID**       | Entity ID / Audience URI                 | Copy   |
| **ACS URL**         | ACS URL / Reply URL / Single Sign-On URL | Copy   |

### SAML — Provider values to paste in Organizations

| Organizations field      | Value                                         |
| ------------------------ | --------------------------------------------- |
| **Metadata XML URL**     | Metadata URL from your provider (recommended) |
| **Metadata XML Content** | Full metadata XML (when URL is not available) |

Use the **Use metadata URL** toggle to switch between URL and pasted XML.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-0c77d58efd3441d27989810a1fca73a8ea378112%2Fsecurity-sso.jpg?alt=media" alt="Organizations - SAML configuration"></div>

Provider setup guides:

* [Microsoft Entra ID (Azure AD)](/caf-docs/user-guide/organizations/sso-configurations/microsoft-entra-id)
* [Okta](/caf-docs/user-guide/organizations/sso-configurations/okta)
* [Auth0](/caf-docs/user-guide/organizations/sso-configurations/auth0)
* [Google Workspace](/caf-docs/user-guide/organizations/sso-configurations/google)
* [Generic Provider](/caf-docs/user-guide/organizations/sso-configurations/generic)

{% hint style="info" %}
The metadata URL or XML contains certificates and endpoints Organizations needs to trust your identity provider.
{% endhint %}
{% endtab %}

{% tab title="OIDC" %}

### OIDC — SP value to copy into your IdP

| Organizations field | Use in provider as          | Action |
| ------------------- | --------------------------- | ------ |
| **Redirect URI**    | Redirect URI / Callback URL | Copy   |

### OIDC — Provider values to paste in Organizations

| Organizations field      | Value                                                                                   |
| ------------------------ | --------------------------------------------------------------------------------------- |
| **Issuer URL**           | Issuer URL from your provider                                                           |
| **Client ID**            | Application client ID                                                                   |
| **Client Secret**        | Application client secret                                                               |
| **Request method**       | `GET` (default) or `POST` — see [OIDC request method](#oidc-request-method-get-vs-post) |
| **Authorization scopes** | `openid email profile` (add `groups` when using group-based assignment rules)           |

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-a031f9763ec0d356d01729c39f119edf471e8c0b%2Fsecurity-oidc.jpg?alt=media" alt="Organizations - OIDC configuration"></div>

### About scopes

| Scope     | Description                                             |
| --------- | ------------------------------------------------------- |
| `openid`  | Required for `OIDC`. Returns the user identifier.       |
| `email`   | Returns the member email address.                       |
| `profile` | Returns profile information (name, and related claims). |
| `groups`  | Returns group membership when the provider supports it. |

{% hint style="info" %}
Separate scopes with a space. Example: `openid email profile`
{% endhint %}

{% hint style="warning" %}
Add the `groups` scope when you configure **Group assignment rules** based on IdP groups.
{% endhint %}

Provider setup guides:

* [Okta](/caf-docs/user-guide/organizations/sso-configurations/okta)
* [Auth0](/caf-docs/user-guide/organizations/sso-configurations/auth0)
* [Generic Provider](/caf-docs/user-guide/organizations/sso-configurations/generic)
  {% endtab %}
  {% endtabs %}

***

## Step 3: Configure Attribute Mapping

Open the **Attribute mapping** tab. Map IdP claim names to Organizations member fields. Names must match the claims or assertions your provider sends.

When you first configure SSO, Organizations pre-fills these defaults:

| Organizations field | Default claim name |
| ------------------- | ------------------ |
| **Email**           | `email`            |
| **Full name**       | `name`             |
| **First name**      | `given_name`       |
| **Last name**       | `family_name`      |

Update the values when your IdP uses different claim names (common for SAML providers — see the [Microsoft Entra ID guide](/caf-docs/user-guide/organizations/sso-configurations/microsoft-entra-id#configure-in-organizations)).

### Standard attributes

| Organizations field   | Required | Description                                                              |
| --------------------- | -------- | ------------------------------------------------------------------------ |
| **Email**             | Yes      | Claim that contains the member email address.                            |
| **Full name**         | Yes      | Claim for the member display name.                                       |
| **First name**        | Yes      | Claim for the given name.                                                |
| **Last name**         | Yes      | Claim for the family name.                                               |
| **Groups (optional)** | No       | Claim that lists IdP groups (required for group-based assignment rules). |

### Custom attributes

Register additional IdP attributes (for example, `department`, `cost_center`) to use them in assignment rules. You can add up to **5** custom attributes.

Each name must match a claim your IdP sends. Custom attributes appear as condition options on the **Group rules** tab (with the **equals** operator).

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-9ae81fd46e4979aaf8649503142ddd92e0543b5a%2Fsecurity-attribute-mapping.jpg?alt=media" alt="Organizations - Attribute mapping"></div>

{% hint style="info" %}
Confirm exact claim names in your provider documentation. SAML attribute URIs and OIDC claim names differ by provider.
{% endhint %}

***

## Step 4: Configure Group Assignment Rules

Open the **Group rules** tab. Rules assign SSO members to **organization groups** based on IdP attributes.

{% hint style="warning" %}
Create target groups in **People** → **Groups** before saving rules. Each rule must reference an existing organization group.
{% endhint %}

### How rules work

* Each **rule** has one or more conditions combined with **AND**.
* Multiple rules are evaluated with **OR** — a member joins every group whose rule matches.
* Conditions on **IdP groups** use **contains**; other attributes use **equals**.
* **Default group** is optional and applies only when no rule matches.

| Field               | Required       | Description                                  |
| ------------------- | -------------- | -------------------------------------------- |
| **Rule conditions** | Yes (per rule) | Attribute, operator, and value from the IdP. |
| **Group**           | Yes (per rule) | Target group when the rule matches.          |
| **Default group**   | No             | Fallback group when no rule matches.         |

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-bf9a41ab122120a5af5b6a40a43a5c06e0e904e9%2Fsecurity-assignment-rules.jpg?alt=media" alt="Organizations - Group assignment rules"></div>

{% hint style="warning" %}
Register the **Groups** claim (or custom attributes) on the **Attribute mapping** tab before creating rules that reference them.
{% endhint %}

{% hint style="warning" %}
When **SCIM** provisioning is active (a bearer token is generated on the **SCIM** tab), **Group assignment rules** are not used. Provision users and assign groups through SCIM and **People** → **Groups** instead. See the [SCIM Provisioning Guide](/caf-docs/user-guide/organizations/scim-provisioning).
{% endhint %}

***

## Member provisioning

How members are created on first SSO login depends on whether SCIM is active.

| Mode           | SCIM token | First SSO login behavior                                                                                                                                                                                                                                            |
| -------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **SSO only**   | Not active | Organizations **creates the member automatically** (JIT provisioning) when the identity provider returns a valid email claim.                                                                                                                                       |
| **SSO + SCIM** | Active     | The member **must exist in Organizations** before login — provision the user through SCIM from your identity provider. Login is blocked until SCIM provisioning completes. See the [SCIM Provisioning Guide](/caf-docs/user-guide/organizations/scim-provisioning). |

{% hint style="info" %}
The email claim is required for SSO sign-in. Map it on the **Attribute mapping** tab and confirm your identity provider sends it in SAML assertions or OIDC tokens.
{% endhint %}

***

## Step 5: Save and Test

1. Save each tab after you change settings (**SSO**, **Attribute mapping**, **Group rules**).
2. Wait until SSO status shows **Active** (not **Provisioning**).
3. Open a private browser window (do not use the Super Admin session).
4. Go to your organization URL (for example, `https://{alias}.sso.caf.io`).
5. Select **Sign in with SSO** — this is the **member** login screen, not `/admin-login`.
6. Complete authentication at your identity provider.
7. Confirm you return to Organizations with the expected group access.

{% hint style="success" %}
**Done!** SSO is configured for your organization.
{% endhint %}

***

## Access model and linked products

SSO authenticates **members**. Access to Certta products linked to your organization is controlled by **groups**:

| Concept         | Description                                                                                                        |
| --------------- | ------------------------------------------------------------------------------------------------------------------ |
| **Group**       | Bundles a **role** (permissions) and **linked account** access (which Certta product tenants the member can open). |
| **Member**      | Signs in with SSO and inherits access through group membership.                                                    |
| **Super Admin** | Manages the organization via `/admin-login`; does not use member SSO.                                              |

Configure groups in **People** → **Groups** before defining **Group assignment rules**, or assign members to groups manually / via SCIM.

After SSO login, members with access to multiple linked accounts may select a product from the access portal.

***

## Operations and maintenance

### Disabling SSO

Turn off **SSO enabled** on the **SSO** tab. The provider configuration is preserved, but members no longer see **Sign in with SSO** on the organization login page. Super Admin login at `/admin-login` is not affected.

### Switching between SAML and OIDC

Changing the protocol in **SSO** recreates the federation integration. After you save:

1. Update your IdP application with the new **Properties** values (Entity ID / ACS URL or Redirect URI).
2. Paste the updated provider settings in Organizations.
3. Review **Attribute mapping** — SAML claim URIs and OIDC claim names often differ.
4. Test member login in a private browser window.

### SAML certificate rotation

When your IdP rotates signing certificates:

1. Obtain the updated metadata URL or XML from your provider.
2. Open **Security** → **SSO** and update **Metadata XML URL** or **Metadata XML Content**.
3. Save and test member login.

You do not need to change Entity ID or ACS URL unless your provider instructs otherwise.

### OIDC request method (`GET` vs `POST`)

The **Request method** field controls how Organizations requests user attributes from the OIDC provider during token exchange.

| Method   | When to use                                                                                                                       |
| -------- | --------------------------------------------------------------------------------------------------------------------------------- |
| **GET**  | Default. Works with most providers (Okta, Auth0, Google, Keycloak).                                                               |
| **POST** | Select when your provider requires POST for the userinfo or attributes endpoint (some enterprise IdPs document this requirement). |

If attribute claims are missing after login, try switching the request method and test again.

***

## Validations and Error Messages

| Situation                  | Message / behavior                                      |
| -------------------------- | ------------------------------------------------------- |
| Required SSO field missing | Field-level validation on save                          |
| Invalid URL or metadata    | Provider configuration rejected                         |
| SSO still provisioning     | Toggle disabled until provisioning completes            |
| No attributes for rules    | Banner prompts you to configure attribute mapping first |
| Invalid assignment rule    | Save rejected with validation details                   |

***

## Troubleshooting

### Configuration errors (admin console)

| Problem                    | Probable cause               | Solution                                                                    |
| -------------------------- | ---------------------------- | --------------------------------------------------------------------------- |
| Redirect error             | URI mismatch                 | Verify **ACS URL** or **Redirect URI** matches exactly in both systems      |
| Invalid token (OIDC)       | Incorrect client secret      | Regenerate and update **Client Secret** in Organizations                    |
| Invalid certificate (SAML) | Expired IdP certificate      | Refresh metadata URL or XML in Organizations                                |
| Claims not received        | Missing scopes or attributes | Add scopes (OIDC) or map attributes in the IdP and in **Attribute mapping** |
| Invalid issuer (OIDC)      | Wrong issuer URL             | Confirm the URL at `/.well-known/openid-configuration`                      |
| Signature error (SAML)     | Outdated metadata            | Update metadata URL or XML in Organizations                                 |
| Wrong group after login    | Assignment rules             | Review **Group rules** and IdP group claims (SSO-only mode)                 |

### Member login errors (sign-in screen)

These messages appear when a member selects **Sign in with SSO** at the organization URL.

| Message                                | Probable cause                                               | Solution                                                                                                         |
| -------------------------------------- | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- |
| Account not yet provisioned            | SCIM is active and the user was not provisioned through SCIM | Provision the user via SCIM before the first SSO login                                                           |
| Account not found in this organization | Member record missing or identity not linked                 | **SSO only:** confirm the IdP sends the email claim. **SSO + SCIM:** verify the SCIM user exists and retry login |
| Account deactivated                    | Member is disabled in Organizations                          | Re-enable the member in **People** → **Members**                                                                 |
| Login cancelled                        | User cancelled authentication at the IdP                     | Retry **Sign in with SSO**                                                                                       |
| Session expired                        | SSO flow interrupted or timed out                            | Retry **Sign in with SSO**                                                                                       |
| Login failed                           | Token exchange or provider error                             | Verify SSO configuration; check IdP assignment and callback URLs                                                 |
| Organization mismatch                  | Authentication targeted the wrong organization               | Confirm the member uses the correct organization URL                                                             |

### Error codes (reference)

These query parameters appear in the organization URL after a failed member SSO attempt (`https://{alias}.sso.caf.io?error=...`). They map to the messages shown on the sign-in screen.

| Error code               | User-facing message                    | Who resolves                                                               |
| ------------------------ | -------------------------------------- | -------------------------------------------------------------------------- |
| `sso_access_denied`      | Login cancelled                        | Member — retry sign-in                                                     |
| `sso_state_mismatch`     | Session expired                        | Member — retry sign-in                                                     |
| `sso_exchange_failed`    | Login failed                           | Organizations admin — verify SSO config, IdP assignment, and callback URLs |
| `member_not_provisioned` | Account not yet provisioned            | IdP admin — provision user via SCIM before first login                     |
| `member_not_found`       | Account not found in this organization | Organizations admin — verify SCIM/JIT provisioning and email claim mapping |
| `member_inactive`        | Account deactivated                    | Organizations admin — re-enable member in **People** → **Members**         |
| `organization_mismatch`  | Organization mismatch                  | Organizations admin — verify organization URL and SSO configuration        |

{% hint style="info" %}
Error codes appear on the **member** login page only (`https://{alias}.sso.caf.io`). The Super Admin login at `/admin-login` uses email and password and does not display these SSO error codes.

When the platform cannot determine a specific failure, the sign-in screen shows **Login failed** (`sso_exchange_failed`) instead of a member-specific code.
{% endhint %}

***

## Glossary

| Term                    | Definition                                                                                                                                                               |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **SSO**                 | Single Sign-On — one corporate login for Organizations and other apps.                                                                                                   |
| **SAML**                | Security Assertion Markup Language — XML-based federation standard.                                                                                                      |
| **OIDC**                | OpenID Connect — identity layer on top of `OAuth 2.0`.                                                                                                                   |
| **IdP**                 | Identity Provider — system that authenticates users (Entra ID, Okta, and others).                                                                                        |
| **SP**                  | Service Provider — Organizations, the application that consumes federation.                                                                                              |
| **Entity ID**           | SAML identifier for the Organizations service provider.                                                                                                                  |
| **ACS URL**             | SAML Assertion Consumer Service URL where the IdP posts assertions.                                                                                                      |
| **Metadata URL / XML**  | IdP federation document with endpoints and certificates.                                                                                                                 |
| **Issuer URL**          | OIDC provider base URL used for discovery and token validation.                                                                                                          |
| **Scopes**              | OIDC permissions that define which user information is shared.                                                                                                           |
| **Claims / assertions** | User attributes returned by the IdP after authentication.                                                                                                                |
| **JIT provisioning**    | Automatic member creation on first SSO login when SCIM is not active.                                                                                                    |
| **SCIM**                | Protocol for identity providers to provision users into Organizations before login. See [SCIM Provisioning Guide](/caf-docs/user-guide/organizations/scim-provisioning). |


# Microsoft Entra ID (SAML)

Configure SSO with Microsoft Entra ID (Azure AD) using the SAML protocol.

This guide explains how to configure SSO integration between Organizations and Microsoft Entra ID (formerly Azure AD) using the `SAML` protocol. After configuring Entra ID, return to the [Organizations SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations) to complete the setup.

{% hint style="info" %}
For **OpenID Connect (`OIDC`)** with Microsoft Entra ID, follow the [Generic Provider Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations/generic) using the **Redirect URI**, client credentials, and issuer URL from your Entra ID app registration.
{% endhint %}

{% hint style="info" %}
**Before you begin:** Open **Authentication** → **SSO** in Organizations and copy the **Entity ID** and **ACS URL** as described in [Step 2 of the SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations#step-2-enable-sso-and-configure-the-provider).
{% endhint %}

***

## Prerequisites

* Administrator access to Microsoft Entra ID
* Super Admin access to Organizations

***

## Create Application in Microsoft Entra ID

1. Access the [Azure Portal](https://portal.azure.com)
2. Navigate to **Microsoft Entra ID** → **Enterprise Applications**
3. Click **New application**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-ceebd6caf7934936d05fc2342a3b046c25fd831e%2Fcreate-new-app-integration.jpg?alt=media" alt="Entra ID - Create App Integration"></div>

4. Click **Create your own application**
5. Enter the application name (e.g., "Certta")
6. Select **Integrate any other application you don't find in the gallery (Non-gallery)**
7. Click **Create**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-154d71f994f0697d5afe586234ce7c5df7ff46a3%2Fcreate-application.jpg?alt=media" alt="Entra ID - Create Application"></div>

***

## Configure SAML

1. In the created application, access **Single sign-on** in the side menu
2. Select **SAML** as the authentication method

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-c659d12afda6b97cd23a0c164e17fd71e616b72f%2Fselect-saml.jpg?alt=media" alt="Entra ID - Select SAML"></div>

3. In the **Basic SAML Configuration** section, click **Edit** and configure:

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-2f13b39b523c6b889cdc4a3bfa3c6739c9ab5ac9%2Fbasic-saml-edit.jpg?alt=media" alt="Entra ID - Basic SAML Edit Configuration"></div>

| Entra ID Field                                 | Value                                             |
| ---------------------------------------------- | ------------------------------------------------- |
| **Identifier (Entity ID)**                     | Paste the **Entity ID** copied from Organizations |
| **Reply URL (Assertion Consumer Service URL)** | Paste the **ACS URL** copied from Organizations   |
| **Sign-on URL**                                | Leave blank (optional)                            |
| **Relay State**                                | Leave blank                                       |
| **Logout Url**                                 | Leave blank (optional)                            |

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-a3280ec05e547bcccfdaa75a620aa78ce260aedc%2Fbasic-saml.jpg?alt=media" alt="Entra ID - Basic SAML Configuration"></div>

4. Click **Save**

***

## Configure Attributes and Claims

In the **Attributes & Claims** section, configure the attributes that will be sent to Organizations:

1. Click **Edit**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-842103d0421e2bf97d1286936d105dde57dbb7a5%2Fedit-attributes-and-claims.jpg?alt=media" alt="Entra ID - Edit Attributes &#x26; Clains"></div>

2. Configure the following claims:

| Claim Name                                                           | Source Attribute         |
| -------------------------------------------------------------------- | ------------------------ |
| `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` | `user.userprincipalname` |
| `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname`    | `user.givenname`         |
| `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name`         | `user.userprincipalname` |
| `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname`      | `user.surname`           |

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-4f3fd12458ddfee2bae59e62968febafda20daf9%2Fattributes-and-claims.jpg?alt=media" alt="Entra ID - Attributes &#x26; Clains"></div>

### Configure Group Claim (Optional)

If you want to use group-based assignment rules in Organizations:

1. Click **Add a group claim**
2. Select **Security groups** or **Groups assigned to the application**
3. In **Source attribute**, select **Group ID** or **Cloud-only group display names**
4. Click **Save**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-2a5bb9e4b6d4370423206fa46b9c5851fdd97d21%2Fadd-group-claim.jpg?alt=media" alt="Entra ID - Add Group Claim"></div>

5. The claim will be: `http://schemas.microsoft.com/ws/2008/06/identity/claims/groups`

{% hint style="warning" %}
**Important:** If using Group ID, map group IDs (GUIDs) in **Group assignment rules**, not display names.
{% endhint %}

***

## Obtain Metadata URL

1. In the **SAML Certificates** section, locate **App Federation Metadata Url**
2. Copy the URL, which will have the format:

```
https://login.microsoftonline.com/{tenant-id}/federationmetadata/2007-06/federationmetadata.xml
```

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-3d684ee373939f9ccdb804d773ac38fd86ba1856%2Fmetadata-url.jpg?alt=media" alt="Entra ID - Metadata URL"></div>

***

## Assign Users and Groups

1. In the side menu, access **Users and groups**
2. Click **Add user/group**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-bdcd62da2a7577f9994e3a887c08dbc881ecb0b2%2Fuser-and-groups.jpg?alt=media" alt="Entra ID - Users and Groups"></div>

3. Click to add users
4. Select the users or groups that will have access to Organizations via SSO
5. Click **Select**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-9dbd20e6aa86bedbca17e61c33ff26eccafc537d%2Fadd-users.jpg?alt=media" alt="Entra ID - Add Users"></div>

***

## Configure in Organizations

Return to the [Organizations SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations#step-2-enable-sso-and-configure-the-provider) and configure:

| Organizations field  | Value                                    |
| -------------------- | ---------------------------------------- |
| **Protocol**         | SAML 2.0                                 |
| **Metadata XML URL** | Paste the copied federation metadata URL |

On the **Attribute mapping** tab, use these claim values:

| Organizations attribute | Claim value                                                          |
| ----------------------- | -------------------------------------------------------------------- |
| **Email**               | `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` |
| **Full name**           | `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name`         |
| **First name**          | `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname`    |
| **Last name**           | `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname`      |
| **Groups** (optional)   | `http://schemas.microsoft.com/ws/2008/06/identity/claims/groups`     |

***

## Next Steps

After configuring Microsoft Entra ID, return to the [Organizations SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations) to:

1. [Configure attribute mapping](/caf-docs/user-guide/organizations/sso-configurations#step-3-configure-attribute-mapping)
2. [Configure group assignment rules](/caf-docs/user-guide/organizations/sso-configurations#step-4-configure-group-assignment-rules)
3. [Save and test](/caf-docs/user-guide/organizations/sso-configurations#step-5-save-and-test)

***

## Troubleshooting

| Problem                 | Probable Cause                       | Solution                                                                    |
| ----------------------- | ------------------------------------ | --------------------------------------------------------------------------- |
| Certificate error       | Invalid or expired Metadata URL      | Verify that the URL is correct and accessible                               |
| Unauthorized user       | User not assigned to the application | Add the user in **Users and groups**                                        |
| Attributes not received | Claims not configured correctly      | Review the **Attributes & Claims** section                                  |
| ACS URL error           | ACS URL does not match               | Verify that the URL in Entra ID is identical to Organizations's **ACS URL** |

***

## References

* [Microsoft Entra ID Documentation - SAML SSO](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/add-application-portal-setup-sso)
* [Configure group claims](https://learn.microsoft.com/en-us/entra/identity/hybrid/connect/how-to-connect-fed-group-claims)


# Okta (SAML / OIDC)

Configure SSO with Okta using SAML or OIDC protocols.

This guide explains how to configure SSO integration between Organizations and Okta. After configuring Okta, return to the [Organizations SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations) to complete the setup.

{% hint style="info" %}
**Before you begin:** Open **Authentication** → **SSO** in Organizations and copy the **Entity ID** and **ACS URL** (SAML) or **Redirect URI** (OIDC) as described in [Step 2 of the SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations#step-2-enable-sso-and-configure-the-provider).
{% endhint %}

***

## Prerequisites

* Administrator access to Okta
* Super Admin access to Organizations

***

## Choose the Protocol

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

## SAML Configuration

### Create Application in Okta

1. Access the [Okta Admin Console](https://admin.okta.com)
2. Navigate to **Applications** → **Applications**
3. Click **Create App Integration**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-26c690a7368d8134b306649150c43c0382d6f84d%2Fokta-create-app-integration.jpg?alt=media" alt="Okta - Create App Integration"></div>

4. Select **SAML 2.0** and click **Next**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-06d677536c05dbc2243b86a196e25cfb07eee1ef%2Fokta-select-saml.jpg?alt=media" alt="Okta - Select SAML 2.0"></div>

5. Configure the **App name** (e.g., "Certta") and click **Next**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-8d753f018901fee5f0ae9df2a323c3b36afe7c86%2Fokta-saml-app-name.png?alt=media" alt="Okta - App Name"></div>

### Configure SAML Settings

In the **SAML Settings** section, configure:

| Okta Field                      | Value                                             |
| ------------------------------- | ------------------------------------------------- |
| **Single sign-on URL**          | Paste the **ACS URL** copied from Organizations   |
| **Audience URI (SP Entity ID)** | Paste the **Entity ID** copied from Organizations |

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-be2497eaa405362a7e19b9bbe31ca601497f60ad%2Fokta-saml-settings.png?alt=media" alt="Okta - SAML Settings"></div>

### Configure Attribute Statements

Configure the attributes that will be sent to Organizations:

| Name          | Value              |
| ------------- | ------------------ |
| `email`       | `user.email`       |
| `name`        | `user.displayName` |
| `given_name`  | `user.firstName`   |
| `family_name` | `user.lastName`    |

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-54fd6ea6a1749e136db81dfb6a0d4b7bc4fe3c28%2Fokta-saml-attributes.png?alt=media" alt="Okta - Attribute Statements"></div>

### Configure Group Attribute Statements (Optional)

If you use **Group assignment rules** based on IdP groups:

| Name     | Filter                                          |
| -------- | ----------------------------------------------- |
| `groups` | Matches regex: `.*` (or filter specific groups) |

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-9e191024259cb2c9f59fc16274af0d3c3490c9f0%2Fokta-saml-groups.png?alt=media" alt="Okta - Group Attribute Statements"></div>

Click **Next** and then **Finish**.

### Get Metadata URL

1. In the created application, access the **Sign On** tab
2. Copy the **Metadata URL**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-b8f75484459a2f996167b21beb4373e4b11f9ceb%2Fokta-saml-metadata-url.png?alt=media" alt="Okta - Metadata URL"></div>

The URL will have the format:

```url
https://{your-domain}.okta.com/app/{app-id}/sso/saml/metadata
```

{% endtab %}

{% tab title="OIDC" %}

## OIDC Configuration

### Create Application in Okta

1. Access the [Okta Admin Console](https://admin.okta.com)
2. Navigate to **Applications** → **Applications**
3. Click **Create App Integration**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-26c690a7368d8134b306649150c43c0382d6f84d%2Fokta-create-app-integration.jpg?alt=media" alt="Okta - Create App Integration"></div>

4. Select **OIDC - OpenID Connect**
5. Select **Web Application** and click **Next**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-aa9a976a310c10cea577582b8e66762b7057c97a%2Fokta-select-oidc.png?alt=media" alt="Okta - Select OIDC"></div>

### Configure OIDC Settings

| Okta Field                 | Value                                                                        |
| -------------------------- | ---------------------------------------------------------------------------- |
| **App integration name**   | (e.g., "Certta")                                                             |
| **Grant type**             | ✅ Authorization Code                                                         |
| **Sign-in redirect URIs**  | Paste the **Redirect URI** copied from Organizations                         |
| **Sign-out redirect URIs** | Paste your organization URL (for example, `https://{your-alias}.sso.caf.io`) |
| **Controlled access**      | Select who can access the application                                        |

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-adf3974af099c17efef717dc8912497ecd6a0e71%2Fokta-oidc-settings.png?alt=media" alt="Okta - OIDC Settings"></div>

Click **Save**.

### Get Credentials

In the created application, copy the following information:

| Okta Field        | Use in Organizations as |
| ----------------- | ----------------------- |
| **Client ID**     | Client ID               |
| **Client Secret** | Client Secret           |

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-2d2f5ab0284f02ee053842bee24d2cc1635a8e53%2Fokta-oidc-credentials.png?alt=media" alt="Okta - Client Credentials"></div>

### Get Issuer URL

The Okta Issuer URL follows the format:

```
https://{your-domain}.okta.com
```

Or, if you use a custom Authorization Server:

```
https://{your-domain}.okta.com/oauth2/{authorization-server-id}
```

{% hint style="info" %}

1. Navigate to **Security** → **API** → **Authorization Servers**
2. Copy the **Issuer URL** from the Authorization Server you use for this application
   {% endhint %}

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-57ed2690d89908a95893fd015c07c769554b3efb%2Fokta-issuer-url.png?alt=media" alt="Okta - Authorization Server Issuer"></div>

{% hint style="warning" %}
Configure the step below when you use **Group assignment rules** based on IdP groups. Otherwise, skip to [Assign Users or Groups](#assign-users-or-groups).
{% endhint %}

### Configure Group Scopes (Optional)

To include groups in OIDC tokens for **Group assignment rules**:

1. Access **Security** → **API** → **Authorization Servers**
2. Select the Authorization Server being used (for example, `default`)
3. Open the **Claims** tab and add a **groups** claim mapped to user groups
4. Open the **Scopes** tab and add a `groups` scope if your server requires explicit scopes

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-92e1692c57312f88b46cd516704d649c0fb6020e%2Fokta-oidc-add-claim.jpg?alt=media" alt="Okta - Add Groups Claim"></div>

5. Click **Add Scope** if you need a dedicated groups scope

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-d8d742eb3294ca550366a1fb1e02a222fac99e8b%2Fokta-oidc-add-scope.jpg?alt=media" alt="Okta - Add Groups Scope"></div>

6. In Organizations, add `groups` to **Authorization scopes** on the **SSO** tab (for example, `openid email profile groups`) and map **Groups** on the **Attribute mapping** tab to `groups`

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-e1fded8e2a55853eecae4e6f527143641adf64db%2Fokta-oidc-add-scope2.jpg?alt=media" alt="Okta - Groups Scope Details"></div>
{% endtab %}
{% endtabs %}

***

## Assign Users or Groups

1. In the created application, access the **Assignments** tab
2. Click **Assign**
3. Select **Assign to People** or **Assign to Groups**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-195056875c9127027b64b24d1fb2ebd12d40625c%2Fokta-assignments.jpg?alt=media" alt="Okta - Assignments"></div>

4. Select the users or groups that will have access and click **Assign**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-406ddf2389a63517ba9fbd778a5ef873f13e65e2%2Fokta-assignments2.jpg?alt=media" alt="Okta - Assignments"></div>

5. Click **Save and Go Back**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-c8f05f229a8c3f01e1010cd2534d2443d1e42e7d%2Fokta-assignments3.jpg?alt=media" alt="Okta - Assignments"></div>

***

## Next Steps

After configuring the identity provider, return to the [Organizations SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations) to:

1. [Configure attribute mapping](/caf-docs/user-guide/organizations/sso-configurations#step-3-configure-attribute-mapping)
2. [Configure group assignment rules](/caf-docs/user-guide/organizations/sso-configurations#step-4-configure-group-assignment-rules)
3. [Save and test](/caf-docs/user-guide/organizations/sso-configurations#step-5-save-and-test)

***

## Troubleshooting

| Problem             | Probable Cause              | Solution                                                            |
| ------------------- | --------------------------- | ------------------------------------------------------------------- |
| Redirect URI error  | URI does not match          | Verify that the reply URL is identical in both systems              |
| Invalid token       | Incorrect Client Secret     | Regenerate the Client Secret in Okta and update it in Organizations |
| Groups not received | Groups claim not configured | Configure the groups claim in the Authorization Server              |
| User not found      | User not assigned           | Add the user in the application's **Assignments**                   |

***

## References

* [Okta Documentation - SAML](https://developer.okta.com/docs/concepts/saml/)
* [Okta Documentation - OIDC](https://developer.okta.com/docs/concepts/oauth-openid/)
* [Configure group claims](https://developer.okta.com/docs/guides/customize-tokens-groups-claim/)


# Auth0 (SAML / OIDC)

Configure SSO with Auth0 using SAML or OIDC protocols.

This guide explains how to configure SSO integration between Organizations and Auth0. After configuring Auth0, return to the [Organizations SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations) to complete the setup.

{% hint style="info" %}
**Before you begin:** Open **Authentication** → **SSO** in Organizations and copy the **Entity ID** and **ACS URL** (SAML) or **Redirect URI** (OIDC) as described in [Step 2 of the SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations#step-2-enable-sso-and-configure-the-provider).
{% endhint %}

***

## Prerequisites

* Administrator access to Auth0
* Super Admin access to Organizations

***

## Choose the Protocol

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

## SAML Configuration

### Create Application in Auth0

1. Access the [Auth0 Dashboard](https://manage.auth0.com)
2. Navigate to **Applications** → **Applications**
3. Click **Create Application**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-9f6b906735bebbf15ea4d303bec0eca78c32563c%2Fauth0-create-application.jpg?alt=media" alt="Auth0 - Create Application"></div>

4. Configure the **Name** (e.g., "Certta")
5. Select **Regular Web Applications** and click **Create**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-6f0480ecc05cba8c27436f3cf578e8bac97046c9%2Fauth0-select-app-type.jpg?alt=media" alt="Auth0 - Select application type"></div>

### Enable SAML

1. In the created application, access the **Addons** tab
2. Locate **SAML2 Web App** and click to enable
3. Click on **SAML2 Web App** after enabling

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-f9c4b2fa110092db74dabaf82bee0048e7da6644%2Fauth0-addons-saml.jpg?alt=media" alt="Auth0 - Addons SAML"></div>

4. In the **Settings** tab, in the **Application Callback URL** field, paste the **ACS URL** from Organizations

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-cc9f93e0c558c3cf6f95a835390beaff128eb2b0%2Fauth0-saml-settings-json.jpg?alt=media" alt="Auth0 - SAML Settings JSON"></div>

5. In the JSON editor, set the **audience** to the Organizations **Entity ID** and configure attribute mappings:

```json
{
  "audience": "Identifier URL",
  "mappings": {
    "email": "email",
    "name": "name",
    "given_name": "given_name",
    "family_name": "family_name"
  },
  "nameIdentifierFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress",
  "nameIdentifierProbes": [
    "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress"
  ]
}
```

6. Scroll to the end of the **Settings** tab and click **Save**

### Configure groups for SAML (optional)

To use **Group assignment rules** in Organizations, add a `groups` entry to the **mappings** object in the SAML2 Web App JSON. The source value depends on how groups are exposed in your Auth0 tenant (for example, directory groups from an Enterprise Connection).

On the **Attribute mapping** tab in Organizations, set **Groups** to `groups`.

### Get Metadata URL

1. Access the **Usage** tab
2. Locate the **Identity Provider Login URL**
3. Build the **Metadata URL** by adding `/metadata` before the client ID:

| Field                           | Format                                             |
| ------------------------------- | -------------------------------------------------- |
| **Identity Provider Login URL** | `https://{your-domain}/samlp/{client-id}`          |
| **Metadata URL**                | `https://{your-domain}/samlp/metadata/{client-id}` |

{% hint style="info" %}
**Example:** If the Identity Provider Login URL is `https://dev-abc123.us.auth0.com/samlp/xyz789`, the Metadata URL will be `https://dev-abc123.us.auth0.com/samlp/metadata/xyz789`.
{% endhint %}

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-1b27f70a83fea1b54af7a5872d481f0c3dd292d7%2Fauth0-saml-metadata-url.jpg?alt=media" alt="Auth0 - SAML Metadata URL"></div>
{% endtab %}

{% tab title="OIDC" %}

## OIDC Configuration

### Create Application in Auth0

1. Access the [Auth0 Dashboard](https://manage.auth0.com)
2. Navigate to **Applications** → **Applications**
3. Click **Create Application**
4. Configure the **Name** (for example, `Certta`)
5. Select **Regular Web Applications** and click **Create**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-9f6b906735bebbf15ea4d303bec0eca78c32563c%2Fauth0-create-application.jpg?alt=media" alt="Auth0 - Create Application"></div>

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-6f0480ecc05cba8c27436f3cf578e8bac97046c9%2Fauth0-select-app-type.jpg?alt=media" alt="Auth0 - Select application type"></div>

### Configure Application Settings

In the application's **Settings** tab, configure:

| Auth0 Field               | Value                                                |
| ------------------------- | ---------------------------------------------------- |
| **Allowed Callback URLs** | Paste the **Redirect URI** copied from Organizations |

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-d2df0a9ad2c08ee5bfc59d99acb3afca33a641e0%2Fauth0-oidc-settings.jpg?alt=media" alt="Auth0 - Application Settings"></div>

Click **Save**.

### Get Credentials

In the same **Settings** tab, copy the following information:

| Auth0 Field       | Use in Organizations as     |
| ----------------- | --------------------------- |
| **Domain**        | Use to build the Issuer URL |
| **Client ID**     | Client ID                   |
| **Client Secret** | Client Secret               |

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-1efd1f7f0108c79e6b0f37fa19a7b5e7275db26b%2Fauth0-oidc-credentials.jpg?alt=media" alt="Auth0 - Client Credentials"></div>

### Get Issuer URL

The Auth0 Issuer URL follows the format:

```
https://{your-domain}/
```

### Configure groups for OIDC (optional)

To use **Group assignment rules** based on IdP groups:

1. Navigate to **Actions** → **Library** → **Build Custom**
2. Create a **Post Login** Action that adds a `groups` claim to the ID token (source depends on your Auth0 roles, Authorization Groups, or upstream IdP attributes)
3. Deploy the Action and add it to the Login flow for this application
4. In Organizations, add `groups` to **Authorization scopes** on the **SSO** tab and map **Groups** on the **Attribute mapping** tab to `groups`

See [Auth0 Actions documentation](https://auth0.com/docs/customize/actions) for claim customization patterns.
{% endtab %}
{% endtabs %}

***

## Enable Connections and Users

In Auth0, user access to the application is controlled by enabled **Connections**. A Connection is the source of user identity (internal database, social login, corporate directory, etc.).

### Enable Connections in the Application

1. In the created application, access the **Connections** tab
2. Enable the connections where your users are registered

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-d18e3dbf9e88f57385971188d0b653821fa89134%2Fauth0-connections.jpg?alt=media" alt="Auth0 - Connections"></div>

| Connection Type | Description                                                                   |
| --------------- | ----------------------------------------------------------------------------- |
| **Database**    | Users registered directly in Auth0 (e.g., `Username-Password-Authentication`) |
| **Social**      | Login via social providers (Google, Microsoft, etc.)                          |
| **Enterprise**  | Corporate connections (SAML, OIDC, Azure AD, etc.)                            |

{% hint style="warning" %}
**Important:** If the Connection where the user is registered is not enabled for the application, the user will not be able to log in.
{% endhint %}

***

## Next Steps

After configuring the identity provider, return to the [Organizations SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations) to:

1. [Configure attribute mapping](/caf-docs/user-guide/organizations/sso-configurations#step-3-configure-attribute-mapping)
2. [Configure group assignment rules](/caf-docs/user-guide/organizations/sso-configurations#step-4-configure-group-assignment-rules)
3. [Save and test](/caf-docs/user-guide/organizations/sso-configurations#step-5-save-and-test)

***

## Troubleshooting

| Problem                | Probable Cause              | Solution                                                                                             |
| ---------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------- |
| Callback URL error     | URL does not match          | Verify **Allowed Callback URLs** (OIDC) or **Application Callback URL** (SAML) matches Organizations |
| Invalid token          | Incorrect Client Secret     | Regenerate the Client Secret in Auth0 and update it in Organizations                                 |
| Groups not received    | Groups claim not configured | Add `groups` to SAML mappings or configure a Post Login Action for OIDC                              |
| Invalid SAML assertion | Incorrect audience          | Verify that the **audience** in the addon JSON matches the Organizations **Entity ID**               |
| User not found         | Connection not enabled      | Check the enabled connections in the **Connections** tab                                             |

***

## References

* [Auth0 Documentation - SAML](https://auth0.com/docs/authenticate/protocols/saml)
* [Auth0 Documentation - OIDC](https://auth0.com/docs/authenticate/protocols/openid-connect-protocol)
* [Configure Actions](https://auth0.com/docs/customize/actions)
* [Add custom claims](https://auth0.com/docs/get-started/apis/scopes/sample-use-cases-scopes-and-claims)


# Google Workspace (SAML)

Configure SSO with Google Workspace using SAML protocol.

This guide explains how to configure SSO integration between Organizations and Google Workspace. After configuring Google, return to the [Organizations SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations) to complete the setup.

{% hint style="info" %}
**Before you begin:** Open **Authentication** → **SSO** in Organizations and copy the **Entity ID** and **ACS URL** as described in [Step 2 of the SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations#step-2-enable-sso-and-configure-the-provider).
{% endhint %}

***

## Prerequisites

* Administrator access to Google Workspace
* Super Admin access to Organizations
* Verified corporate email domain in Google Workspace

***

## SAML Configuration

### Create SAML Application in Google Workspace

1. Access the [Google Admin Console](https://admin.google.com)
2. Navigate to **Apps** → **Web and mobile apps**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-0b8da5cc17065f8818c76f4ad835553a38a0b12a%2Fgoogle-web-app.jpg?alt=media" alt="Google - Add Web app"></div>

3. Click **Add app** → **Add custom SAML app**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-a972a1d74af41f6cecef64fcdc38833ebd8a606f%2Fgoogle-add-custom-saml-app.jpg?alt=media" alt="Google - Add custom SAML app"></div>

4. Configure the **App name** (e.g., "Certta")
5. Optionally add an app icon and description
6. Click **Continue**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-e5714d17e8289f795c7b5316c7a195164b42b339%2Fgoogle-saml-app-details.jpg?alt=media" alt="Google - App Details"></div>

### Download Google IdP Information

1. On the **Google Identity Provider details** page
2. Click **Download Metadata** to save the metadata XML file

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-ef2aee76f2841ea7b16b810c7283399630562cf5%2Fgoogle-idp-details.jpg?alt=media" alt="Google - IdP Details"></div>

{% hint style="info" %}
Note: Keep this metadata file safe. You'll need to either host it publicly or use Google's metadata endpoint URL in Organizations.
{% endhint %}

3. Click **Continue**

***

### Configure Service Provider Details

Configure the following fields:

| Google Field        | Value                                             |
| ------------------- | ------------------------------------------------- |
| **ACS URL**         | Paste the **ACS URL** copied from Organizations   |
| **Entity ID**       | Paste the **Entity ID** copied from Organizations |
| **Start URL**       | Leave blank (optional)                            |
| **Signed response** | Leave unchecked                                   |
| **Name ID format**  | EMAIL                                             |
| **Name ID**         | Basic Information > Primary email                 |

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-28e3138aa290593e8d1bd673381e52dec8a07ff2%2Fgoogle-service-provider-details.jpg?alt=media" alt="Google - Service Provider Details"></div>

Click **Continue**

***

### Configure Attribute Mapping

Map Google user attributes to SAML attributes that Organizations expects:

Click **Add mapping** for each attribute:

| Google Directory attributes | App attributes |
| --------------------------- | -------------- |
| First name                  | `given_name`   |
| Last name                   | `family_name`  |
| Primary email               | `email`        |

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-36719695d2d55516e83489c41323567233007024%2Fgoogle-attribute-mapping.jpg?alt=media" alt="Google - Attribute Mapping"></div>

{% hint style="info" %}
**Note:** The `name` attribute can use **Primary email** as a fallback, or you can create a custom mapping that combines first and last name if needed.
{% endhint %}

### Configure Group Claim (Optional)

If you use **Group assignment rules** based on IdP groups:

1. In Group membership
2. Add Google groups
3. In **App attributes**, enter `groups`

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-58716ae992b20939dbf0694813a960c5d60534fb%2Fgoogle-group-claim.jpg?alt=media" alt="Google - Add Group Claim"></div>

{% hint style="warning" %}
**Important:** Google can send either group email addresses (for example, `admins@company.com`) or group names (for example, `Admins`) in the groups claim, depending on your SAML app configuration. Map the corresponding values in **Group assignment rules**.

Only groups that the user is a direct member of are included. Nested group memberships may not be sent depending on your Google Workspace configuration.
{% endhint %}

4. Click **Finish**

***

### Enable the Application for Users

1. In the app details page, click **User access**

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-794aca2388c8acadefc4d9425ae36d10979e8273%2Fgoogle-user-access.jpg?alt=media" alt="Google - User Access"></div>

2. Select **ON for everyone** or choose specific organizational units
3. Click **Save**

***

### Host Metadata URL

1. Download the metadata XML file from the Google Identity Provider details page
2. Host it on a publicly accessible URL (e.g., your web server or cloud storage)
3. Use that URL as the Metadata URL in Organizations

{% hint style="warning" %}
**Important:** The metadata URL must be publicly accessible for Organizations to retrieve the configuration.
{% endhint %}

***

## Configure in Organizations

After configuring Google Workspace, return to the [Organizations SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations#step-2-enable-sso-and-configure-the-provider) and configure:

| Organizations field  | Value                               |
| -------------------- | ----------------------------------- |
| **Protocol**         | SAML 2.0                            |
| **Metadata XML URL** | Paste your hosted metadata file URL |

On the **Attribute mapping** tab:

| Organizations attribute | Claim value                                 |
| ----------------------- | ------------------------------------------- |
| **Email**               | `email`                                     |
| **Full name**           | `email` (or custom attribute if configured) |
| **First name**          | `given_name`                                |
| **Last name**           | `family_name`                               |
| **Groups** (optional)   | `groups`                                    |

***

## Next Steps

After configuring Google Workspace, return to the [Organizations SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations) to:

1. [Configure attribute mapping](/caf-docs/user-guide/organizations/sso-configurations#step-3-configure-attribute-mapping)
2. [Configure group assignment rules](/caf-docs/user-guide/organizations/sso-configurations#step-4-configure-group-assignment-rules)
3. [Save and test](/caf-docs/user-guide/organizations/sso-configurations#step-5-save-and-test)

***

## Troubleshooting

| Problem                     | Probable Cause                        | Solution                                                                     |
| --------------------------- | ------------------------------------- | ---------------------------------------------------------------------------- |
| ACS URL error               | URI does not match                    | Verify that the ACS URL in Google matches the ACS URL from Organizations     |
| User not authorized         | App not enabled for user              | Enable the app for all users or specific organizational units in User Access |
| Invalid SAML response       | Attribute mapping incorrect           | Verify attribute mappings in Google Admin Console                            |
| Certificate error           | Certificate expired or invalid        | Download new metadata from Google and re-host it                             |
| Metadata URL not accessible | Metadata file not publicly accessible | Ensure the metadata file is hosted on a publicly accessible URL              |
| Domain restriction          | User domain not verified              | Verify the corporate domain in Google Workspace                              |
| Name ID error               | Name ID format incorrect              | Ensure Name ID format is set to EMAIL and mapped to Primary email            |

***

## References

* [Google Workspace - SAML SSO](https://support.google.com/a/answer/6087519)
* [Google Workspace - Custom SAML Applications](https://support.google.com/a/answer/6087519)


# Generic Provider (SAML / OIDC)

Configure SSO with any SAML or OIDC compatible provider.

This guide explains how to configure SSO between Organizations and any identity provider compatible with `SAML 2.0` or `OpenID Connect` (`OIDC`). Use it for providers such as Keycloak, OneLogin, PingFederate, **Microsoft Entra ID (OIDC)**, and others.

{% hint style="info" %}
**Before you begin:** Open **Authentication** → **SSO** in Organizations and copy the **Entity ID** and **ACS URL** (SAML) or **Redirect URI** (OIDC) as described in [Step 2 of the SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations#step-2-enable-sso-and-configure-the-provider).
{% endhint %}

***

## Prerequisites

* Super Admin access to Organizations
* Administrator access to the identity provider
* Provider compatible with `SAML 2.0` or `OpenID Connect` / `OAuth 2.0`

***

## Choose the Protocol

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

## SAML Configuration

### Create Application in the Provider

1. Create a new `SAML 2.0` application or integration.
2. Set the **ACS URL** to the **ACS URL** copied from Organizations.
3. Set the **Entity ID** / **Audience** to the **Entity ID** copied from Organizations.

### Configure Attribute Statements

Map attributes your provider will send to Organizations:

| Name (example) | Typical source |
| -------------- | -------------- |
| `email`        | User email     |
| `name`         | Display name   |
| `given_name`   | First name     |
| `family_name`  | Last name      |

### Configure Group Attribute (Optional)

When you use **Group assignment rules** based on IdP groups:

| Name (example) | Value                                             |
| -------------- | ------------------------------------------------- |
| `groups`       | User group membership (format varies by provider) |

### Get Metadata

Copy the provider **Metadata URL**, or download the metadata XML and paste it in Organizations when URL hosting is not available.

{% hint style="warning" %}
Confirm exact SAML attribute names with your provider documentation, then enter them on the **Attribute mapping** tab in Organizations. Some providers (including Microsoft Entra ID) use long claim URIs such as `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` instead of short names like `email`.
{% endhint %}
{% endtab %}

{% tab title="OIDC" %}

## OIDC Configuration

### Create Application in the Provider

1. Create a `Web` or `Server-side` OIDC client.
2. Set **Grant type** to Authorization Code.
3. Add the **Redirect URI** copied from Organizations.

### Get Provider Credentials

| Provider field    | Description                                   |
| ----------------- | --------------------------------------------- |
| **Client ID**     | Application identifier                        |
| **Client Secret** | Confidential client secret                    |
| **Issuer URL**    | Provider issuer (discovery endpoint base URL) |

{% hint style="info" %}
The issuer is usually listed at `/.well-known/openid-configuration`.
{% endhint %}

### Request method

After saving OIDC settings in Organizations, set **Request method** to **GET** (default) or **POST** based on your provider documentation. See [OIDC request method](/caf-docs/user-guide/organizations/sso-configurations#oidc-request-method-get-vs-post) in the SSO Configuration Guide.
{% endtab %}
{% endtabs %}

***

## Next Steps

Return to the [Organizations SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations) to:

1. [Enable SSO and paste provider settings](/caf-docs/user-guide/organizations/sso-configurations#step-2-enable-sso-and-configure-the-provider)
2. [Configure attribute mapping](/caf-docs/user-guide/organizations/sso-configurations#step-3-configure-attribute-mapping)
3. [Configure group assignment rules](/caf-docs/user-guide/organizations/sso-configurations#step-4-configure-group-assignment-rules)
4. [Save and test](/caf-docs/user-guide/organizations/sso-configurations#step-5-save-and-test)

***

## Troubleshooting

| Problem                    | Probable cause               | Solution                                      |
| -------------------------- | ---------------------------- | --------------------------------------------- |
| Redirect error             | URI mismatch                 | Match **ACS URL** or **Redirect URI** exactly |
| Invalid token (OIDC)       | Wrong client secret          | Regenerate secret and update Organizations    |
| Invalid certificate (SAML) | Expired certificate          | Update metadata in Organizations              |
| Claims not received        | Missing scopes or attributes | Add OIDC scopes or SAML attribute statements  |
| Invalid issuer             | Wrong issuer URL             | Validate `/.well-known/openid-configuration`  |
| Signature error (SAML)     | Stale metadata               | Refresh metadata URL or XML in Organizations  |

***

## References

* [OpenID Connect Specification](https://openid.net/connect/)
* [OAuth 2.0 RFC](https://datatracker.ietf.org/doc/html/rfc6749)
* [SAML 2.0 Specification](https://docs.oasis-open.org/security/saml/v2.0/)


# SCIM Provisioning

Configure SCIM user provisioning for your organization in Organizations.

**SCIM** (System for Cross-domain Identity Management) lets your identity provider provision **members** into Organizations before they sign in with SSO. Use it when user lifecycle (create, update, deactivate) must be controlled centrally in your corporate directory.

{% hint style="info" %}
Organizations supports **inbound SCIM 2.0 user provisioning only**. Your identity provider pushes users to Organizations — Organizations does not provision users back into your IdP. **Group provisioning via SCIM is not supported.**
{% endhint %}

***

## SSO only vs SSO + SCIM

| Mode           | SCIM token    | Member creation                                                       | Group membership                                         |
| -------------- | ------------- | --------------------------------------------------------------------- | -------------------------------------------------------- |
| **SSO only**   | Not generated | Automatic on first SSO login (JIT)                                    | **Group assignment rules** or manual assignment          |
| **SSO + SCIM** | Active        | Identity provider provisions the user via SCIM **before** first login | Managed in Organizations (SCIM does not sync IdP groups) |

Access the [SSO Configuration Guide](/caf-docs/user-guide/organizations/sso-configurations) for federation setup and the [Member provisioning](/caf-docs/user-guide/organizations/sso-configurations#member-provisioning) section for first-login behavior.

***

## Prerequisites

* **Super Admin** access in the Organizations admin console
* **SSO configured and active** — SCIM relies on SSO for member authentication
* Administrator access to SCIM provisioning in your identity provider (Okta, Microsoft Entra ID, Google Workspace, or another SCIM-capable provider)

***

## Recommended order

1. Complete [SSO configuration](/caf-docs/user-guide/organizations/sso-configurations) and confirm status **Active**.
2. Create **groups** in **People** → **Groups** if you assign access by group membership.
3. Generate a SCIM bearer token and copy the **SCIM Base URL** (this guide).
4. Configure SCIM in your identity provider.
5. Provision a test user via SCIM.
6. Verify the member appears in **People** → **Members**.
7. Test **Sign in with SSO** as that member at your organization URL.

***

## Step 1: Generate a bearer token

1. Sign in to the admin console as a **Super Admin** at `https://{your-alias}.sso.caf.io/admin-login`.
2. Open **Security** → **SCIM**.
3. Select **Generate token**.
4. Enter a **token name** (for example, `Okta Production`) and confirm.
5. Copy the token immediately — it is shown **once** and cannot be recovered later.

<div data-with-frame="true"><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2Fgit-blob-2da17f5ca4c4fbacce838f14c8bfc0797d767e9d%2Fsecurity-scim.jpg?alt=media" alt="Organizations - SCIM provisioning"></div>

{% hint style="warning" %}
Store the bearer token securely. Treat it like a password. Only **Super Admins** can generate or revoke SCIM tokens.
{% endhint %}

***

## Step 2: Copy the SCIM Base URL

On the same **SCIM** tab, copy the **SCIM Base URL**. It follows this format:

```
https://{your-alias}.sso.caf.io/api/scim/v2
```

Use this URL as the SCIM endpoint base in your identity provider. User resources are available at:

```
https://{your-alias}.sso.caf.io/api/scim/v2/Users
```

***

## Step 3: Configure your identity provider

Each provider exposes SCIM under different menu names (**Provisioning**, **Automatic provisioning**, **SCIM provisioning**, etc.). Configure:

| Setting                | Value                                                      |
| ---------------------- | ---------------------------------------------------------- |
| **SCIM Base URL**      | URL copied from Organizations                              |
| **Authentication**     | Bearer token (HTTP header `Authorization: Bearer {token}`) |
| **Provisioning scope** | Users only                                                 |

### Supported user operations

| Operation       | SCIM endpoint       | Description                                      |
| --------------- | ------------------- | ------------------------------------------------ |
| Create user     | `POST /Users`       | Pre-provisions a member awaiting first SSO login |
| Replace user    | `PUT /Users/{id}`   | Updates member attributes                        |
| Deactivate user | `PATCH /Users/{id}` | Deactivates the member (`active: false`)         |
| List users      | `GET /Users`        | Lists provisioned members                        |
| Get user        | `GET /Users/{id}`   | Returns a single member                          |

Discovery endpoints (`/Schemas`, `/ResourceTypes`, `/ServiceProviderConfig`) are available for providers that request them during setup.

### Typical user attributes

| SCIM attribute    | Description                        |
| ----------------- | ---------------------------------- |
| `userName`        | Primary identifier (usually email) |
| `emails`          | Email address (primary)            |
| `name.givenName`  | First name                         |
| `name.familyName` | Last name                          |
| `displayName`     | Full display name                  |
| `active`          | Whether the user is active         |

The email address used in SCIM must match the email your identity provider sends during SSO authentication.

***

## First SSO login after SCIM provisioning

When SCIM is active, the member lifecycle works as follows:

1. The identity provider sends `POST /Users` — Organizations creates a member with status **pending identity assignment**.
2. The member selects **Sign in with SSO** at `https://{your-alias}.sso.caf.io`.
3. After successful authentication at the identity provider, Organizations links the federated identity to the SCIM-provisioned member.
4. The member status becomes **active** and the session starts.

If the user attempts SSO **before** SCIM provisioning, login is blocked with **Account not yet provisioned**.

***

## Revoke a token

1. Open **Security** → **SCIM**.
2. Select **Revoke token** on the active token.
3. Confirm revocation.

The identity provider loses access immediately. SCIM sync stops until you generate and configure a new token.

***

## Troubleshooting

| Problem                                              | Probable cause                                | Solution                                                       |
| ---------------------------------------------------- | --------------------------------------------- | -------------------------------------------------------------- |
| Account not yet provisioned (member login)           | User not created via SCIM                     | Provision the user in your IdP SCIM app before first SSO login |
| SCIM sync fails (401/403)                            | Invalid or revoked token                      | Generate a new token and update the IdP configuration          |
| User created in IdP but not in Organizations         | Wrong SCIM Base URL or token                  | Verify URL and bearer token in the IdP                         |
| SSO works without SCIM but fails after enabling SCIM | User missing from SCIM                        | Provision all SSO users through SCIM while a token is active   |
| Duplicate or missing email                           | `userName` / `emails` mismatch with SSO claim | Align SCIM email with the **Email** attribute mapping in SSO   |
| Groups not syncing from IdP                          | Group SCIM not supported                      | Assign groups manually in **People** → **Groups**              |

***

## Related documentation

* [Organizations overview](/caf-docs/user-guide/organizations)
* [SSO Configuration](/caf-docs/user-guide/organizations/sso-configurations)
* [Member provisioning (SSO)](/caf-docs/user-guide/organizations/sso-configurations#member-provisioning)


# Trust Platform


# New Query

### Introduction

The New Query functionality is designed to allow the client's operational team to perform validations and queries related to a Person or a Company. In other words, without the need to send any links to end users or engage in more technical integrations, the operational team can submit the necessary documents and information for analysis with just a few clicks within our platform.

This option only performs queries for **Person (PF) and Company (PJ) in the Brazil flow** and for **KYC in the Global flow**. For KYB queries via Trust Platform, a different set of instructions must be followed. To learn more, please visit [Company](/caf-docs/user-guide/trust-platform/company).

### How to perform a query via Trust Platform?

To carry out a query via Trust Platform, it is necessary that a processing flow have already been created. **Query Template for Brazil transactions** or a **Workflow for Global transactions**. If you want to know how to create one, access [Query Templates](/caf-docs/user-guide/trust-platform/query-templates) or [Workflow Builder](/caf-docs/user-guide/trust-platform/workflow-builder).

With the processing flow created, the validations and rules to be executed are defined, making it possible to perform queries to validate a person or a company via Trust Platform.

Here's how:

1. Click on the **"Queries"** menu.
2. Select the **"New Query"** submenu.
3. A modal (pop-up) will appear with two possible options. To proceed with the query via Trust Platform, keep the **"New Query"** option selected.
4. Click **"Continue"** to proceed.

Next, you will be asked to select the processing flow you want to link to that transaction. If you don't have any created, you can click **"Create New"** and be directed to the creation screen, or continue selecting an existing one.

According to the processing flow selected, you will be asked to fill in some information and/or upload documents. Once completed, click **"Send"**. Once done, your query will be processed and you will be able to follow its status on the **"Executions"** menu. For further information, please visit [Executions](/caf-docs/user-guide/trust-platform/executions).

#### An alternative pathway for Brazil accounts

There is also another way to carry out a new query via Trust Platform, which is right after saving a new processing flow model, the user is given the option of clicking on the **"Web Panel"** button and following the same steps mentioned above.


# Executions

### Introduction

The Query History screen is where you can find a list of all the queries performed, whether it's for an Person (global) or a Company (only for Brazilian companies). When you click on any result, we provide a comprehensive view of the information obtained from various data providers. This section of the training manual will guide you through the different tabs within the Queries Details, highlighting the data and insights available in each tab.

To learn how to view KYB results for international companies, please visit [Company](/caf-docs/user-guide/trust-platform/company).

### Navigating to Query History

To begin analyzing the query results, follow these steps:

1. In Trust Platform, navigate to the **"Queries"** menu on the sidebar.
2. Locate and click on the **Executions** section.
3. Select from the list of queries which one you want to see the details of.

### Basic Information tab

Upon loading the details screen, you will land on the **"Basic Information"** tab. This tab presents essential information about the Person or Company searched for, including:

1. For Brazilian company:
   * Registration Data: Corporate Name, Size, Status, Capital, Financial Activity, etc.
   * Overview of linked individuals associated with the company.
   * Contacts and Addresses details.
2. For Person:
   * Registration Data: Full Name, Person ID, Birth Date, Driver's License, etc.
   * Contacts and Addresses details.

### Queries (Background Checking) tab

This tab provides more detailed information about Person or Company searched for, with sub-tabs for each data provider. Here, you can find some data such as:

1. Basic Information;
2. Contact Methods;
3. Financial Data;
4. Legal Data;
5. Restrictive lists;
6. Presence in the media and websites;
7. Driver information;
8. Criminal background;
9. Labourite information.

### Document tab

This tab provides more detailed information about Document verification captured during the query or onboarding, it is in it that we have the OCR result as well. Information such as:

1. **Document verification:** MRZ, Issue Date, Validity, RNM.
2. **Personal information:** Name, ID, Birth Date, Nationality, etc.
3. **Miscellaneous information:** Classification, Legal Protection, Protocol, Residence term.
4. **Forensic analysis:** Opinio, Whether it's a fraud, Date.

### Identity tab

In this tab, we have the facematch result, which is the Validation between document photo with a selfie (face photo). The information presented includes:

1. **Facematch Result:** Identical, Trust (confidence), Gender, Approximated age.
2. **Official Data:** Query type and Compatibility.

### Compliance Rules tab

In this tab, we have the results of the validations done that define the execution status.

### Activites tab

This tab reflects the history of actions that have occurred in this query since it was generated. It contains information such as date, time, user, and the update made.

### Data informed by the user

This tab provides two pieces of information, namely:

1. **Parameters:** A list of raw data exactly as provided by the user during onboarding.
2. **Metadata:** A list of raw data sent by the system/API.

### Query Status screen

On the details screen, we also have the query status, which can appear as Approved, Rejected, Pending, or Processing. If the status is Pending, the user will need to take a manual action, following these steps:

1. Click on **"Analyze Pending Items"**;
2. In the pending analysis modal, identify the rule that resulted in the pending status;
3. After the analysis, determine the new query status by selecting Approve or Reject;
4. Then, click on **"Apply Changes"**.


# Company

### Introduction

The Manual Company Verification feature allows users to search for a specific company within our Trust Platform, leveraging our extensive data sources. This section of the training manual will guide you through the process of conducting a company search, understanding the search results, and loading a comprehensive report for the selected company.

{% hint style="info" %}
This tool is only available for global client accounts. For Brazilian accounts, the search via Trust continues to use **"New Query"** and the results of the query are found in **"Executions"**.
{% endhint %}

### Navigating to Company Search

To begin the company verification process, follow these steps:

1. Log in to the Trust Platform using your credentials;
2. Once logged in, navigate to the **"Queries"** menu on the sidebar;
3. Locate and click on the **"Company"** section.

### Conducting a Company Search

1. In the Company Verification section, you will find a search interface;
2. Start by selecting the desired country from the drop-down list;
3. Enter the company name or registration number in the provided search field;
4. Click on the **"Search"** button to initiate the search process.

### Understanding search results

Once the search is complete, the system will retrieve the matching company records from our data providers. The results will be presented as a list, ranked in order of the most likely match. Duplicate records, if any, will be merged together and labelled for clear identification.

### Filtering and sorting search results

To refine the search results and find the desired company efficiently, you can utilise the filtering and sorting options.

### Selecting the correct company

Carefully review the search results and select the company that best matches your intended target. Take note of the labels indicating which datasets the company records have been matched against to ensure transparency and accuracy.

### Loading the company report

After selecting the desired company from the search results, you can proceed to load a comprehensive report consolidating all the available data on the target company.

1. Click on the selected company's name or associated action button to load the report;
2. The report will display detailed information obtained from various data sources, providing a comprehensive overview of the company's background, financial status, legal records, and more.


# Onboarding List

### Introduction

The Onboarding List is where clients will find all the created links, listed by the date and time they were generated, and it's also the place where they can track the status of each link and even create new ones.

Onboarding links are a means by which end-users can fill out and submit required data and documents through a series of steps. This allows the information to be validated according to the rules and services defined by Caf. clients.

### List screen

To access the Onboarding List screen, follow these steps:

1. Click on the **"Queries"** menu.
2. Click on the **"Onboarding Lists"** submenu.

Initially, clients can apply search filters to narrow down the results based on the Status, Token, Name, CPF, CNPJ, and processing flows of the created onboarding links.

The listing will be organized by several pieces of information, including:

1. The created links with the date, time, and name of the user who created them.
2. The associated processing flow for that link.
3. The status, allowing you to track whether it is pending, completed, or involves multiple submissions.
4. Finally, there will be buttons to deactivate or activate a link.

{% hint style="warning" %}
**Important:** when clicking on deactivate, a confirmation alert will appear to confirm the deactivation. Please note that performing this action will render the link unusable unless reactivated.
{% endhint %}

### Creating onboarding links

If you want to create a new onboarding link to send to your user, you can do so within the Onboarding List screen by following these steps:

1. Click on the **"Create New"** button.
2. In the modal that appears to choose the type of link you want to create, you need to decide between:
   * **Individual link:** This link will be associated with a Personal or Company identifier, such as a CPF/CNPJ in the case of Brazil. It's expected that this identifier (e.g., CPF/CNPJ) will be used for Onboarding Web. If a different identifier is used, the transaction will be rejected when it reaches Caf. You can choose whether or not to allow multiple document submissions, enabling the possibility to finalize the onboarding process multiple times.
   * **Shared link:** This type of link can be created without being tied to any specific identifier, allowing anyone to use it. Similar to the individual link, you can choose whether or not to allow multiple document submissions.
3. Regardless of the link type chosen, the next steps are quite similar. You will need to select the **Query Template (for Brazil flow)** or **Workflow (for Global flow)** you want to associate with the link (if not already available, you can create a new one). Define whether you will accept multiple document submissions and select the method of delivery - via SMS, email, manual, or a combination of these. For individual links, you will need to provide the personal or company identifier that will be linked to the onboarding.
4. Once you've completed the necessary information, click **"Create Link"** and your link will be generated. It will be sent based on your chosen preferences. You can monitor the link's status on the Onboarding List page.

### Alternative ways to create onboarding links

There are other methods within the Trust Platform to create onboarding links, in addition to the one we just explained, such as through the [New Query](/caf-docs/user-guide/trust-platform/new-query) submenu or by completing the creation of a [Query Templates](/caf-docs/user-guide/trust-platform/query-templates) for the Brazil flow.


# Onboarding Builder

### Introduction

The Onboarding Builder is the place where templates for the client's onboarding can be created. This builder is intuitive and does not require any code for the client to change its settings and customize each of the steps that the end user will go through according to their visual identity and business needs.

In Trust Platform, there is a dedicated menu for it, and that's what we'll discuss below.

### Creating an Onboarding Template

The first step to create a template is to access the Onboarding Builder screen. To do this, simply click on the **"Onboarding Builder"** menu in the sidebar, and when directed to the screen where the templates are already created, if you don't have any yet or want to create a new one, click the **"Create Template"** button.

When the creation modal appears, follow these steps:

1. Select the desired language.
2. Define the template model (whether it's for Person, Company, or Face Authenticator).
3. Finally, choose a theme.

After making these decisions, the user will be directed to the template editing/configuration screen.

{% hint style="info" %}
**Note:** for the Face Authenticator service, it's necessary to create an exclusive template for it in the Builder, hence the model option.
{% endhint %}

{% hint style="warning" %}
**Important:** in the Global flow, there is currently no possibility to create a Face Authenticator Template.
{% endhint %}

### Appearance menu

When you enter the template editing section, you'll find the first customization step, which is **"Appearance"**. In this menu, clients can adapt their visual identity, including:

1. **Font:** you can choose from all the fonts available on Google Fonts.
2. **Background:** this relates to the background of the Onboarding, which can be a solid color or an image.
3. **Colors:** you can automatically change colors.
4. **Texts and Images:** it's possible to alter titles, subtitles, button text, error messages, and the images for each step of the chosen workflow.

Remember to click **"Save"** whenever changes are made.

### Flow menu

The second menu available in the Onboarding Builder is the **"Flow"** section, where you can create and modify flows according to your business needs. To do this, simply click on the second icon on the left side of the screen.

By default, there is a standard suggestion flow already presented, but clients can change it or use it as a guide, adding new steps, for example. It's important to note that the order of some steps in the suggested flow can be changed, but there are also validation rules to assist users in making customizations without creating a flow with issues. For example, the permission to access the camera should not come after capturing the document logically, so we provide these validations.

To add a new step, simply click on a box and drag it to the center of the screen, connecting it to an arrow from an existing flow and step. To delete a step, click on the three dots above it and press delete. It's also possible to view the step as a whole, see what texts and colors it has, and even duplicate it.

### Settings menu

The third menu in the Builder is the **"Settings"** menu, where you have:

1. **Properties:** this includes the favicon, template title, and description.
2. **General:** here you can configure:
   * **Email Template:** customize the message sent to the end user in accordance with the partner's visual identity, built in HTML.
   * **Domain:** customize the onboarding link, providing more user trust in the process.
   * **Help Button:** specify the URL for a help center that the user will be redirected to if they click the button.
   * **Just Mobile:** you can encourage users to complete onboarding on a mobile device by displaying a QR code on the desktop interface that redirects the user to a mobile device.
   * **Capture Data from the Acceptance Terms:** to comply with LGPD, you capture certain information such as the date and time of acceptance, user IP, and browser details.
   * **Browser Compatibility Warning:** you can activate a modal/pop-up warning for users to complete their onboarding using one of the three browsers guaranteed to be 100% compatible: Chrome, Firefox, and Safari. The onboarding also works in other browsers but may not support certain specific components.
   * **Reload data:** you can enable data saving so that if a user hasn't completed their onboarding and returns to it, they won't need to re-enter the data they've already filled out, making the process faster.
3. **Link Resend:** configure intervals for resending links when the link status is pending.
4. **Variables:** a variable is used to store a value that can be modified during the onboarding process. Variables can be used at different stages and moments throughout the process. Some default variables cannot be modified, for example: the personCpf variable cannot be changed when the onboarding link is associated with a CPF.
5. **Accessibility Options:** these options include:
   * **High Contrast:** a dark background with white text is more visually appealing and improves legibility.
   * **Increase All Fonts:** all fonts are displayed in bold for easier reading.
   * **Monochromatic Mode:** a single color scheme improves readability for individuals with color vision deficiencies.

### Template listing

On the initial screen of the Onboarding Builder, you will see a list of all the templates created in your account. From here, you can click on a template to go to the editing screen or click on the three dots (...) and choose from the following options:

* **Properties:** this allows you to configure the favicon, template title, and description.
* **Import/Export:** useful for testing a template in a staging environment and then moving it to a production environment after testing.
* **Duplicate:** it's useful when you want to reuse customizations made to a template.
* **Delete:** used to discard a created template.
* **Design:** this option takes you to the template customization section.

### How an Onboarding Template is used

Once created, a template can be linked to a processing flow and when an onboarding link is created with this template, the end user will go through each step configured in the Onboarding Builder, filling in to finalize their onboarding.

To learn how to create an onboardin link, visit: [Onboarding List](/caf-docs/user-guide/trust-platform/onboarding-list).

And if you want to remember how to link an onboarding template to a [Query Templates](/caf-docs/user-guide/trust-platform/query-templates) and/or [Workflow Builder](/caf-docs/user-guide/trust-platform/workflow-builder) access the links.


# Query Templates

### Introduction

Query Templates are a set of necessary rules, products, and services tailored to the specific requirements of each business. These templates define what will be queried and validated within our Caf. platform.

### Create Query Templates

To start creating query templates, you need to access the Trust Platform and on the sidebar menu, click on **"Tools"** and then on the **"Query Templates"** submenu. When accessing the Query Templates screen, it is possible to see the list of all the templates already created. If you don't have one yet or want to create a new, click the **"Create New Template"** button to start your settings.

The next step is to define whether you want to create your query based on predefined templates or if you want to customize your own. The predefined templates are as follows:

* **CAF:** this package includes OCR, CPF Query (Brazilian Individual Taxpayer Registry), Facematch, Facial Biometrics, and Document Forensics.
* **Automation and Onboarding:** this package includes OCR, CPF Query, and Facematch.

While these packages come with preselected services and rules suggested by Caf., they are both customizable. You have the option to modify them and even add additional sources to the background checking process.

If you want to choose the **"Custom"** option, you must also define whether it will be a Persons or Companies template. After this definition, select which services you want to apply in this validation, as well as the sources that must be consulted and the automated rules. Set a name for your model and save.

As soon as the model is saved, three options appear on the screen for the user to continue the process, namely the creation of an onboarding link ([Onboarding List](/caf-docs/user-guide/trust-platform/onboarding-list)), performing a new query via Trust Platform ([New Query](/caf-docs/user-guide/trust-platform/new-query)) or the integration via API.

### List Query Template

All templates created are saved in a history list, which can be filtered by the name of the template or by its status. By clicking on the three dots of any query template, it is possible to copy the link to carry out the web onboarding, share it individually via sms or email, view the Integration Guide, Duplicate that template or even export it.

{% hint style="warning" %}
Important: remember that as there is still no onboarding template added to this query template, when creating/sharing the onboarding web link, the onboarding template will be the default Caf.
{% endhint %}

At any time, a user can inactivate a query template or activate it again. When inactivating a template, it is important to decide if you want to inactivate the onboarding links that have this template attached, otherwise they remain valid to be used.

### Edit Query Templates

Still in the list, it is possible to click on any query template and edit it afterwards, remembering that any change will have an impact on onboarding/queries performed from that moment onwards, as well as the charged fees.

To edit, you must click on the **"Edit"** button so that all fields are released. On the editing screen, it is possible to change the name of the template, link an onboarding template to it, insert query and profile webhook, in addition to being able to change services, sources and rules.

An important part of this screen is the onboarding template link, if it aligns with the client's flow, so that your web onboarding can be customized according to your needs and visual identity.

An additional feature on the query templates listing screen is the possibility to import a template using a Json file. Simply click on the import icon and upload your file.


# Workflow Builder

### Introduction

The creation of the Workflow Builder tool aims to save time and money by avoiding queries that would be rejected early in the process. It also empowers users to design their desired conditional validation flow in their preferred sequence. The Workflow replaces the well-known Query Template, serving as the template/set of necessary rules and services that define what will be validated in our treadmill.

{% hint style="info" %}
**Note:** this tool is only available for global client accounts.
{% endhint %}

### Create a workflow

Taking into consideration that the Trust Platform account is a global account, meaning the workflow flag is enabled in the client, to initiate the workflow creation process, the user will click on the "Tools" menu and then select the "Workflow Builder" submenu.

Upon accessing the workflow screen, a list of all previously created workflows will be visible. If there are no workflows yet or if a new one needs to be created, start by clicking on "Create Workflow" to define the segmentation type (currently available only for People validation) and assign a name.

{% hint style="warning" %}
**Important:** when a global account is created, a default KYB workflow will automatically be generated, specifically for company validation. At this initial stage, editing the default workflow isn't possible, and due to its default nature, execution will consistently require manual client review.
{% endhint %}

Unlike the Query Template used in the Brazil flow, the Workflow Builder is interconnected with rules and services. This means that to utilize a specific service, it's necessary to select a rule associated with it and then drag it to a validation step within the Workflow Builder. By doing so, the rule will dictate the service to be used, eliminating the need for separate steps for making these choices.

As previously mentioned, the Workflow creates a flow based on validation rules and steps, which can be either singular or conditional, depending on the client's business requirements.

1. **Rules in a Single Step**

If the client wishes to design a workflow with all rules and validations in a single step, they can do so. To achieve this, they need to drag all necessary rules into the initial step and define their validations. In other words, if the rule matches, the status to be displayed should be specified, and the same applies if the rule doesn't match.

* **Approved:** if this status is selected and all rules within the same step are approved, the execution will have a final status of Approved.
* **Rejected:** when this status is chosen, if any of the existing rules in the step are rejected, the execution will have a final status of Rejected.
* **Pending:** if a rule with this status is selected and it results in a pending status, a manual action of either Approve or Reject is required for the rule. Only then can the execution attain its final status.
  * Note: that all rules within the same step will be validated, pending status doesn't halt validation, it merely affects the final execution status.
* **Warning:** if this status is selected, an event/alert will be triggered through the Trust Platform, informing the client to pay attention to this execution. Unlike the Pending status, this won't halt the flow, the execution will continue performing queries and validations on services. If all other rules approve, the final status will be Approved. If any rule rejects, the final status will be Rejected, irrespective of the Alert rule.
  * Note: changing the status of this rule won't be possible.

2. **Rules in Conditional Steps**

To use the conditional flow, where a new service will only be queried if the previous step's validation is completed with a final status of Approved or Rejected, you need to add a new step and follow the same logic of drag-and-drop for necessary rules. To do this, click on the **"New Step"** option and create a conditional step for Rejected or Approved.

Depending on the outcome of the previous step, the workflow will follow the predetermined conditional flow. It's crucial to define Match statuses, as the Workflow relies on them to proceed. In the case of conditional steps:

* **Approved:** if this status is selected within the rules, when the step has a final status of Approved, the next steps configured for this conditional can begin processing. The final execution status will only be determined after all steps are validated. If all steps are approved, the execution's final status will be Approved.
* **Rejected:** when this status is selected within the rules, if any of the rules within a step are rejected, the workflow can only proceed with validations in the next steps if there's a Rejected conditional. Otherwise, the execution's final status would already be Rejected. However, with the conditional in place, the execution's final status will depend on the validations in the other steps.
* **Pending:** in cases where a rule is set to Pending status and becomes pending, that specific step will wait for manual action to determine its final status and continue the defined flow. This manual action is to Approve or Reject the rule, not the entire execution. After this action, the subsequent steps will be carried out if there's a sequence in the flow. The execution's final status will only be determined after all steps are validated.
* **Warning:** if this status is selected, an event/alert will be triggered through the Trust Platform, indicating that attention is required for this execution. Unlike the Pending status, this won't halt the flow, it will continue performing queries and validations on services. The next steps could be validated based on their configured conditionals, either Approved or Rejected. If all steps approve, the final execution status will be Approved. If any step rejects, the final status will be Rejected, regardless of the Alert rule.
  * Note: changing the status of this rule won't be possible.

### Workflow settings

While still on the Workflow Builder screen, some configurations can be performed. You have the option to associate an Onboarding Template with this specific workflow, if it aligns with the client's need. By doing so, when creating onboarding links to be sent to end users, the steps and layout of the onboarding will match the client's needs and visual identity.

{% hint style="warning" %}
**Important:** if no Onboarding Template is associated with the Workflow, the created onboarding links will use the default CAF template. This means an initial basic flow with Caf. visual identity will be applied.
{% endhint %}

Another configuration that can be set on the same screen is the webhook. Under the settings tab, you can edit the Webhook field if you wish to receive notifications whenever a transaction is completed or enters a pending status.

Remember that any changes made require the user to click the save button in the Workflow Builder for the edits to take effect. After this action, all queries linked to this workflow will be affected.

On the initial Workflow Builder listing screen, besides having a list of all created workflows, you can also delete any of them from there or click to edit. Click the three dots on a workflow to perform this action.


# SSO Configuration (legacy redirect)

SSO configuration documentation has moved to Organizations.

SSO configuration for the Caf platform is now managed in **Organizations**.

Go to [Organizations — SSO Configuration](/caf-docs/user-guide/organizations/sso-configurations).


# Smart Auth (identity)

On this page, you will find information about the Smart Auth SDK.

## **Goal**

The main goal of the Smart Auth SDK is to prove that a user is really who he says he is. The SDK works as a form of multi-factor authentication for registered identities.

## **How it works**

How the Smart Auth SDK works can be seen in the flow chart below:

```mermaid
flowchart TB
    A(<b>Requests user authentication <br> via a policy) 
    B{<b>Is the <br> user's context <br> known?}
    C(<b>Performs all <br> re-authentication steps)
    E(<b>Returns an attestation <br> that the user is truthful)
    D{<b>Have they <br> all been <br> approved}
    F(<b>Returns that user <br> authentication failed)
    G(<b>Sends attestation to your <br> server for verification)
    H(<b>Rejects user request)
    I{<b>Have they <br> all been <br> approved?} 
    J(<b>Aproves the user <br> request)

    A --> B
    B --> |Yes| E
    B --> |No| C
    C --> D
    D --> |Yes| E
    D --> |No| F
    E --> G
    F --> H
    G --> I
    I --> |Yes| J
    I --> |No| H

    style A color: #000,fill:#80EABE,stroke:#000,stroke-width:1px
    style B color: #FFFFFF,fill:#3A76CF,stroke:#000,stroke-width:1px
    style C color: #FFFFFF,fill:#3A76CF,stroke:#000,stroke-width:1px
    style D color: #FFFFFF,fill:#3A76CF,stroke:#000,stroke-width:1px
    style E color: #FFFFFF,fill:#3A76CF,stroke:#000,stroke-width:1px
    style F color: #FFFFFF,fill:#3A76CF,stroke:#000,stroke-width:1px
    style G color: #FFFFFF,fill:#3A76CF,stroke:#000,stroke-width:1px
    style H color: #000,fill:#80EABE,stroke:#000,stroke-width:1px
    style I color: #000,fill:#ff999999,stroke:#000,stroke-width:1px
    style J color: #000,fill:#80EABE,stroke:#000,stroke-width:1px
```

Briefly:

1. During some routine of your application or website (such as login, password changes, or bank transfers) a call will be made to the SDK with the ID of the policy to be verified and the PersonId of the user.
2. We will receive the request and, according to policy, determine if the user context is known.
   1. If it is, the SDK jumps to item 3.
   2. If not, the user will go through all the means of authentication required by the policy (e.g. facial authentication, via SMS, etc.).
      1. If all are correct, the SDK jumps to item 3.
      2. If either one fails, the SDK jumps to item 4.
3. The SDK returns a signed JWT using your `clientSecret` attesting that the user is who they say they are.
   1. You send this JWT to your API and check the details and the signature.
      1. If something is incorrect, the user is not authenticated
      2. If everything is correct, the user is authenticated and cleared to perform the desired operation.
   2. End of execution
4. The SDK returns that the user is not authorized.
   1. End of execution

## **Useful resources**

* [Starting the Integration with the Smart Auth SDK](/caf-docs/user-guide/smart-auth/getting-started)
* [Checking the response on your server](/caf-docs/user-guide/smart-auth/checking-the-response)
* [Rules Catalog](/caf-docs/user-guide/smart-auth/catalog-rules)

And these are the versions of the Smart Auth SDK that are publicly available today:

* [SDK Android](https://docs.caf.io/caf-sdk/android/cafsmartauth) (Android)
* [SDK iOS](https://docs.caf.io/caf-sdk/ios/cafsmartauth) (iOS)
* [SDK React Native](https://docs.caf.io/caf-sdk/react-native/cafsmartauth/getting-started) (React Native)
* [SDK Web](https://docs.caf.io/caf-sdk/web-javascript/getting-started/smartauth) (JavaScript)


# Getting Started

## **Account creation**

First of all, you will need to be registered with Smart Auth. If you do not have an account yet, please [register here](https://identity.combateafraude.com/signup).

## **Identities**

Identities are used to authenticate your users.

Go to the "Identities" tab and then go to "Create identity".

### **Data required to create an identity**

| Field          | Required |
| -------------- | -------- |
| **`PersonId`** | Yes      |
| **`Name`**     | Yes      |
| **`Selfie`**   | Yes      |
| **`Phone`**    | No       |
| **`E-mail`**   | No       |

{% hint style="info" %}
You must inform Phone with country and region code, DDI+DDD+NUMBER (5511999999999).
{% endhint %}

### **Create an identity manually**

In the manual creation tab, fill in the data for the desired identity and upload a selfie. To conclude, click "Register identity".

### **Create identities via API**

You can also create identities via API, allowing for a more seamless and integrated experience within your own user flow. This approach enables you to automate identity creation and fully integrate it with your systems.\
For more details, see the [Identity API documentation](https://docs.caf.io/caf-api/smart-auth-api/available-resources/identity).

## **Access policies**

Access policies define how users will be authenticated. Contexts are the information that will be collected to determine if the user is accessing the system from a known context. Reauthentication methods, on the other hand, are the steps the user will have to go through to prove their identity if their context is not known.

To create a policy, go to the "Tools" tab select "Authentication policies" and click "Create policy".

### **Data required for creating an access policy**

| Field                         | Required |
| ----------------------------- | -------- |
| **`Identifier`**              | Yes      |
| **`Name`**                    | Yes      |
| **`Contexts`**                | Yes      |
| **`Reauthentication method`** | Yes      |

### **Identifier**

It is the unique ID of the policy. It is used when invoking the Smart Auth SDK.

### **Contexts**

| Context        | Description                                          |
| -------------- | ---------------------------------------------------- |
| **`Device`**   | Checks if the device being used by the user is known |
| **`Location`** | Checks if the user's access location is known        |
| **`Network`**  | Checks that the user's network information is known  |

### **Reauthentication methods**

| Method                      | Description                                                                                                  |
| --------------------------- | ------------------------------------------------------------------------------------------------------------ |
| **`Facial authentication`** | Takes a picture of the user accessing the system and compares it with the selfie registered for the identity |
| **`E-mail`**                | Sends a code to the e-mail address registered for the identity and uses this code to validate the user       |
| **`SMS`**                   | Sends a code via SMS to the phone registered for the identity and uses this code to validate the user        |


# Access Token

To use Smart Auth SDK, you will need to generate two access tokens: one for Smart Auth and another one for Face Liveness. This page shows the steps on how to create the keys, generate the access tokens and the recommended ways to do it.

## **Getting your Face Liveness keys**

Go to [SDK's access token tutorial page](https://docs.caf.io/caf-sdk/sdk_integration_documentation) to see how to generate it.

## **Getting your Smart Auth keys**

1. Go to the [Smart Auth tokens page](https://identity.combateafraude.com/tokens);
2. If you do not have a token, generate one.
3. Retrieve the `clientId` and `clientSecret` from one of the generated tokens.

{% hint style="warning" %}
Do not store these fields directly in your mobile/web application. These values should not leave your backend.
{% endhint %}

{% hint style="info" %}
You can repeat this procedure to generate accesses combining different functions and SDKs.
{% endhint %}

## **Generating your token**

### **Recommended method**

The following steps describe how you can generate a token that is valid only for a specific user. This is the recommended way to generate and distribute tokens because it limits a possible attack to a single user account.

1. At some point in your application flow, create a JWT with the structure of the example below;
   * Remember to replace the `{clientId}`, `{personId}` and `{expiresAt}` fields.
   * All of these fields are strongly recommended, but you can see which ones are required at the bottom of this page.
2. Sign the token with your `clientSecret`;
3. Send this token to your application.

**Example:**

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

```json
{
  "alg": "HS256",
  "typ": "JWT"
}
```

{% endtab %}

{% tab title="Payload" %}

```json
{
    "iss": "{clientId}", // string
    "exp": {expiresAt}, // number
    "personId": "{personId}" // string
}
```

{% endtab %}
{% endtabs %}

### **Not recommended method (only for tests)**

1. Go to [jwt.io](https://jwt.io/);
2. Keep the **Header** field, do not change;
3. Edit the payload, only the `iss` field is required;
4. Replace \*\*\*\* `your-256-bit-secret` with your `clientSecret`;
5. Click **Share JWT** to copy the generated token to the clipboard;
6. Use this token to authenticate the SDK.

### **JWT payload parameters**

| Parameter      | Required | Description                                                                            |
| -------------- | -------- | -------------------------------------------------------------------------------------- |
| **`iss`**      | Yes      | Your `clientId`                                                                        |
| **`exp`**      | No       | Expiration time (seconds since the [Unix Era](https://pt.wikipedia.org/wiki/Era_Unix)) |
| **`personId`** | No       | The Person Id (Unique identifier for the user) for which the token will be valid       |


# Checking the Response

To ensure the integrity of the results from the Smart Auth SDK, the return information is included in a payload within a JSON Web Token (JWT) signed using your `clientSecret`. This token is called an **attestation** and must be sent to your backend and verified before granting the user access to your system.

In addition to the attestation when isAuthorized is true, which contains the attemptId within the token, there is also a case when isAuthorized is false. In this scenario, the attemptId is returned alongside the isAuthorized field.

Please ensure that both the attestation and attemptId (when applicable) are properly handled and verified in your backend system.

## **How check response without JWT(attestation)**

In cases where the attestation is not present in the response, you will receive an object with two fields: isAuthorized and attemptId.

```javascript
const response = 'response from sdk';
console.log(response);

/* Log:
{
    attemptId: "6018d4da5ea6db000849a669",
    isAuthorized: false
}
*/
```

The attemptId field can be used to capture data about the authentication attempt. For more information, please refer to [here](https://docs.caf.io/caf-api/smart-auth-api/available-resources/authentications).

## **How to get your `clientSecret`**

See [the documentation](/caf-docs/user-guide/smart-auth/access-token) about Smart Auth access tokens.

## **JWT validation**

For user validation, we use the returned JWT token.

From it we take data needed for validation (**`isAuthorized`** and **`isNewContext`**).

### **Data entered into JWT(attestation)**

| Field              | Type    | Description                                                                  |
| ------------------ | ------- | ---------------------------------------------------------------------------- |
| **`attemptId`**    | string  | Authentication attempt ID                                                    |
| **`peopleId`**     | string  | Authenticated user CPF                                                       |
| **`policyId`**     | string  | Validated policy ID                                                          |
| **`isAuthorized`** | boolean | Indicates whether the user has been authorized according to the policy rules |
| **`isNewContext`** | boolean | Indicates whether the user context was already known                         |

### **How to extract data from the JWT**

```javascript
import jwt from 'jsonwebtoken';

const attestation = 'attestation received from SDK';
const secret = 'secret of your user';
const attestationData = jwt.verify(attestation, secret);

console.log(attestationData);
/* Log:
{
    attemptId: "6018d4da5ea6db000849a669"
    exp: 1612240210
    iat: 1612240090
    isAuthorized: true
    isNewContext: false
    peopleId: "[cpf]"
    policyId: "[policy id]"
}
*/
```

### **Authorization check**

<pre class="language-javascript"><code class="lang-javascript">const { isAuthorized, isNewContext } = attestationData;

if(isAuthorized &#x26;&#x26; !isNewContext) {
<strong>    // authorized user with no verification required
</strong>} else if(isAuthorized &#x26;&#x26; isNewContext) {
    // authorized user after verification
}
</code></pre>


# Rules Catalog

Smart Auth evaluates user context during each authentication attempt to determine whether the access is legitimate. These evaluations are grouped by context type — **Device**, **Location**, and **Network** — and each one may contain specific rules that can approve, challenge, or block the attempt.

This page documents the available rules, how they work, and what to expect in the API response when they are triggered.

***

## Location Context Rules

The location context evaluates whether the user's geographical information is consistent and trustworthy. It relies on data such as GPS coordinates, IP-based geolocation, and device-reported timezone.

### Timezone Mismatch

The **Timezone Mismatch** rule detects inconsistencies between the timezone reported by the user's device and the geographical information inferred from their network (IP address).

#### Why it matters

When a user's device reports a timezone that does not match the country or region detected by their IP address, it may indicate the use of a VPN or location spoofing to mask the real origin of the request — a common pattern in fraud attempts.

#### How it works

When the Location context is enabled and the timezone mismatch rule is active in the access policy, Smart Auth performs a **two-layer validation** on each authentication attempt:

```mermaid
flowchart TD
    A["Attempt received"] --> B{"Timezone rule active?"}
    B -->|No| C["Skip validation"]
    B -->|Yes| D{"Device timezone valid for country?"}
    D -->|Yes| E{"VPN fingerprint flags mismatch?"}
    D -->|No| F["❌ TIMEZONE_NOT_IN_COUNTRY_ALLOWLIST"]
    E -->|No| G["✅ Validation passed"]
    E -->|Yes| H["❌ TIMEZONE_CONFIDENCE_THRESHOLD_EXCEEDED"]

    style A fill:#3A76CF,color:#fff,stroke:#000
    style C fill:#80EABE,color:#000,stroke:#000
    style G fill:#80EABE,color:#000,stroke:#000
    style F fill:#ff6b6b,color:#fff,stroke:#000
    style H fill:#ff6b6b,color:#fff,stroke:#000
```

**Layer 1 — Country Allowlist**

Smart Auth maintains an allowlist of valid timezones for each country, based on the [IANA Time Zone Database](https://www.iana.org/time-zones). It compares the timezone reported by the user's device against the list of timezones associated with the country detected from the IP address.

For example, if the IP indicates the user is in Brazil (`BR`), the device timezone must be one of the Brazilian timezones (e.g., `America/Sao_Paulo`, `America/Manaus`, `America/Bahia`, etc.).

If the device timezone does not belong to the detected country's timezone list, the attempt is blocked.

**Layer 2 — VPN Fingerprint Confidence**

If the first validation passes, Smart Auth performs a second check based on VPN fingerprint data. It evaluates whether detection signals — such as VPN metadata and timezone comparison heuristics — suggest a mismatch. If the confidence score meets or exceeds the configured threshold, the attempt is blocked.

{% hint style="info" %}
Both layers must be evaluated in sequence. An attempt is only considered valid for the timezone rule if it passes **both** validations.
{% endhint %}

#### Policy configuration

The timezone mismatch rule is configured within the **Location context** of your access policy. It supports three modes:

| Mode          | Behavior                                                                                                                                                                    |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Allow**     | Timezone mismatch detection is disabled. No validation is performed.                                                                                                        |
| **Block**     | If a timezone mismatch is detected, the authentication attempt is immediately denied.                                                                                       |
| **Challenge** | If a timezone mismatch is detected, the user is challenged to provide GPS-based location verification. If the SDK does not support GPS challenge, the mismatch is bypassed. |

{% hint style="warning" %}
The **Challenge** mode requires SDK support for GPS-based location challenge. If the user's SDK version does not support this feature, the timezone mismatch will be bypassed instead of blocking the attempt.
{% endhint %}

#### API response

When a timezone mismatch is detected and the attempt is blocked, the `GET /authentications/{attemptId}` response will contain the following information in the `contextEvaluation` object:

```json
{
  "contextEvaluation": {
    "location_context": {
      "status": "blocked",
      "reason": "TIMEZONE_MISMATCH",
      "description": "TIMEZONE_NOT_IN_COUNTRY_ALLOWLIST"
    }
  }
}
```

When this rule triggers a block, the `reason` field is `TIMEZONE_MISMATCH` and the `description` field indicates the specific cause:

| Description                              | Meaning                                                                              |
| ---------------------------------------- | ------------------------------------------------------------------------------------ |
| `TIMEZONE_NOT_IN_COUNTRY_ALLOWLIST`      | The device timezone is not a valid timezone for the country detected by the network. |
| `TIMEZONE_CONFIDENCE_THRESHOLD_EXCEEDED` | VPN fingerprint analysis detected a timezone mismatch with high confidence.          |

Additionally, the response includes the raw timezone data collected during the attempt:

| Field                | Location in response  | Description                                                               |
| -------------------- | --------------------- | ------------------------------------------------------------------------- |
| `timezoneFromDevice` | `context.device.info` | The timezone reported by the user's device (e.g., `America/Sao_Paulo`).   |
| `timezoneFromIp`     | `context.network`     | The timezone inferred from the user's IP address (e.g., `Europe/London`). |

{% hint style="info" %}
These fields are always returned in the authentication response when available, regardless of whether the timezone mismatch rule is active.
{% endhint %}

#### Example scenario

Consider a user whose identity is registered in Brazil:

1. The user initiates an authentication attempt.
2. Smart Auth detects the device timezone as `Europe/London`.
3. The IP address resolves to a Brazilian provider, indicating country `BR`.
4. `Europe/London` is **not** in the list of valid timezones for `BR`.
5. The attempt is **blocked** with reason `TIMEZONE_MISMATCH` and description `TIMEZONE_NOT_IN_COUNTRY_ALLOWLIST`.

This could indicate the user is using a Brazilian VPN but is physically located in Europe — or that the device timezone was manually changed.


# Resolution 6

All.id is a distributed network built upon a peer-to-peer protocol using DLT concepts for storing and processing digital identity data.

#### Market context <a href="#market-context" id="market-context"></a>

In a digital first economy, identity is built on data and data drives all business decisions. The ability to harness and analyze the data effectively is more important than ever. However, as data becomes more valuable, businesses are having to spend more and more money as: Fraud continues to grow in size, volume and complexity as fraudsters look to harness and monetize stolen credentials; Countries across the globe are implementing regulations to try to create ways to protect users/data usage. This is further increasing the fragmentation as businesses try to serve a global customer base; Global expansion requires the need to add new and disparate data sources.

All this has created identity as an industry where vendors compete to gain access/control of the data and then monetize them at the expense of the businesses they serve.

#### Identity redefined <a href="#identity-redefined" id="identity-redefined"></a>

We believe that the solutions based on traditional centralized data models are ineffective and there is a need for a layered approach to identity security and validation.

All.id is the world’s first decentralized identity network created to revolutionize compliance and fraud prevention in a democratic and secure way. It is built on the principles of Distributed Ledger Technology (DLT) with a mission to provide a solution that is faster, more accurate, safer and cheaper than existing ones in the market. Some of the key advantages of All.id include:

* **Privacy first approach:** The network is composed of a series of nodes capable of securely sharing customer insights (biometrics, devices and other attributes) without burdening the privacy of individuals or companies;
* **Decision accuracy:** The decentralized approach ensures higher accuracy by cross-referencing across the nodes;
* **Future-proof decisioning:** Customers can share layered insights across data elements (without sharing data), leading to better decision-making. It also ensures that the network self-heals by actively watching all transactions and identifying potential problems and outliers at runtime;
* **A true collaborative identity network:** Redefining the identity to enable you to deliver the best experience and security to your users;
* **Data ownership:** You are the true owner of the data, and we don’t monetize your data against you.


# All.id components

Page actionsAll.id network architecture is composed of three main components, the discovery server, the router and the peer. First we give a brief description of each component, then discussing the process of authenticating a new peer in the network, and at last detailing what components belong to a peer.Comment

### How does the All.id work? <a href="#how-does-the-all.id-work" id="how-does-the-all.id-work"></a>

CommentAs a platform DLT based, All.id is a kind of digital database that is updated and held by every member(peer) independently in a large network.CommentThis way of operating is as revolutionary as it is easy to understand. While traditional solutions send requests and store all assets in a single database, All.id distributes the storage and, consequently, the requests to the databases of the network members (peers). Basically, All.id consists of three components:Comment

#### Discovery server <a href="#discovery-server" id="discovery-server"></a>

CommentThe discovery server is one of the most important network components, begin responsible for authenticating new peers, keeping a global history of network transactions, validating all carried out transactions and guaranteeing the integrity of network resources and communication.Comment

#### Router <a href="#router" id="router"></a>

CommentThe router is mainly responsible for intermediating the communication between network peers, acting as a literal router for requests and making external queries, outside of the All.id network, if necessary. It can act as a logical separator in the network, where each router completely isolates a group of connected peers from the rest of the network.Comment

#### Peer <a href="#peer" id="peer"></a>

CommentThe network main component, it's used by All.id clients to interact with the network ecosystem created by All.id. This component contains all information and functionality needed by clients to allow Requests in the All.id network.


# Peer components

The architecture of a All.id peer consists in the componenents presented bellow, also represented in the following diagram.

<figure><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2FsVNiMV8D4iYYdgIwnRcw%2Farchitecture.png?alt=media&amp;token=66dbd6d6-2b7b-46f4-b440-72b709f3cca6" alt=""><figcaption></figcaption></figure>

### Peer node

The peer node is responsible for communication between the All.id network and the internal peer components. It functions as a gateway to the peer, and is the only externally acessible component. It is responsible for communicating with the database, connecting with the router, dealing with network requests and responsed for biometric validations. It exposes ports for internal communication inside the client infrastructure, as well as ports for external communication with the All.id network.

### Facematch

The facematch component represent the core functionality of the All.id solution, being responsible for generating face embeddings (vectorial representations of a face), which is the main data used by the network, stored only in the peer database. It's also responsible for comparing embeddings to check if two faces match and correspond to the same person. It was developed by the All.id biometrics team as proprietary tech, being a AI algorithm.

### REST API

The REST API acts as a gateway to internal access for the peer node, exposing a API for integration between the client pipeline and the All.id network. This component has routes to insert new biometric assets in he peer, querying the network for biometric validations, generating usage reports, among other operations.


# Facial biometrics


# Features

## What can you do with All.id?

With the All.id network it is possible to quickly configure your applications and start using the following functionalities:

* **Facial biometrics (1:N analysis):** For onboarding or first authentication. By comparing a selfie and CPF with existing data within the All.id network, the recognition process is simple and efficient.
* **Facial authentication (1:1 analysis):** Ideal for situations where the identity has already been validated previously. Facial authentication allows quick and low-cost access by comparing a selfie with a reference image previously validated by the facial biometrics process.
* **Facial recognition (1:N comparison):** It has multiple applications within biometrics-based solutions. Allows the comparison of a selfie without having to inform a unique identifier and compare it with all (hashes of) images of the peer stored in the peer itself or with a restricted list, of suspects for example, maintained within the network. There are several uses for facial recognition on the platform, the main ones are: profile comparison (on-peer) and blocklist.


# Core procedure

In this section, we will provide an overview on how, architecturally, All.id's procedures work.


# Profile insertion

1. The peer receives a batch profile insertion procedure, where it receives multiple batches containing arrays of anonymized biometric assets and arrays of identifiers, where each item in the batch pertains to a different profile.
2. The peer inserts the identifiers it received and the anonymized biometric data into multiple new profiles.
3. The peer returns the operation result.

## Batch profile insertion (non-anonymized)

A Batch profile insertion (non-anonymized) is a proce where the peer receives an array of non-anonymized biometric data that's meant to be anonymized and then inserted as multiple profiles. This operation is best explained through the following diagram:

<figure><img src="https://737907756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI4kncOam5KtDqeGMEiQu%2Fuploads%2FvnmmFxA7j7RjIIjapjkU%2Fbatch-profile-insertion-non-anonymized.svg?alt=media&amp;token=f7886307-713e-4bee-b0ba-cbdfac6574c8" alt=""><figcaption></figcaption></figure>

1. The peer receives a batch profile insertion procedure, where it receives multiple batches containing arrays of non-anonymized biometric assets and arrays of identifiers, where each item in the batch pertains to a different profile.
2. The peer sends the non-anonymized biometric data to a queue, where these assets will be anonymized in the peer's facematch node.
3. The facematch node anonymizes all non-anonymized biometric assets it receives, and then return them to the queue.
4. The queue forwars these anonymized biometric assets back to the peer.
5. The peer inserts the identifiers it received and the anonymized biometric data into multiple new profiles.
6. The peer returns the operation result.


# Biometric validation

## Biometric validation

Page actionsA biometric validation procedure receives an identifier and a biometric asset, which are then compared to existing profiles with the same identifiers in your peer's and other peer's databases. Every validation has three outcomes:MATCH: when the biometric data matches the identifier that's been sent.NON\_MATCH: when the biometric data does not match the identifier that's been sent.NOT\_FOUND: when the peer can't find a profile with a matching identifier.In this section, we will explain how this procedure works internally.Internal biometric validationThis subsection explains the flow of a biometric validation internally.

1. The peer receives a biometric validation procedure, where it receives a single identifier and a byte array containing biometric data.Comment
2. The peer queries its database for a profile with a matching identifier. If a matching identifier is not found, the operation ends here, with a `NOT_FOUND` result.Comment
3. If a matching identifier is found, the peer anonymizes the biometric data that's been received and compares the biometric asset of the matching identifier with the anonymization result.Comment
4. If the distance of these biometric assets is greater than a pre-defined threshold, the operation will result in a `MATCH`. If not, the operation will result in a `NON_MATCH`.

### External biometric validation <a href="#external-biometric-validation" id="external-biometric-validation"></a>

CommentThis subsection explains the flow of a biometric validation inside All.id's network.

![](https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FflZuWSAqvJAIojq0imx0%2Fuploads%2Fgit-blob-060d448c7533a7510cc5bc85e03d6807838a9f28%2Fexternal-biometric-validation.svg?alt=media)

1. The peer receives a biometric validation procedure, where it receives a single identifier and a byte array containing biometric data. The peer will process this request internally, as shown in the previous topic.Comment
2. After processing the biometric validation internally, the peer will send the requested identifier and the biometric data to All.id's router, which will start a new biometric validation process in it.Comment
3. The router forwards the biometric validation procedure to all peers connected to it, which will then compare the requested identifier and biometric data to their databases.Comment
4. After processing the request, all the peers involved will register their result as a transaction in the discovery server.Comment
5. The peers return the result they achieved while processing the requested biometric validation to All.id's router.Comment
6. The router generates a consensus over the biometric validation results it received. If most results achieved are `MATCH`, then the consensus will be `MATCH`, and vice-versa. All `NOT_FOUND` results are not considered while computing this operation's consensus, unless all results are `NOT_FOUND`.Comment
7. At the end of the biometric validation procedure, the peer who originally requested this validation will register the operation result in the discovery server.Comment
8. The peer will return the consensus of the biometric validation operation.


# Onboarding Journey

{% hint style="warning" %}
At this moment we still have part of the journey divided between **Brazil flow** and **Global flow**. We will make clear here the differences and how to perform each one.
{% endhint %}

To start any User Onboarding process, there are some steps to be followed, according to the needs and specificities of each Caf. client.

#### 1. Create an Onboarding Template

If it makes sense for the client's flow to have a customized template, meaning that each step of their onboarding is created in a simple and intuitive manner without requiring code, on our platform, the first step will be to click on the **"Onboarding Builder"** menu and create an onboarding template according to your needs and visual identity. Once created, it should be linked to a processing flow.

To learn how to create an onboarding template, visit [Onboarding Builder](/caf-docs/user-guide/trust-platform/onboarding-builder).

#### 2. Create a processing flow

If you already have an Onboarding Template created or if it doesn't align with the client's flow, the next step is to create a **Query Template** (for the Brazil flow) or a **Workflow** (for the Global flow).

It is through these tools that the creation and definition of validation rules for the execution will be carried out, according to the products that will be used and the sources that need to be consulted in the Background Check process.

To learn more about creating query templates, visit [Query Templates](/caf-docs/user-guide/trust-platform/query-templates).

If you want to know more about creating a workflow, visit [Workflow Builder](/caf-docs/user-guide/trust-platform/workflow-builder).

#### 3. Define the onboarding and query methods

After configuring the processing flow, the client needs to determine how they will conduct the onboarding process: via link, API, or through the Trust Platform.

**3.1. Onboarding via link**

To perform an onboarding via Link, the client must have created a Query Template/Workflow and linked an Onboarding Template to it. After completing this, on the Trust Platform, the client can click on the **"Queries"** menu and choose the submenus:

* **"Onboarding Lists"**, a screen where they can view the list of all the onboarding links reated and their status. On this screen, they can deactivate and reactivate links as needed. Additionally, this screen allows the creation of new onboarding links that will be sent and used by end users. In essence, these links enable users to input the necessary information for their onboarding and subsequently be evaluated by the client company.
* **"New Query"**, a submenu in which you can choose which option you want to carry out a queries, including an onboarding link. To create a new onboarding link, clients should follow the step-by-step instructions provided after selecting this option. The resulting link will be generated in a manner similar to the information described above.

To learn how to create onboarding links, visit [Onboarding List](/caf-docs/user-guide/trust-platform/onboarding-list).

{% hint style="warning" %}
If the onboarding template is not linked to a processing flow, when creating an onboarding link with this processing flow, the default onboarding template will be used (without client-specific branding or edits, and with the basic and standard flow that we recommend during creation).
{% endhint %}

**3.2. Query via Trust Platform**

With the processing flow created, the required validations have been determined, enabling the initiation of queries to validate an individual or legal entity through the Trust Platform dashboard. To do this, simply click on the **"New Query"** menu and select the option for **"New Query"**. In this case, the client's operations team sends the necessary documents and information for analysis.

If you want to know more about how to perform this action, visit [New Query](/caf-docs/user-guide/trust-platform/new-query).

**3.3. Integration via API**

With the processing flow created, the rules and validations to be performed are defined, enabling the client to seamlessly integrate with their system.

**For Query Template**

Each Query Template has an API endpoint responsible for conducting an analysis (creating a transaction), and this endpoint can be found in the following locations:

* At the end of the Query Template creation, by clicking on the API option to access the Integration Guide.
* In the Query Template listing, accessed through the three-dot menu for editing, where the Integration Guide is also available.
* Or in the API Settings menu, which also contains the Integration Guide. To access it, click on the Settings item in the sidebar menu, then select API Settings.

**For Workflow**

Click on the **"Settings"** item in the Trust Platform sidebar menu, and then select **"API Settings"**. On this screen, you will find the **"Tokens and Mobile Keys"** tab (currently under construction).

#### 4. Execution results

Regardless of the chosen path for conducting an person or company query, the outcome of this transaction can be viewed in the query history, accessible to the client within the Trust Platform by clicking on the **"Queries"** and then selecting the **"Executions"** submenu.

On this screen, the history of all executions will be displayed, with the ability to search by status (whether approved, rejected, pending, or processing), creation date, processing flow (KYC), and other filters.

By selecting the desired execution, more details about it can be viewed, such as OCR readings, source returns with validated or invalidated rules, and other specifics according to the service and validations defined by the client in their processing flow (KYC).

For more information on how to analyze and locate the results of your queries, please visit [Executions](/caf-docs/user-guide/trust-platform/executions).

#### 5. Global KYB query and results via Trust Platform

The KYB (Know Your Business) query and the results of executions via Trust Platform is different from other journeys at the moment, including the PJ journey for Brazilian clients. Here's a step-by-step guide detailing the required actions:

1. Upon creating a global account, the client will already have a default KYB workflow established. This means that, currently, it's not possible to create a new workflow specifically for company validations.
2. With the default workflow set up, the client can proceed to perform a query via Trust Platform. To start this, they need to navigate to the "Queries" menu and select the "Company" submenu. On this screen, they should select the country in which the company operates and input the company name. If they possess the company's ID, it can be added to refine the search further.
3. The system will promptly display potential matches sourced from our supplier databases (without running an execution yet). The client should choose the option that most closely aligns with their search criteria. It's at this point that the actual query execution will be initiated.
4. Following this, the same screen will present comprehensive results of the query execution. These results encompass fundamental company information, financial data, shareholder particulars, and more.
5. As the execution is based on a default workflow, it will always be pending for the client to carry out the manual review. This review can be carried out on the same screen where the company's information is presented. So the client can proceed to either approve or reject the company based on their analysis.


# Company Search through API

#### 1. Set up a query template

Access the Trust Platform and then Query Templates. Select the Query Template you want and proceed to create the workflow.

#### 2. Get company ID

The global context is dynamic and different countries use different ways of identifying companies. For this reason, you need to look up the identifier of the company you want to submit to workflow.

Using the **Core API** and the **Services** resource, make a request asking for the **`kybCompanySearch`** service and providing the information of the known company. You can find more details on how to make this request visiting [API Reference > Core API > Available Resources > Services](https://docs.caf.io/api/core-api/available-resources/services).

In response, two identifiers are expected: **`creditReportId`** and **`businessIdentityId`**.

{% hint style="info" %}
**Note:** not all identifiers will always be available. There are cases where only one or no bureau is compatible with the source information.
{% endhint %}

#### 3. Start a transaction

Once you have at least one identifier, you can start a transaction in the flow configured in the [1. Set up a query template](#set-up-a-query-template) step.

Using the **Core API** and the **Orchestrations** resource, make a request to create a transaction. In request’s body, enter at least one of the identifiers obtained in the [2. Get company ID](#get-company-id) step. You can find more details on how to make this request visiting [API Reference > Core API > Transaction Details](https://docs.caf.io/api/core-api/transaction-details).

{% hint style="info" %}
**Note:** keep the same attribute name.
{% endhint %}

If successful, the ID of the newly created transaction will be available in the body of the response, in an attribute named **`id`**.

#### 4. Check results

Finally, once you have the transaction ID, you can retrieve the information that was requested according to the Workflow configuration created in the [1. Set up a query template](#set-up-a-query-template) step.

{% hint style="info" %}
**Note:** you must wait for the transaction to be processed before the data is fully available.
{% endhint %}

**Alternative:** wait for a webhook update and only get the info when the transaction has an update. See more details [here](https://docs.caf.io/api/core-api/webhooks).


# Onboarding links into WebView and iFrame


# WebView

This document provides guidelines for configuring WebView to ensure proper functionality of web Onboarding integrations.

| Platform                                                                                          | Description                                            |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| [Android](/caf-docs/quick-start-guides/onboardings-integration/webview/webview_android)           | Android webview setup instructions                     |
| [iOS](/caf-docs/quick-start-guides/onboardings-integration/webview/webview_ios)                   | iOS webview setup instructions                         |
| [React Native](/caf-docs/quick-start-guides/onboardings-integration/webview/webview_react_native) | Multi platform React Native webview setup instructions |
| [Flutter](/caf-docs/quick-start-guides/onboardings-integration/webview/webview_flutter)           | Multi platform Flutter webview setup instructions      |


# Android

This document provides instructions to create a WebView into an Android project.

### Android Manifest

Add these lines to the AndroidManifest.xml file in your app module:

```xml
<uses-feature
    android:name="android.hardware.camera"
    android:required="true" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
```

### Android WebView (Kotlin)

This is an example of an activity using a WebView

```kotlin
class WebViewActivity : AppCompatActivity() {
    private var filePathCallback: ValueCallback<Array<Uri>>? = null
    private var permissionRequest: PermissionRequest? = null
    private lateinit var webView: WebView

    private val url = "https://cadastro.io/:token"

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        this.webView = getWebView()
        setContentView(webView)
        webView.loadUrl(url)
    }

    private fun getWebView(): WebView {
        val webView = WebView(this)
        val webSettings = webView.settings
        webSettings.javaScriptEnabled = true
        webSettings.domStorageEnabled = true
        webSettings.mediaPlaybackRequiresUserGesture = false
        webSettings.javaScriptCanOpenWindowsAutomatically = true
        webSettings.loadWithOverviewMode = true
        webSettings.useWideViewPort = true
        webSettings.allowFileAccess = true
        webSettings.allowContentAccess = true
        webSettings.mixedContentMode = WebSettings.MIXED_CONTENT_ALWAYS_ALLOW
        webView.setLayerType(View.LAYER_TYPE_HARDWARE, null)
        webView.webChromeClient = MyWebChromeClient()
        webView.webViewClient = WebViewClient()
        return webView
    }

    /**
     * The permission request result is handled here.
     * If the permission is granted, the webView is loaded.
     */
    override fun onRequestPermissionsResult(
        requestCode: Int,
        permissions: Array<String?>,
        grantResults: IntArray
    ) {
        super.onRequestPermissionsResult(requestCode, permissions, grantResults)
        if (requestCode == CAMERA_REQUEST_CODE && grantResults.size > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
            permissionRequest?.grant(permissionRequest?.resources)
        } else {
            permissionRequest?.deny()
        }
    }

    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        super.onActivityResult(requestCode, resultCode, data)
        if (requestCode == FILE_CHOOSER_REQUEST_CODE) {
            if (filePathCallback == null) {
                return
            }
            val results = WebChromeClient.FileChooserParams.parseResult(resultCode, data)
            filePathCallback!!.onReceiveValue(results)
            filePathCallback = null
        }
    }

    private inner class MyWebChromeClient : WebChromeClient() {
        var originalOrientation: Int = ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED
        var originalVisibility: Int = View.INVISIBLE
        private var customView: View? = null
        private var customViewCallback: CustomViewCallback? = null

        override fun onPermissionRequest(request: PermissionRequest) {
            val requestedAndroidPermissions = ArrayList<String>()
            for (requestedResource in request.resources) {
                if (requestedResource == PermissionRequest.RESOURCE_VIDEO_CAPTURE &&
                    ContextCompat.checkSelfPermission(
                        this@WebViewActivity.applicationContext,
                        Manifest.permission.CAMERA
                    ) != PackageManager.PERMISSION_GRANTED) {
                    requestedAndroidPermissions.add(Manifest.permission.CAMERA)
                }
            }
            if (requestedAndroidPermissions.isEmpty()) {
                request.grant(request.resources)
                return
            }
            permissionRequest = request
            requestPermissions(
                requestedAndroidPermissions.toTypedArray<String>(),
                CAMERA_REQUEST_CODE
            )
        }

        /**
         * Callback will tell the host application that the current page would
         * like to show a custom View in a particular orientation
         */
        override fun onShowCustomView(view: View, callback: CustomViewCallback) {
            if (customView != null) {
                onHideCustomView()
                return
            }
            customView = view
            originalVisibility = window.decorView.systemUiVisibility
            originalOrientation = requestedOrientation
            (window.decorView as FrameLayout).addView(
                customView,
                FrameLayout.LayoutParams(-1, -1)
            )
            // This will ensure the custom view is in fullscreen mode
            window.decorView.systemUiVisibility = 3846 or View.SYSTEM_UI_FLAG_LAYOUT_STABLE
        }

        /**
         * Callback will tell the host application that the current page exited full screen mode,
         * and the app has to hide custom view.
         */
        override fun onHideCustomView() {
            (window.decorView as FrameLayout).removeView(customView)
            customView = null
            window.decorView.systemUiVisibility = originalVisibility
            requestedOrientation = originalOrientation
            if (customViewCallback != null) {
                customViewCallback!!.onCustomViewHidden()
            }
            customViewCallback = null
        }

        override fun onShowFileChooser(
            webView: WebView,
            filePathCallback: ValueCallback<Array<Uri>>,
            fileChooserParams: FileChooserParams
        ): Boolean {
            if (this@WebViewActivity.filePathCallback != null) {
                this@WebViewActivity.filePathCallback?.onReceiveValue(null)
            }
            this@WebViewActivity.filePathCallback = filePathCallback

            val intent = fileChooserParams.createIntent()
            try {
                startActivityForResult(intent, FILE_CHOOSER_REQUEST_CODE)
            } catch (e: ActivityNotFoundException) {
                this@WebViewActivity.filePathCallback = null
                return false
            }
            return true
        }
    }

    companion object {
        private const val CAMERA_REQUEST_CODE = 1001
        private const val FILE_CHOOSER_REQUEST_CODE = 1002
    }
}
```

### Android WebView (Java)

```java
public class WebViewActivity extends AppCompatActivity {

    private ValueCallback<Uri[]> filePathCallback;
    private WebView webView;
    private PermissionRequest permissionRequest;
    private static final String url = "https://cadastro.io/:token";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        this.webView = getWebView();
        setContentView(webView);
        webView.loadUrl(url);
    }

    private WebView getWebView() {
        WebView webView = new WebView(this);
        WebSettings webSettings = webView.getSettings();
        webSettings.setJavaScriptEnabled(true);
        webSettings.setDomStorageEnabled(true);
        webSettings.setMediaPlaybackRequiresUserGesture(false);
        webSettings.setJavaScriptCanOpenWindowsAutomatically(true);
        webSettings.setLoadWithOverviewMode(true);
        webSettings.setUseWideViewPort(true);
        webSettings.setAllowFileAccess(true);
        webSettings.setAllowContentAccess(true);
        webSettings.setMixedContentMode(WebSettings.MIXED_CONTENT_ALWAYS_ALLOW);
        webView.setLayerType(View.LAYER_TYPE_HARDWARE, null);
        webView.setWebChromeClient(new MyWebChromeClient());
        webView.setWebViewClient(new WebViewClient());
        return webView;
    }

    /**
     * The permission request result is handled here.
     * If the permission is granted, the webView is loaded.
     */
    @Override
    public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) {
        super.onRequestPermissionsResult(requestCode, permissions, grantResults);
        if (requestCode == CAMERA_REQUEST_CODE && grantResults.length > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
            if (permissionRequest != null) {
                permissionRequest.grant(permissionRequest.getResources());
            }
        } else {
            if (permissionRequest != null) {
                permissionRequest.deny();
            }
        }
    }

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
        if (requestCode == FILE_CHOOSER_REQUEST_CODE) {
            if (filePathCallback == null) {
                return;
            }
            Uri[] results = WebChromeClient.FileChooserParams.parseResult(resultCode, data);
            filePathCallback.onReceiveValue(results);
            filePathCallback = null;
        }
    }

    private class MyWebChromeClient extends WebChromeClient {
        private int originalOrientation = ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED;
        private int originalVisibility = View.INVISIBLE;
        private View customView;
        private CustomViewCallback customViewCallback;

        @Override
        public void onPermissionRequest(PermissionRequest request) {
            ArrayList<String> requestedAndroidPermissions = new ArrayList<>();
            for (String requestedResource : request.getResources()) {
                if (requestedResource.equals(PermissionRequest.RESOURCE_VIDEO_CAPTURE) &&
                        ContextCompat.checkSelfPermission(
                                WebViewActivity.this,
                                android.Manifest.permission.CAMERA
                        ) != PackageManager.PERMISSION_GRANTED) {
                    requestedAndroidPermissions.add(android.Manifest.permission.CAMERA);
                }
            }
            permissionRequest = request;
            if (requestedAndroidPermissions.isEmpty()) {
                request.grant(request.getResources());
                return;
            }
            requestPermissions(requestedAndroidPermissions.toArray(new String[0]), CAMERA_REQUEST_CODE);
        }

        /**
         * Callback will tell the host application that the current page would
         * like to show a custom View in a particular orientation
         */
        @Override
        public void onShowCustomView(View view, CustomViewCallback callback) {
            if (customView != null) {
                onHideCustomView();
                return;
            }
            customView = view;
            originalVisibility = getWindow().getDecorView().getSystemUiVisibility();
            originalOrientation = getRequestedOrientation();
            ((FrameLayout) getWindow().getDecorView()).addView(
                    customView,
                    new FrameLayout.LayoutParams(-1, -1)
            );
            // This will ensure the custom view is in fullscreen mode
            getWindow().getDecorView().setSystemUiVisibility(3846 | View.SYSTEM_UI_FLAG_LAYOUT_STABLE);
        }

        /**
         * Callback will tell the host application that the current page exited full screen mode,
         * and the app has to hide custom view.
         */
        @Override
        public void onHideCustomView() {
            ((FrameLayout) getWindow().getDecorView()).removeView(customView);
            customView = null;
            getWindow().getDecorView().setSystemUiVisibility(originalVisibility);
            setRequestedOrientation(originalOrientation);
            if (customViewCallback != null) {
                customViewCallback.onCustomViewHidden();
            }
            customViewCallback = null;
        }

        @Override
        public boolean onShowFileChooser(WebView webView, ValueCallback<Uri[]> filePathCallback, FileChooserParams fileChooserParams) {
            if (WebViewActivity.this.filePathCallback != null) {
                WebViewActivity.this.filePathCallback.onReceiveValue(null);
            }
            WebViewActivity.this.filePathCallback = filePathCallback;

            Intent intent = fileChooserParams.createIntent();
            try {
                startActivityForResult(intent, FILE_CHOOSER_REQUEST_CODE);
            } catch (ActivityNotFoundException e) {
                WebViewActivity.this.filePathCallback = null;
                return false;
            }
            return true;
        }
    }

    private static final int CAMERA_REQUEST_CODE = 1001;
    private static final int FILE_CHOOSER_REQUEST_CODE = 1002;
}
```


# iOS

This document provides instructions to create a WebView into an iOS project.

### iOS Info.plist

Add these lines to the Info.plist file in you iOS module:

```plist
<key>NSCameraUsageDescription</key>
<string>Camera Permission</string>
<key>NSMotionUsageDescription</key>
<string>Motion Permission</string>
```

### iOS WebView (Swift)

In order for web Onboarding integrations that use WKWebView for iOS to function properly, it is necessary to customize the configuration to allow media playback without request user's action and to reproduce the media inline.

{% hint style="warning" %}
For iOS, **WKWebView** is the preferred WebView. The example below is a basic illustration.
{% endhint %}

#### AppDelegate

```swift
@main
class AppDelegate: UIResponder, UIApplicationDelegate {
    var window: UIWindow?

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        window = UIWindow(frame: UIScreen.main.bounds)
        window?.rootViewController = WebViewController()
        window?.makeKeyAndVisible()
        return true
    }
}
```

#### SceneDelegate

```swift
import UIKit

class SceneDelegate: UIResponder, UIWindowSceneDelegate {
    var window: UIWindow?

    func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
        guard let windowScene = scene as? UIWindowScene else { return }

        window = UIWindow(windowScene: windowScene)
        window?.rootViewController = WebViewController()
        window?.makeKeyAndVisible()
    }
}
```

#### WebViewController

```swift
@preconcurrency import WebKit
import AVFoundation

class WebViewController: UIViewController, WKNavigationDelegate, WKUIDelegate {
    var webView: WKWebView!
    
    override func viewDidLoad() {
        super.viewDidLoad()
        setupViews()
        setupConstraints()
    }

    func setupViews() {
        let webConfiguration = WKWebViewConfiguration()
        webConfiguration.allowsInlineMediaPlayback = true
        webConfiguration.defaultWebpagePreferences.allowsContentJavaScript = true
        webConfiguration.mediaTypesRequiringUserActionForPlayback = []

        webView = WKWebView(frame: .zero, configuration: webConfiguration)
        webView.navigationDelegate = self
        webView.uiDelegate = self
        view.addSubview(webView)

        let request = URLRequest(url: URL(string: "https://cadastro.io/:token")!)
        webView.load(request)
        
        AVCaptureDevice.requestAccess(for: .video) { granted in
            if granted {
                // Access granted
            } else {
                // Access denied
            }
        }
    }

    func setupConstraints() {
        webView.translatesAutoresizingMaskIntoConstraints = false
        NSLayoutConstraint.activate([
            webView.topAnchor.constraint(equalTo: view.topAnchor),
            webView.leadingAnchor.constraint(equalTo: view.leadingAnchor),
            webView.trailingAnchor.constraint(equalTo: view.trailingAnchor),
            webView.bottomAnchor.constraint(equalTo: view.bottomAnchor)
        ])
    }
}
```


# React Native

This document provides instructions to create a WebView using React Native.

### Dependencies

Add react-native-webview to your dependencies

```
yarn add react-native-webview
```

or

```
npm install --save react-native-webview
```

### Android Manifest

Add these lines to the AndroidManifest.xml file in your Android app module:

```xml
<uses-feature
    android:name="android.hardware.camera"
    android:required="true" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
```

### iOS Info.plist

Add these lines to the Info.plist file in you iOS module:

```plist
<key>NSCameraUsageDescription</key>
<string>Camera Permission</string>
<key>NSMotionUsageDescription</key>
<string>Motion Permission</string>
```

### React Native WebView

```typescript
import React, { useEffect } from "react";
import {
  SafeAreaView,
  StyleSheet,
  PermissionsAndroid,
  Platform,
} from "react-native";
import { WebView } from "react-native-webview";

function App(): React.JSX.Element {
  return (
    <SafeAreaView style={styles.container}>
      <WebView
        style={styles.container}
        mediaPlaybackRequiresUserAction={false}
        allowsFullscreenVideo
        allowsInlineMediaPlayback
        source={{
          uri: "https://cadastro.io/:token",
        }}
      />
    </SafeAreaView>
  );
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
  },
});

export default App;
```


# Flutter

This document provides instructions to create a WebView using Flutter.

### Dependencies

To create a WebView to a Flutter application, it's needed to apply the dependencies [flutter\_inappwebview](https://pub.dev/packages/flutter_inappwebview) and [permission\_handler](https://pub.dev/packages/permission_handler) to your `pubspec.yaml`:

```yaml
dependencies:
  flutter:
    sdk: flutter
  flutter_inappwebview: ^6.0.0
  permission_handler: ^11.3.1
```

### Android Manifest

Add these lines to the AndroidManifest.xml file in your Android app module:

```xml
<uses-feature
    android:name="android.hardware.camera"
    android:required="true" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
```

### iOS Info.plist

Add these lines to the Info.plist file in you iOS module:

```plist
<key>NSCameraUsageDescription</key>
<string>Camera Permission</string>
<key>NSMotionUsageDescription</key>
<string>Motion Permission</string>
```

### Flutter WebView (Dart)

This is an example of an activity using a WebView

```dart
import 'package:flutter/material.dart';
import 'package:flutter_inappwebview/flutter_inappwebview.dart';
import 'package:permission_handler/permission_handler.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const WebViewScreen(),
    );
  }
}

class WebViewScreen extends StatefulWidget {
  const WebViewScreen({super.key});

  @override
  _WebViewScreenState createState() => _WebViewScreenState();
}

class _WebViewScreenState extends State<WebViewScreen> {
  InAppWebViewController? webViewController;

  @override
  void initState() {
    super.initState();
    _checkCameraPermission();
  }

  Future<void> _checkCameraPermission() async {
    var status = await Permission.camera.status;
    if (!status.isGranted) {
      await Permission.camera.request();
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Flutter WebView Example')),
      body: InAppWebView(
        initialUrlRequest: URLRequest(
          url: WebUri.uri(Uri.parse('https://cadastro.io/:token')),
        ),
        onWebViewCreated: (controller) {
          webViewController = controller;
        },
        androidOnPermissionRequest: (controller, origin, resources) async {
          return PermissionRequestResponse(
            resources: resources,
            action: PermissionRequestResponseAction.GRANT,
          );
        },
      ),
    );
  }
}
```


# iFrame

This document provides instructions for integrating the Onboarding process into an iFrame.

To integrate the Onboarding process into an iFrame, follow the example code provided below. Ensure that you grant access to the device's camera using the allow attribute and enable geolocation to capture the location for the trust platform dashboard. If your template includes Liveness or FaceAuthenticator features, you'll need to allow the following parameters: `fullscreen`, `accelerometer`, `gyroscope`, `magnetometer`.

```html
<iframe
  src="https://cadastro.io/:token"
  allow="geolocation;camera;fullscreen;accelerometer;gyroscope;magnetometer;"
  allowfullscreen="true"
  style="width: 100vw; height: 100vh; border: 0"
></iframe>
```

### iOS Sensor Permission Requirements for iProov

When your Onboarding template includes a `LIVENESS HUB` step and it is configured to use iProov Provider for face verification, the button implementation below is **required** for proper functionality on iOS devices. This ensures motion sensor permissions are granted from the parent page before the iframe loads.

#### Complete implementation example

```html
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Onboarding iframe Example</title>
    <style>
      body {
        margin: 0;
        padding: 0;
        font-family: Arial, sans-serif;
        display: flex;
        justify-content: center;
        align-items: center;
        height: 100vh;
        background: #f5f5f5;
      }

      #startButton {
        padding: 16px 32px;
        font-size: 18px;
        background: #051f61;
        color: white;
        border: none;
        border-radius: 8px;
        cursor: pointer;
      }

      #startButton:hover {
        background: #1fd660;
      }

      iframe {
        display: none;
        width: 100%;
        height: 100vh;
        border: none;
      }
    </style>
  </head>
  <body>
    <!-- Step 1: Show button to request sensor permission -->
    <button id="startButton">Start Onboarding</button>

    <!-- Step 2: Onboarding iframe (hidden initially) -->
    <!-- IMPORTANT: Replace :token with your actual onboarding token -->
    <iframe
      style="width: 100vw; height: 100vh; border: 0"
      id="onboardingIframe"
      allow="geolocation; camera; fullscreen; accelerometer; gyroscope; magnetometer"
      src="https://cadastro.io/:token"
      allowfullscreen="true"
    ></iframe>

    <script>
      // IMPORTANT: This script must run on the PARENT PAGE that hosts the iframe
      // iOS requires sensor permissions to be requested from the parent page, not from within the iframe
      
      // When user clicks the button
      document
        .getElementById("startButton")
        .addEventListener("click", async () => {
          try {
            // Check if device requires motion permission (iOS 13+ Safari)
            if (typeof DeviceMotionEvent.requestPermission === "function") {
              // Request permission from the parent page (required for iOS)
              const permission = await DeviceMotionEvent.requestPermission();

              if (permission === "granted") {
                // Permission granted - show iframe
                showIframe();
              } else {
                // Permission denied
                alert(
                  "Sensor access is required for face verification. Please allow access in your browser settings."
                );
              }
            } else {
              // No permission needed (Android, Desktop, older iOS)
              showIframe();
            }
          } catch (error) {
            console.error("Error:", error);
            alert(
              "Error requesting permissions. Please try again or check your browser settings."
            );
          }
        });

      // Function to show the iframe
      function showIframe() {
        document.getElementById("startButton").style.display = "none";
        document.getElementById("onboardingIframe").style.display = "block";
      }

      // Optional: Listen for messages from the iframe
      window.addEventListener("message", (event) => {
        // Validate origin for security
        // IMPORTANT: Replace with your onboarding domain
        if (event.origin !== "https://cadastro.io") return;
        
        // Handle onboarding completion or other events
        console.log("Onboarding event:", event.data);
      });
    </script>
  </body>
</html>
```

{% hint style="warning" %}
The Onboarding service may not function correctly within an iFrame if the user has **Block third-party cookies enabled** in their browser. This is particularly common in anonymous browser sessions.
{% endhint %}

{% hint style="warning" %}
If you encounter issues with the permission pop-up not appearing, consider specifying the allowed origin in the allow attribute or creating a Content Security Policy (CSP) to define the trusted sources more explicitly.
{% endhint %}


# Events

This document explains how to handle events emitted by the onboarding process using window\.postMessage().

#### Onboarding Event Codes

Here is the table with descriptions:

| EVENT                            | DESCRIPTION                                                                                                                                  | DETAIL                                                                       |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| **STEP\_STARTED**                | General event to every begin of step of onboarding flow. (GENERICAL DETAIL)                                                                  | `{ "stepName":"INSTRUCTIONS", "stepIndex":0 }`                               |
| **STEP\_COMPLETED**              | General event trigger when setp finish. (GENERICAL DETAIL)                                                                                   | `{ "stepName":"INSTRUCTIONS", "stepIndex":0 }`                               |
| **GET\_CAMERA\_PERMISSIONS**     | The user clicked the button to enable camera access but has not yet granted permission.                                                      | `{}`                                                                         |
| **SDK\_CAMERA\_DENIED**          | The user denied camera access, preventing further progress until permissions are granted.                                                    | `{ "StepName":"LIVENESS_IPROOV" }`                                           |
| **LIVENESS\_CAPTURE**            | The user clicked the button to start the liveness detection capture. After capture, the liveness count will indicate the number of attempts. | `{ "livenessCount": X }`                                                     |
| **SDK\_CAPTURE\_DENIED**         | The user denied motion access, preventing the system from verifying their identity.                                                          | `{ "assuranceType":"liveness" }`                                             |
| **SDK\_CAPTURE\_FAILED**         | The liveness capture failed due to an issue such as poor lighting or improper movement, requiring the user to retry.                         | `{ "assuranceType":"liveness","reason":"Try again","passed":false }`         |
| **LIVENESS\_IPROOV\_ERROR**      | An error occurred while performing liveness verification. Contact the SDK team for further assistance.                                       | `{}`                                                                         |
| **SDK\_CAPTURE\_INVALID**        | The liveness capture was invalid, possibly due to improper user positioning or lighting issues.                                              | `{"assuranceType":"liveness","reason":"error_device_motion_unsupported"}}`   |
| **SDK\_CAPTURE\_RESULT**         | The result of the liveness capture, indicating whether the user is deemed alive or not.                                                      | `{ "isAlive":true/false }`                                                   |
| **LIVENESS\_PREVIEW\_RETRY**     | The user opted to retry the selfie capture, restarting the liveness verification process.                                                    | `{}`                                                                         |
| **DOCUMENT\_REUSE\_FLOW**        | The option that the user selected when finding their document in the Document Reuse step, which can be `REUSE` or `CAPTURE`.                 | `{ "selected":"REUSE" }`                                                     |
| **DOCUMENT\_TYPE\_SELECTED**     | The user selected a document type (e.g., CNH) to proceed with document verification.                                                         | `{ "type":"CNH" }`                                                           |
| **TERM\_ACCEPTED**               | The user checked the checkbox to accept the terms of use. If unchecked, an event with `false` is emitted.                                    | `{ "term":"DocumentType_0_Terms of Use and Privacy Policy","checked":true }` |
| **SELECT\_DOCUMENT\_TYPE**       | The user checked the checkbox to accept the terms of use. If unchecked, an event with `false` is emitted.                                    | `{ "option":upload/picture }`                                                |
| **SDK\_FRONT\_CAPTURE\_STARTED** | The front document image capture started                                                                                                     | `{ "assuranceType":"document_detector"}`                                     |
| **SDK\_BACK\_CAPTURE\_STARTED**  | Theb back document image capture started                                                                                                     | `{ "assuranceType":"document_detector"}`                                     |
| **SDK\_UPLOAD\_INVALID**         | The event is trigger when sdk retorns failed on the document upload                                                                          | `{"assuranceType":"document_detector","eventId":"DOCUMENT_NOT_SUPPORTED"}`   |
| **DD\_CAPTURE\_FINISH**          | The user canceled the document capture step.                                                                                                 | `{}`                                                                         |
| **DD\_PREVIEW\_RETRY**           | The document capture was successful.                                                                                                         | `{ "assuranceType":"document", "stepName":"DOCUMENT_CAPTURE" }`              |
| **SDK\_CAPTURE\_FAILED**         | The document capture failed due to image quality issues.                                                                                     | `{ "assuranceType":"document", "reason":"Blurred Image", "passed":false }`   |
| **FIELD\_CHANGE**                | The event is triggered when the user edits or enters a value in the text field                                                               | `{"field":"email"}`                                                          |
| **FAILED\_PHONE\_CODE**          | Incorrect code entered                                                                                                                       | `{}`                                                                         |
| **RESEND\_PHONE\_CODE**          | The event is triggered when the user ask to resend the phone code                                                                            | `{}`                                                                         |
| **FAILED\_EMAIL\_CODE**          | Incorrect code entered                                                                                                                       | `{}`                                                                         |
| **RESEND\_EMAIL\_CODE**          | The event is triggered when the user ask to resend the email code                                                                            | `{}`                                                                         |
| **ONBOARDING\_FINISHED**         | The onboarding process was completed successfully, and the user is now onboarded.                                                            | `{ "executionId":"67b27030a0e08600085f0c0f" }`                               |

***

The **STEP\_STARTED** and **STEP\_COMPLETED** events are indicators of the beginning and completion of various stages within the onboarding process. These events help to track the user's progress through each step.

* The **STEP\_STARTED** event signifies that a particular step has started. It contains two key parameters:
  * `stepName`: The name of the step, which could be one of several predefined stages in the onboarding process. Examples of possible values include:
    * `INSTRUCTIONS`
    * `CAMERA_ACCESS`
    * `LIVENESS_CAPTURE`
    * `DOCUMENT_TYPE`
    * `DISPATCH_ADDRESS`
    * `DOCUMENT_REUSE`
    * `DOCUMENT_REUSE_SEARCH`
    * `SEND_DOCUMENT_TYPE`
    * `COMPANY_ADDRESS`
    * `COMPANY_DATA`
    * `COMPANY_LISTING`
    * `COMPANY_SEARCH`
    * `COMPANY_LOCATION`
    * `BUSINESS_ADDRESS`
    * `INCOME`
    * `EMPLOYEE_DATA`
    * `PHONE_NUMBER_VALIDATION`
    * `EMAIL_VALIDATION`
    * `UPLOAD_DOCUMENT`
    * `WELCOME`
    * `NEW_ACCESS`
    * `FLOW_CHOICE`
    * `CUSTOM`
    * `QSA_CONTACT`
    * `QSA_CONTACT_INFO`
    * `QSA_NUMBER`
    * `PFL_PREVIEW`
    * `LIVENESS_CLEAR_SALE_PREVIEW`
    * `FA_PREVIEW`
    * `CUSTOM_FORM`
    * `DONE`
    * `USING_TERMS`
    * `DOCUMENT_ISSUED_COUNTRY`
    * `DD`
    * `PFL`
    * `LIVENESS_CLEAR_SALE`
    * `FA`
    * `FACE_AUTH_IPROOV`
    * `FACE_AUTH_FACETEC_3D`
    * `FACE_AUTH_FACETEC_2D`
    * `LIVENESS_IPROOV`
    * `LIVENESS_FACETEC_3D`
    * `LIVENESS_FACETEC_2D`
    * `DD_PREVIEW`
    * `FACE_AUTH_IPROOV_PREVIEW`
    * `LIVENESS_IPROOV_PREVIEW`
    * `LIVENESS_FACETEC_3D_PREVIEW`
    * `LIVENESS_FACETEC_2D_PREVIEW`
    * and others.
  * `stepIndex`: The index of the current step, which provides a numerical reference to the user's position within the overall onboarding flow. This allows for precise identification of which step is in progress.
* The **STEP\_COMPLETED** event signifies that a particular step has been completed successfully. Like the **STEP\_STARTED** event, it includes:
  * `stepName`: The name of the completed step.
  * `stepIndex`: The index of the completed step, which marks the successful progression to the next step in the process.

These events are crucial for monitoring the flow of the onboarding process, providing both the name of the current step and its index to help determine where the user is in the onboarding journey.

***

The Onboarding process communicates with an iFrame or WebView by emitting events through `window.postMessage()`. Event support is currently available for iFrame, Flutter\*, and React Native.

```javascript
window.addEventListener(
  "message",
  function (e) {
    console.log(e.data);
  },
  false
);
```

#### Example of a Returned Message:

```json
{
  "code": "ONBOARDING_FINISHED",
  "detail": {
    "executionId": "xxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}
```

{% hint style="warning" %}
Always listen to the `"message"` event, as communication with the onboarding link through an iFrame utilizes the `postMessage` API.
{% endhint %}

#### Using a Specific Event Code from Onboarding:

To handle specific event codes emitted by Onboarding, you can check the `code` property in the event data:

```javascript
window.addEventListener(
  "message",
  function (e) {
    if (e.data.code === "SDK_BACK_CAPTURE_STARTED") {
      console.log("The capture was started");
    }
  },
  false
);
```

{% hint style="info" %}
**If using** Web Message Listeners with Flutter, then [InAppWebView](https://inappwebview.dev/) should be used, with **`jsObjectName`** set as **`FutterOnboardingChannel`**
{% endhint %}

The events that can be issued by Onboarding are as follows:

* `SDK_CAPTURE_INVALID`: Will be triggered when capture is invalid, such as an incorrect document or poor image quality. (Document Detector and Passive Face Liveness)
* `SDK_CAPTURE_FAILED`: Some other failure in the capture. (Document Detector and Passive Face Liveness)
* `SDK_CAPTURE_RESULT`: Result of the capture. (Liveness and FaceAuthenticator)
* `SDK_BACK_CAPTURE_STARTED`: Started capturing the backside of the document (Document Detector)
* `SDK_FRONT_CAPTURE_STARTED`: Started capturing the front of the document (Document Detector)
* `DD_CAPTURE_FINISH`: Document Detector capture step in onboarding completed (If it has both sides, it will only be triggered when both sides are captured) in fact it is only triggered when you are already moving on to the next step, if everything is ok with the capture
* `ONBOARDING_FINISHED`: Onboarding finished


# Overview

Welcome to the API documentation! On this page, you will find everything you need to know to improve the security and quality of your apps using our API.

### Integration

The CAF API follows the [REST ](https://en.wikipedia.org/wiki/Representational_state_transfer)standard. Therefore, our API has predictable resource-oriented URLs that accept and return data in JSON format while also using standard HTTP code in the response.

{% hint style="warning" %}
**Important Notice on Authentication and Integrations**

All integrations with CAF APIs must be implemented exclusively via backend/server-side. Client-side or frontend-based integrations may be blocked and significantly increase the risk of authentication key exposure.

Caf continuously monitors the usage and exposure of authentication keys. Any key identified as exposed, compromised, or used in non-compliant implementations will be immediately revoked, which may result in the interruption of the associated operation, without prior notice.

It is the integrator’s responsibility to ensure compliance with the recommended authentication patterns and security best practices described in this documentation.
{% endhint %}

### Responses <a href="#czs" id="czs"></a>

We use conventional response codes to indicate success or failure in a request. In short, codes in the `2xx` range represent success. Codes in the `4xx` range indicate validation error types with the information provided or mapped failures. Finally, codes in the `5xx` range indicate an error with the servers or some other unforeseen failure.

In addition, all responses have an identifier for the request, the `requestId` field. This field is helpful for us to find the exact request in case of investigation.


# Getting Started

Welcome! This guide will help you get started with the Connect API, from creating your first application to making authenticated requests and understanding permissions.

## Step 1: Create an application

To use the APIs, you first need to create an application in [Trust](https://trust.caf.io/). You will receive a `client_id` and `client_secret`.

* Access [Creating an Application](/caf-api/connect/authentication/applications/creating-application) for step-by-step instructions.

## Step 2: Understand permissions

Your application requires specific permissions to access different API features. Review and select the permissions needed for your use case.

* Access [Available Permissions](/caf-api/connect/authentication/applications/available-permissions) for a full list.

## Step 3: Authenticate and obtain an access token

With your credentials, you can authenticate and obtain an OAuth2 access token. This token is required for all API requests.

* Learn how to authenticate in [Authenticating](/caf-api/connect/authentication/authenticating).

## Step 4: Set up mutual TLS (mTLS) authentication (recommended)

For enhanced security, Connect supports mutual TLS (mTLS) authentication. This provides an additional layer of security by requiring both the client and server to verify each other's certificates.

1. **Create a Certificate**:
   * Follow the instructions in [Creating a Certificate](/caf-api/connect/authentication/certificates/creating-certificate) to generate a client certificate.
2. **Configure mTLS in Your Application**:
   * Implement mTLS authentication using your certificate and private key.
   * Access [Using mTLS](/caf-api/connect/authentication/using-mtls) for code examples and detailed instructions.

## Next steps

* Explore the [Available Resources](/caf-api/connect/available-resources) to see what you can do with the API.
* Review [Managing Applications](/caf-api/connect/authentication/applications/managing-applications) for tips on updating or deleting your applications.
* Learn about [Managing Certificates](/caf-api/connect/authentication/certificates/managing-certificate) to handle certificate renewal and revocation.

> **Tip:** Keep your credentials and certificates secure and never expose them in client-side code or public repositories.


# Rate Limit

Rate limiting defines the maximum number of requests an application can make to the API within a specified time period. This mechanism is crucial for maintaining the overall health and reliability of the services.

## Why we use rate limiting

Rate limiting serves several important purposes:

### API stability and performance

* Prevents any single client from overwhelming our servers with too many requests
* Ensures consistent response times for all users
* Protects backend services from traffic spikes
* Maintains predictable load patterns on the infrastructure

### Security benefits

* Defends against brute force attacks
* Mitigates distributed denial-of-service (DDoS) attacks
* Reduces the impact of poorly implemented client applications
* Limits damage from compromised API credentials

### Fair resource allocation

* Ensures equitable access to shared API resources across all clients
* Prevents aggressive clients from degrading service for other users
* Helps prioritize traffic according to business needs
* Encourages efficient API usage patterns

## How rate limiting works

Each endpoint may have different limits, defined by:

* Time window (per minute, hour, or day)
* Application type (standard or enterprise)
* Operation type (higher limits for read operations, lower for writes)

When you exceed your rate limit, you receive a `HTTP 429` (Too Many Requests) response.

## Example rate limit exceeded response

When you exceed the rate limit, you'll receive a response like this:

```json
{
  "message": "Too Many Requests"
}
```

## Handling 429 too many requests errors

When you receive a `429` error, implement these strategies to handle it gracefully:

### Implement exponential backoff with jitter

Exponential backoff is a retry strategy where you progressively increase the waiting time between retries:

```javascript
// Pseudo-code example of exponential backoff with jitter
function fetchWithBackoff(url, maxRetries = 5) {
  let retries = 0;
  
  while (retries < maxRetries) {
    try {
      const response = await fetch(url);
      if (response.status !== 429) {
        return response; // Success or different error
      }
      
      // Calculate backoff time with jitter
      const baseWaitTime = Math.pow(2, retries) * 1000; // 1s, 2s, 4s, 8s, 16s
      const jitter = Math.random() * 0.5 * baseWaitTime;
      const waitTime = baseWaitTime + jitter;
      
    
      console.log(`Rate limited. Waiting ${waitTime/1000} seconds before retry ${retries + 1}/${maxRetries}`);
      await sleep(waitTime);
      retries++;
      
    } catch (error) {
      // Handle other errors
      throw error;
    }
  }
  
  throw new Error("Maximum retry attempts reached");
}
```

### Review application behavior

* Audit your code to identify inefficient API usage patterns
* Look for unintended loops or redundant API calls
* Consider batching multiple operations into single requests where applicable
* Distribute your requests more evenly over time instead of sending them in bursts

### Implement caching

* Cache frequently accessed and rarely changing data
* Implement proper cache invalidation strategies
* Use appropriate cache timeouts based on data volatility
* Consider using ETags or Last-Modified headers for conditional requests


# Transactions

This section contains documentation about transaction processing rules and validations.

## Topics

* [Validation rules](/caf-api/connect/transactions/validation-rules) - Rules applied during transaction validation
* [Manual reprovals](/caf-api/connect/transactions/manual-reprovals) - Manual reproval codes and reasons

## Overview

When processing transactions, the system applies various validation rules and may manually reprove transactions that don't meet specific criteria. This section documents these rules and reproval reasons to help you understand transaction outcomes.


# Transaction linking

For clients using Certta SDKs who subsequently create transactions to perform additional validations, it is crucial to link the session tokens with these transactions to ensure full traceability of the user journey.

{% hint style="warning" %}
This process applies exclusively to clients who use both the SDK for a user session and the API for subsequent validations. If you only use our APIs directly, this step is not necessary.
{% endhint %}

This linkage is done by sending the **Mobile Token** (Session Token) at the time of transaction creation. Specifically, include the mobile token in the request body using the parameter `referenceToken` when calling the endpoint.

Check out [Transaction Creation Integration](/caf-api/connect/available-resources/transaction) for more details on how to create transactions.

{% hint style="info" %}
By associating the transaction with the mobile token, you enable a complete audit trail that connects user authentication sessions with subsequent transaction validations, enhancing security and monitoring capabilities.
{% endhint %}


# Validation rules

The validations of a transaction are characterised by a set of rules that are used to define the query status/result. Each rule has an identifier, a status and a description. For example, if the rule indicates an irregularity, it will contain the status INVALID and a corresponding description. If the rule is successfully validated, its status will be VALID and have a description accordingly.

{% hint style="info" %}
**Note:** There are scenarios where not all rules are processed, so a transaction may not contain all available validations.
{% endhint %}

### Available rules

| Identifier                                        | Title                                                                                                                                                           | Description                                                                                                                                                                                                                                                       |
| ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| active\_cnpj\_number                              | Active CNPJ on Federal Revenue                                                                                                                                  | Checks if the CNPJ (National Legal Entity Register) is active with the Federal Revenue.                                                                                                                                                                           |
| attorney                                          | Attorney Flow                                                                                                                                                   | Validates if the query was generated from the Attorney flow.                                                                                                                                                                                                      |
| authentic\_cnpj\_number                           | Authentic CNPJ number                                                                                                                                           | Checks if the CNPJ (National Legal Entity Register) number is authentic.                                                                                                                                                                                          |
| authentic\_document                               | Authenticity of the identity                                                                                                                                    | Checks if the document's authenticity.                                                                                                                                                                                                                            |
| big\_data\_source\_underage                       | Age of majority                                                                                                                                                 | Checks if the source indicates the holder is under 18 years old.                                                                                                                                                                                                  |
| cnh\_has\_valid\_date                             | Expired Expired (CNH)                                                                                                                                           | Checks if driver's license has not expired.                                                                                                                                                                                                                       |
| company\_qsa\_data\_compatibility                 | Compatibility between Person and Company data                                                                                                                   | Checks if the individual data matches the company's membership data.                                                                                                                                                                                              |
| cpf\_equal\_name                                  | Equivalent names                                                                                                                                                | Checks if the name found in the run (parameter/OCR) is the same as the official database.                                                                                                                                                                         |
| cpf\_error\_code                                  | Regular CPF                                                                                                                                                     | Checks if the CPF (Individuals Register) is in order.                                                                                                                                                                                                             |
| cpf\_has\_not\_dead                               | Death                                                                                                                                                           | Checks if the CPF (Individuals Register) consulted is deceased.                                                                                                                                                                                                   |
| cpf\_null                                         | Basic data invalid return                                                                                                                                       | Checks if the basic data source is returning values.                                                                                                                                                                                                              |
| cpf\_query                                        | CPF Inquiry                                                                                                                                                     | Checks if it was possible to consult the CPF (Individuals Register) at the Federal Revenue.                                                                                                                                                                       |
| credit\_score\_available                          | Available credit score                                                                                                                                          | Checks if the document consulted has an available credit score.                                                                                                                                                                                                   |
| credit\_score\_below                              | Score below\...                                                                                                                                                 | Checks if the credit score is below the defined value.                                                                                                                                                                                                            |
| credit\_score\_between                            | Score between...                                                                                                                                                | Checks if the credit score is between the defined values.                                                                                                                                                                                                         |
| credit\_score\_over                               | Score above...                                                                                                                                                  | Checks if the credit score is above the defined value.                                                                                                                                                                                                            |
| data\_and\_document\_are\_equal                   | Diverging parameters                                                                                                                                            | Checks for discrepancies between information collected and entered manually.                                                                                                                                                                                      |
| disabled\_on\_bacen                               | It is not included in the general list of disabled persons with BACEN.                                                                                          | Checks if the CPF (Individuals Register) consulted is not authorized by the Central Bank.                                                                                                                                                                         |
| document\_is\_known                               | Type of document different from others                                                                                                                          | Checks if the document is not of type other.                                                                                                                                                                                                                      |
| document\_issue\_less\_than\_10                   | Verification of a document under 10 years old                                                                                                                   | Checks if the document was issued less than 10 years ago.                                                                                                                                                                                                         |
| documentscopy\_approved                           | Documentoscopy approved                                                                                                                                         | Checks if the document has passed the documentary examination.                                                                                                                                                                                                    |
| documentscopy\_available                          | Documentoscopy available                                                                                                                                        | Checks if documentscopy is available.                                                                                                                                                                                                                             |
| does\_not\_exist\_on\_receita\_federal\_database  | Invalidate if CPF is not found in the Internal Revenue Service.                                                                                                 | Checks if you can find the document at Federal Revenue.                                                                                                                                                                                                           |
| driver\_has\_pending\_traffic\_violations         | Invalidate if pending traffic violations are found for the driver                                                                                               | Checks if there are any outstanding infractions for the document consulted.                                                                                                                                                                                       |
| driver\_has\_traffic\_violations                  | Invalidate if violations are found for the driver                                                                                                               | Checks for infringements for the document consulted.                                                                                                                                                                                                              |
| face\_and\_birthdate\_compare                     | CPF vs Selfie                                                                                                                                                   | Checks selfie upload.                                                                                                                                                                                                                                             |
| facematch\_has\_selfie\_photo                     | Selfie present                                                                                                                                                  | Checks whether the submission has a selfie or not. What triggers the rule is not having a selfie.                                                                                                                                                                 |
| facematch\_is\_equal                              | Facematch                                                                                                                                                       | Checks similarity between document and selfie.                                                                                                                                                                                                                    |
| first\_and\_last\_name\_similarity                | Similarity between the union of the first and last names                                                                                                        | Checks the similarity between the union of the first and last name sent in the parameters compared to the union of the first name and each surname of the source.                                                                                                 |
| government\_document\_approved                    | Similar biometrics                                                                                                                                              | Checks whether it has been possible to validate the person's face on the basis of official information.                                                                                                                                                           |
| government\_document\_available                   | Do facial biometrics exist                                                                                                                                      | Checks if the person's face can be found in official databases.                                                                                                                                                                                                   |
| has\_active\_social\_assistence                   | Active social assistance                                                                                                                                        | Checks if have active social assistance benefits.                                                                                                                                                                                                                 |
| has\_arrest\_warrant                              | There are no warrants before the National Justice Council (CNJ)                                                                                                 | Checks for arrest warrants with the CNJ (National Council of Justice).                                                                                                                                                                                            |
| has\_at\_least\_one\_cnae                         | Verification of CNAEs in the company's activities                                                                                                               | Checks if the company has at least one CNAE (National Classification of Economic Activities) corresponding to those defined in the validation.                                                                                                                    |
| has\_at\_least\_one\_legal\_nature                | Verification of the legal nature of the company                                                                                                                 | Checks if the company has a legal nature code corresponding to those defined in the validation.                                                                                                                                                                   |
| has\_author\_type\_null\_in\_criminal\_processes  | Empty AuthorType in criminal processes                                                                                                                          | Checks if there is an empty ‘authorType’ field in any criminal case.                                                                                                                                                                                              |
| has\_cnh\_for\_more\_than\_three\_years           | Has had a CNH for at least 3 years                                                                                                                              | Checks if the driver has had a license (temporary or permanent) for at least 3 years.                                                                                                                                                                             |
| has\_cpf                                          | Present CPF                                                                                                                                                     | Checks if the document was found in the document or entered manually.                                                                                                                                                                                             |
| has\_debts\_on\_pgfn                              | List of PGFN debtors                                                                                                                                            | Checks if has debts with the PGFN (Attorney General's Office).                                                                                                                                                                                                    |
| has\_definitive\_cnh                              | Has a definitive CNH                                                                                                                                            | Checks if driver has a permanent license.                                                                                                                                                                                                                         |
| has\_no\_class\_organizations                     | Verification of relationship with class boards                                                                                                                  | Checks whether the document is linked to professional associations.                                                                                                                                                                                               |
| has\_no\_criminal\_background                     | Advance criminal police (Civil + Federal)                                                                                                                       | Checks if the document has criminal records/background.                                                                                                                                                                                                           |
| has\_no\_criminal\_background\_federal            | Federal Police criminal background check                                                                                                                        | Checks if the document has any criminal records/background with the federal police.                                                                                                                                                                               |
| has\_no\_criminal\_processes                      | Criminal Proceedings                                                                                                                                            | Checks if the document is linked to criminal proceedings.                                                                                                                                                                                                         |
| has\_no\_defendant\_processes                     | Defendant in lawsuits                                                                                                                                           | Checks if the document is linked to proceedings as a defendant.                                                                                                                                                                                                   |
| has\_no\_ibope\_income                            | Ibope Income Verification                                                                                                                                       | Checks the Ibope income of a document.                                                                                                                                                                                                                            |
| has\_no\_inconsistent\_data                       | There is no inconsistency in the data for consultation with the Federal Police.                                                                                 | Checks for inconsistencies in the data sent for consultation.                                                                                                                                                                                                     |
| has\_no\_labor\_debts                             | Has a negative labor debt certificate                                                                                                                           | Checks if there are any labor debts.                                                                                                                                                                                                                              |
| has\_no\_media\_exposure                          | Media exposure                                                                                                                                                  | Checks if the document holder has media exposure.                                                                                                                                                                                                                 |
| has\_no\_participant\_antt                        | ANTT Enabled Transporter                                                                                                                                        | Checks the ANTT (National Land Transport Agency) website to see if the vehicle and person/company consulted are authorized to carry out the activity.                                                                                                             |
| has\_no\_participant\_cvm                         | Checks if the consulted CPF/CNPJ is registered with the CVM                                                                                                     | Checks if the participant is registered with the CMV (Securities Commission).                                                                                                                                                                                     |
| has\_no\_pep                                      | Political exposure                                                                                                                                              | Checks whether the bearer of the document has political exposure.                                                                                                                                                                                                 |
| has\_no\_pep\_department                          | Checking Departments in the PEP history                                                                                                                         | Checks whether politically exposed persons fall within the defined departments.                                                                                                                                                                                   |
| has\_no\_pep\_or\_sanctions\_compliance\_owners   | Verification of PEPs or sanctions on the partners of a company                                                                                                  | Checks for PEPs or sanctions on a company's partners.                                                                                                                                                                                                             |
| has\_no\_personal\_relationships\_trust\_rl       | Related people + Trust Monitor's restrictive lists                                                                                                              | Checks if people related to the CPF (Individuals Register) are present in Trust Monitor's restrictive lists.                                                                                                                                                      |
| has\_no\_processes                                | Processes                                                                                                                                                       | Checks if the document is linked to processes.                                                                                                                                                                                                                    |
| has\_no\_processes\_active\_party                 | Processes - active party                                                                                                                                        | Checks if the document is linked to processes as an active party.                                                                                                                                                                                                 |
| has\_no\_processes\_other\_party                  | Processes - other parties                                                                                                                                       | Checks if the document is linked to legal processes as other parties.                                                                                                                                                                                             |
| has\_no\_processes\_passive\_party                | Processes - passive party                                                                                                                                       | Checks if the document is linked to legal processes as a passive party.                                                                                                                                                                                           |
| has\_no\_sanctions                                | Presence on sanction lists                                                                                                                                      | Checks that no sanctions have been found in restrictive lists.                                                                                                                                                                                                    |
| has\_no\_sintegra\_record                         | Company Stegra Data                                                                                                                                             | Checks if a company is registered.                                                                                                                                                                                                                                |
| has\_no\_total\_share                             | Does not have a participation percentage                                                                                                                        | Checks if the participation percentage has a valid value.                                                                                                                                                                                                         |
| has\_penalties\_on\_cvm                           | Invalidate if you have temporary penalties with the CVM.                                                                                                        | Checks whether the participant is temporarily barred from acting before the CVM (Securities Commission).                                                                                                                                                          |
| has\_process\_on\_cade                            | Check if you have procedural protocols with CADE.                                                                                                               | Checks if you have any procedural protocols with CADE (Administrative Council for Economic Defense).                                                                                                                                                              |
| has\_processes\_keywords                          | Processes with keywords                                                                                                                                         | Checks for keywords in processes.                                                                                                                                                                                                                                 |
| has\_salary\_information                          | Invalidate if estimated income information is not found                                                                                                         | Checks if information on estimated income has been found.                                                                                                                                                                                                         |
| invalid\_range\_ages                              | Age ranges not accepted.                                                                                                                                        | Checks if the document holder is of an age within the configured ranges.                                                                                                                                                                                          |
| invalid\_zip\_code                                | The ZIP code entered is valid.                                                                                                                                  | Checks if the provided CEP (ZIP code) is valid.                                                                                                                                                                                                                   |
| is\_between\_two\_and\_four\_salaries             | Invalidate if estimated income is between two and four minimum wages                                                                                            | Checks if the estimated income is between two (02) and four (04) minimum wages.                                                                                                                                                                                   |
| is\_biometrics\_approved                          | Low facial biometrics similarity                                                                                                                                | Checks whether the similarity of the selfie found in the database is below the confidence threshold configured in the profile template.                                                                                                                           |
| is\_cnh                                           | CNH                                                                                                                                                             | Checks that the document sent is a CNH (Brazilian driver's license).                                                                                                                                                                                              |
| is\_company\_lifetime\_greater\_than\_six\_months | A company from SC with less than 6 months since its opening                                                                                                     | Checks if the lifespan of an SC company is longer than 6 months.                                                                                                                                                                                                  |
| is\_cpf\_regular                                  | Regular CPF                                                                                                                                                     | Checks the regularity of the document.                                                                                                                                                                                                                            |
| is\_document\_liveness\_colored\_copy\_doc        | Invalidate if the document is identified as a colored photocopy.                                                                                                | Checks if the document is a color photocopy.                                                                                                                                                                                                                      |
| is\_document\_liveness\_grayscale\_copy\_doc      | Invalidate if the document is identified as a black and white photocopy.                                                                                        | Checks if the document is a black and white photocopy.                                                                                                                                                                                                            |
| is\_document\_liveness\_screen\_photo\_doc        | Invalidate if the document is identified as a screen photo.                                                                                                     | Checks if the document is a screenshot.                                                                                                                                                                                                                           |
| is\_less\_than\_two\_salaries                     | Invalidate if estimated income is less than two minimum wages                                                                                                   | Checks if the estimated income is less than two (02) minimum wages.                                                                                                                                                                                               |
| is\_literate                                      | Invalidate if the document belongs to an illiterate person                                                                                                      | Checks if the person is literate.                                                                                                                                                                                                                                 |
| is\_more\_than\_four\_salaries                    | Invalidate if estimated income is above four minimum wages                                                                                                      | Checks if the estimated income is above four (04) minimum wages.                                                                                                                                                                                                  |
| is\_not\_alive                                    | Invalidate if the registration status is deceased.                                                                                                              | Checks if the document belongs to a deceased holder.                                                                                                                                                                                                              |
| is\_not\_cancelled                                | Invalidate if registration status is canceled.                                                                                                                  | Checks if the document is canceled with the Federal Revenue.                                                                                                                                                                                                      |
| is\_not\_ctps                                     | Document should not be a work card                                                                                                                              | Checks if the document is not a work card.                                                                                                                                                                                                                        |
| is\_not\_deepfake                                 | The selfie sent does not present characteristics indicative of deepfake.                                                                                        | Checks if the selfie sent is not a deepfake.                                                                                                                                                                                                                      |
| is\_not\_expired\_passport                        | Check passport validity.                                                                                                                                        | Checks if the passport presented is valid.                                                                                                                                                                                                                        |
| is\_not\_me\_company                              | Not a Micro Company (ME)                                                                                                                                        | Checks if the company size is not ME (Individual Microentrepreneur) according to the Federal Revenue.                                                                                                                                                             |
| is\_not\_null                                     | Invalidate if registration status is null.                                                                                                                      | Checks if the document is listed as null and void with the Federal Revenue.                                                                                                                                                                                       |
| is\_not\_passport                                 | Document is not a passport                                                                                                                                      | Checks if the document sent is not a passport.                                                                                                                                                                                                                    |
| is\_not\_pendant\_of\_regularization              | Invalidate if the registration status is pending adjustment.                                                                                                    | Checks if the document is pending regularization.                                                                                                                                                                                                                 |
| is\_not\_suspended                                | Invalidate if registration status is suspended.                                                                                                                 | Checks if the document is listed as suspended with the Federal Revenue.                                                                                                                                                                                           |
| is\_on\_ofac\_sanctions\_list                     | Invalidate if sanctions are found with OFAC                                                                                                                     | Checks if there are records in OFAC (Office of Foreign Assets Control) for the given name.                                                                                                                                                                        |
| is\_passport                                      | passport                                                                                                                                                        | Checks if the document sent is a passport.                                                                                                                                                                                                                        |
| is\_prevented\_from\_betting                      | Checks whether the person is legally prohibited from placing bets, that is, if they have ties to the sports sector, betting houses, or the Ministry of Finance. | Checks if the person is barred from betting.                                                                                                                                                                                                                      |
| is\_readable                                      | Legible document                                                                                                                                                | Checks if the images uploaded are legible.                                                                                                                                                                                                                        |
| is\_sport\_related\_person                        | Verifies if the individual is related to sports                                                                                                                 | Checks if the individual is related to sports.                                                                                                                                                                                                                    |
| issued\_over\_16\_years                           | Under the age of 16 as of the date of issue                                                                                                                     | Checks if the difference between the date of birth and the issue of the identification document is greater than or equal to 16 years.                                                                                                                             |
| its\_on\_deny\_list                               | Private list of restrictions                                                                                                                                    | Checks presence on the private restrictions list.                                                                                                                                                                                                                 |
| liveness\_approved                                | Liveness approved                                                                                                                                               | Checks if the liveness has been approved.                                                                                                                                                                                                                         |
| liveness\_double\_check                           | Double check Liveness                                                                                                                                           | Send the selfie for a manual anti-spoofing check.                                                                                                                                                                                                                 |
| liveness\_manual\_revision                        | Liveness manual review                                                                                                                                          | Send the selfie for a manual anti-spoofing check.                                                                                                                                                                                                                 |
| minimum\_company\_lifetime                        | Minimum company lifespan                                                                                                                                        | Checks if the company's lifetime is longer than the minimum required.                                                                                                                                                                                             |
| ocr\_equals\_parameters                           | Comparison of all data entered in the parameters vs OCR                                                                                                         | Checks if the data entered in the parameters is the same as that read by the OCR.                                                                                                                                                                                 |
| ocr\_equals\_parameters\_data                     | Comparison of data entered in the parameters vs OCR (Name, CPF and Date of Birth - Selectable data)                                                             | Checks if the data entered in the parameters is the same as that read by the OCR.                                                                                                                                                                                 |
| ocr\_equals\_receita                              | Comparison of data returned by the Federal Revenue Service vs OCR                                                                                               | Checks if the data from the Federal Revenue is the same as that read by the OCR.                                                                                                                                                                                  |
| over\_14                                          | Greater than 14                                                                                                                                                 | Checks if the document holder is over 14 years old.                                                                                                                                                                                                               |
| over\_16                                          | Greater than 16                                                                                                                                                 | Checks if the document holder is over 14 years old.                                                                                                                                                                                                               |
| over\_18                                          | Age of majority                                                                                                                                                 | Checks if the document holder is of legal age (18).                                                                                                                                                                                                               |
| over\_21                                          | Greater than 21                                                                                                                                                 | Checks if the document holder is over 21 years old.                                                                                                                                                                                                               |
| parameters\_and\_document\_are\_equal             | Diverging data (CPF parameter vs CPF OCR)                                                                                                                       | Checks for discrepancies between document and manually entered data.                                                                                                                                                                                              |
| parameters\_and\_document\_undefined\_or\_equal   | Divergent or non-existent data (Parameter CPF vs OCR CPF)                                                                                                       | Checks for non-existence or divergence between document data and manually entered data.                                                                                                                                                                           |
| parameters\_equals\_receita                       | Comparison of data returned by the Federal Revenue Service vs. data provided in the parameters                                                                  | Checks if the data from Federal Revenue is the same as that entered in the parameters.                                                                                                                                                                            |
| private\_faceset\_not\_contains\_face             | Private bank                                                                                                                                                    | Checks if the selfie sent corresponds to one of the selfies registered in the Private Face Bank.                                                                                                                                                                  |
| public\_service\_history                          | Public service history.                                                                                                                                         | Checks if the document consulted has a civil service history.                                                                                                                                                                                                     |
| qsa\_consistent                                   | Complete and compatible QSA                                                                                                                                     | Checks if the QSA entered in attributes is the same as that obtained from the Federal Revenue query.                                                                                                                                                              |
| qsa\_pj\_data\_not\_empty                         | The company has registered partners.                                                                                                                            | Checks if the corporate structure is disclosed by the Federal Revenue.                                                                                                                                                                                            |
| qsa\_with\_company\_partner                       | The company has a Legal Person in its corporate structure.                                                                                                      | Checks if the company has a legal entity on its board of directors.                                                                                                                                                                                               |
| rg\_has\_cpf                                      | RG has a CPF                                                                                                                                                    | Checks if the RG (Brazilian identity card) has a CPF (Individuals Register).                                                                                                                                                                                      |
| rg\_issue\_less\_than\_25                         | Verification of RGs under 25                                                                                                                                    | Checks if the RG (Brazilian identity card) was issued less than 25 years ago.                                                                                                                                                                                     |
| selfie\_is\_not\_similar                          | The selfie sent is not similar to any of the images from previous transactions.                                                                                 | Checks the similarity of the selfie with the private base of previously transacted selfies.                                                                                                                                                                       |
| shared\_faceset\_not\_contains\_face              | Shared Face Bank                                                                                                                                                | Checks if the selfie sent matches one of the selfies registered in the Shared Face Bank.                                                                                                                                                                          |
| valid\_cnh\_registration\_number                  | Valid CNH registration number                                                                                                                                   | Checks if the CNH (Brazilian driver's license) registration number is valid.                                                                                                                                                                                      |
| valid\_cpf\_number                                | Valid CPF number                                                                                                                                                | Checks if the CPF (Individuals Register) number is valid.                                                                                                                                                                                                         |
| valid\_issue\_date                                | Valid Issue Date                                                                                                                                                | Checks if the document's issue date is valid.                                                                                                                                                                                                                     |
| valid\_issue\_state                               | Valid state of the issuing authority                                                                                                                            | Checks if the UF (Federative Unit) of the issuing body is valid.                                                                                                                                                                                                  |
| valid\_rg\_issue\_authority                       | Valid ID issuer                                                                                                                                                 | Checks that the issuing body of the RG (Brazilian identity card) is valid.                                                                                                                                                                                        |
| valid\_rg\_number                                 | Valid ID number                                                                                                                                                 | Checks if the Document number on the RG/CIN (Brazilian identity card) is valid.                                                                                                                                                                                   |
| vehicle\_has\_pending\_traffic\_violations        | Invalidate if pending traffic violations are found for the vehicle                                                                                              | Checks if the vehicle has any outstanding infractions.                                                                                                                                                                                                            |
| vehicle\_has\_traffic\_violations                 | Invalidate if violations are found for the vehicle                                                                                                              | Checks if the vehicle has any infractions with Denatran(National Transit Departament) in the last 365 days.                                                                                                                                                       |
| verifai\_smart\_ocr\_address\_completeness        | Address Completeness                                                                                                                                            | Checks whether the document address is complete (street, number, postal code, neighborhood and city). Part of the [Verif AI Smart OCR](/caf-api/connect/transactions/services/verif-ai-smart-ocr) service.                                                        |
| verifai\_smart\_ocr\_document\_holder             | Document Holder                                                                                                                                                 | Checks whether the document belongs to the expected holder by comparing the extracted name and/or CPF with `attributes.holderName` / `attributes.holderCpf`. Part of the [Verif AI Smart OCR](/caf-api/connect/transactions/services/verif-ai-smart-ocr) service. |
| verifai\_smart\_ocr\_document\_validity           | Document Validity                                                                                                                                               | Checks whether the document was issued within the configured maximum validity window, using `attributes.analysisDate` as reference date. Part of the [Verif AI Smart OCR](/caf-api/connect/transactions/services/verif-ai-smart-ocr) service.                     |
| verifai\_smart\_ocr\_required\_fields             | Required Fields                                                                                                                                                 | Checks that all fields listed in `requiredTerms` (configured per document class in the template) are present in the extraction. Part of the [Verif AI Smart OCR](/caf-api/connect/transactions/services/verif-ai-smart-ocr) service.                              |

{% hint style="info" %}
The four `verifai_smart_ocr_*` rules are produced exclusively by the **Verif AI Smart OCR** service. For full behavior details, accepted status values, and configuration options, see the dedicated service page:
{% endhint %}


# Manual reprovals

Transactions that are identified in the flow as not likely to have a completion will be manually reproved by our support team. The cases will be reproved with a special field in the document called `manualReprovalReasons`.

## List of manual reproval reasons

| Code | Reason (API response)                                                                             | Description                                                                                    |
| ---- | ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| 10   | Parâmetros necessários não informados                                                             | Required parameters not informed                                                               |
| 30   | Menor de 16 anos                                                                                  | Under 16 years old                                                                             |
| 31   | Foram encontrados protestos                                                                       | Disputes were found                                                                            |
| 32   | Foram encontrados processos                                                                       | Processes were found                                                                           |
| 50   | Documento ilegível: qualidade da foto está ruim                                                   | Illegible documents: photo quality is poor                                                     |
| 51   | Documento ilegível: apresenta recorte na foto                                                     | Illegible documents: has clipping in the photo                                                 |
| 52   | Documento ilegível: apresenta obstrução na imagem (invólucro plástico, reflexo, adesivos, etc...) | Illegible documents: has obstruction on image (plastic wrapping, reflection, stickers, etc...) |
| 60   | CPF enviado como parâmetro diverge do documento                                                   | CPF sent as a parameter deviates from the document                                             |
| 61   | Envio não possui as fotos necessárias para análise (Frente)                                       | Submission does not have the photos needed for analysis (Front)                                |
| 62   | Envio não possui as fotos necessárias para análise (Verso)                                        | Submission does not have the photos required for analysis (Back)                               |
| 63   | Algum dado informado no parâmetro de entrada diverge do documento                                 | Some data informed in the input parameter deviates from the document                           |
| 70   | Documento não suportado                                                                           | Unsupported document                                                                           |
| 71   | Documento inválido                                                                                | Invalid document                                                                               |
| 72   | Formato de arquivo não suportado                                                                  | File format not supported                                                                      |
| 80   | CPF inválido                                                                                      | Invalid CPF                                                                                    |
| 81   | CNPJ inválido                                                                                     | Invalid CNPJ                                                                                   |
| 82   | Data de nascimento do documento está divergente com a dos dados oficiais                          | Date of birth of the document is divergent from the official data                              |
| 83   | CPF não informado                                                                                 | CPF not informed                                                                               |
| 84   | CNPJ não informado                                                                                | CNPJ not informed                                                                              |
| 90   | Menor de 18 anos                                                                                  | Under 18 years old                                                                             |
| 91   | A selfie não é similar ao documento                                                               | The selfie is not similar to the document                                                      |
| 92   | Reprovado pelo liveness                                                                           | Reproved by liveness                                                                           |
| 93   | CPF irregular na Receita Federal                                                                  | CPF irregular at Receita Federal                                                               |
| 94   | O nome identificado no documento não condiz com o cadastro da Receita Federal                     | The name identified on the document does not match the IRS registry                            |
| 95   | A face foi encontrada na base compartilhada de suspeitos                                          | The face was found in the suspects' shared base                                                |
| 96   | Pessoa politicamente exposta                                                                      | Politically exposed person                                                                     |

## Example of API response

```json
{
  "_id": "xxxxxxxxxxxxxxxxxxxxxxxx",
  "status": "REPROVED",
  "manualReprovalReasons": [
    {
      "code": "50",
      "reason": "Documento ilegível: qualidade da foto está ruim"
    }
  ],
  ...
}
```


# Services

Services are resources that can be used in a transaction to obtain information and perform validations based on the images (document and selfie) submitted.

#### Available services:

{% content-ref url="/pages/fRNuSsRw1mKnsgOJDTSm" %}
[Document OCR](/caf-api/connect/transactions/services/document-ocr)
{% endcontent-ref %}

{% content-ref url="/pages/WcY4GlNvucMjuv32w74G" %}
[Documentscopy](/caf-api/connect/transactions/services/documentscopy)
{% endcontent-ref %}

{% content-ref url="/pages/vEj00YpcLsdPRqx7iqg5" %}
[Facematch](/caf-api/connect/transactions/services/facematch)
{% endcontent-ref %}

{% content-ref url="/pages/TRZQk6LcqImSyMLWXMV3" %}
[Facial Biometrics](/caf-api/connect/transactions/services/facial-biometrics)
{% endcontent-ref %}

{% content-ref url="/pages/URMc7dSlKeS3pFB4xojG" %}
[Deepfake Detection](/caf-api/connect/transactions/services/deepfake-detection)
{% endcontent-ref %}

{% content-ref url="/pages/tiAnOpI1zMTy72gKd66c" %}
[Image Similarity Check](/caf-api/connect/transactions/services/image-similarity-check)
{% endcontent-ref %}

{% content-ref url="/pages/NfDzeFx25vCCWDzYiKNI" %}
[VerifAI Smart OCR](/caf-api/connect/transactions/services/verif-ai-smart-ocr)
{% endcontent-ref %}


# Document OCR

Optical Character Recognition - extraction of data from submitted documents.

**Section**: `ocr`

**Required files:** `any document images`

#### Specific attributes (RG)

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

| Attribute              | Type   | Description              |
| ---------------------- | ------ | ------------------------ |
| federativeUnit         | String | State                    |
| rg                     | String | RG                       |
| via                    | String |                          |
| issueDate              | String | Date of Issue            |
| name                   | String | Name                     |
| fatherName             | String | Father's name            |
| motherName             | String | Mother's name            |
| birthPlace             | String | Place of birth           |
| birthDate              | String | Date of birth            |
| referenceDocument      | String | Document Source          |
| cpf                    | String | CPF                      |
| issueState             | String | State of Issue           |
| issuingAuthority       | String | Issuing Agency           |
| rgIssuingAuthority     | String | RG Issuing Agency        |
| rgIssueState           | String | State of RG Issue        |
| department             | String | Department               |
| documentTypeRgFront    | String | Document Type            |
| footerRgBack           | String | Footer RG back           |
| graphicName            | String | Graphic Name             |
| headerRgFront          | String | Header RG front          |
| institute              | String | Institute                |
| issuingAuthorityHeader | String | Issuing Authority Header |
| lawRgBack              | String | Law Rg back              |
| parentsSeparator       | String | ParentsSeparator         |
| {% endtab %}           |        |                          |

{% tab title="Example" %}

```json
{
  "ocr": {
    "federativeUnit": "ESTADO DA BAHIA",
    "rg": "00.000.000-00",
    "via": "",
    "issueDate": "13/04/2015",
    "name": "JANE DOE",
    "fatherName": "JOHN DOE",
    "motherName": "MARIA DOE",
    "birthPlace": "JAGUAQUARA BA",
    "birthDate": "25/02/1952",
    "referenceDocument": "C.NAS. CM JAGUAQUARA BA",
    "cpf": "00000000000",
    "issueState": "BA",
    "issuingAuthority": "SSP",
    "rgIssuingAuthority": "SSP",
    "rgIssueState": "BA",
    "department": "SPTC / DEPARTAMENTO DE IDENTIFICACAO",
    "documentTypeRgFront": "CARTEIRA DE IDENTIDADE",
    "footerRgBack": "",
    "graphicName": "THOMAS GREG & SONS",
    "headerRgFront": "REPUBLICA FEDERATIVA DO BRASIL",
    "institute": "POLICIA CIVIL",
    "issuingAuthorityHeader": "SECRETARIA DE ESTADO DE SEGURANCA PUBLICA",
    "lawRgBack": "LEI NO 7.116 DE 29/08/83",
    "parentsSeparator": "E"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                            | Description                                                                                                                                                       |
| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| is\_readable                                    | Checks that the documents are legible                                                                                                                             |
| is\_cnh                                         | Verifies if the document sent is a CNH                                                                                                                            |
| has\_cpf                                        | Checks whether the transaction has a CPF (read by the OCR or entered manually)                                                                                    |
| cnh\_has\_valid\_date                           | Checks that the expiry date of the CNH is not expired                                                                                                             |
| valid\_issue\_date                              | Checks that the document's issue date is valid.                                                                                                                   |
| valid\_cpf\_number                              | Verifies if the CPF number is valid                                                                                                                               |
| valid\_rg\_number                               | Check that the ID number is valid.                                                                                                                                |
| valid\_cnh\_registration\_number                | Check that the CNH registration number is valid.                                                                                                                  |
| valid\_rg\_issue\_authority                     | Check that the issuing body of the ID card is valid.                                                                                                              |
| valid\_issue\_state                             | Checks that the UF of the body issuing the document is valid.                                                                                                     |
| parameters\_and\_document\_are\_equal           | Checks for discrepancies between the data in the document and that entered manually.                                                                              |
| ocr\_equals\_parameters                         | The rule will be invalid if the information provided in the parameters and read by the OCR are different.                                                         |
| rg\_issue\_less\_than\_25                       | The rule will be invalid if the RG document type was issued more than 25 years ago.                                                                               |
| is\_literate                                    | The rule will be invalid if the OCR identifies that the document belongs to a non-literate person.                                                                |
| rg\_has\_cpf                                    | The rule will be invalid if the RG document type does not have the CPF field filled.                                                                              |
| company\_qsa\_data\_compatibility               | The rule will be invalid if the name and CPF of the partners sent in the PJ onboarding are different from those in the PF onboarding.                             |
| data\_and\_document\_are\_equal                 | The rule will be invalid if there is a discrepancy between the parameter information and the OCR.                                                                 |
| has\_cnh\_for\_more\_than\_three\_years         | The rule will be invalid if the driver has less than 3 years of licensing.                                                                                        |
| has\_definitive\_cnh                            | The rule will be invalid if the driver does not have a permanent license.                                                                                         |
| document\_issue\_less\_than\_10                 | The rule will be invalid if the document was issued more than 10 years ago.                                                                                       |
| issued\_over\_16\_years                         | Checks that the difference between the date of birth and the issue of the ID document is greater than or equal to 16 years.                                       |
| first\_and\_last\_name\_similarity              | Checks the similarity between the union of the first and last name sent in the parameters compared to the union of the first name and each surname in the source. |
| is\_passport                                    | The rule will be invalid if the document is not a passport.                                                                                                       |
| is\_not\_passport                               | The rule will be invalid if the document is a passport.                                                                                                           |
| is\_not\_ctps                                   | The rule will be invalid if the document is not a work permit.                                                                                                    |
| document\_is\_known                             | The rule will be invalid if the document is categorized as "others", "null", or "invalid".                                                                        |
| parameters\_and\_document\_undefined\_or\_equal | Checks for non-existence or divergence between document data and manually entered data.                                                                           |
| invalid\_range\_ages                            | Checks that the CPF holder is within the configured age range.                                                                                                    |
| ocr\_over\_18                                   | Checks that the age on the document is less than 18 years old.                                                                                                    |
| {% endtab %}                                    |                                                                                                                                                                   |
| {% endtabs %}                                   |                                                                                                                                                                   |

#### Specific attributes (CNH)

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

| Attribute              | Type   | Description                         |
| ---------------------- | ------ | ----------------------------------- |
| birthDate              | String | Date of birth                       |
| cpf                    | String | CPF                                 |
| name                   | String | Name                                |
| motherName             | String | Mother's Name                       |
| fatherName             | String | Father's Name                       |
| issueDate              | String | Date of issue                       |
| rg                     | String | RG                                  |
| rgIssueState           | String | RG Issuing State                    |
| rgIssuingAuthority     | String | RG issuing agency                   |
| acc                    | String | Moped Permit                        |
| category               | String | Driver's license category           |
| firstDriverLicenseDate | String | Date of your first driver's license |
| placeOfIssue           | String | Place where CNH was issued          |
| mirrorNumber           | String | CNH mirror number                   |
| registrationNumber     | String | CNH registration number             |
| renachNumber           | String | RENACH number                       |
| securityNumber         | String | Security number                     |
| notes                  | String | Observations                        |
| expirationDate         | String | Expiration date                     |
| cnhIssueState          | String | CNH issue state                     |
| {% endtab %}           |        |                                     |

{% tab title="Example" %}

```json
{
  "ocr": {
    "name": "JANE DOE",
    "rg": "00XXXXXXX99",
    "rgIssuingAuthority": "SSP",
    "rgIssueState": "RS",
    "cpf": "00000000000",
    "birthDate": "08/05/1999",
    "fatherName": "JOHN DOE",
    "motherName": "MARIA DOE",
    "acc": "",
    "category": "AB",
    "registrationNumber": "06XXXXXXX02",
    "expirationDate": "07/05/2032",
    "firstDriverLicenseDate": "26/07/2017",
    "mirrorNumber": "23XXXXXX51",
    "notes": "",
    "placeOfIssue": "PORTO ALEGRE, RS",
    "issueDate": "07/05/2022",
    "securityNumber": "02XXXXXXX60",
    "renachNumber": "RSXXXXXX070",
    "cnhIssueState": "RS"
  }
}
```

{% endtab %}
{% endtabs %}

#### Specific attributes (CRLV)

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

| Attribute              | Type   | Description              |
| ---------------------- | ------ | ------------------------ |
| issueState             | String | Issue state              |
| crlvNumber             | String | CRLV number              |
| via                    | String | Via                      |
| renavamCode            | String | Renavam code             |
| rntrc                  | String | rntrc                    |
| assignmentYear         | String | Assignment year          |
| name                   | String | Name                     |
| cpf                    | String | CPF                      |
| cnpj                   | String | CNPJ                     |
| plate                  | String | Plate                    |
| previousPlateAndState  | String | Previous plate and state |
| chassis                | String | Chassis                  |
| type                   | String | Type                     |
| fuel                   | String | Fuel                     |
| brandAndMovel          | String | Brand and Movel          |
| manufactureYear        | String | Manufacture Year         |
| modelYear              | String | Model year               |
| capacityPowerCylinders | String | Capacity power cylinders |
| category               | String | Category                 |
| predominantColor       | String | PredominantColor         |
| issueDate              | String | Issue date               |
| {% endtab %}           |        |                          |

{% tab title="Example" %}

```json
{
  "ocr": {
    "issueState": "SC",
    "crlvNumber": "00000000000000",
    "via": "",
    "renavamCode": "00000000000",
    "rntrc": "",
    "assignmentYear": "2017",
    "name": "CAF",
    "cpf": "",
    "cnpj": "0000000000000000",
    "plate": "00000",
    "previousPlateAndState": "000000",
    "chassis": "000000000000000000000000",
    "type": "PAS/AUTOMOVEL",
    "fuel": "",
    "brandAndModel": "VW/VOYAGE CL MB",
    "manufactureYear": "2014",
    "modelYear": "2015",
    "capacityPowerCylinders": "5P/104CV",
    "category": "ALCO/GASOL OFICIAL",
    "predominantColor": "PRATA",
    "issueDate": "20/07/2017"
  }
}
```

{% endtab %}
{% endtabs %}

#### Specific attributes (CTPS)

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

| Attribute         | Type   | Description        |
| ----------------- | ------ | ------------------ |
| pisPasep          | String | Pis Pasep          |
| documentNumber    | String | Document Number    |
| documentSeries    | String | Document Series    |
| federativeUnit    | String | Federative Unit    |
| name              | String | Name               |
| motherName        | String | Mother name        |
| fatherName        | String | Father name        |
| birthDate         | String | Birth date         |
| maritalStatus     | String | Marital Status     |
| referenceDocument | String | Reference Document |
| cpf               | String | CPF                |
| issuePlace        | String | Issue Place        |
| issueDate         | String | Issue Date         |
| {% endtab %}      |        |                    |

{% tab title="Example" %}

```json
{
  "ocr": {
    "pisPasep": "0000000000000",
    "documentNumber": "00000000",
    "documentSeries": "0000",
    "federativeUnit": "MG",
    "name": "JANE DOE",
    "motherName": "JOHN DOE",
    "fatherName": "MARIA DOE",
    "birthDate": "02/08/1979",
    "maritalStatus": "SOLTEIRO",
    "birthPlace": "BELO HORIZONTE - MG",
    "referenceDocument": "C. I. MG 000000 19/11/2004 PC MG",
    "cpf": "00000000000000",
    "issuePlace": "SRTE/MG -",
    "issueDate": "18/05/2015"
  }
}
```

{% endtab %}
{% endtabs %}

#### Specific attributes (RNE)

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

| Attribute        | Type   | Description       |
| ---------------- | ------ | ----------------- |
| birthDate        | String | Birth Date        |
| classification   | String | Classification    |
| entryDate        | String | Entry date        |
| fatherName       | String | Father name       |
| gender           | String | Gender            |
| issueDate        | String | Issue date        |
| issuingAuthority | String | Issuing Authority |
| legalProtection  | String | Legal protection  |
| motherName       | String | Mother name       |
| mrz              | String | MRZ               |
| name             | String | Name              |
| nationality      | String | Nationality       |
| nativeCountry    | String | Native Country    |
| rne              | String | RNE               |
| validity         | String | Validity          |
| via              | String | Via               |
| {% endtab %}     |        |                   |

{% tab title="Example" %}

```json
{
  "ocr": {
    "birthDate": "01/11/1988",
    "classification": "PERMANENTE",
    "entryDate": "31/08/2011",
    "fatherName": "JOHN DOE",
    "gender": "M",
    "issueDate": "17/11/2017",
    "issuingAuthority": "CGPI/DIREX/DPF",
    "legalProtection": "",
    "motherName": "MARIE DOE",
    "mrz": "",
    "name": "JAMES DEE",
    "nationality": "ANGOLANA",
    "nativeCountry": "ANGOLA",
    "rne": "0000000",
    "validity": "06/11/2026",
    "via": "1"
  }
}
```

{% endtab %}
{% endtabs %}

#### Specific attributes (RNM)

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

| Attribute        | Type   | Description       |
| ---------------- | ------ | ----------------- |
| birthDate        | String | Birth Date        |
| classification   | String | Classification    |
| cpf              | String | CPF               |
| fatherName       | String | Father name       |
| gender           | String | Gender            |
| issueDate        | String | Issue date        |
| issuingAuthority | String | Issuing Authority |
| legalProtection  | String | Legal protection  |
| motherName       | String | Mother name       |
| mrz              | String | MRZ               |
| name             | String | Name              |
| nationality      | String | Nationality       |
| protocol         | String | Protocol          |
| residenceTerm    | String | Resident Term     |
| rnm              | String | RNM               |
| validity         | String | Validity          |
| {% endtab %}     |        |                   |

{% tab title="Example" %}

```json
{
  "ocr": {
    "birthDate": "30/05/1989",
    "classification": "TEMPORARIO",
    "cpf": "0000000000",
    "fatherName": "MARIE DEE",
    "gender": "M",
    "issueDate": "22/01/2019",
    "issuingAuthority": "CGPI/DIREX/PF",
    "legalProtection": "ART. 14. I. LETRA C DA LEI 13.445/2017.",
    "motherName": "ROSEMOND DEE",
    "mrz": "<<<<<<<<< 000 <<<<<<<<<< 0 000",
    "name": "JEAN DEE",
    "nationality": "HAITI",
    "protocol": "",
    "residenceTerm": "22/10/2020",
    "rnm": "000000000",
    "validity": "22/10/2020"
  }
}
```

{% endtab %}
{% endtabs %}

#### Specific attributes (PASSPORT)

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

| Attribute        | Type   | Description       |
| ---------------- | ------ | ----------------- |
| birthDate        | String | Birth Date        |
| expirationDate   | String | Expiration date   |
| frontNumber      | String | Front number      |
| gender           | String | Gender            |
| issueDate        | String | Issue date        |
| issuingAuthority | String | Issuing authority |
| issuingCountry   | String | Issuing country   |
| motherName       | String | Mother name       |
| mrz              | String | MRZ               |
| name             | String | Name              |
| nationality      | String | Nationality       |
| naturality       | String | Nationality       |
| number           | String | Number            |
| type             | String | Type              |
| {% endtab %}     |        |                   |

{% tab title="Example" %}

```json
{
  "ocr": {
    "birthDate": "23/07/1982",
    "expirationDate": "05/06/2027",
    "fatherName": "JOSE DEE",
    "front_number": "000000",
    "gender": "M",
    "issueDate": "06/06/2017",
    "issuingAuthority": "DPF/CAS/SP",
    "issuingCountry": "BRA",
    "motherName": "MARIA DEE",
    "mrz": "0<000<000<000 << 000<000 <<<<<<<<<<<<<< 00000<000000 <<<<<<<<<<<<<< 00",
    "name": "JOSE DEE JUNIOR",
    "nationality": "BRASILEIRO(A)",
    "naturality": "MARILIA/SP",
    "number": "00000",
    "type": "P"
  }
}
```

{% endtab %}
{% endtabs %}

#### Specific attributes (NEW CRLV)

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

| Attribute              | Type   | Description              |
| ---------------------- | ------ | ------------------------ |
| assignmentYear         | String | Assignment year          |
| axles                  | String | Axles                    |
| body                   | String | Body                     |
| brandAndModel          | String | Brand and Model          |
| capacityInPeople       | String | Capacity in people       |
| capacityInWeight       | String | Capacity in Weight       |
| capacityPowerCylinders | String | Capacity power cylinders |
| cat                    | String | Cat                      |
| category               | String | Category                 |
| chassis                | String | Chassis                  |
| claSecurityNumber      | String | Cla security number      |
| cmt                    | String | CMT                      |
| cnpj                   | String | CNPJ                     |
| cpf                    | String | CPF                      |
| cpfMask                | String | CPF mask                 |
| crlvNumber             | String | CRLV number              |
| crvNumber              | String | CRV number               |
| fuel                   | String | Fuel                     |
| issueAuthority         | String | Issue authority          |
| issueDate              | String | Issue date               |
| issuePlace             | String | Issue place              |
| issueState             | String | Issue state              |
| manufactureYear        | String | Manufacture Year         |
| modelYear              | String | Model year               |
| motor                  | String | Motor                    |
| name                   | String | Name                     |
| plate                  | String | Plate                    |
| predominantColor       | String | Predominant color        |
| previousPlateAndState  | String | Previous plate and state |
| renavamCode            | String | Renavam code             |
| type                   | String | Type                     |
| vehicleObservations    | String | Vehicle observations     |
| {% endtab %}           |        |                          |

{% tab title="Example" %}

```json
{
  "ocr": {
    "assignmentYear": "",
    "axles": "3",
    "body": "NAO APLICAVEL CARROCERIA ABERTA",
    "brandAndModel": "SR/RANDON SR CA",
    "capacityInPeople": "00P",
    "capacityInWeight": "26.0",
    "capacityPowerCylinders": "0CV/****",
    "cat": "",
    "category": "BRANCA",
    "chassis": "00000000000000",
    "claSecurityNumber": "",
    "cmt": "*.*",
    "cnpj": "00000000000000",
    "cpf": "",
    "cpfMask": "",
    "crlvNumber": "",
    "crvNumber": "",
    "fuel": "",
    "issueAuthority": "DETRAN-GO",
    "issueDate": "06/04/2020",
    "issuePlace": "RIO VERDE GO",
    "issueState": "GO",
    "manufactureYear": "",
    "modelYear": "",
    "motor": "0000000000000",
    "name": "CAF",
    "plate": "",
    "predominantColor": "",
    "previousPlateAndState": "00000/MT",
    "renavamCode": "",
    "type": "SEMI-REBOQUE",
    "vehicleObservations": ""
  }
}
```

{% endtab %}
{% endtabs %}

#### Specific attributes (NEW CNH)

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

| Attribute                 | Type   | Description                 |
| ------------------------- | ------ | --------------------------- |
| name                      | String | Name                        |
| firstDriverLicenseDate    | String | First driver license date   |
| birthDate                 | String | Birth date                  |
| birthPlace                | String | Birth place                 |
| birthState                | String | Birth state                 |
| birthDateCityState        | String | Birth date, city and state  |
| issueDate                 | String | Issue date                  |
| expirationDate            | String | Expiration date             |
| acc                       | String | Acc                         |
| definitiveOrPermissionary | String | Definitive or permissionary |
| rg                        | String | RG                          |
| rgMask                    | String | RG mask                     |
| rgIssuingAuthority        | String | RG issuingAuthority         |
| rgIssueState              | String | RG issue state              |
| rgNumberAuthorityState    | String | RG number authority state   |
| cpf                       | String | CPF                         |
| cpfMask                   | String | CPF mask                    |
| registrationNumber        | String | Registration number         |
| category                  | String | Category                    |
| nationality               | String | Nationality                 |
| fatherName                | String | Father name                 |
| motherName                | String | Mother name                 |
| mirrorNumber              | String | Mirror number               |
| notes                     | String | Notes                       |
| placeOfIssue              | String | Place of issue              |
| securityNumber            | String | Security number             |
| renachNumber              | String | Renach number               |
| cnhIssueState             | String | CNH issue state             |
| {% endtab %}              |        |                             |

{% tab title="Example" %}

```json
{
  "ocr": {
    "name": "EDIO DEE",
    "firstDriverLicenseDate": "24/04/1985",
    "birthDate": "27/09/1966",
    "birthPlace": "BLUMENAU",
    "birthState": "SC",
    "birthDateCityState": "27/09/1966 BLUMENAU/SC",
    "issueDate": "30/06/2022",
    "expirationDate": "09/06/2027",
    "acc": "",
    "definitiveOrPermissionary": "D",
    "rg": "00000000",
    "rgMask": "9999999",
    "rgIssuingAuthority": "SSP",
    "rgIssueState": "SC",
    "rgNumberAuthorityState": "000000 SSP SC",
    "cpf": "00000000000",
    "cpfMask": "999.999.999-99",
    "registrationNumber": "0000000000000",
    "category": "AB",
    "nationality": "BRASILEIRO",
    "fatherName": "WALTER DEE",
    "motherName": "INGELORE DEE",
    "mirrorNumber": "000000000000000",
    "notes": "",
    "placeOfIssue": "FLORIANOPOLIS, SC",
    "securityNumber": "000000000000",
    "renachNumber": "SC00000000",
    "cnhIssueState": "SC"
  }
}
```

{% endtab %}
{% endtabs %}

#### Specific attributes (NEW RG)

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

| Attribute              | Type   | Description              |
| ---------------------- | ------ | ------------------------ |
| birthDate              | String | Birth date               |
| birthPlace             | String | Birth place              |
| cpf                    | String | CPF                      |
| cpfMask                | String | CPF mask                 |
| department             | String | Department               |
| documentTypeRgFront    | String | Document type RG front   |
| expirationDate         | String | Expiration date          |
| fatherName             | String | Father name              |
| federativeUnit         | String | Federative Unit          |
| footerRgBack           | String | Footer RG Back           |
| graphicName            | String | Graphic Name             |
| headerRgFront          | String | Header RG front          |
| institute              | String | Institute                |
| issueDate              | String | Issue date               |
| issueState             | String | Issue state              |
| issuingAuthority       | String | Issuing Authority        |
| issuingAuthorityHeader | String | Issuing Authority Header |
| lawRgBack              | String | Law RG back              |
| motherName             | String | Mother name              |
| name                   | String | Name                     |
| parentsSeparator       | String | Parents separator        |
| referenceDocument      | String | Reference Document       |
| rg                     | String | RG                       |
| rgIssueState           | String | RG issue state           |
| rgIssuingAuthority     | String | RG issue authority       |
| rgMask                 | String | RG mask                  |
| via                    | String | Via                      |
| {% endtab %}           |        |                          |

{% tab title="Example" %}

```json
{
  "ocr": {
    "birthDate": "27/07/1978",
    "birthPlace": "GUARULHOS - SP",
    "cpf": "00000000000",
    "cpfMask": "999999999/99",
    "department": "",
    "documentTypeRgFront": "CARTEIRA DE IDENTIDADE",
    "expirationDate": "01/01/2030",
    "fatherName": "JOHN DEE",
    "federativeUnit": "ESTADO DE SAO PAULO",
    "footerRgBack": "VAL",
    "graphicName": "VALI5",
    "headerRgFront": "REPUBLICA FEDERATIVA DO BRASIL",
    "institute": "INSTITUTO DE IDENTIFICACAO 'RICARDO GUMBLETON DAUNT'",
    "issueDate": "06/01/2020",
    "issueState": "SP",
    "issuingAuthority": "SSP-SP",
    "issuingAuthorityHeader": "SIPA SECRETARIA DA SEGURANCA PUBLICA",
    "lawRgBack": "LEINO 7.116, DE 29 DE AGOSTO DE 1983",
    "motherName": "MARIA DEE",
    "name": "REIS DEE",
    "parentsSeparator": "",
    "referenceDocument": "GUARULHOS - SP 1.SUBDISTRITO CC:LV.0000/0000 /N.00000",
    "rg": "0000000000",
    "rgIssueState": "SP",
    "rgIssuingAuthority": "SSP-SP",
    "rgMask": "99.999.999-9",
    "via": "2 via"
  }
}
```

{% endtab %}
{% endtabs %}


# Documentscopy

Documentoscopy is an advanced science for resolving any doubt of document fraud. Our algorithms compare the pattern of the submitted document with thousands of other documents from the same state and year of issue, looking for inconsistencies in more than 200 points of attention on the same document. Then it still has the approval of an expert.

This verification is already included in the "Combating Fraud product". For the other products, you can make an on-demand request to use this service.

**Section**: `documentscopy`

**Required files:** `any document images`

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

| Attribute                    | Type    | Description                                                                        |
| ---------------------------- | ------- | ---------------------------------------------------------------------------------- |
| status                       | String  | Status                                                                             |
| fraud                        | Boolean | Fraud identification                                                               |
| evaluation                   | Array   | Details of the evaluation. Available in case of failure by the documentary survey. |
| evaluation\[X].referenceCode | Number  | Description code                                                                   |
| evaluation\[X].message       | String  | Description                                                                        |
| reviewDate                   | String  | Date of the analysis                                                               |
| {% endtab %}                 |         |                                                                                    |

{% tab title="Example" %}

```json
{
  "documentscopy": {
    "status": "REPROVED",
    "fraud": false,
    "evaluation": [
      {
        "referenceCode": 1004,
        "message": "Spoofing de documento"
      }
    ],
    "reviewDate": "2022-12-22T10:58:25.681Z"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                     | Description                                                                      |
| ------------------------ | -------------------------------------------------------------------------------- |
| documentscopy\_available | The rule will be invalid if document analysis is unavailable.                    |
| documentscopy\_approved  | Verifies the authenticity of the document on the basis of documentary expertise. |
| {% endtab %}             |                                                                                  |
| {% endtabs %}            |                                                                                  |

### Reproval reasons

List of reproval reasons when a document is evaluated in Certta Documentscopy and can be reproved for one or more reasons.

#### 1. General rejections

| Reference Code | Reason (API response)                                                                                         | Description                                                                                                                  |
| -------------- | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| 1001           | Fotocópia preto e branco                                                                                      | Black and white photocopy                                                                                                    |
| 1002           | Fotocópia colorida                                                                                            | Color photocopy                                                                                                              |
| 1003           | Spoofing na selfie                                                                                            | Spoofing in the selfie                                                                                                       |
| 1004           | Spoofing de documento                                                                                         | Document Spoofing                                                                                                            |
| 1005           | Documento inválido                                                                                            | Invalid document                                                                                                             |
| 1006           | A selfie não é similar ao documento (facematch)                                                               | The selfie is not similar to the document                                                                                    |
| 1007           | Captura da selfie mal executada                                                                               | Poorly-executed selfie capture                                                                                               |
| 1008           | Falta frente ou verso do documento. Recomenda-se uma nova captura do documento.                               | The front or back of the document is missing. Recapture of the document is recommended                                       |
| 1009           | Documento vencido                                                                                             | Expired document                                                                                                             |
| 1010           | Frente e verso do documento não coincidem                                                                     | Front and back of document do not match                                                                                      |
| 1011           | Documento digital sem QR code                                                                                 | Digital document without QR code                                                                                             |
| 1012           | O documento se apresenta fora do padrão para o órgão emissor. Recomenda se a renovação do documento.          | The document does not meet the standard for the issuing body. It is recommended that the document be renewed.                |
| 1013           | RG Digital - Não é possível verificar a autenticidade do documento. Recomenda-se o envio do documento físico. | Digital ID - It is not possible to verify the authenticity of the document. It is recommended to send the physical document. |

#### 2. Rejections by illegibility

| Reference Code | Reason (API response)                                                                                                                   | Description                                                                                                                               |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| 2001           | O documento está desfocado e/ou apresenta pontos de ilegibilidade sobre algum campo.                                                    | The document is blurred and/or has points of illegibility on some field                                                                   |
| 2002           | O documento apresenta pontos de ilegibilidade sobre o campo CPF.                                                                        | The document has illegibility points over the CPF field                                                                                   |
| 2003           | O documento apresenta pontos de ilegibilidade sobre o campo RG.                                                                         | The document has illegibility points over the RG field                                                                                    |
| 2004           | O documento apresenta pontos de ilegibilidade sobre a perfuração.                                                                       | The document has illegibility points over drilling                                                                                        |
| 2005           | O documento apresenta pontos de ilegibilidade sobre o campo da data de expedição.                                                       | The document has illegibility points over the shipping date field                                                                         |
| 2006           | O documento apresenta pontos de ilegibilidade sobre o campo da data de nascimento.                                                      | The document has illegibility points over the date of birth field                                                                         |
| 2007           | O documento apresenta pontos de ilegibilidade sobre o campo do separador da filiação.                                                   | The document has illegibility points over the field of the parentage tab                                                                  |
| 2008           | O documento apresenta pontos de ilegibilidade sobre a escrita do estado emissor.                                                        | The document has illegibility points over the writing of the issuing state                                                                |
| 2009           | O documento apresenta pontos de ilegibilidade sobre a escrita do órgão emissor.                                                         | The document has points of illegibility over the writing of the issuing body                                                              |
| 2010           | O documento apresenta pontos de ilegibilidade sobre a escrita do departamento/instituto emissor.                                        | The document has points of illegibility on the writing of the issuing department/institute                                                |
| 2011           | O documento apresenta pontos de ilegibilidade sobre a imagem do brasão.                                                                 | The document has points of illegibility on the image of the coat of arms                                                                  |
| 2012           | O documento apresenta pontos de ilegibilidade sobre a assinatura do diretor.                                                            | The document has points of illegibility on the signature of the director                                                                  |
| 2013           | O documento apresenta pontos de ilegibilidade sobre o campo de documento de origem.                                                     | The document has points of illegibility on the source document field                                                                      |
| 2014           | O documento apresenta pontos de ilegibilidade sobre os mínimos gráficos.                                                                | The document has points of illegibility over the graphic minima                                                                           |
| 2015           | O documento apresenta a borda (talho doce) avariada.                                                                                    | The document has a damaged border (intaglio)                                                                                              |
| 2016           | O documento apresenta dano sobre algum campo.                                                                                           | The document has damage on some field                                                                                                     |
| 2017           | O documento apresenta rasura sobre algum campo.                                                                                         | The document has erasures over some field                                                                                                 |
| 2018           | O documento apresenta baixa resolução de captura causando algum ponto de ilegibilidade sobre o documento.                               | The document has a low capture resolution causing some point of illegibility on the document                                              |
| 2019           | O documento apresenta baixa resolução de captura causando ponto de ilegibilidades sobre os mínimos gráficos.                            | The document has a low resolution, causing an unreadable point on the smallest graphics                                                   |
| 2020           | O documento apresenta baixa resolução de captura causando ponto de ilegibilidade sobre a perfuração.                                    | The document presents low capture resolution causing point of illegibility over the perforation                                           |
| 2021           | Falta o verso do documento de identificação                                                                                             | The back of the ID document is missing                                                                                                    |
| 2022           | Falta a frente do documento de identificação                                                                                            | The front of the ID document is missing                                                                                                   |
| 2023           | A imagem de selfie enviada apresenta condições que impossibilitam a realização da análise                                               | The submitted selfie image has conditions that make it impossible to perform the analysis                                                 |
| 2024           | A foto do portador está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)                                | The photo of the bearer is blurred and/or presents illegibility points (reflection, erasure, cuts, etc.)                                  |
| 2025           | A perfuração está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)                                      | The perforation is blurred and/or has points of illegibility (reflection, erasure, cuts, etc.)                                            |
| 2026           | A assinatura do delegado está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)                          | Delegate's signature is blurred and/or has points of illegibility (reflection, erasure, nicks, etc.)                                      |
| 2027           | O brasão está desfocado e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)                                          | The coat of arms is blurred and/or has points of illegibility (reflection, erasure, nicks, etc.)                                          |
| 2028           | O nome do estado emissor está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)                          | The name of the issuing state is blurred and/or has points of illegibility (reflection, erasure, nicks, etc.)                             |
| 2029           | O departamento emissor está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)                            | The issuing department is blurred and/or has points of illegibility (reflection, erasure, nicks, etc.)                                    |
| 2030           | O instituto emissor está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)                               | The issuing institute is blurred and/or has points of illegibility (reflection, erasure, nicks, etc.)                                     |
| 2031           | O órgão emissor está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)                                   | The issuing agency is blurred and/or has points of illegibility (reflection, erasure, nicks, etc.)                                        |
| 2032           | O número de registro geral está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)                        | The general registration number is blurred and/or has points of illegibility (reflection, erasure, nicks, etc.)                           |
| 2033           | A data de nascimento está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)                              | Date of birth is blurred and/or has points of illegibility (reflection, erasure, nicks, etc.)                                             |
| 2034           | O número de CPF está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)                                   | CPF number is blurred and/or has points of illegibility (reflection, erasure, cuts, etc.)                                                 |
| 2035           | A data de expedição está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)                               | The date of issue is blurred and/or has points of illegibility (reflection, erasure, cuts, etc.)                                          |
| 2036           | A sigla que separa o nome do pai e da mãe está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)         | The initials separating the father's and mother's names are blurred and/or have points of illegibility (reflection, erasure, nicks, etc.) |
| 2037           | A naturalidade está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)                                    | The naturalness is blurred and/or has points of illegibility (reflection, erasure, nicks, etc.)                                           |
| 2038           | O documento de origem está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.)                             | Document of origin is blurred and/or has points of illegibility (reflection, erasure, cuts, etc.)                                         |
| 2039           | A foto do portador está desfocada e/ou apresenta pontos de ilegibilidade (reflexo, rasura, cortes, etc.) que impedem a análise de idade | The bearer's photo is blurred and/or has points of illegibility (reflection, erasure, cuts, etc.) that prevent age analysis               |
| 2040           | O documento apresenta ilegibilidade sobre o campo da assinatura do portador                                                             | The document shows illegibility in the holder's signature field                                                                           |
| 2041           | O documento apresenta ilegibilidade no campo da digital                                                                                 | The document shows illegibility in the fingerprint field                                                                                  |

#### 3. Rejections by fraud

| Reference Code | Reason (API response)                                                                                                                                                                                                                                      | Description                                                                                                                                                                                                                             |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 3001           | REGISTRO GERAL - A formatação do campo "REGISTRO GERAL" não apresenta as condições padrões para o estado e ano emissor                                                                                                                                     | GENERAL REGISTRATION - The formatting of the field "GENERAL REGISTRATION" does not present the standard conditions for the issuing state and year                                                                                       |
| 3002           | DATA EXPEDIÇÃO - A formatação do campo "DATA EXPEDIÇÃO" não apresenta as condições padrões para o estado e ano emissor                                                                                                                                     | EXPEDITION DATE - The formatting of the field "EXPEDITION DATE" does not present the standard conditions for the issuing state and year                                                                                                 |
| 3003           | DATA NASCIMENTO - A formatação do campo "DATA NASCIMENTO" não apresenta as condições padrões para o estado e ano emissor                                                                                                                                   | DATE OF BIRTH - The formatting of the field "DATE OF BIRTH" does not present the standard conditions for the issuing state and year                                                                                                     |
| 3004           | CPF - A formatação do campo "CPF" não apresenta as condições padrões para o estado e ano emissor                                                                                                                                                           | CPF - The formatting of the field "CPF" does not present the standard conditions for the issuing state and year                                                                                                                         |
| 3005           | DOC ORIGEM - A formatação do campo "DOC ORIGEM" não apresenta as condições padrões para o estado e ano emissor                                                                                                                                             | DOC ORIGIN - The formatting of the field "DOC ORIGIN" does not present the standard conditions for the state and year of issuance                                                                                                       |
| 3006           | SEPARADOR FILIAÇÃO - A formatação do "SEPARADOR FILIAÇÃO" apresenta irregularidades para o padrão do estado e ano emissor                                                                                                                                  | SONATION SEPARATOR - The formatting of the "SONATION SEPARATOR" presents irregularities for the standard of the state and issuing year                                                                                                  |
| 3007           | NATURALIDADE - A formatação do campo "NATURALIDADE" não apresenta as condições padrões para o estado e ano emissor                                                                                                                                         | NATURALITY - The formatting of the "NATURALITY" field does not meet the standard conditions for the issuing state and year                                                                                                              |
| 3008           | ESTADO EMISSOR - A nomenclatura utilizada para o campo "ESTADO EMISSOR" está irregular para o estado e ano emissor                                                                                                                                         | ISSUING STATE - The nomenclature used for the "ISSUING STATE" field is irregular for the issuing state and year                                                                                                                         |
| 3009           | DEPARTAMENTO/INSTITUTO - A nomenclatura utilizada para o campo "DEPARTAMENTO/INSTITUTO" emissor está irregular para o estado e ano emissor                                                                                                                 | DEPARTMENT/INSTITUTE - The nomenclature used for the field "ISSUING DEPARTMENT/INSTITUTE" is irregular for the issuing state and year                                                                                                   |
| 3010           | ALINHAMENTO RG - Alinhamentos do campo "RG" irregulares para o estado e ano emissor                                                                                                                                                                        | RG ALIGNMENT - Field "RG" field alignments are irregular for the issuing state and year                                                                                                                                                 |
| 3011           | ALINHAMENTO NOME - Alinhamentos do campo "NOME" irregulares para o estado e ano emissor                                                                                                                                                                    | ALIGNMENT NAME - field "NAME" field alignments are irregular for the issuing state and year                                                                                                                                             |
| 3012           | ALINHAMENTO DATA EXPEDIÇÃO - Alinhamentos do campo "DATA EXPEDIÇÃO" irregulares para o estado e ano emissor                                                                                                                                                | EXPEDITION DATE ALIGNMENT - Irregular "EXPEDITION DATE" field alignments for issuing state and year                                                                                                                                     |
| 3013           | ALINHAMENTO GRÁFICO - O documento apresenta "ALINHAMENTOS GRÁFICOS" irregulares para o estado e ano emissor                                                                                                                                                | GRAPHIC ALIGNMENT - Document has irregular "GRAPHIC ALIGNMENTS" for issuing state and year                                                                                                                                              |
| 3014           | EVOLUÇÃO CIVIL - A "EVOLUÇÃO CIVIL" do portador está irregular para o estado e ano emissor                                                                                                                                                                 | CIVIL EVOLUTION - The "CIVIL EVOLUTION" of the bearer is irregular for the state and year of issue                                                                                                                                      |
| 3015           | BRASÃO - O "BRASÃO" no documento não apresenta condições padrões para o estado e ano emissor                                                                                                                                                               | BRAZON - The "BRAZON" on the document does not present standard conditions for the state and year of issue                                                                                                                              |
| 3016           | PERFURAÇÃO - A "PERFURAÇÃO" do documento apresenta siglas e/ou condições irregulares para o estado e ano emissor                                                                                                                                           | PERFURATION - The "PERFURATION" on the document has irregular acronyms and/or conditions for the issuing state and year                                                                                                                 |
| 3017           | ASSINATURA DIRETOR - A "ASSINATURA DO DIRETOR" está irregular para o estado e ano emissor                                                                                                                                                                  | DIRECTOR'S SIGNATURE - The "DIRECTOR'S SIGNATURE" is irregular for the state and year of issue                                                                                                                                          |
| 3018           | FOTO - O formato da "FOTO" do portador está irregular para o estado e ano emissor ou há sobreposição de fotos                                                                                                                                              | PHOTO - The format of the bearer's "PHOTO" is irregular for the state and year of issue or there are overlapping photos                                                                                                                 |
| 3019           | MÍNIMOS GRÁFICOS - O "FORMULÁRIO" apresenta falta de acentos, espaçamentos e/ou demais mínimas características que variam entre os institutos responsáveis                                                                                                 | MINIMUM GRAPHICS - The "FORM" lacks accents, spacing and/or other minimal characteristics that vary among the responsible institutes                                                                                                    |
| 3020           | REPRODUÇÃO FORMULÁRIO - O "FORMULÁRIO" (papel do documento) não apresenta os elementos de segurança previstos na legislação e/ou coloração fora do padrão                                                                                                  | REPRODUCTIVE FORM - The "FORM" (paper of the document) does not present the security elements foreseen in the legislation and/or coloring out of the standard                                                                           |
| 3021           | FONTE - A "FONTE" utilizada para os dados contidos no documento está irregular para os padrões do estado e ano emissor                                                                                                                                     | SOURCE - The "SOURCE" used for the data contained in the document is irregular for the standards of the issuing state and year                                                                                                          |
| 3022           | GRÁFICA - A nomenclatura utilizada para a "GRÁFICA" está irregular para os padrões do estado e ano emissor                                                                                                                                                 | GRAPHIC - The nomenclature used for the "GRAPHIC" is irregular for the standards of the issuing state and year                                                                                                                          |
| 3023           | MINISTÉRIO IRREGULAR - A CNH apresenta o ministério fora do padrão da época. Recomenda-se a reprovação efetiva por fraude deste documento                                                                                                                  | IRREGULAR MINISTRY - The CNH presents the ministry outside the standard of the time. It is recommended that this document be effectively failed for fraud                                                                               |
| 3024           | VALIDADE - A CNH apresenta validade superior para o período de emissão                                                                                                                                                                                     | VALIDITY - The CNH is valid beyond its issuing period                                                                                                                                                                                   |
| 3025           | FOTO ADULTERADA - Há resquícios de adulteração nas fotos enviadas. Recomenda-se a reprovação efetiva por fraude deste documento                                                                                                                            | ADULTERED PHOTO - There are traces of tampering on the photos sent. It is recommended that this document be effectively rejected for fraud                                                                                              |
| 3026           | A selfie enviada se trata de uma tentativa de spoofing, ou seja, foi utilizado máscaras, imagem de pessoas não reais, indivíduo não estava consciente ou demais possibilidades que possam envolver a tentativa de uma pessoa tentando se passar por outra. | The selfie sent is an attempt at spoofing, i.e., masks were used, images of people who are not real, the individual was not conscious, or other possibilities that may involve one person trying to pass himself/herself off as another |
| 3027           | O formato da foto do portador está irregular para o estado e ano emissor                                                                                                                                                                                   | The format of the bearer's photo is irregular for the issuing state and year                                                                                                                                                            |
| 3028           | A perfuração do documento apresenta siglas e/ou condições irregulares para o estado e ano emissor                                                                                                                                                          | The perforation of the document has irregular acronyms and/or conditions for the issuing state and year                                                                                                                                 |
| 3029           | A assinatura do delegado no documento não apresenta as condições padrões para o estado e ano emissor                                                                                                                                                       | The delegate's signature on the document is not in standard condition for the issuing state and year                                                                                                                                    |
| 3030           | O brasão no documento não apresenta as condições padrões para o estado e ano emissor                                                                                                                                                                       | The coat of arms on the document does not meet standard conditions for the issuing state and year                                                                                                                                       |
| 3031           | A nomenclatura utilizada para o nome do estado emissor está irregular                                                                                                                                                                                      | The nomenclature used for the name of the issuing state is irregular                                                                                                                                                                    |
| 3032           | A nomenclatura utilizada para o departamento emissor está irregular                                                                                                                                                                                        | The nomenclature used for the issuing department is irregular                                                                                                                                                                           |
| 3033           | A nomenclatura utilizada para o instituto emissor está irregular                                                                                                                                                                                           | The nomenclature used for the issuing institute is irregular                                                                                                                                                                            |
| 3034           | A nomenclatura utilizada para o nome do órgão emissor está irregular                                                                                                                                                                                       | The nomenclature used for the name of the issuing agency is irregular                                                                                                                                                                   |
| 3035           | A formatação do número de registro geral não apresenta as condições padrões para o estado e ano emissor                                                                                                                                                    | The formatting for the general registration number does not meet the standard conditions for the issuing state and year                                                                                                                 |
| 3036           | A formatação da data de nascimento não apresenta as condições padrões para o estado e ano emissor                                                                                                                                                          | The formatting for the date of birth does not conform to the standard conditions for the issuing state and year                                                                                                                         |
| 3037           | A formatação do número de CPF não apresenta as condições padrões para o estado e ano emissor                                                                                                                                                               | The CPF number formatting is not the standard format for the issuing state and year                                                                                                                                                     |
| 3038           | A formatação da data de expedição não apresenta as condições padrões para o estado e ano emissor                                                                                                                                                           | The shipping date formatting does not meet the default conditions for the issuing state and year                                                                                                                                        |
| 3039           | A formatação da sigla que separa o nome do pai e da mãe não apresenta as condições padrões para o estado e ano emissor                                                                                                                                     | The formatting of the abbreviation separating the father's and mother's name does not meet standard conditions for the issuing state and year                                                                                           |
| 3040           | A formatação da naturalidade não apresenta as condições padrões para o estado e ano emissor                                                                                                                                                                | The birthplace formatting is not standard for the issuing state and year                                                                                                                                                                |
| 3041           | A formatação do documento de origem não apresenta as condições padrões para o estado e ano emissor                                                                                                                                                         | The formatting of the document of origin does not show standard conditions for the issuing state and year                                                                                                                               |
| 3042           | A idade apresentada com base na data de nascimento do documento não condiz com a idade da foto do portador                                                                                                                                                 | The age shown based on the document's date of birth does not match the age on the bearer's photo                                                                                                                                        |
| 3043           | ALINHAMENTO VIA - Alinhamentos do campo "VIA" irregulares para o estado e ano emissor                                                                                                                                                                      | VIA ALIGNMENT - Irregular "VIA" field alignments for the issuing state and year                                                                                                                                                         |


# Facematch

Comparison of the document photo and the selfie.

**Section**: `facematch`

**Required files:** `selfie and document image containing a picture`

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

| Attribute    | Type    | Description                                                                                         |
| ------------ | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode   | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| confidence   | Number  | Level of similarity in the compared images                                                          |
| identical    | Boolean | Confirmation of similarity                                                                          |
| ageRange     | String  | Approximate age range (optional)                                                                    |
| gender       | String  | `Male` or `Female` (optional)                                                                       |
| {% endtab %} |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "facematch": {
    "statusCode": "01",
    "confidence": 0.90068,
    "identical": true,
    "ageRange": "16 - 22",
    "gender": "Male"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                          | Description                                                                                                         |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| facematch\_has\_selfie\_photo | The rule checks whether the submission contains a selfie or not. What triggers the rule is the absence of a selfie. |
| facematch\_is\_equal          | Compare the similarity of the document to the selfie.                                                               |
| liveness\_manual\_revision    | This rule sends the selfie for manual anti-spoofing verification.                                                   |
| {% endtab %}                  |                                                                                                                     |
| {% endtabs %}                 |                                                                                                                     |

{% hint style="info" %}
**Note about the "gender" field:** The value returned in this field is the result of an automated estimate made by artificial intelligence models based on analysis of the image submitted. This classification does not necessarily reflect the gender identity with which the person identifies. Therefore, it is only an attribute inferred by the system, without any value judgment or intention to define the individual's personal identity.
{% endhint %}


# Facial Biometrics

Comparison of the submitted photo with the photo on official bases.

**Section**: `officialData`

**Required parameter:** `cpf`\
**Required files:** `selfie or document image containing a picture`

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

| Attribute    | Type   | Description                                                     |
| ------------ | ------ | --------------------------------------------------------------- |
| code         | String | Response code                                                   |
| confidence   | Number | Percentage of similarity of document face with official base    |
| probability  | String | Probability of authenticity of document face with official base |
| {% endtab %} |        |                                                                 |

{% tab title="Example" %}

```json
{
  "officialData": {
    "code": "01",
    "confidence": 0.9600528478622437,
    "probability": "Altíssima probabilidade"
  }
}
```

{% endtab %}

{% tab title="Possible Values" %}
**`code`**

| Code | Description                                                                                                               |
| ---- | ------------------------------------------------------------------------------------------------------------------------- |
| `01` | Success (comparison performed). `confidence`, `confidenceStatus` and `probability` are only returned when `code` is `01`. |
| `02` | Required attribute not informed (e.g. missing CPF)                                                                        |
| `03` | Image/source not applicable to the provider (e.g. provider only accepts selfie)                                           |
| `04` | Face not found in the provider's official databases                                                                       |
| `05` | Image quality/size error, or call failure ("face not found")                                                              |
| `06` | Invalid CPF (validated by the provider itself)                                                                            |
| `07` | Generic error / query failure (default value)                                                                             |

**`probability`**

Only returned when `code` is `01`.

| Value (API response)     | Description           |
| ------------------------ | --------------------- |
| Baixíssima probabilidade | Very low probability  |
| Baixa probabilidade      | Low probability       |
| Média probabilidade      | Medium probability    |
| Alta probabilidade       | High probability      |
| Altíssima probabilidade  | Very high probability |
| {% endtab %}             |                       |

{% tab title="Validations Rules" %}

| Rule                            | Description                                                                                                                             |
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| government\_document\_available | Checks if the document is available in the Government base.                                                                             |
| government\_document\_approved  | Verifies the authenticity of the document with the Government's base.                                                                   |
| liveness\_manual\_revision      | This rule sends the selfie for manual anti-spoofing verification.                                                                       |
| is\_biometrics\_approved        | Checks whether the similarity of the selfie found in the database is below the confidence threshold configured in the profile template. |
| {% endtab %}                    |                                                                                                                                         |
| {% endtabs %}                   |                                                                                                                                         |


# Private Faceset

Comparison of the submitted photo with the photo on private database faces of client.

**Section**: `privateFaceset`

**Required files:** `selfie or document image containing a picture`

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

| Attribute                                | Type    | Description                                                                                                                             |
| ---------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| statusCode                               | String  | Response status code                                                                                                                    |
| data                                     | Object  | Return data                                                                                                                             |
| data.suspect                             | Boolean | General indicator that a similar face was found. This value considers the manual confirmation of the verified field of each face match. |
| data.faceMatches                         | Array   | Array of images match with the face input                                                                                               |
| data.faceMatches\[X].similarity          | String  | Level of similarity in the compared images                                                                                              |
| data.faceMatches\[X].verified            | Boolean | Indicates that the match was manually confirmed by our operators.                                                                       |
| data.faceMatches\[X].faceset             | Object  | Data of face inserted in private faceset                                                                                                |
| data.faceMatches\[X].faceset.\_id        | Object  | Id of face inserted in private faceset                                                                                                  |
| data.faceMatches\[X].faceset.createdAt   | Object  | Creation date of face inserted in private faceset                                                                                       |
| data.faceMatches\[X].faceset.description | Object  | Description of face inserted in private faceset                                                                                         |
| {% endtab %}                             |         |                                                                                                                                         |

{% tab title="Example" %}

```json
{
  "privateFaceset": {
    "statusCode": "01",
    "data": {
      "faceMatches": [
        {
          "similarity": "99.99998474121094",
          "verified": true,
          "faceset": {
            "_id": "6349abae10920e000909b47a",
            "createdAt": "2022-10-14T18:34:24.606Z",
            "description": "Changed Document"
          }
        }
      ],
      "suspect": true
    }
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                  | Description                                                                                                          |
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| private\_faceset\_not\_contains\_face | The rule will be invalid if the submitted selfie matches one of the selfies registered in the Private Face Database. |
| {% endtab %}                          |                                                                                                                      |
| {% endtabs %}                         |                                                                                                                      |


# Shared Faceset

Comparison of the submitted photo with the photo on shared database of faces Certta.

**Section**: `sharedFaceset`

**Required files:** `selfie or document image containing a picture`

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

| Attribute                       | Type    | Description                                                                                                                             |
| ------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| statusCode                      | String  | Response status code                                                                                                                    |
| data                            | Object  | Return data                                                                                                                             |
| data.suspect                    | Boolean | General indicator that a similar face was found. This value considers the manual confirmation of the verified field of each face match. |
| data.faceMatches                | Array   | Array of images match with the face input                                                                                               |
| data.faceMatches\[X].similarity | String  | Level of similarity in the compared images                                                                                              |
| data.faceMatches\[X].verified   | Boolean | Indicates that the match was manually confirmed by our operators.                                                                       |
| {% endtab %}                    |         |                                                                                                                                         |

{% tab title="Example" %}

```json
{
  "sharedFaceset": {
    "statusCode": "01",
    "data": {
      "faceMatches": [
        {
          "similarity": "99.99998474121094",
          "verified": true
        }
      ],
      "suspect": true
    }
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                 | Description                                                                                                         |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------- |
| shared\_faceset\_not\_contains\_face | The rule will be invalid if the submitted selfie matches one of the selfies registered in the Shared Face Database. |
| {% endtab %}                         |                                                                                                                     |
| {% endtabs %}                        |                                                                                                                     |


# Document Liveness

This is a service that checks whether the photo on the document is a black and white photocopy, a color photocopy or a screenshot.

{% hint style="info" %}
This is a AI service integrated with Certta, and we are continuously improving its accuracy. Currently, the accuracy may be lower for less common documents, such as passports, RNE, functional documents, and others. The service is more effective at identifying documents like RG and CNH. Remember that the result provided is a probability that the document is a screen photo or a photocopy, not a final decision.
{% endhint %}

{% hint style="warning" %}
If the `decision` attribute is **false** and the confidence level (`confidence`) is **LOW**, the rule will be approved. Make sure to carefully review these cases, as a low confidence level may indicate uncertainty in the provided result.
{% endhint %}

**Section**: `documentLiveness`

**Required files:** `any document images`

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

| Attribute                         | Type    | Description                                                                                                                                                                                                                                    |
| --------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| statusCode                        | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code))                                                                                                                                            |
| data                              | Object  | Return data                                                                                                                                                                                                                                    |
| data.message                      | String  | Return message                                                                                                                                                                                                                                 |
| data.front                        | Object  | Object containing the image result description (front of document)                                                                                                                                                                             |
| data.front.decision               | Boolean | Decision result for the front of the document                                                                                                                                                                                                  |
| data.front.confidence             | String  | Confidence level for the front decision (e.g., **"LOW"**, **"MEDIUM"**, **"HIGH"**)                                                                                                                                                            |
| data.front.indicators             | Array   | Array of indicators for the front of the document                                                                                                                                                                                              |
| data.front.indicators\[x]         | Object  | Indicator object at index x                                                                                                                                                                                                                    |
| data.front.indicators\[x].id      | String  | Indicator ID for the front of the document (e.g., "real\_doc", **"screen\_photo\_doc"**, **"grayscale\_copy\_doc"**, **"colored\_copy\_doc"**)                                                                                                 |
| data.front.indicators\[x].message | String  | Message associated with the indicator for the front (e.g., **"The document is probably real"**, **"The document is probably a colored copy"**, **"The document is probably a grayscale copy"**, **"The document is probably a screen photo"**) |
| data.back                         | Object  | Object containing the image result description (back of document)                                                                                                                                                                              |
| data.back.decision                | Boolean | Decision result for the back of the document                                                                                                                                                                                                   |
| data.back.confidence              | String  | Confidence level for the back decision (e.g., **"LOW"**, **"MEDIUM"**, **"HIGH"**)                                                                                                                                                             |
| data.back.indicators              | Array   | Array of indicators for the back of the document                                                                                                                                                                                               |
| data.back.indicators\[x]          | Object  | Indicator object at index x                                                                                                                                                                                                                    |
| data.back.indicators\[x].id       | String  | Indicator ID for the back of the document (e.g., **"real\_doc"**, **"screen\_photo\_doc"**, **"grayscale\_copy\_doc"**, **"colored\_copy\_doc"**)                                                                                              |
| data.back.indicators\[x].message  | String  | Message associated with the indicator for the back (e.g., **"The document is probably real"**, **"The document is probably a colored copy"**, **"The document is probably a grayscale copy"**, **"The document is probably a screen photo"**)  |
| {% endtab %}                      |         |                                                                                                                                                                                                                                                |

{% tab title="Example" %}

```json
{
  "documentLiveness": {
    "statusCode": "01",
    "data": {
      "front": {
        "decision": true,
        "confidence": "MEDIUM",
        "indicators": [
          {
            "message": "The document is probably real.",
            "id": "real_doc"
          }
        ]
      },
      "back": {
        "decision": true,
        "confidence": "HIGH",
        "indicators": [
          {
            "message": "The document is probably real.",
            "id": "real_doc"
          }
        ]
      }
    }
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                         | Description                                                                                                                                                                                                                                                                |
| -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| is\_document\_liveness\_screen\_photo\_doc   | This rule checks whether the document provided is a screen photo, which could indicate an attempt at fraud. If the document is identified as a screen photo, the rule will be considered invalid, indicating that the document is not authentic.                           |
| is\_document\_liveness\_colored\_copy\_doc   | This rule checks whether the document provided is a color photocopy, which could indicate an attempt at fraud. If the document is identified as a color photocopy, the rule will be considered invalid, indicating that the document is not authentic.                     |
| is\_document\_liveness\_grayscale\_copy\_doc | This rule checks whether the document provided is a black and white photocopy, which could indicate an attempt at fraud. If the document is identified as a black and white photocopy, the rule will be considered invalid, indicating that the document is not authentic. |
| {% endtab %}                                 |                                                                                                                                                                                                                                                                            |
| {% endtabs %}                                |                                                                                                                                                                                                                                                                            |


# Global Document Reader

The Global Document Reader service processes identity documents, identifying the country and type of document, as well as extracting the information contained within.

**Section**: `globalDocReader`

**Required parameter:** `documentCountry` and `files (any document images)`

## Fields and rules

Check out the examples, rules, and attributes for the service to function.

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

| Attribute                                                 | Type                  | Description                                                                                                                      |
| --------------------------------------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| statusCode                                                | string                | Refers to the status of this specific query, not the entire transaction. [Check our status guide](/caf-api/connect/transactions) |
| data                                                      | object                | Object containing the main data.                                                                                                 |
| data.files                                                | array                 | Files resulting from processing.                                                                                                 |
| data.files\[x].name                                       | [FileName](#filename) | File name.                                                                                                                       |
| data.files\[x].url                                        | string                | File URL.                                                                                                                        |
| data.documentType                                         | object                | Information about the document.                                                                                                  |
| data.documentType.isoAlpha2CountryCode                    | string                | Country issuing the document (ISO 3166-1 alpha 2).                                                                               |
| data.documentType.isoAlpha3CountryCode                    | string                | Country issuing the document (ISO 3166-1 alpha 3).                                                                               |
| data.documentType.type                                    | [DocType](#doctype)   | Type of document.                                                                                                                |
| data.textFields                                           | object                | Information extracted from the document.                                                                                         |
| data.textFields.fields                                    | object                | Fields of document. The list of fields can be viewed [here](#fields).                                                            |
| data.textFields.fields.{fieldName}                        | object                | Field of document.                                                                                                               |
| data.textFields.fields.{fieldName}.value                  | string                | Field value.                                                                                                                     |
| data.textFields.fields.{fieldName}.originalLanguage       | object                | (*Optional*) Information from the field in the document's original language.                                                     |
| data.textFields.fields.{fieldName}.originalLanguage.lang  | string                | Document language.                                                                                                               |
| data.textFields.fields.{fieldName}.originalLanguage.value | string                | Value of the field in the original language of the document.                                                                     |
| {% endtab %}                                              |                       |                                                                                                                                  |

{% tab title="Example" %}

```json
{
    "statusCode": "01",
    "data": {
        "files": [
            {
                "name": "CROPPED_DOC_FRONT",
                "url": "https://..."
            },
            {
                "name": "CROPPED_DOC_BACK",
                "url": "https://..."
            }
        ],
        "documentType": {
            "isoAlpha2CountryCode": "AR",
            "isoAlpha3CountryCode": "ARG",
            "type": "IDENTITY_CARD"
        },
        "textFields": {
            "fields": {
                "personalNumber": {
                    "value": "00000000000"
                },
                "givenNames": {
                    "value": "JANE DOE",
                    "originalLanguage": {
                        "lang": "Spanish (Argentina)",
                        "value": "JANE DOE"
                    }
                },
                "surname": {
                    "value": "SILVA",
                    "originalLanguage": {
                        "lang": "Spanish (Argentina)",
                        "value": "SILVA"
                    }
                },
                "name": {
                    "value": "SILVA JANE DOE",
                    "originalLanguage": {
                        "lang": "Spanish (Argentina)",
                        "value": "SILVA JANE DOE"
                    }
                },
                "finalCheckDigit": {
                    "value": "0"
                },
                "expirationDateCheckDigit": {
                    "value": "4"
                },
                "expirationDate": {
                    "value": "2035-06-14"
                },
                "mrz": {
                    "value": "IDARG99999999<4<<<<<<<<<<<<<<<^8508085F3506144ARG<<<<<<<<<<<0^SILVA<<JANE<DOE<<"
                },
                "sex": {
                    "value": "F"
                },
                "birthDateCheckDigit": {
                    "value": "5"
                },
                "birthDate": {
                    "value": "1985-08-08"
                },
                "documentNumber": {
                    "value": "99999999"
                },
                "nationalityCode": {
                    "value": "ARG"
                },
                "documentNumberCheckDigit": {
                    "value": "4"
                },
                "controlNumber": {
                    "value": "00000000000"
                },
                "birthPlace": {
                    "value": "CIUDAD DE BUENOS AIRES",
                    "originalLanguage": {
                        "lang": "Spanish (Argentina)",
                        "value": "CIUDAD DE BUENOS AIRES"
                    }
                },
                "identityCardNumber": {
                    "value": "000000000000000"
                },
                "address": {
                    "originalLanguage": {
                        "lang": "Spanish (Argentina)",
                        "value": "EXAMPLE ADDRESS"
                    }
                },
                "issueDate": {
                    "value": "2020-02-20"
                }
            }
        }
    }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                                                               | Description                                                                            |
| ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| The country on the document is the same as the country specified in the parameters | Checks if the country on the document matches the country specified in the parameters. |
| Document not expired                                                               | Check if the document is not expired or does not have an expiration date.              |
| Age ranges not accepted                                                            | Checks if the person is within the configured age range.                               |
| {% endtab %}                                                                       |                                                                                        |
| {% endtabs %}                                                                      |                                                                                        |

{% hint style="info" %}
The returned date format is `yyyy-mm-dd`.

* yyyy = four-digit year
* mm = two-digit month
* dd = two-digit day
  {% endhint %}

## Data types

### FileName

| Value               | Description                           |
| ------------------- | ------------------------------------- |
| `CROPPED_DOC_FRONT` | Front area of ​​the document cut out. |
| `CROPPED_DOC_BACK`  | Back area of ​​the document cut out.  |

### DocType

| Value              | Description                             |
| ------------------ | --------------------------------------- |
| `IDENTITY_CARD`    | Identity document.                      |
| `DRIVER_LICENSE`   | Driver's license or permit.             |
| `PASSPORT`         | Passport.                               |
| `RESIDENCE_PERMIT` | Identity card or permit for foreigners. |
| `VISA`             | Visa.                                   |
| `VOTER_CARD`       | Voter card or voting document.          |
| `UNKNOWN`          | Unknown document.                       |

### Fields

| Value                          | Description                                        |
| ------------------------------ | -------------------------------------------------- |
| `name`                         | Person's full name.                                |
| `givenNames`                   | Person's given names.                              |
| `surname`                      | Person's surname.                                  |
| `socialName`                   | Person's social name.                              |
| `sex`                          | Person's sex or gender.                            |
| `personalNumber`               | Personal identification number.                    |
| `birthDate`                    | Person's date of birth.                            |
| `birthPlace`                   | Place of birth.                                    |
| `nationalityCode`              | Nationality code.                                  |
| `nationality`                  | Person's nationality.                              |
| `address`                      | Person's address.                                  |
| `uniqueNumber`                 | Unique identification number.                      |
| `voterKey`                     | Voter registration key.                            |
| `fatherName`                   | Father's name.                                     |
| `motherName`                   | Mother's name.                                     |
| `documentNumber`               | Document identification number.                    |
| `documentClass`                | Document class or category.                        |
| `expirationDate`               | Document expiration date.                          |
| `issueDate`                    | Document issue date.                               |
| `issuingAuthority`             | Authority that issued the document.                |
| `issuePlace`                   | Place where the document was issued.               |
| `issuingCountryCode`           | Code of the issuing country.                       |
| `issuingStateCode`             | Code of the issuing state (federative unit).       |
| `mrz`                          | Machine Readable Zone (MRZ) data.                  |
| `controlNumber`                | Document control number.                           |
| `optionalData`                 | Optional data field.                               |
| `identityCardNumber`           | Identity card number.                              |
| `identityCardIssuingAuthority` | Authority that issued the identity card.           |
| `identityCardIssuingStateCode` | State code of the identity card issuer.            |
| `dlCategory`                   | Driver's license category.                         |
| `firstIssueDate`               | Date of first document issue.                      |
| `bookletNumber`                | Booklet number.                                    |
| `securityNumber`               | Security or verification number.                   |
| `renachNumber`                 | RENACH (Brazilian driver's license) number.        |
| `notes`                        | Additional notes or observations.                  |
| `entryDate`                    | Entry date or registration date.                   |
| `dlCategoryAccExpirationDate`  | Expiration date for driver's license category ACC. |
| `dlCategoryAExpirationDate`    | Expiration date for driver's license category A.   |
| `dlCategoryA1ExpirationDate`   | Expiration date for driver's license category A1.  |
| `dlCategoryBExpirationDate`    | Expiration date for driver's license category B.   |
| `dlCategoryB1ExpirationDate`   | Expiration date for driver's license category B1.  |
| `dlCategoryCExpirationDate`    | Expiration date for driver's license category C.   |
| `dlCategoryC1ExpirationDate`   | Expiration date for driver's license category C1.  |
| `dlCategoryDExpirationDate`    | Expiration date for driver's license category D.   |
| `dlCategoryD1ExpirationDate`   | Expiration date for driver's license category D1.  |
| `dlCategoryBeExpirationDate`   | Expiration date for driver's license category BE.  |
| `dlCategoryCeExpirationDate`   | Expiration date for driver's license category CE.  |
| `dlCategoryC1eExpirationDate`  | Expiration date for driver's license category C1E. |
| `dlCategoryDeExpirationDate`   | Expiration date for driver's license category DE.  |
| `dlCategoryD1eExpirationDate`  | Expiration date for driver's license category D1E. |
| `optionalDataCheckDigit`       | Check digit for optional data field.               |
| `finalCheckDigit`              | Final check digit for document validation.         |
| `expirationDateCheckDigit`     | Check digit for expiration date.                   |
| `documentNumberCheckDigit`     | Check digit for document number.                   |
| `birthDateCheckDigit`          | Check digit for birth date.                        |


# Global Document Verification

Global Document Verification service processes identity documents, extracting information and performing checks such as image quality, document type, data integrity, document validity, and authenticity points, to ensure truthfulness and quality.

**Section**: `globalDocVerification`

**Required parameter:** `files (any document images)`

## Fields and rules

Check out the examples, rules, and attributes for the service to function.

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

| Attribute                                                                     | Type              | Description                                                                                                                              |
| ----------------------------------------------------------------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| data                                                                          | object            | Object containing the main data.                                                                                                         |
| data.documentCategory                                                         | string            | Document category.                                                                                                                       |
| data.documentType                                                             | string            | Document type and version.                                                                                                               |
| data.documentNumber                                                           | string            | Document number.                                                                                                                         |
| data.name                                                                     | string            | Holder's full name.                                                                                                                      |
| data.sex                                                                      | string            | Holder's sex.                                                                                                                            |
| data.birthDate                                                                | string            | Holder's birth date.                                                                                                                     |
| data.birthPlace                                                               | string            | Holder's place of birth.                                                                                                                 |
| data.nationality                                                              | string            | Holder's nationality.                                                                                                                    |
| data.nationalityCode                                                          | string            | Holder's nationality code.                                                                                                               |
| data.address                                                                  | string            | Holder's complete address.                                                                                                               |
| data.issueState                                                               | string            | Document issuing state or country.                                                                                                       |
| data.issueStateCode                                                           | string            | Issuing state/country code (ISO 3166-1 alpha-3).                                                                                         |
| data.authority                                                                | string            | Document issuing authority.                                                                                                              |
| data.issueDate                                                                | string            | Document issue date.                                                                                                                     |
| data.expirationDate                                                           | string            | Document expiration date.                                                                                                                |
| data.validations.overallStatus                                                | [Status](#status) | Overall validations status.                                                                                                              |
| data.validations.authenticityCheck                                            | object            | Document authenticity checks.                                                                                                            |
| data.validations.authenticityCheck.status                                     | [Status](#status) | Overall authenticity check status.                                                                                                       |
| data.validations.authenticityCheck.*{documentSide}*                           | object            | Results of authenticity checks performed on each document side. *{documentSide}* can be `front` or `back`.                               |
| data.validations.authenticityCheck.*{documentSide}*.result                    | [Status](#status) | Overall authenticity check status for the corresponding image.                                                                           |
| data.validations.authenticityCheck.*{documentSide}*.imagePattern.result       | [Status](#status) | Status of the presence/absence verification of image patterns.                                                                           |
| data.validations.authenticityCheck.*{documentSide}*.photoEmbedType.result     | [Status](#status) | Status of the embedded photo verification.                                                                                               |
| data.validations.authenticityCheck.*{documentSide}*.barcodeFormatCheck.result | [Status](#status) | Status of the barcode format verification.                                                                                               |
| data.validations.documentType                                                 | object            | Document type checks .                                                                                                                   |
| data.validations.documentType.validityStatus                                  | [Status](#status) | Document type check status.                                                                                                              |
| data.validations.textFieldsCheck                                              | object            | Document text fields checks.                                                                                                             |
| data.validations.textFieldsCheck.status                                       | [Status](#status) | Overall text fields check status (cross-comparison of different sources, dates and check digits verification).                           |
| data.validations.textFieldsCheck.mrz                                          | [Status](#status) | MRZ integrity verification status.                                                                                                       |
| data.validations.textFieldsCheck.documentExpiry.result                        | [Status](#status) | Document expiry verification status.                                                                                                     |
| data.validations.imageQualityCheck                                            | object            | Image quality checks.                                                                                                                    |
| data.validations.imageQualityCheck.status                                     | [Status](#status) | Overall image quality verification status.                                                                                               |
| data.validations.imageQualityCheck.*{documentSide}*                           | object            | Results of image quality checks performed on each document side. *{documentSide}* can be `front` or `back`.                              |
| data.validations.imageQualityCheck.*{documentSide}*.result                    | [Status](#status) | Overall image quality check status for the corresponding image.                                                                          |
| data.validations.imageQualityCheck.*{documentSide}*.imageColorness            | [Status](#status) | Indicates if the image is colorless.                                                                                                     |
| data.validations.imageQualityCheck.*{documentSide}*.imageFocus                | [Status](#status) | Indicates whether the image is in focus.                                                                                                 |
| data.validations.imageQualityCheck.*{documentSide}*.bounds                    | [Status](#status) | Indicates if the document is not fully present in the image.                                                                             |
| data.validations.imageQualityCheck.*{documentSide}*.imageGlares               | [Status](#status) | Indicates the presence of glare on the image.                                                                                            |
| data.validations.imageQualityCheck.*{documentSide}*.perspective               | [Status](#status) | Indicates if the document in the image has perspective distortion above threshold.                                                       |
| data.validations.imageQualityCheck.*{documentSide}*.portrait                  | [Status](#status) | Indicates if the portrait is present.                                                                                                    |
| data.validations.imageQualityCheck.*{documentSide}*.imageResolution           | [Status](#status) | Indicates if the image resolution is below the threshold.                                                                                |
| statusCode                                                                    | string            | Refers to the status of this specific query, not the entire transaction. [Check our status guide](/caf-api/core-api/transaction-details) |
| {% endtab %}                                                                  |                   |                                                                                                                                          |

{% tab title="Example" %}

```json
{
    "data": {
        "documentCategory": "DRIVER_LICENSE",
        "documentType": "United Kingdom - Driver License (2021) #1",
        "documentNumber": "XXXXXXXXXXXXXXXX",
        "name": "JANE DOE",
        "sex": "F",
        "birthDate": "11/05/1993",
        "birthPlace": "UNITED KINGDOM",
        "nationality": "UNITED KINGDOM",
        "nationalityCode": "GBR",
        "address": "14 Meadow Lane, Nottingham, NGX XHQ",
        "issueState": "UNITED KINGDOM",
        "issueStateCode": "GBR",
        "authority": "DVLA",
        "issueDate": "01/04/2022",
        "expirationDate": "01/04/2032",
        "validations": {
            "overallStatus": 1,
            "authenticityCheck": {
                "status": 1,
                "back": {
                    "result": 1,
                    "imagePattern": {
                        "result": 1,
                    }
                },
                "front": {
                    "result": 1,
                    "imagePattern": {
                        "result": 1,
                    },
                    "photoEmbedType": {
                        "result": 1,
                    }
                }
            },
            "documentType": {
                "validityStatus": 1
            },
            "textFieldsCheck": {
                "status": 1,
                "mrz": 2,
                "documentExpiry": {
                    "result": 1,
                }
            },
            "imageQualityCheck": {
                "status": 1,
                "back": {
                    "result": 1,
                    "imageColorness": 2,
                    "imageFocus": 1,
                    "screenCapture": 2,
                    "bounds": 1,
                    "imageGlares": 1,
                    "perspective": 1,
                    "portrait": 2,
                    "imageResolution": 1
                },
                "front": {
                    "result": 1,
                    "imageColorness": 2,
                    "imageFocus": 1,
                    "screenCapture": 2,
                    "bounds": 1,
                    "imageGlares": 0,
                    "perspective": 1,
                    "portrait": 1,
                    "imageResolution": 1
                }
            }
        }
    },
    "statusCode": "01"
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                           | Description                                                         |
| ------------------------------ | ------------------------------------------------------------------- |
| Validate document fields       | Indicates whether all fields extracted from the document are valid. |
| Validate document authenticity | Indicates whether all verified authenticity points are valid.       |
| {% endtab %}                   |                                                                     |
| {% endtabs %}                  |                                                                     |

{% hint style="info" %}
The date format used is `dd/MM/yyyy`.

* dd = two-digit day
* MM = two-digit month
* yyyy = four-digit year
  {% endhint %}

{% hint style="info" %}
Returned and undocumented fields are for internal use only.
{% endhint %}

## Status

When the document verification service is used, some statuses regarding what was analyzed may be returned:

| Value | Description                                     |
| ----- | ----------------------------------------------- |
| 0     | Check was performed and result is **negative**. |
| 1     | Check was performed and result is **positive**. |
| 2     | Check was **not performed**.                    |


# Deepfake Detection

Checks if the selfie sent is a deepfake.

**Section**: `deepfakeDetection`

**Required files:** `selfie`

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

| Attribute       | Type    | Description                                                                                         |
| --------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode      | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data            | Object  | Return data                                                                                         |
| data.message    | String  | Query message                                                                                       |
| data.isDeepfake | Boolean | Deepfake response                                                                                   |
| {% endtab %}    |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "deepfakeDetection": {
    "statusCode": "01",
    "data": {
      "message": "Consulta realizada com sucesso",
      "isDeepfake": true
    }
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule              | Description                                     |
| ----------------- | ----------------------------------------------- |
| is\_not\_deepfake | Check if the selfie you sent is not a deepfake. |
| {% endtab %}      |                                                 |
| {% endtabs %}     |                                                 |


# Image Similarity Check

Check if the selfie you sent has already been sent.

**Section**: `imageSimilarityCheck`

**Required files:** `selfie`

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

| Attribute      | Type    | Description                                                                                         |
| -------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode     | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data           | Object  | Return data                                                                                         |
| data.message   | String  | Query message                                                                                       |
| data.isSimilar | Boolean | Similarity response                                                                                 |
| {% endtab %}   |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "imageSimilarityCheck": {
    "statusCode": "01",
    "data": {
      "message": "Consulta realizada com sucesso",
      "isSimilar": true
    }
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                     | Description                                                                             |
| ------------------------ | --------------------------------------------------------------------------------------- |
| selfie\_is\_not\_similar | Check if the selfie you sent is not similar to any other selfie you've sent previously. |
| {% endtab %}             |                                                                                         |
| {% endtabs %}            |                                                                                         |


# Face Details

Information extracted from the submitted selfie.

**Section**: `faceDetails`

**Required files:** `selfie`

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

| Attribute         | Type   | Description                                                                                         |
| ----------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode        | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data              | Object | Return data                                                                                         |
| data.ageRangeLow  | Number | Minimum approximate age                                                                             |
| data.ageRangeHigh | Number | Maximum approximate age                                                                             |
| data.gender       | String | Gender                                                                                              |
| {% endtab %}      |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "faceDetails": {
    "statusCode": "01",
    "data": {
      "ageRangeLow": 28,
      "ageRangeHigh": 32,
      "gender": "Male"
    }
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                          | Description                                                                                                                            |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| face\_and\_birthdate\_compare | Check if the estimated age based on the selfie is different from the date of birth returned in the Receita Federal or read in the OCR. |
| face\_details\_over\_18       | Check if the approximate age identified in the selfie is under 18 years old.                                                           |
| {% endtab %}                  |                                                                                                                                        |
| {% endtabs %}                 |                                                                                                                                        |


# VerifAI Smart OCR

AI-powered analysis of generic Brazilian documents that combines OCR (text extraction) with a generative model that classifies the document, extracts structured fields and feeds dedicated validation rules. The service is engineered for documents that the standard [Document OCR](/caf-api/connect/transactions/services/document-ocr) does not cover (proof of residence, proof of income, social contract, power of attorney and arbitrary documents) and is the only OCR-style service that exposes ready-to-use validation rules out of the box.

**Section**: `smartOcr`

**Required files:** any document file (`application/pdf`, `image/png`, `image/jpeg`, `image/bmp`, `image/webp`, `image/heic`, `image/heif`).

{% hint style="info" %}
Verif AI Smart OCR runs only when the [transaction template](/caf-api/connect/available-resources/transaction) explicitly enables it. Configuration of supported document classes, expiration windows and required terms lives in the template — the request body only carries the **runtime** parameters listed below.
{% endhint %}

## Request parameters

When the service is enabled, three optional fields can be passed inside the `attributes` object of `POST /transactions`. They are forwarded to the Smart OCR validation rules; the extraction itself runs regardless of these values.

| Field                     | Type                           | Used by           | Description                                                                                                                                                                                                                                                      |
| ------------------------- | ------------------------------ | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `attributes.holderName`   | string                         | Document Holder   | Expected document holder name. Compared (case-insensitive, accent-insensitive, substring match) against the holder name extracted from the document (`customerName`, `employeeName`, `taxpayerName`, `shareholderName1`, etc., depending on the document class). |
| `attributes.holderCpf`    | string (only digits, 11 chars) | Document Holder   | Expected document holder CPF. Compared (digits only) against the CPF extracted from the document (`customerPersonalTaxId`, `employeePersonalTaxId`, `taxpayerPersonalTaxId`, `shareholderPersonalTaxId1`). When omitted, falls back to `attributes.cpf`.         |
| `attributes.analysisDate` | string (`YYYY-MM-DD`)          | Document Validity | Reference date used to compute the document age. Defaults to the request date when omitted. Documents with an issue date in the future relative to this value are always considered invalid.                                                                     |

{% hint style="info" %}
All three fields are **optional**. The Document Holder rule needs at least one of `holderName` / `holderCpf` (or `cpf`) to be informative — when neither is provided, the rule cannot be evaluated and stays `PENDING`.

Extracted CPF fields (e.g. `customerPersonalTaxId`) may include formatting characters (dots and dashes); comparisons use digits only. Send `attributes.holderCpf` with **11 digits only**, without punctuation.
{% endhint %}

**Request example:**

```json
{
  "templateId": "your_template_id",
  "attributes": {
    "cpf": "12345678901",
    "holderName": "Maria Silva Santos",
    "holderCpf": "12345678901",
    "analysisDate": "2025-08-15"
  },
  "files": [{ "data": "https://example.com/proof-of-residence.pdf", "type": "ATTACHMENTS" }]
}
```

### Password-protected PDFs

When a PDF requires a password to be opened, send the password in the `filePassword` field of the same item in `files`. The password is used only to open the file for processing.

| Field                  | Type   | Description                                                                             |
| ---------------------- | ------ | --------------------------------------------------------------------------------------- |
| `files[].filePassword` | string | Password required to open the PDF. Optional; send it only for password-protected files. |

{% hint style="warning" %}
`filePassword` is only considered for files sent with `"type": "ATTACHMENTS"`. Each file carries its own password, so a request can mix protected and unprotected files. When a password-protected PDF is sent without `filePassword`, or with a wrong one, the file cannot be processed.
{% endhint %}

**Request example with a password-protected PDF:**

```json
{
  "templateId": "your_template_id",
  "files": [
    {
      "data": "https://example.com/bank-statement.pdf",
      "type": "ATTACHMENTS",
      "filePassword": "<FILE_PASSWORD>"
    }
  ]
}
```

## Document classification

Smart OCR classifies the uploaded document into one of the supported classes before extracting structured fields. Classification combines text features (OCR) and visual features (the generative model), so each document is processed only with the schema relevant to its class.

| Class                | Subclass            | Typical documents                                                                                      |
| -------------------- | ------------------- | ------------------------------------------------------------------------------------------------------ |
| `PROOF_OF_RESIDENCE` | —                   | Utility bills (energy, water, gas), telecom invoices, bank statements, condo bills.                    |
| `PROOF_OF_INCOME`    | —                   | Pay slips (holerite/contracheque), employment letters with income, social security benefit statements. |
| `PROOF_OF_INCOME`    | `INCOME_TAX_RETURN` | Income tax return receipts and statements (DIRPF / Recibo de Entrega).                                 |
| `SOCIAL_CONTRACT`    | —                   | Company social contracts, articles of association and consolidated amendments.                         |
| `POWER_OF_ATTORNEY`  | —                   | Public, private and digital powers of attorney (procurações).                                          |
| `GENERIC`            | —                   | Generic documents that do not match the categories above (invoices, contracts, declarations).          |

The classification result and the subclass (when applicable) are returned inside the `smartOcr` section together with the extracted fields, so downstream consumers can decide how to interpret the payload.

## Specific attributes (PROOF\_OF\_RESIDENCE)

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

| Attribute                   | Type    | Description                                                                                                                                                                                                                          |
| --------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| relatedMonth                | Integer | Reference month of the proof of residence (1-12, no leading zero).                                                                                                                                                                   |
| relatedYear                 | Integer | Reference year of the proof of residence (4 digits).                                                                                                                                                                                 |
| issueDate                   | String  | Issue date of the document (`DD/MM/YYYY`).                                                                                                                                                                                           |
| dueDate                     | String  | Due date of the document (`DD/MM/YYYY`).                                                                                                                                                                                             |
| companyName                 | String  | Issuer company legal/fantasy name (Razão Social).                                                                                                                                                                                    |
| companyBusinessTaxId        | String  | Issuer company CNPJ (formatting and masking characters preserved).                                                                                                                                                                   |
| companyAddress              | String  | Issuer company address.                                                                                                                                                                                                              |
| customerName                | String  | Document holder full name.                                                                                                                                                                                                           |
| customerPersonalTaxId       | String  | Document holder CPF (formatting and masking characters preserved).                                                                                                                                                                   |
| customerBusinessTaxId       | String  | Document holder CNPJ, when applicable.                                                                                                                                                                                               |
| customerCompleteAddress     | String  | Holder complete address as printed in the document.                                                                                                                                                                                  |
| customerAddressStreet       | String  | Street component of the holder address.                                                                                                                                                                                              |
| customerAddressNumber       | String  | Number component of the holder address.                                                                                                                                                                                              |
| customerAddressNeighborhood | String  | Neighborhood (bairro) component of the holder address.                                                                                                                                                                               |
| customerAddressCity         | String  | City component of the holder address.                                                                                                                                                                                                |
| customerAddressState        | String  | Brazilian state (UF) component of the holder address.                                                                                                                                                                                |
| customerAddressPostalCode   | String  | CEP component of the holder address.                                                                                                                                                                                                 |
| customerAddressExtraInfo    | String  | Address extra information / complemento.                                                                                                                                                                                             |
| digitableLine               | String  | Payment slip digitable line (linha digitável) as printed on the document, digits only: 47 digits for a bank slip, 48 for a collection slip. Returned as read — the encoded values are derived from the barcode, not from this field. |
| amount                      | Float   | Total amount to be paid, as printed in the document. Present when the document shows an amount.                                                                                                                                      |
| bankCode                    | String  | Issuing bank code as printed in the payment slip header. Present on bank slips only.                                                                                                                                                 |
| barcode                     | String  | Payment slip barcode, decoded from the printed bars: 44 digits. Present when the document is a payment slip and the bars could be read.                                                                                              |
| barcodeAmount               | String  | Amount encoded in the barcode, in cents. Omitted when the slip carries a reference amount instead of an effective one.                                                                                                               |
| barcodeAmountFormatted      | String  | Same amount in decimal notation, without a currency symbol.                                                                                                                                                                          |
| barcodeDueDate              | String  | Due date encoded in the barcode (`DD/MM/YYYY`). Bank slips only — collection slips do not carry a due date in the layout.                                                                                                            |
| barcodeBankCode             | String  | Bank code encoded in the barcode. Bank slips only.                                                                                                                                                                                   |
| {% endtab %}                |         |                                                                                                                                                                                                                                      |

{% tab title="Example" %}

```json
{
  "smartOcr": {
    "documentClass": "PROOF_OF_RESIDENCE",
    "subClass": null,
    "relatedMonth": 3,
    "relatedYear": 2025,
    "issueDate": "01/03/2025",
    "dueDate": "10/03/2025",
    "companyName": "ENEL DISTRIBUIDORA SP",
    "companyBusinessTaxId": "61.695.227/0001-93",
    "companyAddress": "AV PRES JUSCELINO KUBITSCHEK, 222 - SP",
    "customerName": "Maria Silva Santos",
    "customerPersonalTaxId": "123.456.789-01",
    "customerBusinessTaxId": "",
    "customerCompleteAddress": "RUA OSVALDO ARANHA, 123 BAIRRO CENTRO - SP 01310-000",
    "customerAddressStreet": "RUA OSVALDO ARANHA",
    "customerAddressNumber": "123",
    "customerAddressNeighborhood": "CENTRO",
    "customerAddressCity": "SAO PAULO",
    "customerAddressState": "SP",
    "customerAddressPostalCode": "01310000",
    "customerAddressExtraInfo": "APTO 501",
    "digitableLine": "836200000013234512340006000000000000000000000000",
    "amount": 123.45,
    "barcode": "83620000001234512340000000000000000000000000",
    "barcodeAmount": "12345",
    "barcodeAmountFormatted": "123.45"
  }
}
```

{% endtab %}

{% tab title="Validation Rules" %}

| Validation rule      | Behaviour for `PROOF_OF_RESIDENCE`                                                                                                                                                                                                                                              |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Document Validity    | Uses `issueDate` (or `relatedMonth` + `relatedYear` when issue date is missing) compared against `attributes.analysisDate`. Default expiration window is 180 days; can be customized in the template via `documentTypeRules` (`maxDays`, `maxMonths`, `lastMonth`, `lastYear`). |
| Document Holder      | Compares `attributes.holderName` against `customerName` (substring, case/accent-insensitive) and/or `attributes.holderCpf` (or `attributes.cpf`) against `customerPersonalTaxId` (digits only). At least one match makes the rule valid.                                        |
| Required Fields      | Validates that every term configured in the template (`requiredTerms`) is present in the extraction.                                                                                                                                                                            |
| Address Completeness | Validates each individual component (`customerAddressStreet`, `customerAddressNumber`, `customerAddressPostalCode`, `customerAddressNeighborhood`, `customerAddressCity`). All five must be present and non-empty.                                                              |
| Barcode Exists       | Checks whether the printed barcode could be decoded and its check digit holds over the 44 digits. A proof of residence with no readable barcode is not approved. Exclusive to this document class.                                                                              |
| Barcode Match        | Verifies the slip in three steps: the barcode is readable, its 44 digits match the printed digitable line, and the encoded values match `amount`, `dueDate` and `bankCode`, over the fields selected in `fieldsToCompare`. Exclusive to this document class.                    |
| {% endtab %}         |                                                                                                                                                                                                                                                                                 |
| {% endtabs %}        |                                                                                                                                                                                                                                                                                 |

## Specific attributes (PROOF\_OF\_INCOME)

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

| Attribute                    | Type    | Description                                                                    |
| ---------------------------- | ------- | ------------------------------------------------------------------------------ |
| relatedMonth                 | Integer | Reference month (1-12).                                                        |
| relatedYear                  | Integer | Reference year (4 digits).                                                     |
| companyName                  | String  | Employer legal/fantasy name (Razão Social).                                    |
| companyBusinessTaxId         | String  | Employer CNPJ.                                                                 |
| companyCompleteAddress       | String  | Employer complete address.                                                     |
| companyAddressStreet         | String  | Employer street component.                                                     |
| companyAddressNumber         | String  | Employer number component.                                                     |
| companyAddressNeighborhood   | String  | Employer neighborhood component.                                               |
| companyAddressCity           | String  | Employer city component.                                                       |
| companyAddressState          | String  | Employer Brazilian state (UF).                                                 |
| companyAddressPostalCode     | String  | Employer CEP.                                                                  |
| companyAddressExtraInfo      | String  | Employer address extra information.                                            |
| employeeName                 | String  | Employee full name.                                                            |
| employeePersonalTaxId        | String  | Employee CPF.                                                                  |
| employeeCompleteAddress      | String  | Employee complete address.                                                     |
| employeeRole                 | String  | Employee job position/role.                                                    |
| employeeContractType         | String  | Contract type (e.g. `Prazo indeterminado`, `Temporário`, `Prazo determinado`). |
| employeeHireDate             | String  | Hire date (`DD/MM/YYYY`).                                                      |
| employeeEndDate              | String  | Contract end date (empty when `employmentStatus` is `Aberto`).                 |
| employeeBaseIncome           | Float   | Base income amount (no `R$`/symbols).                                          |
| employeeGrossIncome          | Float   | Gross income amount.                                                           |
| employeeTotalDeductions      | Float   | Total deductions amount.                                                       |
| employeeNetIncome            | Float   | Net income (`employeeGrossIncome` - `employeeTotalDeductions`).                |
| employeeBankNumber           | String  | Bank code/number where the salary is paid.                                     |
| employeeBankBranchNumber     | String  | Branch/agency number.                                                          |
| employeeBankAccountNumber    | String  | Account number.                                                                |
| employeeRetirementIndicative | String  | Indicative of retirement status (e.g. `Aposentado`, `Pensão`).                 |
| employmentStatus             | String  | `Aberto` (active) or `Encerrado` (terminated).                                 |
| {% endtab %}                 |         |                                                                                |

{% tab title="Example" %}

```json
{
  "smartOcr": {
    "documentClass": "PROOF_OF_INCOME",
    "subClass": null,
    "relatedMonth": 8,
    "relatedYear": 2025,
    "companyName": "EMPRESA EXEMPLO LTDA",
    "companyBusinessTaxId": "12.345.678/0001-90",
    "companyCompleteAddress": "AV PAULISTA, 1000 BELA VISTA - SP 01310-100",
    "companyAddressStreet": "AV PAULISTA",
    "companyAddressNumber": "1000",
    "companyAddressNeighborhood": "BELA VISTA",
    "companyAddressCity": "SAO PAULO",
    "companyAddressState": "SP",
    "companyAddressPostalCode": "01310100",
    "companyAddressExtraInfo": "",
    "employeeName": "Maria Silva Santos",
    "employeePersonalTaxId": "123.456.789-01",
    "employeeCompleteAddress": "RUA DAS FLORES, 50 - SP",
    "employeeRole": "Analista de Sistemas",
    "employeeContractType": "Prazo indeterminado",
    "employeeHireDate": "01/02/2020",
    "employeeEndDate": "",
    "employeeBaseIncome": 7500.0,
    "employeeGrossIncome": 8250.0,
    "employeeTotalDeductions": 1320.5,
    "employeeNetIncome": 6929.5,
    "employeeBankNumber": "341",
    "employeeBankBranchNumber": "1234-5",
    "employeeBankAccountNumber": "67890-1",
    "employeeRetirementIndicative": "",
    "employmentStatus": "Aberto"
  }
}
```

{% endtab %}

{% tab title="Validation Rules" %}

| Validation rule      | Behaviour for `PROOF_OF_INCOME`                                                                                                                                                                       |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Document Validity    | Uses `relatedMonth` + `relatedYear` (end of the reference month) compared against `attributes.analysisDate`. Default expiration window is 180 days; configurable in the template.                     |
| Document Holder      | Compares `attributes.holderName` against `employeeName` (substring, case/accent-insensitive) and/or `attributes.holderCpf` (fallback `attributes.cpf`) against `employeePersonalTaxId` (digits only). |
| Required Fields      | Validates that every term configured in `requiredTerms` is present.                                                                                                                                   |
| Address Completeness | Validates the **employee** address (`employeeCompleteAddress`). When the employee address is not extracted, the company address is used and a warning is added.                                       |
| {% endtab %}         |                                                                                                                                                                                                       |
| {% endtabs %}        |                                                                                                                                                                                                       |

## Specific attributes (PROOF\_OF\_INCOME · INCOME\_TAX\_RETURN)

When the document is classified as `PROOF_OF_INCOME` with `subClass = INCOME_TAX_RETURN` (Recibo de Entrega da Declaração de Imposto de Renda), a different set of fields is extracted.

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

| Attribute                      | Type    | Description                                                                                                                                              |
| ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| fiscalYear                     | Integer | Fiscal year of the return (e.g. `2024`).                                                                                                                 |
| calendarYear                   | Integer | Calendar year of the income reported (e.g. `2023`).                                                                                                      |
| taxpayerType                   | String  | Taxpayer type (e.g. `personal`, `business`).                                                                                                             |
| taxpayerName                   | String  | Taxpayer full name.                                                                                                                                      |
| taxpayerPersonalTaxId          | String  | Taxpayer CPF.                                                                                                                                            |
| taxpayerBusinessTaxId          | String  | Taxpayer CNPJ when the return belongs to a legal entity.                                                                                                 |
| taxpayerBirthDate              | String  | Taxpayer birth date (`DD/MM/YYYY`).                                                                                                                      |
| taxpayerCompleteAddress        | String  | Taxpayer complete address.                                                                                                                               |
| taxpayerEmail                  | String  | Taxpayer e-mail when present.                                                                                                                            |
| taxpayerRoleNature             | String  | Nature of the role (e.g. `Empregado`, `Autônomo`).                                                                                                       |
| taxpayerMainRole               | String  | Taxpayer main role/occupation.                                                                                                                           |
| taxpayerTotalTaxableIncome     | Float   | Total taxable income.                                                                                                                                    |
| taxpayerTotalNonTaxableIncome  | Float   | Total non-taxable income.                                                                                                                                |
| taxpayerExclusiveTaxableIncome | Float   | Exclusive taxable income.                                                                                                                                |
| taxpayerCalculatedMontlyIncome | Float   | Calculated average monthly income, based on equation (taxpayerTotalTaxableIncome + taxpayerTotalNonTaxableIncome + taxpayerExclusiveTaxableIncome) / 12. |
| {% endtab %}                   |         |                                                                                                                                                          |

{% tab title="Example" %}

```json
{
  "smartOcr": {
    "documentClass": "PROOF_OF_INCOME",
    "subClass": "INCOME_TAX_RETURN",
    "fiscalYear": 2024,
    "calendarYear": 2023,
    "taxpayerType": "private",
    "taxpayerName": "Maria Silva Santos",
    "taxpayerPersonalTaxId": "123.456.789-01",
    "taxpayerBusinessTaxId": "",
    "taxpayerBirthDate": "12/05/1985",
    "taxpayerCompleteAddress": "RUA OSVALDO ARANHA, 123 CENTRO - SP 01310-000",
    "taxpayerEmail": "maria.silva@example.com",
    "taxpayerRoleNature": "Empregado",
    "taxpayerMainRole": "Analista de Sistemas",
    "taxpayerTotalTaxableIncome": 99000.0,
    "taxpayerTotalNonTaxableIncome": 12000.0,
    "taxpayerExclusiveTaxableIncome": 1500.0,
    "taxpayerCalculatedMontlyIncome": 8250.0
  }
}
```

{% endtab %}

{% tab title="Validation Rules" %}

| Validation rule      | Behaviour for `INCOME_TAX_RETURN`                                                                                                                                                                             |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Document Validity    | Uses the end of `fiscalYear` (or `calendarYear` when fiscal year is missing) compared against `attributes.analysisDate`. Default expiration window is 365 days for tax returns; configurable in the template. |
| Document Holder      | Compares `attributes.holderName` against `taxpayerName` and/or `attributes.holderCpf` (fallback `attributes.cpf`) against `taxpayerPersonalTaxId`.                                                            |
| Required Fields      | Validates configured `requiredTerms`.                                                                                                                                                                         |
| Address Completeness | Validates `taxpayerCompleteAddress` as a single string (not component-by-component).                                                                                                                          |
| {% endtab %}         |                                                                                                                                                                                                               |
| {% endtabs %}        |                                                                                                                                                                                                               |

## Specific attributes (SOCIAL\_CONTRACT)

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

| Attribute                          | Type            | Description                                                                              |
| ---------------------------------- | --------------- | ---------------------------------------------------------------------------------------- |
| companyName                        | String          | Company legal/fantasy name (Razão Social).                                               |
| companyBusinessTaxId               | String          | Parent company CNPJ.                                                                     |
| companyCnae                        | Array of String | Main activity CNAE codes and descriptions ("o objeto da sociedade").                     |
| companyType                        | String          | Company type (e.g. `Sociedade Empresária Limitada`, `Sociedade Simples Limitada`).       |
| companyCompleteAddress             | String          | Company complete address.                                                                |
| companyAddressStreet               | String          | Company street component.                                                                |
| companyAddressNumber               | String          | Company number component.                                                                |
| companyAddressNeighborhood         | String          | Company neighborhood component.                                                          |
| companyAddressCity                 | String          | Company city component.                                                                  |
| companyAddressState                | String          | Company UF.                                                                              |
| companyAddressPostalCode           | String          | Company CEP.                                                                             |
| companyAddressExtraInfo            | String          | Company address extra information.                                                       |
| companyIncorporationDate           | String          | Company incorporation date (`DD/MM/YYYY`).                                               |
| companyIsActive                    | Boolean         | `true` when the document indicates indefinite duration (no expiration date).             |
| companyQuotasTotal                 | Integer         | Total amount of quotas.                                                                  |
| companyQuotasCurrency              | String          | Currency of the quotas (e.g. `BRL`).                                                     |
| companyQuotasValue                 | Float           | Value of one quota.                                                                      |
| shareholderName{N}                 | String          | Name of shareholder N (1, 2, 3...).                                                      |
| shareholderPersonalTaxId{N}        | String          | CPF of shareholder N (when shareholder is a person).                                     |
| shareholderRole{N}                 | String          | Role of shareholder N (e.g. `Sócio Administrador`, `Procurador`, `Representante Legal`). |
| shareholderPowers{N}               | Array of String | Powers granted to shareholder N.                                                         |
| shareholderSignAlone{N}            | Boolean         | `true` only when the document explicitly states the shareholder can sign alone.          |
| shareholderSignAloneDescription{N} | String          | Textual description of the signing rule.                                                 |
| shareholderRestrictions{N}         | Array of String | Restrictions applicable to shareholder N.                                                |
| shareholderQuotas{N}               | Integer         | Quotas owned by shareholder N.                                                           |
| shareholderBusinessTaxId{N}        | String          | CNPJ of shareholder N (when shareholder is a company).                                   |
| shareholderAddress{N}              | String          | Address of shareholder N (when shareholder is a company).                                |
| shareholderMandateStartDate{N}     | String          | Mandate start date (when shareholder is a company).                                      |
| shareholderMandateEndDate{N}       | String          | Mandate end date (when shareholder is a company).                                        |
| shareholderSignatureType{N}        | String          | `digital_signature` or `physical_signature`.                                             |
| shareholderSignatureMet{N}         | Boolean         | `true` when the signature was found in the document.                                     |
| {% endtab %}                       |                 |                                                                                          |

{% tab title="Example" %}

```json
{
  "smartOcr": {
    "documentClass": "SOCIAL_CONTRACT",
    "subClass": null,
    "companyName": "EMPRESA EXEMPLO LTDA",
    "companyBusinessTaxId": "12.345.678/0001-90",
    "companyCnae": [
      "62.01-5-01 - Desenvolvimento de programas de computador sob encomenda"
    ],
    "companyType": "Sociedade Empresária Limitada",
    "companyCompleteAddress": "AV PAULISTA, 1000 BELA VISTA - SP 01310-100",
    "companyAddressStreet": "AV PAULISTA",
    "companyAddressNumber": "1000",
    "companyAddressNeighborhood": "BELA VISTA",
    "companyAddressCity": "SAO PAULO",
    "companyAddressState": "SP",
    "companyAddressPostalCode": "01310100",
    "companyAddressExtraInfo": "",
    "companyIncorporationDate": "15/01/2018",
    "companyIsActive": true,
    "companyQuotasTotal": 100000,
    "companyQuotasCurrency": "BRL",
    "companyQuotasValue": 1.0,
    "shareholderName1": "Maria Silva Santos",
    "shareholderPersonalTaxId1": "123.456.789-01",
    "shareholderRole1": "Sócio Administrador",
    "shareholderPowers1": [
      "Abertura e movimentação de contas bancárias",
      "Assinatura de contratos"
    ],
    "shareholderSignAlone1": true,
    "shareholderSignAloneDescription1": "Assina isoladamente",
    "shareholderRestrictions1": [],
    "shareholderQuotas1": 60000,
    "shareholderBusinessTaxId1": "",
    "shareholderAddress1": "",
    "shareholderMandateStartDate1": "",
    "shareholderMandateEndDate1": "",
    "shareholderSignatureType1": "digital_signature",
    "shareholderSignatureMet1": true,
    "shareholderName2": "João Oliveira",
    "shareholderPersonalTaxId2": "987.654.321-00",
    "shareholderRole2": "Sócio",
    "shareholderQuotas2": 40000,
    "shareholderSignAlone2": false,
    "shareholderSignAloneDescription2": "Assina em conjunto com Maria Silva Santos"
  }
}
```

{% endtab %}

{% tab title="Validation Rules" %}

| Validation rule      | Behaviour for `SOCIAL_CONTRACT`                                                                                                                                                               |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Document Validity    | Uses `companyIncorporationDate` compared against `attributes.analysisDate`. Default window is broader (configurable). Documents whose incorporation date is in the future are always invalid. |
| Document Holder      | Compares `attributes.holderName` against `shareholderName1` (and/or every `shareholderName{N}`) and `attributes.holderCpf` (fallback `attributes.cpf`) against `shareholderPersonalTaxId{N}`. |
| Required Fields      | Validates configured `requiredTerms` (typical use: ensure shareholder powers, quotas and incorporation date are present).                                                                     |
| Address Completeness | Validates the **headquarter** address (`companyCompleteAddress`). When only branch addresses are extracted, an informative warning is added.                                                  |
| {% endtab %}         |                                                                                                                                                                                               |
| {% endtabs %}        |                                                                                                                                                                                               |

## Specific attributes (POWER\_OF\_ATTORNEY)

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

| Attribute                        | Type            | Description                                                                                           |
| -------------------------------- | --------------- | ----------------------------------------------------------------------------------------------------- |
| companyName                      | String          | Granting company name (when applicable).                                                              |
| companyBusinessTaxId             | String          | Granting company CNPJ.                                                                                |
| companyCompleteAddress           | String          | Company complete address.                                                                             |
| companyAddressStreet             | String          | Company street component.                                                                             |
| companyAddressNumber             | String          | Company number component.                                                                             |
| companyAddressNeighborhood       | String          | Company neighborhood component.                                                                       |
| companyAddressCity               | String          | Company city component.                                                                               |
| companyAddressState              | String          | Company UF.                                                                                           |
| companyAddressPostalCode         | String          | Company CEP.                                                                                          |
| companyAddressExtraInfo          | String          | Company address extra information.                                                                    |
| shareholderName{N}               | String          | Grantor (outorgante) full name.                                                                       |
| shareholderPersonalTaxId{N}      | String          | Grantor CPF.                                                                                          |
| shareholderRole{N}               | String          | Grantor role (e.g. `Outorgante`, `Sócio Administrador`).                                              |
| shareholderPowers{N}             | Array of String | Powers granted by grantor N.                                                                          |
| shareholderSignAlone{N}          | Boolean         | Whether grantor N can sign alone.                                                                     |
| assigneeName{N}                  | String          | Assignee (outorgado) full name.                                                                       |
| assigneeSignsAlone               | Boolean         | `true` when the assignee can sign alone after the PoA.                                                |
| signObservation                  | String          | Observations about the signing rule.                                                                  |
| powersGranted                    | Array of String | Consolidated list of powers granted in the PoA.                                                       |
| type                             | String          | `public`, `private` or `invalid`.                                                                     |
| hasExpirationDate                | Boolean         | `true` when the PoA has an expiration date.                                                           |
| expirationDate                   | String          | Expiration date (empty when `hasExpirationDate` is `false`).                                          |
| hasNotaryStamps                  | Boolean         | `true` when at least one notary stamp was found.                                                      |
| notaryStampAuthenticationForm{N} | String          | Authentication form of stamp N (`Assinado digitalmente via GOV.BR`, `Reconhecimento de Firma`, etc.). |
| notaryStampName{N}               | String          | Name on stamp N (when readable).                                                                      |
| isValidNotaryStamp{N}            | Boolean         | Whether stamp N is considered valid.                                                                  |
| notaryStampType{N}               | String          | `digital_signature` or `handwritten_signature`.                                                       |
| isValid                          | Boolean         | Final validity decision computed by the model.                                                        |
| textualDecision                  | String          | Textual explanation of `isValid`.                                                                     |
| {% endtab %}                     |                 |                                                                                                       |

{% tab title="Example" %}

```json
{
  "smartOcr": {
    "documentClass": "POWER_OF_ATTORNEY",
    "subClass": null,
    "companyName": "EMPRESA EXEMPLO LTDA",
    "companyBusinessTaxId": "12.345.678/0001-90",
    "companyCompleteAddress": "AV PAULISTA, 1000 BELA VISTA - SP 01310-100",
    "shareholderName1": "Maria Silva Santos",
    "shareholderPersonalTaxId1": "123.456.789-01",
    "shareholderRole1": "Outorgante",
    "shareholderPowers1": ["Abrir contas bancárias", "Assinar contratos"],
    "shareholderSignAlone1": true,
    "assigneeName1": "João Oliveira",
    "assigneeSignsAlone": true,
    "signObservation": "Outorgante com poderes para assinar isoladamente.",
    "powersGranted": [
      "Abrir contas bancárias",
      "Movimentar contas bancárias",
      "Assinar contratos"
    ],
    "type": "public",
    "hasExpirationDate": true,
    "expirationDate": "31/12/2026",
    "hasNotaryStamps": true,
    "notaryStampAuthenticationForm1": "Reconhecimento de Firma",
    "notaryStampName1": "Maria Silva Santos",
    "isValidNotaryStamp1": true,
    "notaryStampType1": "handwritten_signature",
    "isValid": true,
    "textualDecision": "Procuração pública com firma reconhecida e poderes claros para movimentação bancária."
  }
}
```

{% endtab %}

{% tab title="Validation Rules" %}

| Validation rule      | Behaviour for `POWER_OF_ATTORNEY`                                                                                                                                                                                           |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Document Validity    | Uses `expirationDate` when `hasExpirationDate = true`; otherwise compares `attributes.analysisDate` (or the request date when omitted) against the PoA validity window. Documents past `expirationDate` are always invalid. |
| Document Holder      | Compares `attributes.holderName` against `shareholderName{N}` (grantors) and `attributes.holderCpf` (fallback `attributes.cpf`) against `shareholderPersonalTaxId{N}`.                                                      |
| Required Fields      | Validates configured `requiredTerms` (typical use: ensure powers like `Abrir conta bancária` are explicitly listed).                                                                                                        |
| Address Completeness | Validates `companyCompleteAddress` as a single string.                                                                                                                                                                      |
| {% endtab %}         |                                                                                                                                                                                                                             |
| {% endtabs %}        |                                                                                                                                                                                                                             |

## Specific attributes (GENERIC)

When the document does not match any of the categories above, Smart OCR falls back to the `GENERIC` schema with role-based fields. Field names follow the pattern `{role}{Property}` (e.g. `payerName`, `receiverBusinessTaxId`). Fields naming may vary from one document to another;

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

| Attribute              | Type   | Description                               |
| ---------------------- | ------ | ----------------------------------------- |
| issueDate              | String | Document issue date when present.         |
| dueDate                | String | Document due date when present.           |
| payerName              | String | Payer / debtor full name.                 |
| payerPersonalTaxId     | String | Payer CPF.                                |
| payerBusinessTaxId     | String | Payer CNPJ.                               |
| receiverName           | String | Receiver / creditor full name.            |
| receiverPersonalTaxId  | String | Receiver CPF.                             |
| receiverBusinessTaxId  | String | Receiver CNPJ.                            |
| companyName            | String | Company name when applicable.             |
| companyBusinessTaxId   | String | Company CNPJ when applicable.             |
| companyAddress         | String | Company address when applicable.          |
| companyCompleteAddress | String | Company complete address when applicable. |
| netAmount              | Float  | Net monetary amount when present.         |
| grossAmount            | Float  | Gross monetary amount when present.       |
| {% endtab %}           |        |                                           |

{% tab title="Example" %}

```json
{
  "smartOcr": {
    "documentClass": "GENERIC",
    "subClass": null,
    "issueDate": "15/08/2025",
    "dueDate": "26/09/2025",
    "payerName": "JOÃO DA SILVA",
    "payerPersonalTaxId": "486.884.452-13",
    "receiverName": "EMBALAGENS DO SUL LTDA",
    "receiverBusinessTaxId": "98.765.432/0001-10",
    "companyName": "EMBALAGENS DO SUL LTDA",
    "companyBusinessTaxId": "98.765.432/0001-10",
    "companyAddress": "RUA OSVALDO ARANHA, 123 BAIRRO CENTRO - RS 96800-215",
    "companyCompleteAddress": "RUA OSVALDO ARANHA, 123 BAIRRO CENTRO - RS 96800-215",
    "netAmount": 1850.0,
    "grossAmount": 2000.0
  }
}
```

{% endtab %}

{% tab title="Validation Rules" %}

| Validation rule      | Behaviour for `GENERIC`                                                                                                                                                          |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Document Validity    | Uses `issueDate` (or `dueDate` as fallback) compared against `attributes.analysisDate`. Documents that have neither cannot be validated and stay `PENDING`.                      |
| Document Holder      | Compares `attributes.holderName` against `payerName`/`receiverName` and `attributes.holderCpf` (fallback `attributes.cpf`) against `payerPersonalTaxId`/`receiverPersonalTaxId`. |
| Required Fields      | Validates configured `requiredTerms` (typical use: ensure that contract clauses are present).                                                                                    |
| Address Completeness | Validates `companyCompleteAddress` as a single string when present.                                                                                                              |
| {% endtab %}         |                                                                                                                                                                                  |
| {% endtabs %}        |                                                                                                                                                                                  |

## Validation rules

The `smart_ocr` rules below can be enabled in the [transaction template](/caf-api/connect/transactions/validation-rules). The descriptions below document the behaviour exposed publicly; template-only configuration knobs (such as `documentTypeRules` or `requiredTerms`) are managed in Trust.

| Rule key                                      | Title                                 | Request parameters                                                          | Status values                 |
| --------------------------------------------- | ------------------------------------- | --------------------------------------------------------------------------- | ----------------------------- |
| `verifai_smart_ocr_document_validity`         | Document Validity                     | `attributes.analysisDate`                                                   | `VALID`, `INVALID`, `PENDING` |
| `verifai_smart_ocr_document_holder`           | Document Holder                       | `attributes.holderName`, `attributes.holderCpf` (fallback `attributes.cpf`) | `VALID`, `INVALID`, `PENDING` |
| `verifai_smart_ocr_required_fields`           | Required Fields                       | — (configured via `requiredTerms` in the template)                          | `VALID`, `INVALID`, `PENDING` |
| `verifai_smart_ocr_address_completeness`      | Address Completeness                  | —                                                                           | `VALID`, `INVALID`, `PENDING` |
| `smart_ocr_proof_of_residence_barcode_exists` | Barcode on proof of residence         | —                                                                           | `VALID`, `INVALID`, `PENDING` |
| `smart_ocr_proof_of_residence_barcode_match`  | Proof of residence barcode comparison | — (configured via `fieldsToCompare` in the template)                        | `VALID`, `INVALID`, `PENDING` |

### Document Validity (`verifai_smart_ocr_document_validity`)

Verifies whether the document was issued within the configured maximum window. The rule uses the document issue date, due date or reference month/year (whichever is available for the document class) to compute how many days have passed compared to the `analysisDate` provided in the request — or the request date when omitted. The default window is **180 days** and can be customized per document class via `documentTypeRules` in the template (`maxDays`, `maxMonths`, `lastMonth`, `lastYear`). Documents whose date is in the future relative to `analysisDate` are always considered invalid.

### Document Holder (`verifai_smart_ocr_document_holder`)

Verifies whether the document belongs to the expected holder. The rule compares the holder name and/or CPF extracted from the document with the values informed in `attributes.holderName` and `attributes.holderCpf`. Name comparison is case-insensitive and accent-insensitive (substring match); CPF comparison uses digits only. Either match is enough — the rule is `VALID` when at least one of the provided values matches the corresponding field in the document.

### Required Fields (`verifai_smart_ocr_required_fields`)

Verifies that the terms listed in `requiredTerms` (configured per document class in the template) are all present in the extraction. A term is considered found when at least one extracted field has a label/metadata correspondence and a non-empty value.

### Address Completeness (`verifai_smart_ocr_address_completeness`)

Verifies whether the document address is complete (street, number, postal code, neighborhood and city). `PROOF_OF_RESIDENCE` validates each component individually using the dedicated `customerAddress*` fields, while other document classes validate `companyCompleteAddress` / `taxpayerCompleteAddress` as a single string. When `PROOF_OF_INCOME` or `SOCIAL_CONTRACT` documents extract only secondary addresses (employee address, branch address), an informative warning is added to the rule output without changing its status.

### Barcode on proof of residence (`smart_ocr_proof_of_residence_barcode_exists`)

Verifies whether the proof of residence is a payment slip, by decoding the printed barcode and checking the check digit of its 44 digits — which proves the reading is correct.

A proof of residence whose barcode cannot be read is **not approved**. The barcode is the source of truth and the printed digitable line does not replace it.

This rule applies **only** to documents classified as `PROOF_OF_RESIDENCE`. A document of any other class is not evaluated and the rule stays `VALID`.

### Proof of residence barcode comparison (`smart_ocr_proof_of_residence_barcode_match`)

Verifies the payment slip against itself, in three steps. The check stops at the first step that fails, because after a failure the following one no longer says anything.

| Step | Verifies                                                      | A failure means                                     |
| ---- | ------------------------------------------------------------- | --------------------------------------------------- |
| 1    | the barcode is readable and its check digit holds             | the barcode could not be read                       |
| 2    | the 44 digits match the printed digitable line                | the barcode or the digitable line was tampered with |
| 3    | the encoded values match the fields read on the document body | the barcode or the slip body was tampered with      |

Step 3 covers the fields selected in `fieldsToCompare`:

| Value      | Compares                                                |
| ---------- | ------------------------------------------------------- |
| `AMOUNT`   | the amount encoded in the barcode against `amount`      |
| `DUE_DATE` | the due date encoded in the barcode against `dueDate`   |
| `BANK`     | the bank code encoded in the barcode against `bankCode` |

A field the slip format does not carry is ignored, and the remaining selected fields are still compared: a collection slip — the usual format on a utility bill — carries neither a due date nor a bank code. A field that should exist and was not read fails the rule, as does a divergence.

With no `fieldsToCompare` configured the rule stays `PENDING`. Like the rule above, it applies only to `PROOF_OF_RESIDENCE`.

For configuration of which rules are enabled per template and how `availableActions` are interpreted, see [Validation rules](/caf-api/connect/transactions/validation-rules).


# Background check

The data sources are a complement of data and allows the complete generation of a dossier with relevant information about the individual (KYC), company (KYB) or vehicle.

#### See the data sources for each proposal:

{% content-ref url="/pages/FyRKhK5084tvYeheEz4H" %}
[KYC](/caf-api/connect/transactions/background-check/kyc)
{% endcontent-ref %}

{% content-ref url="/pages/uBZgrndMqwzSZnSrf47H" %}
[KYB](/caf-api/connect/transactions/background-check/kyb)
{% endcontent-ref %}

{% content-ref url="/pages/6cdqBZBf9AWIk2iCbzpF" %}
[Vehicle](/caf-api/connect/transactions/background-check/vehicle)
{% endcontent-ref %}


# Data structure

### Status Code

The data sources return a code that details the status of the query. This code is identified as `statusCode` and helps in interpreting the results.

| Value    | Description                  |
| -------- | ---------------------------- |
| 01       | Query performed successfully |
| 02       | Invalid or insufficient data |
| 05       | Awaiting processing          |
| 50 or 70 | Failed to perform query      |
| 55       | Unavailable                  |

### Data

The data sources return, by default, an object called `data` that contains the queried data. Each source has a different schema for returns in this field and this can be seen on each source's page.


# KYC

{% content-ref url="/pages/WKJg1EmdjNdxC4I6l0w1" %}
[Driver](/caf-api/connect/transactions/background-check/kyc/driver)
{% endcontent-ref %}

{% content-ref url="/pages/t8c2ex2PdIlBLj5cf0aX" %}
[Financial](/caf-api/connect/transactions/background-check/kyc/financial)
{% endcontent-ref %}

{% content-ref url="/pages/kdwdM22kswtBrzEaxoq2" %}
[Labor](/caf-api/connect/transactions/background-check/kyc/labor)
{% endcontent-ref %}

{% content-ref url="/pages/xS9Bx97lDJHPfpgGVOoC" %}
[Register data](/caf-api/connect/transactions/background-check/kyc/register-data)
{% endcontent-ref %}

{% content-ref url="/pages/mvk00bF9vYLKI17YeANZ" %}
[Relationships](/caf-api/connect/transactions/background-check/kyc/relationships)
{% endcontent-ref %}

{% content-ref url="/pages/rpfd3Gg4nGNuvVS8z1LE" %}
[Risk](/caf-api/connect/transactions/background-check/kyc/risk)
{% endcontent-ref %}

{% content-ref url="/pages/jalP7Ulq52Yv0tWv1ut4" %}
[Documents](/caf-api/connect/transactions/background-check/kyc/documents)
{% endcontent-ref %}


# Driver

## DENATRAN Driver Data + Traffic Violations

Consultation of driver data and possible CPF traffic violations with Denatran.

**Section:** `denatranDriverViolations`

**Required parameters:** `cpf`

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

| Attribute                                                    | Type    | Description                                                                                         |
| ------------------------------------------------------------ | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                                                   | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                                         | Object  | Return data                                                                                         |
| data.message                                                 | String  | Description of the query status                                                                     |
| data.driver                                                  | Object  | Contains the driver's information                                                                   |
| data.driver.isDriver                                         | Boolean | If you have a driver for the document entered (T/F)                                                 |
| data.driver.cnhNumber                                        | String  | CNH number                                                                                          |
| data.driver.cnhIssuerAgency                                  | String  | CNH issuing agency                                                                                  |
| data.driver.driverName                                       | String  | Driver's name                                                                                       |
| data.driver.driverGender                                     | String  | Sex of the driver                                                                                   |
| data.driver.driverBirthDate                                  | String  | Driver's date of birth                                                                              |
| data.driver.driverCpf                                        | String  | Driver's CPF                                                                                        |
| data.driver.documentType                                     | String  | Document Type                                                                                       |
| data.driver.driverDocumentType                               | String  | Identity document type                                                                              |
| data.driver.driverDocumentIssuer                             | String  | Document issuing agency                                                                             |
| data.driver.documentNumber                                   | String  | Document number                                                                                     |
| data.driver.driverNationality                                | String  | Nationality                                                                                         |
| data.driver.driverMotherName                                 | String  | Mother's name                                                                                       |
| data.driver.driverFatherName                                 | String  | Father's name                                                                                       |
| data.driver.driverFirstLicenseDate                           | String  | Date of first driver's license                                                                      |
| data.driver.pguId                                            | String  | PGU Code                                                                                            |
| data.driver.cnhCategory                                      | String  | CNH Category                                                                                        |
| data.driver.addressUsedCnhRequest                            | String  | Cadastral address used in the CNH                                                                   |
| data.driver.addressStreet                                    | String  | Street address                                                                                      |
| data.driver.addressNumber                                    | String  | Address number                                                                                      |
| data.driver.addressComplement                                | String  | Address complement                                                                                  |
| data.driver.addressNeighborhood                              | String  | Neighborhood                                                                                        |
| data.driver.addressZipCode                                   | String  | ZIP code                                                                                            |
| data.driver.addressCityCode                                  | String  | City code                                                                                           |
| data.driver.addressCityName                                  | String  | City name                                                                                           |
| data.driver.addressState                                     | String  | Address state                                                                                       |
| data.driver.cnhStatus                                        | String  | CNH Status                                                                                          |
| data.driver.previousCnhStatus                                | String  | Previous CNH status                                                                                 |
| data.driver.cnhExpirationDate                                | String  | CNH expiration date                                                                                 |
| data.driver.ufDomain                                         | String  | UF Domain                                                                                           |
| data.driver.renachFormNumber                                 | Number  | Renach form number                                                                                  |
| data.driver.cnhFormNumber                                    | Number  | CNH form number                                                                                     |
| data.driver.impedimentListNumber                             | Number  | Impediment list number                                                                              |
| data.driver.ufDocumentIssuer                                 | String  | State of the Document Sender                                                                        |
| data.driver.placeOfBirth                                     | String  | Birthplace                                                                                          |
| data.driver.birthplaceCode                                   | String  | IBGE code of birthplace                                                                             |
| data.driver.birthplaceName                                   | String  | Name of birthplace                                                                                  |
| data.driver.requestReason1                                   | String  | Reason for request 1                                                                                |
| data.driver.requestReason2                                   | String  | Reason for request 2                                                                                |
| data.driver.requestReason3                                   | String  | Reason for request 3                                                                                |
| data.driver.requestReason4                                   | String  | Reason for request 4                                                                                |
| data.driver.ufFirstDriverLicense                             | String  | UF of first qualification                                                                           |
| data.driver.relegatedCategory                                | String  | Downgraded Category                                                                                 |
| data.driver.authorizedCategory                               | String  | Authorized Category                                                                                 |
| data.driver.ufCurrentDriverLicense                           | String  | UF of current qualification                                                                         |
| data.driver.cnhRemarksTable                                  | String  | Current Observation Board                                                                           |
| data.driver.ufTransferApplicant                              | String  | UF of the transfer requester                                                                        |
| data.driver.permitHolder                                     | Number  | Permissionary                                                                                       |
| data.driver.cancellation                                     | String  | Cancellation                                                                                        |
| data.driver.lastRecordEmissionDate                           | String  | History Issue Date                                                                                  |
| data.driver.lastTransitionUpdateId                           | String  | Transaction code from the last update                                                               |
| data.driver.lastTransitionUpdateDate                         | String  | Transaction date of the last update                                                                 |
| data.driver.courseTppRating                                  | String  | TPP course rating                                                                                   |
| data.driver.ufCourseTpp                                      | String  | TPP course UF                                                                                       |
| data.driver.courseTeRating                                   | String  | TE course rating                                                                                    |
| data.driver.ufCourseTe                                       | String  | UF of TE course                                                                                     |
| data.driver.courseTcpRating                                  | String  | TCP course rating                                                                                   |
| data.driver.ufCourseTcp                                      | String  | UF of course TCP                                                                                    |
| data.driver.courseTveRating                                  | String  | TVE course rating                                                                                   |
| data.driver.ufCourseTve                                      | String  | UF of course TVE                                                                                    |
| data.driver.courseTciRating                                  | String  | TCI course rating                                                                                   |
| data.driver.ufCourseTci                                      | String  | UF of TCI course                                                                                    |
| data.driver.courseTmtRating                                  | String  | TMT course rating                                                                                   |
| data.driver.ufCourseTmt                                      | String  | UF of TMT course                                                                                    |
| data.driver.courseTmfRating                                  | String  | TMF course rating                                                                                   |
| data.driver.ufCourseTmf                                      | String  | UF of TMF course                                                                                    |
| data.driver.ufRecyclingCourseViolator                        | String  | UF of offender refresher course                                                                     |
| data.driver.modalityRecyclingCourseViolator                  | String  | Modality of the offender refresher course                                                           |
| data.driver.ufRefreshCourseCnh                               | String  | UF of the CNH renewal course                                                                        |
| data.driver.refreshCourseCnh                                 | String  | Modality of the CNH renewal course                                                                  |
| data.driver.nationalRegistrationForeigner                    | String  | Foreign national registration                                                                       |
| data.driver.countryOriginDriverLicense                       | String  | Country of origin of the foreign qualification                                                      |
| data.driver.foreignDriverLicenseId                           | String  | Identification of the foreign qualification                                                         |
| data.driver.expirationDatePid                                | String  | PID expiration date                                                                                 |
| data.driver.ufExpeditionPid                                  | String  | UF of dispatch of the PID                                                                           |
| data.driver.numberFormCnhBasedPid                            | String  | PID-based CNH form number                                                                           |
| data.driver.requestReasonPid1                                | String  | Reason for PID 1 request                                                                            |
| data.driver.requestReasonPid2                                | String  | Reason for PID 2 request                                                                            |
| data.driver.requestReasonPid3                                | String  | Reason for PID 3 request                                                                            |
| data.driver.requestReasonPid4                                | String  | Reason for PID 4 request                                                                            |
| data.driver.statusPid                                        | String  | PID Status                                                                                          |
| data.driver.medicalRestrictions                              | String  | Medical restrictions                                                                                |
| data.driver.quantityIncidentsImpediments                     | String  | Number of Occurrences and/or Impediments                                                            |
| data.violations                                              | Array   | List of traffic violations                                                                          |
| data.violations\[x].violationId                              | String  | Infraction Code                                                                                     |
| data.violations\[x].violationBreakdownId                     | String  | Infraction Deployment Code                                                                          |
| data.violations\[x].violationDescription                     | String  | Infraction Description                                                                              |
| data.violations\[x].renainfId                                | String  | Renainf Code                                                                                        |
| data.violations\[x].violationRegistrationDate                | String  | Date of Infraction Registration                                                                     |
| data.violations\[x].actuatorAgencyState                      | String  | UF of the Authorizing Body                                                                          |
| data.violations\[x].plate                                    | String  | Plate                                                                                               |
| data.violations\[x].renavamId                                | String  | Renavam Code                                                                                        |
| data.violations\[x].modelBrandId                             | String  | Vehicle make and model code                                                                         |
| data.violations\[x].modelBrandDescription                    | String  | Description of the vehicle make and model                                                           |
| data.violations\[x].vehicleTypeId                            | Number  | Vehicle type code                                                                                   |
| data.violations\[x].vehicleTypeDescription                   | String  | Vehicle type description                                                                            |
| data.violations\[x].vehicleColorId                           | Number  | Vehicle color code                                                                                  |
| data.violations\[x].vehicleColorDescription                  | String  | Vehicle Color Description                                                                           |
| data.violations\[x].vehicleKindId                            | Number  | Vehicle type code                                                                                   |
| data.violations\[x].vehicleKindDescription                   | String  | Description of the vehicle type                                                                     |
| data.violations\[x].vehicleBodyworkId                        | Number  | Vehicle body code                                                                                   |
| data.violations\[x].vehicleBodyworkDescription               | String  | Description of the vehicle body                                                                     |
| data.violations\[x].vehicleCategoryId                        | Number  | Vehicle category code                                                                               |
| data.violations\[x].vehicleCategoryDescription               | String  | Vehicle category description                                                                        |
| data.violations\[x].vehicleJurisdictionState                 | String  | UF of the vehicle's jurisdiction                                                                    |
| data.violations\[x].informedRegistrationState                | String  | State where the vehicle was registered                                                              |
| data.violations\[x].registrationCityId                       | Number  | Code of the municipality where the vehicle is registered                                            |
| data.violations\[x].registrationCityDescription              | String  | Description of the municipality where the vehicle is registered                                     |
| data.violations\[x].vehicleCoutryId                          | Number  | Vehicle country code                                                                                |
| data.violations\[x].vehicleCoutryDescription                 | String  | Country description of the vehicle                                                                  |
| data.violations\[x].restrictionId1                           | Number  | Restriction code 1                                                                                  |
| data.violations\[x].restrictionDescription1                  | String  | Description of Constraint 1                                                                         |
| data.violations\[x].restrictionId2                           | Number  | Restriction code 2                                                                                  |
| data.violations\[x].restrictionDescription2                  | String  | Description of Constraint 2                                                                         |
| data.violations\[x].restrictionId3                           | Number  | Restriction code 3                                                                                  |
| data.violations\[x].restrictionDescription3                  | String  | Description of Constraint 3                                                                         |
| data.violations\[x].restrictionId4                           | Number  | Restriction code 4                                                                                  |
| data.violations\[x].restrictionDescription4                  | String  | Description of Constraint 4                                                                         |
| data.violations\[x].restrictionIndicatorRenajud              | Boolean | Renajud restriction indicator                                                                       |
| data.violations\[x].restrictionIndicatorRenavam              | Boolean | Renavam restriction indicator                                                                       |
| data.violations\[x].burglaryTheftIndicatorRenavam            | Boolean | Theft or Renavam indicator                                                                          |
| data.violations\[x].actuatorAgencyId                         | String  | Code of the Notary Body                                                                             |
| data.violations\[x].actuatorAgencyDescription                | String  | Description of the Notifying Body                                                                   |
| data.violations\[x].autoInfractionNumber                     | String  | Infraction notice number                                                                            |
| data.violations\[x].autoSignatureId                          | Number  | Infringement notice signature indicator                                                             |
| data.violations\[x].autoSignatureDescription                 | String  | Description of signature on the infraction notice                                                   |
| data.violations\[x].driverCnhModelId                         | Number  | Driver's CNH model code                                                                             |
| data.violations\[x].driverCnhModelDescription                | String  | Description of the driver's CNH model                                                               |
| data.violations\[x].driverCnhRegistrationNumber              | String  | Driver's CNH registration number code                                                               |
| data.violations\[x].driverCnhExpeditionState                 | String  | Description of the driver's CNH registration number                                                 |
| data.violations\[x].violationDate                            | String  | Date of infraction                                                                                  |
| data.violations\[x].violationTime                            | String  | Time of the infraction                                                                              |
| data.violations\[x].violationOccurrencePlace                 | String  | Place where the infraction occurred                                                                 |
| data.violations\[x].violationCityId                          | String  | City code of the infraction                                                                         |
| data.violations\[x].violationCityDescription                 | String  | Description of the city of infringement                                                             |
| data.violations\[x].autoTypeId                               | Number  | Auto type code                                                                                      |
| data.violations\[x].autoTypeDescription                      | String  | Description of the auto type                                                                        |
| data.violations\[x].notLicensedDriverDocumentNumber          | String  | Document number of the unlicensed driver                                                            |
| data.violations\[x].notLicensedDriverDocumentTypeId          | Number  | Unlicensed driver document number code                                                              |
| data.violations\[x].notLicensedDriverDocumentTypeDescription | String  | Description of the document number of the unlicensed driver                                         |
| data.violations\[x].actualMeasurement                        | String  | Actual Measurement                                                                                  |
| data.violations\[x].allowedLimit                             | String  | Allowed Limit                                                                                       |
| data.violations\[x].measurementConsidered                    | String  | Measurement Considered                                                                              |
| data.violations\[x].measurementUnitId                        | Number  | Unit of measure code                                                                                |
| data.violations\[x].measurementUnitDescription               | String  | Description of the unit of measure                                                                  |
| data.violations\[x].violationFullValue                       | String  | Full value of the violation                                                                         |
| data.violations\[x].vehicleOwnerOriginId                     | Number  | Code of the origin of the possessor                                                                 |
| data.violations\[x].vehicleOwnerOriginDescription            | String  | Description of the origin of the possessor                                                          |
| data.violations\[x].ownerDocumentTypeId                      | Number  | Code of the document type of the possessor                                                          |
| data.violations\[x].ownerDocumentTypeDescription             | String  | Description of the possessor's document type                                                        |
| data.violations\[x].ownerIdentificationNumber                | String  | Owner identification number                                                                         |
| data.violations\[x].ownerName                                | String  | Owner's name                                                                                        |
| data.violations\[x].notificationNoticeIssueDate              | String  | Date of issuance of the notice of violation                                                         |
| data.violations\[x].defenseNoticeLimitDate                   | String  | Deadline for defense of the infraction                                                              |
| data.violations\[x].notificationNoticeIndicator              | Boolean | Notification of notice indicator                                                                    |
| data.violations\[x].numberNotificationPenalty                | String  | Number of the penalty notice                                                                        |
| data.violations\[x].penaltyNotificationIssueDate             | String  | Date of issuance of penalty notice                                                                  |
| data.violations\[x].penaltyNotificationExpirationDate        | String  | Due date of penalty notice                                                                          |
| data.violations\[x].penaltyType                              | Number  | Penalty Type                                                                                        |
| data.violations\[x].penaltyDescription                       | String  | Description of the penalty                                                                          |
| data.violations\[x].violatorActualName                       | String  | Name of the real offender                                                                           |
| data.violations\[x].violatorActualCnhModelId                 | Number  | Model code of the real offender's CNH                                                               |
| data.violations\[x].violatorActualCnhModelDescription        | String  | Description of the model of the real offender's CNH                                                 |
| data.violations\[x].violatorActualCnhRegistrationNumber      | String  | CNH registration number of the real offender                                                        |
| data.violations\[x].driverActualCnhExpeditionState           | String  | UF of issue of the real driver's CNH                                                                |
| data.violations\[x].scoreAnalysisStatusId                    | String  | Score Analysis Status Indicator                                                                     |
| data.violations\[x].scoreAnalysisStatusDescription           | String  | Score Analysis Status Description                                                                   |
| data.violations\[x].scoredCnhModelId                         | Number  | Model code of the scored CNH                                                                        |
| data.violations\[x].scoredCnhModelDescription                | String  | Description of the model of the scored CNH                                                          |
| data.violations\[x].scoredCnhRegistrationNumber              | String  | Registration number of the scored CNH                                                               |
| data.violations\[x].scoredCnhExpeditionState                 | String  | UF of expedition of the scored CNH                                                                  |
| data.violations\[x].enforceabilityId                         | Number  | Demandability Indicator                                                                             |
| data.violations\[x].enforceabilityDescription                | String  | Description of the enforceability indicator                                                         |
| data.violations\[x].paymentState                             | String  | Uf of payment                                                                                       |
| data.violations\[x].violationPaymentDate                     | String  | Date of payment of the infraction                                                                   |
| data.violations\[x].violationPaidValue                       | String  | Paid amount of the infraction                                                                       |
| data.violations\[x].paymentRegistrationDate                  | String  | Record date of payment of the infraction                                                            |
| data.violations\[x].paymentsAmount                           | Number  | Total payments                                                                                      |
| data.violations\[x].occurrenceTypeId                         | Number  | Occurrence type code                                                                                |
| data.violations\[x].occurrenceTypeDescription                | String  | Description of the type of occurrence                                                               |
| data.violations\[x].occurrenceOriginDescription              | String  | Description of the origin of the occurrence                                                         |
| data.violations\[x].proccessNumber                           | String  | Case number                                                                                         |
| {% endtab %}                                                 |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "driver": {
      "isDriver": true,
      "cnhIssuerAgency": "SSP/DI",
      "driverName": "JOHN DOE",
      "driverGender": "MASCULINO",
      "driverBirthDate": "08/05/1987",
      "driverCpf": "123.456.789-00",
      "documentType": "CARTEIRA IDENTIDADE",
      "driverDocumentType": "CARTEIRA IDENTIDADE",
      "driverDocumentIssuer": "SSP",
      "driverNationality": "BRASILEIRO",
      "driverMotherName": "MARIA DOE",
      "driverFatherName": "JOSEPH DOE",
      "driverFirstLicenseDate": "26/07/2017",
      "pguId": "000000000",
      "cnhCategory": "AB",
      "addressUsedCnhRequest": "R. Tiradentes, 1077 - sala 505 - Centro, Venâncio Aires - RS, 95800-000",
      "addressStreet": "R. Tiradentes",
      "addressNumber": "1077",
      "addressComplement": "sala 505",
      "addressNeighborhood": "Centro",
      "addressZipCode": "95800-000",
      "addressCityCode": "43188",
      "addressCityName": "Venâncio Aires",
      "addressState": "RS",
      "cnhStatus": "CONFIRMADA",
      "previousCnhStatus": "ALTERADA",
      "cnhExpirationDate": "07/05/2032",
      "ufDomain": "RS",
      "ufDocumentIssuer": "RS",
      "placeOfBirth": "VENANCIO AIRES",
      "birthplaceCode": "43188",
      "birthplaceName": "VENANCIO AIRES",
      "requestReason1": "RENOVACAO DE EXAMES",
      "requestReason2": "INEXISTENTE",
      "requestReason3": "INEXISTENTE",
      "requestReason4": "INEXISTENTE",
      "ufFirstDriverLicense": "RS",
      "relegatedCategory": "",
      "authorizedCategory": "AB",
      "ufCurrentDriverLicense": "RS",
      "cnhRemarksTable": "99",
      "ufTransferApplicant": "",
      "permitHolder": 2,
      "cancellation": "",
      "lastRecordEmissionDate": "07/05/2022",
      "lastTransitionUpdateId": "180",
      "lastTransitionUpdateDate": "09/05/2022",
      "courseTppRating": "INEXISTENTE",
      "ufCourseTpp": "",
      "courseTeRating": "INEXISTENTE",
      "ufCourseTe": "",
      "courseTcpRating": "INEXISTENTE",
      "ufCourseTcp": "",
      "courseTveRating": "INEXISTENTE",
      "ufCourseTve": "",
      "courseTciRating": "INEXISTENTE",
      "ufCourseTci": "",
      "courseTmtRating": "INEXISTENTE",
      "ufCourseTmt": "",
      "courseTmfRating": "INEXISTENTE",
      "ufCourseTmf": "",
      "ufRecyclingCourseViolator": "",
      "modalityRecyclingCourseViolator": "INEXISTENTE",
      "ufRefreshCourseCnh": "",
      "refreshCourseCnh": "INEXISTENTE",
      "nationalRegistrationForeigner": "",
      "countryOriginDriverLicense": "INEXISTENTE",
      "foreignDriverLicenseId": "",
      "expirationDatePid": "",
      "ufExpeditionPid": "",
      "numberFormCnhBasedPid": "0000000000",
      "requestReasonPid1": "INEXISTENTE",
      "requestReasonPid2": "INEXISTENTE",
      "requestReasonPid3": "INEXISTENTE",
      "requestReasonPid4": "INEXISTENTE",
      "statusPid": "",
      "medicalRestrictions": "",
      "quantityIncidentsImpediments": "0"
    },
    "violations": [
      {
        "violationId": "51620",
        "violationBreakdownId": "516201",
        "violationDescription": "Dirigir o veículo com CNH vencida há mais de 30 dias",
        "renainfId": "RS123456789",
        "violationRegistrationDate": "15/03/2022",
        "actuatorAgencyState": "RS",
        "plate": "ABC1234",
        "renavamId": "12345678901",
        "modelBrandId": "123456",
        "modelBrandDescription": "FIAT/UNO MILLE",
        "vehicleTypeId": 1,
        "vehicleTypeDescription": "AUTOMOVEL",
        "vehicleColorId": 1,
        "vehicleColorDescription": "BRANCA",
        "vehicleKindId": 1,
        "vehicleKindDescription": "PASSAGEIRO",
        "vehicleBodyworkId": 1,
        "vehicleBodyworkDescription": "HATCH",
        "vehicleCategoryId": 1,
        "vehicleCategoryDescription": "PARTICULAR",
        "vehicleJurisdictionState": "RS",
        "informedRegistrationState": "RS",
        "registrationCityId": 4308607,
        "registrationCityDescription": "GUAIBA",
        "vehicleCoutryId": 1,
        "vehicleCoutryDescription": "BRASIL",
        "restrictionId1": 0,
        "restrictionDescription1": "",
        "restrictionId2": 0,
        "restrictionDescription2": "",
        "restrictionId3": 0,
        "restrictionDescription3": "",
        "restrictionId4": 0,
        "restrictionDescription4": "",
        "restrictionIndicatorRenajud": false,
        "restrictionIndicatorRenavam": false,
        "burglaryTheftIndicatorRenavam": false,
        "actuatorAgencyId": "43086",
        "actuatorAgencyDescription": "DETRAN/RS",
        "autoInfractionNumber": "A123456789",
        "autoSignatureId": 1,
        "autoSignatureDescription": "CONDUTOR ASSINOU",
        "driverCnhModelId": 1,
        "driverCnhModelDescription": "MODELO ATUAL",
        "driverCnhRegistrationNumber": "00000000000",
        "driverCnhExpeditionState": "RS",
        "violationDate": "15/03/2022",
        "violationTime": "14:30",
        "violationOccurrencePlace": "AV BRASIL, 1000",
        "violationCityId": "4308607",
        "violationCityDescription": "GUAIBA",
        "autoTypeId": 1,
        "autoTypeDescription": "AUTO DE INFRACAO",
        "notLicensedDriverDocumentNumber": "",
        "notLicensedDriverDocumentTypeId": 0,
        "notLicensedDriverDocumentTypeDescription": "",
        "actualMeasurement": "",
        "allowedLimit": "",
        "measurementConsidered": "",
        "measurementUnitId": 0,
        "measurementUnitDescription": "",
        "violationFullValue": "293.47",
        "vehicleOwnerOriginId": 1,
        "vehicleOwnerOriginDescription": "CONDUTOR",
        "ownerDocumentTypeId": 1,
        "ownerDocumentTypeDescription": "CPF",
        "ownerIdentificationNumber": "12345678900",
        "ownerName": "JOHN DOE",
        "notificationNoticeIssueDate": "20/03/2022",
        "defenseNoticeLimitDate": "05/04/2022",
        "notificationNoticeIndicator": true,
        "numberNotificationPenalty": "P123456789",
        "penaltyNotificationIssueDate": "10/04/2022",
        "penaltyNotificationExpirationDate": "10/05/2022",
        "penaltyType": 1,
        "penaltyDescription": "MULTA GRAVISSIMA",
        "violatorActualName": "JOHN DOE",
        "violatorActualCnhModelId": 1,
        "violatorActualCnhModelDescription": "MODELO ATUAL",
        "violatorActualCnhRegistrationNumber": "00000000000",
        "driverActualCnhExpeditionState": "RS",
        "scoreAnalysisStatusId": "1",
        "scoreAnalysisStatusDescription": "PONTUADA",
        "scoredCnhModelId": 1,
        "scoredCnhModelDescription": "MODELO ATUAL",
        "scoredCnhRegistrationNumber": "00000000000",
        "scoredCnhExpeditionState": "RS",
        "enforceabilityId": 1,
        "enforceabilityDescription": "EXIGIVEL",
        "paymentState": "",
        "violationPaymentDate": "",
        "violationPaidValue": "",
        "paymentRegistrationDate": "",
        "paymentsAmount": 0,
        "occurrenceTypeId": 1,
        "occurrenceTypeDescription": "INFRACAO",
        "occurrenceOriginDescription": "DETRAN/RS",
        "proccessNumber": ""
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                             | Description                                                       |
| -------------------------------- | ----------------------------------------------------------------- |
| driver\_has\_traffic\_violations | Checks if there are any infringements for the document consulted. |
| {% endtab %}                     |                                                                   |
| {% endtabs %}                    |                                                                   |

## Driver data

Returns essential information about the driver, including details of the National Driver's License (CNH), basic personal data, unpaid infractions, possible restrictions and a history of completed courses and exams.

**Section:** `driverViolations`

**Required parameter:** `cpf, registrationNumber (cnh)`

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

| Attribute                                      | Type   | Description                                                                                         |
| ---------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                     | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| message                                        | String | Descriptive with query status                                                                       |
| data                                           | Object | Return data                                                                                         |
| data.driverName                                | String | Driver's name                                                                                       |
| data.cpf                                       | String | CPF                                                                                                 |
| data.driverBirthDate                           | String | Driver's date of birth                                                                              |
| data.state                                     | String | State                                                                                               |
| data.driverMotherName                          | String | Mother's name                                                                                       |
| data.driverFatherName                          | String | Father's name                                                                                       |
| data.renachNumber                              | String | Renach number                                                                                       |
| data.cnhNumber                                 | String | Driver's license number                                                                             |
| data.cnhStatus                                 | String | Driver's license status                                                                             |
| data.cnhCategory                               | String | Driver's license category                                                                           |
| data.cnhEmissionDate                           | String | Driver's license emission date                                                                      |
| data.cnhExpirationDate                         | String | Driver's license expiration date                                                                    |
| data.driverFirstLicenseDate                    | String | Date of first driver's license                                                                      |
| data.cnhObservation                            | String | Driver's license observation                                                                        |
| data.cnhOrdinance                              | String | Driver's license ordinance                                                                          |
| data.cnhImpediment                             | String | Driver's license impediment                                                                         |
| data.violations                                | Array  | List of violations                                                                                  |
| data.violations\[x].violationNumber            | String | Violation number                                                                                    |
| data.violations\[x].violationIssuer            | String | Violation issuer                                                                                    |
| data.violations\[x].violationDate              | String | Violation date                                                                                      |
| data.violations\[x].violationDescription       | String | Violation description                                                                               |
| data.violations\[x].violationLicensePlate      | String | Violation license plate                                                                             |
| data.violations\[x].violationLocation          | String | Violation location                                                                                  |
| data.violations\[x].violationPoints            | String | Violation points                                                                                    |
| data.violations\[x].violationNumberFine        | String | Violation fine number                                                                               |
| data.violations\[x].violationProcess           | String | Violation process                                                                                   |
| data.violations\[x].violationSituation         | String | Violation situation                                                                                 |
| data.violations\[x].violationPointsResponsible | String | Violation points responsible                                                                        |
| data.violations\[x].violationValue             | String | Violation value                                                                                     |
| data.exams                                     | Array  | List of exams                                                                                       |
| data.exams\[x].examDescription                 | String | Exam description                                                                                    |
| data.exams\[x].examAllowedCategory             | String | Exam allowed category                                                                               |
| data.exams\[x].examIntendedCategory            | String | Exam intended category                                                                              |
| data.exams\[x].examCnpjEntity                  | String | Exam entity CNPJ                                                                                    |
| data.exams\[x].examCpfProfessional1            | String | Exam professional CPF                                                                               |
| data.exams\[x].examCpfProfessional2            | String | Exam professional CPF                                                                               |
| data.exams\[x].examDate                        | String | Exam date                                                                                           |
| data.exams\[x].examExpirationDate              | String | Exam expiration date                                                                                |
| data.exams\[x].examCity                        | String | Exam city                                                                                           |
| data.exams\[x].examState                       | String | Exam state                                                                                          |
| data.exams\[x].examObservation                 | String | Exam observation                                                                                    |
| data.exams\[x].examRestrictionsText            | String | Exam restrictions message                                                                           |
| data.exams\[x].examResult                      | String | Exam result                                                                                         |
| data.exams\[x].examUpdateType                  | String | Exam update type                                                                                    |
| data.courses                                   | Array  | List of courses                                                                                     |
| data.courses\[x].courseDescription             | String | Course description                                                                                  |
| data.courses\[x].courseWorkload                | String | Course workload                                                                                     |
| data.courses\[x].courseCategory                | String | Course category                                                                                     |
| data.courses\[x].courseCnpjEntity              | String | Course entity CNPJ                                                                                  |
| data.courses\[x].courseCpfProfessional         | String | Course professional CPF                                                                             |
| data.courses\[x].courseStartDate               | String | Course start date                                                                                   |
| data.courses\[x].courseEndDate                 | String | Course end date                                                                                     |
| data.courses\[x].courseExpirationDate          | String | Course expiration date                                                                              |
| data.courses\[x].courseMode                    | String | Course mode                                                                                         |
| data.courses\[x].courseCity                    | String | Course city                                                                                         |
| data.courses\[x].courseState                   | String | Course state                                                                                        |
| data.courses\[x].courseCertificateNumber       | String | Course certificate number                                                                           |
| data.courses\[x].courseUpdateType              | String | Course updateType                                                                                   |
| data.blocks                                    | Array  | List of blocks                                                                                      |
| data.blocks\[x].blockDescription               | String | Block description                                                                                   |
| data.blocks\[x].blockBlockDate                 | String | Block date                                                                                          |
| data.blocks\[x].blockStartPenaltyDate          | String | Block penalty start date                                                                            |
| data.blocks\[x].blockEndPenaltyDate            | String | Block penalty end date                                                                              |
| data.blocks\[x].blockReleaseBlockDate          | String | Block release date                                                                                  |
| data.blocks\[x].blockGeneratorDoc              | String | Block generator doc                                                                                 |
| data.blocks\[x].blockReleaseBlockGeneratorDoc  | String | Block release date generator doc                                                                    |
| data.blocks\[x].blockBlockReason               | String | Block reason                                                                                        |
| data.blocks\[x].blockReleaseBlockReason        | String | Block release reason                                                                                |
| data.blocks\[x].blockRespAgency                | String | Block responsible agency                                                                            |
| data.blocks\[x].blockReleaseBlockRespAgency    | String | Block release responsible agency                                                                    |
| data.blocks\[x].blockDetranReleaseBlockState   | String | Block release Detran state                                                                          |
| data.blocks\[x].blockPenaltyTerm               | String | Block penalty term                                                                                  |
| data.blocks\[x].blockTotalPenaltyTerm          | String | Block total penalty term                                                                            |
| data.blocks\[x].blockCnhCollection             | String | Block Driver's license collection                                                                   |
| data.blocks\[x].blockReleaseRequirements       | String | Block release requirements                                                                          |
| data.blocks\[x].blockUpdateType                | String | Block update type                                                                                   |
| data.blocks\[x].blockBlockDecisionType         | String | Block decision type                                                                                 |
| data.blocks\[x].blockState                     | String | Block state                                                                                         |
| {% endtab %}                                   |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "message": "Consulta realizada com sucesso.",
  "data": {
    "driverName": "Mario Lima",
    "cpf": "45678912300",
    "driverBirthDate": "1985-03-10",
    "state": "RS",
    "driverMotherName": "Laura Lima",
    "driverFatherName": "Carlos Lima",
    "renachNumber": "456789123",
    "cnhNumber": "789123456",
    "cnhStatus": "EMITIDA",
    "cnhCategory": "D",
    "cnhEmissionDate": "2010-03-10",
    "cnhExpirationDate": "2030-03-10",
    "driverFirstLicenseDate": "2005-03-10",
    "cnhObservation": "A",
    "cnhOrdinance": "000",
    "cnhImpediment": "NADA CONSTA",
    "violations": [
      {
        "violationNumber": "003",
        "violationIssuer": "Detran RS",
        "violationDate": "2022-05-20",
        "violationDescription": "Uso de celular ao volante",
        "violationLicensePlate": "GHI-7890",
        "violationLocation": "Porto Alegre",
        "violationPoints": "4",
        "violationNumberFine": "789012",
        "violationProcess": "Em andamento",
        "violationSituation": "Não paga",
        "violationPointsResponsible": "Mario Lima",
        "violationValue": "100.00"
      }
    ],
    "exams": [
      {
        "examDescription": "Exame Psicotécnico",
        "examAllowedCategory": "D",
        "examIntendedCategory": "D",
        "examCnpjEntity": "23.456.789/0001-00",
        "examCpfProfessional1": "456.789.123-00",
        "examCpfProfessional2": "321.654.987-00",
        "examDate": "2010-03-10",
        "examExpirationDate": "2030-03-10",
        "examCity": "Porto Alegre",
        "examObservation": "",
        "examRestrictionsText": "",
        "examResult": "Apto",
        "examUpdateType": "Inclusão",
        "examState": "RS"
      }
    ],
    "courses": [
      {
        "courseDescription": "Curso de Transporte Coletivo",
        "courseWorkload": "50 horas",
        "courseCategory": "D",
        "courseCnpjEntity": "23.456.789/0001-00",
        "courseCpfProfessional": "456.789.123-00",
        "courseStartDate": "2010-03-10",
        "courseEndDate": "2010-04-10",
        "courseExpirationDate": "2030-03-10",
        "courseMode": "Presencial",
        "courseCity": "Porto Alegre",
        "courseCertificateNumber": "789123",
        "courseUpdateType": "Inclusão",
        "courseState": "RS"
      }
    ],
    "blocks": [
      {
        "blockDescription": "Suspensão do direito de dirigir",
        "blockBlockDate": "2022-06-01",
        "blockEndPenaltyDate": "2022-12-01",
        "blockStartPenaltyDate": "2022-06-01",
        "blockReleaseBlockDate": "2022-12-01",
        "blockReleaseBlockGeneratorDoc": "456789",
        "blockGeneratorDoc": "123456",
        "blockBlockReason": "Excesso de pontos",
        "blockReleaseBlockReason": "Cumprimento da penalidade",
        "blockReleaseBlockRespAgency": "Detran RS",
        "blockRespAgency": "Detran RS",
        "blockPenaltyTerm": "6 meses",
        "blockTotalPenaltyTerm": "6 meses",
        "blockCnhCollection": "Sim",
        "blockReleaseRequirements": "Curso de reciclagem",
        "blockUpdateType": "Inclusão",
        "blockBlockDecisionType": "Administrativo",
        "blockState": "RS",
        "blockDetranReleaseBlockState": "RS"
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                      | Description                                          |
| ----------------------------------------- | ---------------------------------------------------- |
| driver\_has\_pending\_traffic\_violations | Checks if the driver has pending traffic violations. |
| {% endtab %}                              |                                                      |
| {% endtabs %}                             |                                                      |


# Financial

## List of PGFN Debtors (PF94)

Returns whether the consulted CPF is enrolled in active debts with the PGFN.

**Section:** `pfPgfnDebtors`

**Required parameter:** `cpf`

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

| Attribute      | Type    | Description                                                                                         |
| -------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode     | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data           | Object  | Return data                                                                                         |
| data.message   | String  | Query result descriptive message                                                                    |
| data.hasDebts  | Boolean | Debt status (true/false)                                                                            |
| data.debtValue | String  | Amount owed to PGFN                                                                                 |
| {% endtab %}   |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso.",
    "hasDebts": false,
    "debtValue": "0"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                 | Description                                                |
| -------------------- | ---------------------------------------------------------- |
| has\_debts\_on\_pgfn | The rule will be invalid if there are debts with the PGFN. |
| {% endtab %}         |                                                            |
| {% endtabs %}        |                                                            |

## Equity and Income Estimate (PF24)

Returns an estimate of the person's income and wealth calculated by different variables from available public queries.

**Section:** `pfFinantialData`

**Required parameter:** `cpf`

**Optional parameter:** `birthDate` *This information is required in some sources to complete the execution of minors*

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

| Attribute                             | Type   | Description                                                                                         |
| ------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                            | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                  | Object | Return data                                                                                         |
| data.totalAssets                      | String | Estimated total wealth of the individual                                                            |
| data.taxReturns                       | Array  | List of objects with the history of income tax refunds                                              |
| data.taxReturns\[x].year              | String | Year of tax return                                                                                  |
| data.taxReturns\[x].status            | String | Tax return status                                                                                   |
| data.taxReturns\[x].bank              | String | Bank used for tax return                                                                            |
| data.taxReturns\[x].captureDate       | String | Date of capture                                                                                     |
| data.taxReturns\[x].lastUpdateDate    | String | Date of last update                                                                                 |
| data.incomeEstimates                  | Object | Estimated income                                                                                    |
| data.incomeEstimates.mte              | String | Estimated income according to the MTE                                                               |
| data.incomeEstimates.ibge             | String | Estimated income according to IBGE                                                                  |
| data.incomeEstimates.companyOwnership | String | Estimated income even without formal work history                                                   |
| data.lastUpdateDate                   | String | Date of last update                                                                                 |
| {% endtab %}                          |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "totalAssets": "ABAIXO DE 100K",
    "taxReturns": [
      {
        "year": "2021",
        "status": "SUA DECLARACAO NAO CONSTA NA BASE DE DADOS DA RECEITA FEDERAL",
        "bank": "",
        "branch": "0000",
        "batch": "",
        "isVipBranch": "false",
        "captureDate": "2021-11-28T00:00:00Z",
        "creationDate": "2021-11-28T00:00:00Z",
        "lastUpdateDate": "2021-11-28T00:00:00Z"
      }
    ],
    "incomeEstimates": {
      "mte": "SEM INFORMACAO",
      "ibge": "SEM INFORMACAO",
      "companyOwnership": "SEM INFORMACAO"
    },
    "lastUpdateDate": "2022-10-22T00:00:00Z"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                  | Description                                                                    |
| ------------------------------------- | ------------------------------------------------------------------------------ |
| is\_less\_than\_two\_salaries         | Checks if the estimated income is less than two (02) minimum wages.            |
| is\_between\_two\_and\_four\_salaries | Check if the estimated income is between two (02) and four (04) minimum wages. |
| is\_more\_than\_four\_salaries        | Checks if the estimated income is above four (04) minimum wages                |
| has\_salary\_information              | Checks if information on estimated income has been found                       |
| {% endtab %}                          |                                                                                |
| {% endtabs %}                         |                                                                                |

## General Table of Disabled Persons - Central Bank of Brazil (PF44)

Returns, if included in the General Table of Disabled Persons of the Central Bank of Brazil, information about the disqualification.

**Section:** `pfBacenQgi`

**Mandatory parameters:** `cpf`

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

| Attribute                             | Type   | Description                                                                                         |
| ------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                            | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                  | Object | Return data                                                                                         |
| data.message                          | String | Description with query status                                                                       |
| data.disabledList                     | Array  | List of objects with the disqualification data                                                      |
| data.disabledList\[x].pas             | String | PAS (Sanctioning Administrative Process)                                                            |
| data.disabledList\[x].name            | String | Name                                                                                                |
| data.disabledList\[x].cpf             | String | CPF                                                                                                 |
| data.disabledList\[x].penalty         | String | Penalty                                                                                             |
| data.disabledList\[x].publicationDate | String | Date of publication                                                                                 |
| data.disabledList\[x].penaltyDeadline | String | Penalty deadline                                                                                    |
| {% endtab %}                          |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "O CPF não consta no quadro geral de inabilitados junto ao BACEN."
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                | Description                                                        |
| ------------------- | ------------------------------------------------------------------ |
| disabled\_on\_bacen | Checks if the CPF consulted is not authorized by the Central Bank. |
| {% endtab %}        |                                                                    |
| {% endtabs %}       |                                                                    |

## CVM Associate (PF47)

Returns CPF information related to financial institutions

**Section:** `pfAssociatedCvm`

**Required parameter:** `cpf`

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

| Attribute                                     | Type   | Description                                                                                         |
| --------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                    | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                          | Object | Return data                                                                                         |
| data.message                                  | String | Descriptive with query status                                                                       |
| data.associates                               | Array  | Describes the data of the types of registration at the Comissão de Valores Mobiliarios              |
| data.associates\[x].name                      | String | Name of the individual                                                                              |
| data.associates\[x].type                      | String | Type of registration                                                                                |
| data.associates\[x].recordDate                | String | Date of registration                                                                                |
| data.associates\[x].situation                 | String | Cadastro Situation                                                                                  |
| data.associates\[x].directors                 | Array  | List of objects that contain data about directors                                                   |
| data.associates\[x].directors\[x].name        | String | Name of the company in which the CPF is a director                                                  |
| data.associates\[x].directors\[x].startDate   | String | Beginning date of the position as director                                                          |
| data.associates\[x].directors\[x].instruction | String | Instruction of the director in the company                                                          |
| {% endtab %}                                  |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Não foram encontrados participantes para esta consulta."
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                      | Description                                                                        |
| ------------------------- | ---------------------------------------------------------------------------------- |
| has\_no\_participant\_cvm | The rule will be invalid if the consulted CPF/CNPJ is not registered with the CVM. |
| {% endtab %}              |                                                                                    |
| {% endtabs %}             |                                                                                    |

## Income Ibope (PF50)

Returns information about a person's house hold income / ibope income

**Section:** `pfIbopeIncome`

**Required parameter:** `cpf`

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

| Attribute        | Type   | Description                                                                                         |
| ---------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode       | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data             | Object | Return data                                                                                         |
| data.message     | String | Descriptive with query situation                                                                    |
| data.ibopeIncome | Float  | ibope income value                                                                                  |
| {% endtab %}     |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "ibopeIncome": 0
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                   | Description                      |
| ---------------------- | -------------------------------- |
| has\_no\_ibope\_income | Check the Ibope income of a CPF. |
| {% endtab %}           |                                  |
| {% endtabs %}          |                                  |

## Estimated Income (PF51)

Returns a person's estimated income information

**Section:** `pfEstimatedIncome`

**Required parameter:** `cpf`

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

| Attribute            | Type   | Description                                                                                         |
| -------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode           | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                 | Object | Return data                                                                                         |
| data.message         | String | Descriptive with query status                                                                       |
| data.estimatedIncome | Float  | Estimated income value                                                                              |
| {% endtab %}         |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "estimatedIncome": 0000
  }
}
```

{% endtab %}
{% endtabs %}

## Credit Information System (PF96)

Returns a person's credit information.

**Section:** `pfCreditOperationScr`

**Required parameters:** `cpf, PF`

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

| Attribute                                                          | Type   | Description                                                                                                                                                                                    |
| ------------------------------------------------------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| statusCode                                                         | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code))                                                                                            |
| data                                                               | Object | Return data                                                                                                                                                                                    |
| data.message                                                       | String | Description with query status                                                                                                                                                                  |
| data.clientCode                                                    | String | CPF                                                                                                                                                                                            |
| data.registrationDate                                              | Date   | Registration date                                                                                                                                                                              |
| data.baseDate                                                      | Date   | Base date for query                                                                                                                                                                            |
| data.assumedCoobligation                                           | Number | Co-obligation assumed in cession of credit by client                                                                                                                                           |
| data.receivedCoobligation                                          | Number | Co-obligation received in credit assignment                                                                                                                                                    |
| data.processedDocumentsPercentage                                  | Number | Percentage of the 3040 documents expected for the base date and that have already been incorporated to the SCR database at the Central Bank, not considering the exempt financial institutions |
| data.processedVolumePercentage                                     | Number | Percentage of the volume expected for the base date and which are already incorporated to the SCR database at the Central Bank, not considering the exempted financial institutions            |
| data.totalOfInstituions                                            | String | Number of financial institutions (FIs) where the client has operations                                                                                                                         |
| data.totalOfTransactions                                           | String | Number of operations of the client in the SFN                                                                                                                                                  |
| data.totalDisagreementTransactions                                 | String | Number of operations marked with a manifestation of disagreement                                                                                                                               |
| data.totalSubJudiceTransactions                                    | String | Number of operations marked with sub judice                                                                                                                                                    |
| data.fullLiabilityDisagreement                                     | String | Total responsibility of operations marked with manifestation of disagreement                                                                                                                   |
| data.fullLiabilitySubJudice                                        | String | Total liability of operations under judgement                                                                                                                                                  |
| data.indirectVendorRisk                                            | String | Indirect risk assumed by the client in vendor operations                                                                                                                                       |
| data.operationSumaryList                                           | Array  | List containing summary of operations                                                                                                                                                          |
| data.operationSumaryList\[x].modalityCategoryCode                  | String | Operation modality code                                                                                                                                                                        |
| data.operationSumaryList\[x].modalityCategoryDescription           | String | Description of the operation modality code                                                                                                                                                     |
| data.operationSumaryList\[x].modalitySubCategoryCode               | String | Subcategory code                                                                                                                                                                               |
| data.operationSumaryList\[x].modalitySubCategoryDescription        | String | Description of the subcategory indicator                                                                                                                                                       |
| data.operationSumaryList\[x].listOfDebts                           | Array  | Due date list                                                                                                                                                                                  |
| data.operationSumaryList\[x].listOfDebts\[x].expirationCode        | String | Maturity indicator                                                                                                                                                                             |
| data.operationSumaryList\[x].listOfDebts\[x].expirationDescription | String | Maturity indicator description                                                                                                                                                                 |
| data.operationSumaryList\[x].listOfDebts\[x].value                 | String | Due date value                                                                                                                                                                                 |
| {% endtab %}                                                       |        |                                                                                                                                                                                                |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "clientCode": "0XX52XX90XX",
    "registrationDate": "2020-05-08",
    "baseDate": "2022-10",
    "assumedCoobligation": 0,
    "receivedCoobligation": 0,
    "processedVolumePercentage": 99.98,
    "totalOfTransactions": "3",
    "totalDisagreementTransactions": "0",
    "totalSubJudiceTransactions": "0",
    "fullLiabilityDisagreement": "0",
    "fullLiabilitySubJudice": "0",
    "indirectVendorRisk": "0.00",
    "operationSumaryList": [
      {
        "modalityCategoryCode": "13",
        "modalityCategoryDescription": "Outros créditos",
        "modalitySubCategoryCode": "XXXX",
        "modalitySubCategoryDescription": "cartão de crédito - compra à vista e parcelado lojista ",
        "listOfDebts": [
          {
            "expirationCode": "140",
            "expirationDescription": "Créditos a vencer de 91 a 180 dias",
            "value": "XX.94"
          },
          {
            "expirationCode": "150",
            "expirationDescription": "Créditos a vencer de 181 a 360 dias ",
            "value": "XX.37"
          },
          {
            "expirationCode": "110",
            "expirationDescription": "Créditos a vencer até 30 dias",
            "value": "XX.92"
          },
          {
            "expirationCode": "120",
            "expirationDescription": "Créditos a vencer de 31 a 60 dias",
            "value": "XX.54"
          },
          {
            "expirationCode": "130",
            "expirationDescription": "Créditos a vencer de 61 a 90 dias",
            "value": "XX.93"
          }
        ]
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

## Temporary Penalties at CVM (PF93)

Query the CVM's list of Temporary Penalties to see if the participant is temporarily prevented from operating in the capital market due to a decision in an Administrative Sanctioning Process

**Section:** `pfPenaltiesOnCvm`

**Required parameters:** `name`

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

| Attribute                    | Type   | Description                                                                                         |
| ---------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                   | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                         | Object | Return data                                                                                         |
| data.message                 | String | Description with query status                                                                       |
| data.result                  | Object | Details of members set/punished                                                                     |
| data.result.processNumber    | String | Process Number                                                                                      |
| data.result.name             | String | Participant                                                                                         |
| data.result.decisionType     | String | Type of Decision                                                                                    |
| data.result.judgementDate    | String | Date of CVM Sentencing                                                                              |
| data.result.effectiveDate    | String | Effective Date of Penalty                                                                           |
| data.result.timeOfWithdrawal | String | Removal Time                                                                                        |
| data.result.decisionLink     | String | Link of the decision sentence                                                                       |
| {% endtab %}                 |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso.",
    "result": {
      "processNumber": "01/2005",
      "name": "MASSA FALIDA DO BANCO SANTOS S.A.",
      "decisionType": "Inabilitação",
      "judgementDate": "26/11/2008",
      "effectiveDate": "25/07/2014",
      "timeOfDeparture": "20 anos",
      "decisionLink": "http://conteudo.cvm.gov.br/sancionadores/sancionador/2008/20081126_0105.html"
    }
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                    | Description                                                                         |
| ----------------------- | ----------------------------------------------------------------------------------- |
| has\_penalties\_on\_cvm | The rule will be invalid if the CPF is temporarily barred from acting with the CVM. |
| {% endtab %}            |                                                                                     |
| {% endtabs %}           |                                                                                     |

## Credit Score - NEW (PF87)

Returns the credit score of a consumer based on their behavior, the score will estimate the proability of default and how risky the profile is, related to credit

**Section:** `pfCreditScore`

**Required parameter:** `cpf`

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

| Attribute         | Type    | Description                                                                                         |
| ----------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode        | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| message           | String  | Descriptive with query status                                                                       |
| data              | Object  | Return data                                                                                         |
| data.score        | Integer | Consumer Score rating                                                                               |
| data.scoreMessage | String  | Context of recommendation for decision-making                                                       |
| {% endtab %}      |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "message": "Consulta realizada com sucesso.",
  "data": {
    "score": 777,
    "scoreMessage":
      "É provável que 96% das pessoas com esse mesmo comportamento, paguem suas contas nos próximos 6 meses.",
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                     | Description                                                                     |
| ------------------------ | ------------------------------------------------------------------------------- |
| credit\_score\_available | The rule will become invalid if the credit score is unavailable.                |
| credit\_score\_below     | The rule will become invalid if the credit score is below the defined value.    |
| credit\_score\_over      | The rule will become invalid if the credit score is above the defined value.    |
| credit\_score\_between   | The rule will become invalid if the credit score is between the defined values. |
| {% endtab %}             |                                                                                 |
| {% endtabs %}            |                                                                                 |

## Credit Profile - NEW (PF88)

Return a comprehensive evaluation of an individual's financial health by returning their credit score and offering a detailed financial profile. Leveraging a wide range of data, including registered debts, inquiry history, protests, returns, and banking history, as well as supplementary data such as company affiliations and bankruptcy records, it delivers a predictive analysis of current and future payment capacity. This solution enables access to a reliable and comprehensive financial overview, making it ideal for credit decisions and risk analysis, offering clear insights to mitigate risks and maximize financial opportunities.

Data blocks will only be returned if information is available.

**Section:** `pfCreditProfileDetails`

**Required parameter:** `cpf`

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

| Attribute                                                                                         | Type    | Description                                                                                                   |
| ------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| statusCode                                                                                        | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code))           |
| message                                                                                           | String  | Descriptive with query status                                                                                 |
| data                                                                                              | Object  | Return data                                                                                                   |
| data.civilActionsSummary                                                                          | Object  | A block providing a consolidated view of civil action records                                                 |
| data.civilActionsSummary.quantity                                                                 | String  | Civil actions total quantity                                                                                  |
| data.civilActionsSummary.initialPeriod                                                            | String  | Civil actions initial period                                                                                  |
| data.civilActionsSummary.finalPeriod                                                              | String  | Civil actions final period                                                                                    |
| data.civilActionsList                                                                             | Array   | A list containing detailed information on each recorded civil action                                          |
| data.civilActionsList\[x].court                                                                   | String  | Court                                                                                                         |
| data.civilActionsList\[x].lawsuitNumber                                                           | String  | Civil action number                                                                                           |
| data.civilActionsList\[x].civilAction                                                             | String  | Civil action title                                                                                            |
| data.civilActionsList\[x].distributionDate                                                        | String  | Civil action distribution date                                                                                |
| data.civilActionsList\[x].plaintiff                                                               | String  | Civil action author                                                                                           |
| data.civilActionsList\[x].amount                                                                  | String  | Amount                                                                                                        |
| data.civilActionsList\[x].location                                                                | String  | Location                                                                                                      |
| data.civilActionsList\[x].state                                                                   | String  | State                                                                                                         |
| data.civilActionsList\[x].municipalityCode                                                        | String  | City code                                                                                                     |
| data.debtOccurrencesSummary                                                                       | Object  | A block providing a consolidated view of debt records                                                         |
| data.debtOccurrencesSummary.totalDebtor                                                           | String  | Total debts as debtor                                                                                         |
| data.debtOccurrencesSummary.totalGuarantor                                                        | String  | Total debts as guarantor                                                                                      |
| data.debtOccurrencesSummary.accumulatedAmount                                                     | String  | Debts accumulated amount                                                                                      |
| data.debtOccurrencesSummary.firstDebtDate                                                         | String  | First debt date                                                                                               |
| data.debtOccurrencesSummary.firstDebtAmount                                                       | String  | First debt amount                                                                                             |
| data.debtOccurrencesSummary.largestDebtDate                                                       | String  | Largest debt date                                                                                             |
| data.debtOccurrencesSummary.largestDebtAmount                                                     | String  | Largest debt amount                                                                                           |
| data.debts                                                                                        | Array   | A list containing detailed information on each debt.                                                          |
| data.debts\[x].occurrenceType                                                                     | String  | Occurrence type                                                                                               |
| data.debts\[x].contract                                                                           | String  | Debt contract number                                                                                          |
| data.debts\[x].occurrenceDate                                                                     | String  | Debt occurrence date                                                                                          |
| data.debts\[x].availabilityDate                                                                   | String  | Debt availability date                                                                                        |
| data.debts\[x].currency                                                                           | String  | Currency type                                                                                                 |
| data.debts\[x].amount                                                                             | String  | Amount                                                                                                        |
| data.debts\[x].status                                                                             | String  | Debt status                                                                                                   |
| data.debts\[x].informer                                                                           | String  | Debt informer                                                                                                 |
| data.debts\[x].informedByConsultee                                                                | String  | Was the debt informed by the consultee                                                                        |
| data.debts\[x].city                                                                               | String  | City                                                                                                          |
| data.debts\[x].state                                                                              | String  | State                                                                                                         |
| data.debts\[x].condition                                                                          | String  | Debt condition                                                                                                |
| data.debts\[x].municipalityCondition                                                              | String  | City condition code                                                                                           |
| data.previous90DaysInquiriesSummary                                                               | Object  | A block providing a consolidated view of from previous 90 days records                                        |
| data.previous90DaysInquiriesSummary.total                                                         | String  | Total                                                                                                         |
| data.previous90DaysInquiriesSummary.year                                                          | String  | Year                                                                                                          |
| data.previous90DaysInquiriesSummary.month                                                         | String  | month                                                                                                         |
| data.previousInquiries                                                                            | Array   | A list containing detailed information on each previous inquiry                                               |
| data.previousInquiries\[x].occurrenceType                                                         | String  | Occurrence type                                                                                               |
| data.previousInquiries\[x].date                                                                   | String  | Inquiry date                                                                                                  |
| data.previousInquiries\[x].amount                                                                 | String  | Amount                                                                                                        |
| data.previousInquiries\[x].currency                                                               | String  | Currency type                                                                                                 |
| data.previousInquiries\[x].informer                                                               | String  | Inquiry informer                                                                                              |
| data.previousInquiries\[x].product                                                                | String  | Inquiry product                                                                                               |
| data.additionalAnfo                                                                               | Array   | A list containing additional information                                                                      |
| data.additionalAnfo\[x].text                                                                      | String  | Additional information text                                                                                   |
| data.additionalAnfo\[x].originState                                                               | String  | Origin state                                                                                                  |
| data.additionalAnfo\[x].origin                                                                    | String  | Additional information origin                                                                                 |
| data.additionalAnfo\[x].type                                                                      | String  | Type                                                                                                          |
| data.protestedBillsSummary                                                                        | Object  | A block providing a consolidated view of protested bills records                                              |
| data.protestedBillsSummary.total                                                                  | String  | Protested bills total quantity                                                                                |
| data.protestedBillsSummary.initialPeriod                                                          | String  | Protested bills initial period                                                                                |
| data.protestedBillsSummary.finalPeriod                                                            | String  | Protested bills final period                                                                                  |
| data.protestedBillsSummary.currency                                                               | String  | Currency type                                                                                                 |
| data.protestedBillsSummary.accumulatedValue                                                       | String  | Protested bills accumulated value                                                                             |
| data.protestedBills                                                                               | Array   | A list containing detailed information on each protested bill                                                 |
| data.protestedBills\[x].occurrenceType                                                            | String  | Occurrence type                                                                                               |
| data.protestedBills\[x].notaryOffice                                                              | String  | Notary office                                                                                                 |
| data.protestedBills\[x].occurrenceDate                                                            | String  | Protested bill occurrence date                                                                                |
| data.protestedBills\[x].currency                                                                  | String  | Currency type                                                                                                 |
| data.protestedBills\[x].amount                                                                    | String  | Amount                                                                                                        |
| data.protestedBills\[x].city                                                                      | String  | City                                                                                                          |
| data.protestedBills\[x].state                                                                     | String  | State                                                                                                         |
| data.cancelledCheckBook                                                                           | Array   | A list containing detailed information on each cancelled bank checkbook                                       |
| data.cancelledCheckBook\[x].occurrenceType                                                        | String  | Occurrence type                                                                                               |
| data.cancelledCheckBook\[x].documentType                                                          | String  | Document type                                                                                                 |
| data.cancelledCheckBook\[x].documentNumber                                                        | String  | Document number                                                                                               |
| data.cancelledCheckBook\[x].bank                                                                  | String  | Bank                                                                                                          |
| data.cancelledCheckBook\[x].agency                                                                | String  | Agency                                                                                                        |
| data.cancelledCheckBook\[x].currentAccount                                                        | String  | Current account number                                                                                        |
| data.cancelledCheckBook\[x].check                                                                 | String  | Bank check number                                                                                             |
| data.cancelledCheckBook\[x].reasonCode                                                            | String  | Alinea                                                                                                        |
| data.cancelledCheckBook\[x].occurrenceDate                                                        | String  | Cancellation occurrence date                                                                                  |
| data.cancelledCheckBook\[x].availabilityDate                                                      | String  | Availability date                                                                                             |
| data.cancelledCheckBook\[x].informer                                                              | String  | Informer                                                                                                      |
| data.cancelledCheckBook\[x].indicator                                                             | String  | Indicator                                                                                                     |
| data.ccfReportedReturnsSummary                                                                    | Object  | A block providing a consolidated view of returns reported by CCF records                                      |
| data.ccfReportedReturnsSummary.documentType                                                       | String  | Document type                                                                                                 |
| data.ccfReportedReturnsSummary.documentNumber                                                     | String  | Document number                                                                                               |
| data.ccfReportedReturnsSummary.name                                                               | String  | Name                                                                                                          |
| data.ccfReportedReturnsSummary.totalNames                                                         | String  | Total name                                                                                                    |
| data.ccfReportedReturnsSummary.totalReturns                                                       | String  | Total returns                                                                                                 |
| data.ccfReportedReturnsSummary.reason12                                                           | String  | Reason 12 - Bank check without funds - 2nd presentation                                                       |
| data.ccfReportedReturnsSummary.reason13                                                           | String  | Reason 13 - Account closed                                                                                    |
| data.ccfReportedReturnsSummary.reason14                                                           | String  | Reason 14 - Spurious practice                                                                                 |
| data.ccfReportedReturnsSummary.reason99                                                           | String  | Reason 99 - Financial institution no longer in business                                                       |
| data.ccfReportedReturnsList                                                                       | Array   | A list containing detailed information on each returns reported by CCF                                        |
| data.ccfReportedReturnsList\[x].documentType                                                      | String  | Document type                                                                                                 |
| data.ccfReportedReturnsList\[x].documentNumber                                                    | String  | Document number                                                                                               |
| data.ccfReportedReturnsList\[x].name                                                              | String  | Name                                                                                                          |
| data.ccfReportedReturnsList\[x].bank                                                              | String  | Bank                                                                                                          |
| data.ccfReportedReturnsList\[x].agency                                                            | String  | Agency                                                                                                        |
| data.ccfReportedReturnsList\[x].reason12                                                          | String  | Reason 12 - Bank check without funds - 2nd presentation                                                       |
| data.ccfReportedReturnsList\[x].lastOccurrenceDate12                                              | String  | Last occurrence date - reason 12                                                                              |
| data.ccfReportedReturnsList\[x].reason13                                                          | String  | Reason 13 - Account closed                                                                                    |
| data.ccfReportedReturnsList\[x].lastOccurrenceDate13                                              | String  | Last occurrence date - reason 13                                                                              |
| data.ccfReportedReturnsList\[x].reason14                                                          | String  | Reason 14 - Spurious practice                                                                                 |
| data.ccfReportedReturnsList\[x].lastOccurrenceDate14                                              | String  | Last occurrence date - reason 14                                                                              |
| data.ccfReportedReturnsList\[x].reason99                                                          | String  | Reason 99 - Financial institution no longer in business                                                       |
| data.ccfReportedReturnsList\[x].lastOccurrenceDate99                                              | String  | Last occurrence date - reason 99                                                                              |
| data.ccfReportedReturnsList\[x].bankName                                                          | String  | Bank name                                                                                                     |
| data.previousCheckInquiriesSummary                                                                | Object  | A block providing a consolidated view of previous bank check inquiries records                                |
| data.previousCheckInquiriesSummary.documentType                                                   | String  | Document type                                                                                                 |
| data.previousCheckInquiriesSummary.documentNumber                                                 | String  | Document number                                                                                               |
| data.previousCheckInquiriesSummary.total                                                          | String  | Previous bank check inquiries total quantity                                                                  |
| data.previousCheckInquiriesSummary.amount                                                         | String  | Amount                                                                                                        |
| data.previousCheckInquiriesSummary.day                                                            | String  | Day                                                                                                           |
| data.previousCheckInquiriesSummary.dailyValue                                                     | String  | Daily value                                                                                                   |
| data.previousCheckInquiriesSummary.postdated                                                      | String  | Postdated                                                                                                     |
| data.previousCheckInquiriesSummary.postdatedValue                                                 | String  | Postdated value                                                                                               |
| data.previousCheckInquiries                                                                       | Array   | A list containing detailed information on each previous bank check inquiry                                    |
| data.previousCheckInquiries\[x].documentType                                                      | String  | Document type                                                                                                 |
| data.previousCheckInquiries\[x].documentNumber                                                    | String  | Document number                                                                                               |
| data.previousCheckInquiries\[x].type                                                              | String  | Type                                                                                                          |
| data.previousCheckInquiries\[x].creditDate                                                        | String  | Credit date                                                                                                   |
| data.previousCheckInquiries\[x].creditTime                                                        | String  | Credit time                                                                                                   |
| data.previousCheckInquiries\[x].currency                                                          | String  | Currency type                                                                                                 |
| data.previousCheckInquiries\[x].amount                                                            | String  | Amount                                                                                                        |
| data.previousCheckInquiries\[x].informer                                                          | String  | Informer                                                                                                      |
| data.phoneConfirmation                                                                            | Array   | A list containing detailed information on each phone confirmation                                             |
| data.phoneConfirmation\[x].areaCode                                                               | String  | Area code                                                                                                     |
| data.phoneConfirmation\[x].phoneNumber                                                            | String  | Phone number                                                                                                  |
| data.phoneConfirmation\[x].documentType                                                           | String  | Document type                                                                                                 |
| data.phoneConfirmation\[x].documentNumber                                                         | String  | Document number                                                                                               |
| data.phoneConfirmation\[x].name                                                                   | String  | Name                                                                                                          |
| data.phoneConfirmation\[x].neighborhood                                                           | String  | Neighborhood                                                                                                  |
| data.phoneConfirmation\[x].postalCode                                                             | String  | Postal code                                                                                                   |
| data.phoneConfirmation\[x].city                                                                   | String  | City                                                                                                          |
| data.phoneConfirmation\[x].state                                                                  | String  | State                                                                                                         |
| data.bankBranchContactDetails                                                                     | Array   | A list containing detailed information on each bank branch contact                                            |
| data.bankBranchContactDetails\[x].bank                                                            | String  | Bank                                                                                                          |
| data.bankBranchContactDetails\[x].bankName                                                        | String  | Bank name                                                                                                     |
| data.bankBranchContactDetails\[x].agency                                                          | String  | Agency                                                                                                        |
| data.bankBranchContactDetails\[x].branchName                                                      | String  | Branch name                                                                                                   |
| data.bankBranchContactDetails\[x].address                                                         | String  | Address                                                                                                       |
| data.bankBranchContactDetails\[x].neighborhood                                                    | String  | Neighborhood                                                                                                  |
| data.bankBranchContactDetails\[x].postalCode                                                      | String  | Postal code                                                                                                   |
| data.bankBranchContactDetails\[x].city                                                            | String  | City                                                                                                          |
| data.bankBranchContactDetails\[x].state                                                           | String  | State                                                                                                         |
| data.bankBranchContactDetails\[x].location                                                        | String  | Location                                                                                                      |
| data.bankBranchContactDetails\[x].areaCode                                                        | String  | Area code                                                                                                     |
| data.bankBranchContactDetails\[x].phoneNumber1                                                    | String  | Phone number 1                                                                                                |
| data.bankBranchContactDetails\[x].phoneNumber2                                                    | String  | Phone number 2                                                                                                |
| data.bankBranchContactDetails\[x].reserved                                                        | String  | Reserved                                                                                                      |
| data.postalCodeConfirmation                                                                       | Object  | A block providing a consolidated view of postal code confirmation                                             |
| data.postalCodeConfirmation.postalCode                                                            | String  | Postal code                                                                                                   |
| data.postalCodeConfirmation.address                                                               | String  | Address                                                                                                       |
| data.postalCodeConfirmation.neighborhood                                                          | String  | Neighborhood                                                                                                  |
| data.postalCodeConfirmation.city                                                                  | String  | City                                                                                                          |
| data.postalCodeConfirmation.state                                                                 | String  | State                                                                                                         |
| data.documentName                                                                                 | Array   | A list containing detailed information on each document                                                       |
| data.documentName\[x].name                                                                        | String  | Name                                                                                                          |
| data.documentName\[x].birthDate                                                                   | String  | Birth date                                                                                                    |
| data.documentName\[x].document                                                                    | String  | document                                                                                                      |
| data.documentName\[x].documentType                                                                | String  | Document type                                                                                                 |
| data.documentName\[x].documentNumber                                                              | String  | Document number                                                                                               |
| data.checkAdditionalInformation                                                                   | Array   | A list containing detailed additional information about bank checks                                           |
| data.checkAdditionalInformation\[x].documentType                                                  | String  | Document type                                                                                                 |
| data.checkAdditionalInformation\[x].documentNumber                                                | String  | Document number                                                                                               |
| data.checkAdditionalInformation\[x].text                                                          | String  | Additional information text                                                                                   |
| data.userReportedReturnsSummary                                                                   | Object  | Returns reported by the user                                                                                  |
| data.userReportedReturnsSummary.documentType                                                      | String  | Document type                                                                                                 |
| data.userReportedReturnsSummary.documentNumber                                                    | String  | Document number                                                                                               |
| data.userReportedReturnsSummary.total                                                             | String  | Total                                                                                                         |
| data.userReportedReturnsSummary.firstReturnDate                                                   | String  | First return date                                                                                             |
| data.userReportedReturnsSummary.lastReturnDate                                                    | String  | Last return date                                                                                              |
| data.userReportedReturns                                                                          | Array   | A list containing detailed information on each return reported by the user                                    |
| data.userReportedReturns\[x].documentType                                                         | String  | Document type                                                                                                 |
| data.userReportedReturns\[x].document                                                             | String  | Document number                                                                                               |
| data.userReportedReturns\[x].bank                                                                 | String  | Bank                                                                                                          |
| data.userReportedReturns\[x].agency                                                               | String  | Agency                                                                                                        |
| data.userReportedReturns\[x].currentAccount                                                       | String  | Current account number                                                                                        |
| data.userReportedReturns\[x].initialCheck                                                         | String  | Initial bank check                                                                                            |
| data.userReportedReturns\[x].finalCheck                                                           | String  | Final bank check                                                                                              |
| data.userReportedReturns\[x].reason                                                               | String  | Reason                                                                                                        |
| data.userReportedReturns\[x].reasonCode                                                           | String  | Reason code                                                                                                   |
| data.userReportedReturns\[x].occurrenceDate                                                       | String  | Occurrence date                                                                                               |
| data.userReportedReturns\[x].registrationDate                                                     | String  | Registration date                                                                                             |
| data.userReportedReturns\[x].currency                                                             | String  | Currency type                                                                                                 |
| data.userReportedReturns\[x].amount                                                               | String  | Amount                                                                                                        |
| data.userReportedReturns\[x].reporterCode                                                         | String  | Informer code                                                                                                 |
| data.userReportedReturns\[x].informer                                                             | String  | Informer                                                                                                      |
| data.userReportedReturns\[x].city                                                                 | String  | City                                                                                                          |
| data.userReportedReturns\[x].state                                                                | String  | State                                                                                                         |
| data.checksCancelledReason21                                                                      | Array   | A list containing detailed information on each bank check cancelled for reason 21 - cancelled or revoked      |
| data.checksCancelledReason21\[x].documentType                                                     | String  | Document type                                                                                                 |
| data.checksCancelledReason21\[x].documentNumber                                                   | String  | Document number                                                                                               |
| data.checksCancelledReason21\[x].bank                                                             | String  | Bank                                                                                                          |
| data.checksCancelledReason21\[x].agency                                                           | String  | Agency                                                                                                        |
| data.checksCancelledReason21\[x].currentAccount                                                   | String  | Current account number                                                                                        |
| data.checksCancelledReason21\[x].initialCheck                                                     | String  | Initial bank check                                                                                            |
| data.checksCancelledReason21\[x].finalCheck                                                       | String  | Final bank check                                                                                              |
| data.checksCancelledReason21\[x].reasonCode                                                       | String  | Reason code                                                                                                   |
| data.checksCancelledReason21\[x].occurrenceDate                                                   | String  | Occurrence date                                                                                               |
| data.checksCancelledReason21\[x].availabilityDate                                                 | String  | Availability date                                                                                             |
| data.checksCancelledReason21\[x].currency                                                         | String  | Currency type                                                                                                 |
| data.checksCancelledReason21\[x].amount                                                           | String  | Amount                                                                                                        |
| data.checksCancelledReason21\[x].informer                                                         | String  | Informer                                                                                                      |
| data.reportedCheckHistory                                                                         | Array   | A list containing detailed information on each reported check                                                 |
| data.reportedCheckHistory\[x].documentType                                                        | String  | Document type                                                                                                 |
| data.reportedCheckHistory\[x].documentNumber                                                      | String  | Document number                                                                                               |
| data.reportedCheckHistory\[x].bank                                                                | String  | Bank                                                                                                          |
| data.reportedCheckHistory\[x].agency                                                              | String  | Agency                                                                                                        |
| data.reportedCheckHistory\[x].currentAccount                                                      | String  | Current account number                                                                                        |
| data.reportedCheckHistory\[x].check                                                               | String  | Bank check number                                                                                             |
| data.reportedCheckHistory\[x].inquiryDate                                                         | String  | Inquiry date                                                                                                  |
| data.reportedCheckHistory\[x].inquiryTime                                                         | String  | Inquiry time                                                                                                  |
| data.reportedCheckHistory\[x].network                                                             | String  | Network                                                                                                       |
| data.reportedCurrentAccountHistory                                                                | Array   | A list containing detailed information on each reported current account                                       |
| data.reportedCurrentAccountHistory\[x].bank                                                       | String  | Bank                                                                                                          |
| data.reportedCurrentAccountHistory\[x].agency                                                     | String  | Agency                                                                                                        |
| data.reportedCurrentAccountHistory\[x].currentAccount                                             | String  | Current account number                                                                                        |
| data.reportedCurrentAccountHistory\[x].documentType                                               | String  | Document type                                                                                                 |
| data.reportedCurrentAccountHistory\[x].documentNumber                                             | String  | Document number                                                                                               |
| data.reportedCurrentAccountHistory\[x].inquiryDate                                                | String  | Inquiry date                                                                                                  |
| data.reportedCurrentAccountHistory\[x].inquiryTime                                                | String  | Inquiry time                                                                                                  |
| data.participationsOfConsultedDocument                                                            | Array   | A list containing detailed information on each participations of consulted document                           |
| data.participationsOfConsultedDocument\[x].documentTypeA                                          | String  | Document type                                                                                                 |
| data.participationsOfConsultedDocument\[x].documentNumberA                                        | String  | Document number                                                                                               |
| data.participationsOfConsultedDocument\[x].companyName                                            | String  | Company name                                                                                                  |
| data.participationsOfConsultedDocument\[x].currencyType                                           | String  | Currency type                                                                                                 |
| data.participationsOfConsultedDocument\[x].amount                                                 | String  | Amount                                                                                                        |
| data.participationsOfConsultedDocument\[x].observation                                            | String  | Observation                                                                                                   |
| data.participationsOfConsultedDocument\[x].percentageValue                                        | String  | Percentage value                                                                                              |
| data.participationsOfConsultedDocument\[x].entryDate                                              | String  | Entry date                                                                                                    |
| data.participationsOfConsultedDocument\[x].role                                                   | String  | Role                                                                                                          |
| data.participationsOfConsultedDocument\[x].documentTypeB                                          | String  | Document type                                                                                                 |
| data.participationsOfConsultedDocument\[x].documentNumberB                                        | String  | Document number                                                                                               |
| data.participationsOfConsultedDocument\[x].partnerType                                            | String  | Partner type                                                                                                  |
| data.bankruptcyJudicialRecoveryRelationship                                                       | Array   | A list containing detailed information on each bankruptcy judicial recovery relationship                      |
| data.bankruptcyJudicialRecoveryRelationship\[x].documentType                                      | String  | Document type                                                                                                 |
| data.bankruptcyJudicialRecoveryRelationship\[x].documentNumber                                    | String  | Document number                                                                                               |
| data.bankruptcyJudicialRecoveryRelationship\[x].companyName                                       | String  | Company name                                                                                                  |
| data.bankruptcyJudicialRecoveryRelationship\[x].occurrenceType                                    | String  | Occurrence type                                                                                               |
| data.bankruptcyJudicialRecoveryRelationship\[x].notaryOffice                                      | String  | Notary office                                                                                                 |
| data.bankruptcyJudicialRecoveryRelationship\[x].occurrenceDate                                    | String  | Occurrence date                                                                                               |
| data.bankruptcyJudicialRecoveryRelationship\[x].location                                          | String  | Location                                                                                                      |
| data.bankruptcyJudicialRecoveryRelationship\[x].state                                             | String  | State                                                                                                         |
| data.bankruptcyJudicialRecoveryRelationship\[x].municipalityCode                                  | String  | City code                                                                                                     |
| data.identification                                                                               | Object  | data.Identification information                                                                               |
| data.identification.document                                                                      | String  | Document                                                                                                      |
| data.identification.name                                                                          | String  | Name                                                                                                          |
| data.identification.motherName                                                                    | String  | Mother name                                                                                                   |
| data.identification.dataOfBirth                                                                   | String  | Data of birth                                                                                                 |
| data.identification.rgNumber                                                                      | String  | RG number                                                                                                     |
| data.identification.issuingAgency                                                                 | String  | Issuing agency                                                                                                |
| data.identification.rgFederativeUnit                                                              | String  | RG state origin                                                                                               |
| data.identification.rgIssueDate                                                                   | String  | RG issue date                                                                                                 |
| data.identification.gender                                                                        | String  | Gender                                                                                                        |
| data.identification.nacionalidade                                                                 | String  | Nationality                                                                                                   |
| data.identification.maritalStatus                                                                 | String  | Marital status                                                                                                |
| data.identification.numberOfDependents                                                            | String  | Number of dependants                                                                                          |
| data.identification.educationLevel                                                                | String  | Education level                                                                                               |
| data.identification.revenueStatus                                                                 | String  | CPF status                                                                                                    |
| data.identification.updateDate                                                                    | String  | Last update date                                                                                              |
| data.identification.cpfRegion                                                                     | String  | CPF origin region                                                                                             |
| data.identification.voterRegistration                                                             | String  | Voter registration                                                                                            |
| data.identification.message                                                                       | String  | Identification observation message                                                                            |
| data.location                                                                                     | Object  | data.Location information                                                                                     |
| data.location.streetType                                                                          | String  | Street type                                                                                                   |
| data.location.streetName                                                                          | String  | Street name                                                                                                   |
| data.location.streetNumber                                                                        | String  | Street number                                                                                                 |
| data.location.addressComplement                                                                   | String  | Address complement                                                                                            |
| data.location.neighborhood                                                                        | String  | Neighborhood                                                                                                  |
| data.location.city                                                                                | String  | City                                                                                                          |
| data.location.state                                                                               | String  | State                                                                                                         |
| data.location.postalCode                                                                          | String  | Postal code                                                                                                   |
| data.location.areaCode                                                                            | String  | Area code                                                                                                     |
| data.location.phoneNumber                                                                         | String  | Phone number                                                                                                  |
| data.scores                                                                                       | Array   | Consumer data.Scores rating                                                                                   |
| data.scores\[x].score                                                                             | Integer | Score rating                                                                                                  |
| data.scores\[x].scoreDescription                                                                  | String  | Credit score or Income score                                                                                  |
| data.scores\[x].probability                                                                       | String  | Probability                                                                                                   |
| data.scores\[x].numericalClassification                                                           | String  | Numerical classification                                                                                      |
| data.scores\[x].alphabeticalClassification                                                        | String  | Alphabetical classification                                                                                   |
| data.scores\[x].scoreMessage                                                                      | String  | Context of recommendation for decision-making                                                                 |
| data.scores\[x].presumedIncomeRange                                                               | String  | Presumed income range. Present only on Income score                                                           |
| data.positiveControlPanel                                                                         | Object  | Scores indicators panel. A rating scale from 'A' to 'E' where 'A' is the highest and 'E' is the lowest rating |
| data.positiveControlPanel.positivePaymentBehaviorIndicators                                       | Object  | Positive payment behavior indicators                                                                          |
| data.positiveControlPanel.positivePaymentBehaviorIndicators.lateInvoiceBehaviorScore              | Object  | Late invoice behavior score                                                                                   |
| data.positiveControlPanel.positivePaymentBehaviorIndicators.lateInvoiceBehaviorScore.score        | String  | Covers information on the payment status of credit cards loans and financing over the past six months         |
| data.positiveControlPanel.positiveConsumptionBehaviorIndicators                                   | Object  | Positive payment behavior indicators                                                                          |
| data.positiveControlPanel.positiveConsumptionBehaviorIndicators.recentContractBehaviorScore       | Object  | Late invoice behavior score                                                                                   |
| data.positiveControlPanel.positiveConsumptionBehaviorIndicators.recentContractBehaviorScore.score | String  | Covers recent contract information on payments for credit cards loans and financing over the past six months  |
| data.consumerStatus                                                                               | Object  | Consumer status                                                                                               |
| data.consumerStatus.message                                                                       | String  | Consumer status message                                                                                       |
| {% endtab %}                                                                                      |         |                                                                                                               |

{% tab title="Example" %}

```json
{
    "code": "01",
    "message": "Consulta realizada com sucesso.",
    "data": {
      "civilActionsSummary": {
        "quantity": "1",
        "initialPeriod": "20/01/2018",
        "finalPeriod": "06/10/2019"
      },
      "civilActionsList": [
        {
          "court": "2",
          "lawsuitNumber": "1234567891011",
          "civilAction": "Ação executiva Fazenda Federal",
          "distributionDate": "06/10/2018",
          "plaintiff": "Banco Itaú",
          "amount": "30.000,00",
          "location": "São Paulo",
          "state": "SP",
          "municipalityCode": "3550308"
        }
      ],
      "debtOccurrencesSummary": {
        "totalDebtor": "1",
        "totalGuarantor": "0",
        "accumulatedAmount": "9.301,00",
        "firstDebtDate": "12/03/2023",
        "firstDebtAmount": "9.301,00",
        "largestDebtDate": "12/03/2023",
        "largestDebtAmount": "9.301,00"
      },
      "debts": [
        {
          "occurrenceType": "Crédito Direto",
          "contract": "12345678910",
          "occurrenceDate": "12/03/2023",
          "availabilityDate": "12/03/2023",
          "currency": "R$",
          "amount": "9.301,00",
          "status": "C",
          "informer": "Banco Itaú",
          "informedByConsultee": "S",
          "city": "SCPC São Paulo",
          "state": "SP",
          "condition": "A",
          "municipalityCondition": "3550308"
        }
      ],
      "previous90DaysInquiriesSummary": {
        "total": "00011",
        "year1": "2024",
        "month1": "10",
        "total1": "0003",
        "year2": "2024",
        "month2": "09",
        "total2": "0005",
        "year3": "2024",
        "month3": "08",
        "total3": "0003",
        "year4": "2024",
        "month4": "07",
        "total4": "0000"
      },
      "additionalAnfo": [
        {
          "text": "CARTEIRA PROFIS PERDA / EXTRAVIO 01/08/2019 12/08/2019 09:57:57",
          "originState": "SP",
          "origin": "SSP",
          "type": "01"
        }
      ],
      "previousInquiries": [
        {
          "occurrenceType": "Crédito Pessoal",
          "date": "03/10/2024",
          "amount": "0,00",
          "currency": "R$",
          "informer": "CAF",
          "product": "S"
        },
        {
          "occurrenceType": "Cartão de Crédito",
          "date": "16/09/2024",
          "amount": "0,00",
          "currency": "R$",
          "informer": "BoaVista",
          "product": "S"
        }
      ],
      "protestedBillsSummary": {
        "total": "1",
        "initialPeriod": "17/02/2022",
        "finalPeriod": "17/02/2022",
        "currency": "R$",
        "accumulatedValue": "2.789,45"
      },
      "protestedBills": [
        {
          "occurrenceType": "Crédito Pessoal",
          "notaryOffice": "3",
          "occurrenceDate": "17/02/2022",
          "currency": "R$",
          "amount": "2.789,45",
          "city": "São Paulo",
          "state": "SP"
        }
      ],
      "phoneConfirmation": [
        {
          "areaCode": "011",
          "phoneNumber": "1137833742",
          "documentType": "CPF",
          "documentNumber": "74146649889",
          "name": "Guilherme Joaquim Mateus Cardoso",
          "neighborhood": "União de Vila Nova",
          "postalCode": "08071105",
          "city": "São Paulo",
          "state": "SP"
        }
      ],
      "bankBranchContactDetails": [
        {
          "bank": "Banco Itaú",
          "bankName": "Itaú",
          "agency": "0177",
          "branchName": "Itaú - Ag. 0177 - SP AV Liberdade",
          "address": "Avenia Liberdade, 87",
          "neighborhood": "Liberdade",
          "postalCode": "01503-000",
          "city": "São Paulo",
          "state": "SP",
          "areaCode": "011",
          "phoneNumber1": "40044828",
          "phoneNumber2": "08009704828"
        }
      ],
      "postalCodeConfirmation": {
        "postalCode": "08071105",
        "address": "Rua das Flores",
        "neighborhood": "União de Vila Nova",
        "city": "São Paulo",
        "state": "SP"
      },
      "documentName": [
        {
          "name": "Guilherme Joaquim Mateus Cardoso",
          "birthDate": "06/04/1986",
          "documentType": "CPF",
          "documentNumber": "74146649889"
        },
        {
          "name": "Guilherme Joaquim Mateus Cardoso",
          "birthDate": "06/04/1986",
          "documentType": "RG",
          "documentNumber": "183004164"
        },
        {
          "name": "Guilherme Joaquim Mateus Cardoso",
          "birthDate": "06/04/1986",
          "documentType": "CNH",
          "documentNumber": "86671530071"
        }
      ],
      "reportedCurrentAccountHistory": [
        {
          "bank": "Itaú",
          "agency": "0177",
          "currentAccount": "29414-1",
          "documentType": "RG",
          "documentNumber": "183004164",
          "inquiryDate": "10/11/2024",
          "inquiryTime": "14:00:00"
        }
      ],
      "participationsOfConsultedDocument": [
        {
          "documentTypeA": "CPF",
          "documentNumberA": "74146649889",
          "companyName": "Joaquim Buffet Ltda",
          "currencyType": "R$",
          "amount": "100,00",
          "observation": "N",
          "percentageValue": "50,00",
          "entryDate": "19/04/2019",
          "role": "SOCIO ADMINISTRADOR",
          "documentTypeB": "CNPJ",
          "documentNumberB": "13628777000147",
          "partnerType": "S"
        },
        {
          "documentTypeA": "CPF",
          "documentNumberA": "74146649889",
          "companyName": "Bruno e Samuel Telecom Ltda",
          "currencyType": "R$",
          "amount": "80,00",
          "observation": "N",
          "percentageValue": "33,00",
          "entryDate": "19/10/2022",
          "role": "SOCIO ADMINISTRADOR",
          "documentTypeB": "CNPJ",
          "documentNumberB": "14293465000192",
          "partnerType": "S"
        }
      ],
      "bankruptcyJudicialRecoveryRelationship": [
        {
          "documentType": "CNPJ",
          "documentNumber": "54036433000126",
          "companyName": "Joca Locações de Automóveis ME",
          "occurrenceType": "Outros",
          "notaryOffice": "0001",
          "occurrenceDate": "10/09/2019",
          "location": "Guarulhos",
          "state": "SP",
          "municipalityCode": "3518800"
        }
      ],
      "identification": {
        "document": "74146649889",
        "name": "Guilherme Joaquim Mateus Cardoso",
        "motherName": "Raquel Amanda Cardoso",
        "dataOfBirth": "06/04/1986",
        "rgNumber": "183004164",
        "issuingAgency": "SSP",
        "rgFederativeUnit": "SP",
        "rgIssueDate": "02/03/1999",
        "gender": "Masculino",
        "nacionalidade": "Brasileiro",
        "maritalStatus": "Casado",
        "numberOfDependents": "2",
        "educationLevel": "Mestrado Completo",
        "revenueStatus": "Regular",
        "updateDate": "31/10/2024",
        "cpfRegion": "SP",
        "voterRegistration": "776102840124"
      },
      "location": {
        "streetType": "R",
        "streetName": "Rua das Flores",
        "streetNumber": "707",
        "addressComplement": "504",
        "neighborhood": "União de Vila Nova",
        "city": "São Paulo",
        "state": "SP",
        "postalCode": "08071105",
        "areaCode1": "0011",
        "phoneNumber1": "1137833742",
        "areaCode2": "0011",
        "phoneNumber2": "11992681016"
      },
      "scores": [
        {
          "score": "802",
          "probability": "01300",
          "numericalClassification": "11",
          "alphabeticalClassification": "B",
          "scoreMessage": "É provável que 92% das pessoas com esse mesmo comportamento, paguem suas contas nos próximos 6 meses."
        },
        {
          "score": "10",
          "probability": "00000",
          "numericalClassification": "00",            
          "alphabeticalClassification": "F",
          "scoreMessage": "Renda estimada a partir de informações comportamentais e cadastrais do consumidor.",
          "presumedIncomeRange": "De R$ 9.001 até R$ 12.000"
        }
      ],
      "positiveControlPanel": {
        "positivePaymentBehaviorIndicators": {
          "lateInvoiceBehaviorScore": {
            "score": "A"
          }
        },
        "positiveConsumptionBehaviorIndicators": {
          "recentContractBehaviorScore": {
            "score": "B"
          }
        }
      },
      "consumerStatus": {
        "message": "CONSUMIDOR PARTICIPANTE DO CADASTRO POSITIVO COM INFORMAÇÃO"
      }
    }
    }
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                     | Description                                                                     |
| ------------------------ | ------------------------------------------------------------------------------- |
| credit\_score\_available | The rule will become invalid if the credit score is unavailable.                |
| credit\_score\_below     | The rule will become invalid if the credit score is below the defined value.    |
| credit\_score\_over      | The rule will become invalid if the credit score is above the defined value.    |
| credit\_score\_between   | The rule will become invalid if the credit score is between the defined values. |
| {% endtab %}             |                                                                                 |
| {% endtabs %}            |                                                                                 |


# Labor

## Professional History (PF10)

Returns a list of companies that the person probably works for or has worked for and the period of each professional experience.

**Section:** `pfOccupationData`

**Required parameter:** `cpf`

**Optional parameter:** `birthDate` *This information is required in some sources to complete the execution of minors*

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

| Attribute                            | Type    | Description                                                                                         |
| ------------------------------------ | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                           | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                 | Object  | Return data                                                                                         |
| data.professions                     | Array   | List of objects with the details of each job found                                                  |
| data.professions\[x].sector          | String  | Company sector                                                                                      |
| data.professions\[x].companyIdNumber | String  | Company identification number (cnpj)                                                                |
| data.professions\[x].companyName     | String  | Company name (trade name)                                                                           |
| data.professions\[x].status          | String  | Employment status (ACTIVE / INACTIVE)                                                               |
| data.professions\[x].incomeRange     | String  | Salary Range                                                                                        |
| data.professions\[x].startDate       | Date    | Job start or admission date                                                                         |
| data.professions\[x].endDate         | Date    | Job end or dismissal date                                                                           |
| data.professions\[x].lastUpdateDate  | Date    | Date of last update                                                                                 |
| data.isEmployed                      | Boolean | Indicates whether the person is employed or not                                                     |
| {% endtab %}                         |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "professions": [
      {
        "sector": "PRIVATE - XXXXXXX - IT",
        "companyIdNumber": "61160438000636",
        "companyName": "COMBATEAFRAUDE TECNOLOGIA DA INFORMACAO S.A.",
        "status": "ACTIVE",
        "incomeRange": "",
        "startDate": "2018-03-13T00:00:00Z",
        "endDate": "9999-12-31T23:59:59.9999999",
        "lastUpdateDate": "2022-08-19T00:00:00Z"
      }
    ],
    "isEmployed": "true"
  }
}
```

{% endtab %}
{% endtabs %}

## Economic Relationships (PF36)

Returns the list of entities related to the queried individual in an economic scope, which includes types of relationships such as equity interests in companies, and employment relationships (for which details can be seen in the Professional Data dataset, among others).

**Section:** `pfBusinessRelationships`

**Required parameter:** `cpf`

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

| Attribute                                               | Type   | Description                                                                                         |
| ------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                              | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                                    | Object | Return data                                                                                         |
| data.businessRelationships                              | Array  | Array of objects with economic relationships                                                        |
| data.businessRelationships\[x].relatedEntityTaxIdNumber | String | Number of the Entity relationship                                                                   |
| data.businessRelationships\[x].relatedEntityTaxIdType   | String | Type of Entity relationship                                                                         |
| data.businessRelationships\[x].relatedEntityName        | String | Name                                                                                                |
| data.businessRelationships\[x].relationshipType         | String | Relationship type                                                                                   |
| data.businessRelationships\[x].relationshipLevel        | String | Relationship Level                                                                                  |
| data.businessRelationships\[x].relationshipStartDate    | String | Relationship Start Date                                                                             |
| data.businessRelationships\[x].relationshipEndDate      | String | Relationship End                                                                                    |
| data.businessRelationships\[x].lastUpdateDate           | String | Last maintained                                                                                     |
| {% endtab %}                                            |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "businessRelationships": [
      {
        "relatedEntityTaxIdNumber": "6XX60XXX000XXX",
        "relatedEntityTaxIdType": "CNPJ",
        "relatedEntityName": "COMBATEAFRAUDE S.A.",
        "relationshipType": "EMPLOYMENT",
        "relationshipLevel": "DIRECT",
        "relationshipStartDate": "2018-03-13T00:00:00Z",
        "relationshipEndDate": "0001-01-01T00:00:00Z",
        "lastUpdateDate": "2022-08-19T00:00:00Z"
      }
    ],
  }
}
```

{% endtab %}
{% endtabs %}

## Government Social Assistance (PF16)

Returns if the person is part of Bolsa Família or some other government benefit. Along with the value of these benefits.

**Section:** `pfSocialAssistance`

**Required parameter:** `cpf`

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

| Attribute                                   | Type    | Description                                                                                         |
| ------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                                  | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                        | Object  | Return data                                                                                         |
| data.socialAssistances                      | Array   | List of social assistance programs                                                                  |
| data.socialAssistances\[x].programName      | String  | Program name                                                                                        |
| data.socialAssistances\[x].programState     | String  | State where the program is applied                                                                  |
| data.socialAssistances\[x].assistanceAmount | String  | Amount received by the assistance program                                                           |
| data.totalAssistances                       | String  | Total amount of assistance the person has received                                                  |
| data.isReceivingAssistance                  | Boolean | Indicates whether the person is currently receiving any assistance                                  |
| {% endtab %}                                |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "socialAssistances": null,
    "totalAssistances": "0",
    "isReceivingAssistance": false
  }
}
```

{% endtab %}
{% endtabs %}

## Class Councils (PF37)

Returns whether this person is associated with any class council such as: OAB, CREA, CRA, ...

**Section:** `pfClassOrganization`

**Required parameter:** `cpf`

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

| Attribute                           | Type   | Description                                                                                         |
| ----------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                          | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                | Object | Return data                                                                                         |
| memberships                         | Array  | Class Organization data                                                                             |
| memberships\[x].organizationName    | String | Organization name                                                                                   |
| memberships\[x].organizationCountry | String | Organization country                                                                                |
| memberships\[x].organizationType    | String | Type of organization                                                                                |
| memberships\[x].organizationChapter | String | State where the organization operates                                                               |
| memberships\[x].registrationId      | String | Registration Id                                                                                     |
| memberships\[x].category            | String | Category                                                                                            |
| memberships\[x].status              | String | Status                                                                                              |
| memberships\[x].membershipStartDate | String | Date person joined                                                                                  |
| memberships\[x].membershipEndDate   | String | Date membership ended                                                                               |
| {% endtab %}                        |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": 0,
  "data": {
    "memberships": [
      {
        "organizationName": "XXXXXXXXXXXX",
        "organizationCountry": "BRAZIL",
        "organizationType": "CLASS ASSOCIATION",
        "organizationChapter": "SP",
        "registrationId": "SP00000",
        "category": "ENGENHEIRO(A) DE COMPUTACAO",
        "status": "INATIVO",
        "membershipStartDate": "0001-01-01T00:00:00Z",
        "membershipEndDate": "9999-12-31T23:59:59.9999999"
      },
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                          | Description                                               |
| ----------------------------- | --------------------------------------------------------- |
| has\_no\_class\_organizations | Checks if the CPF has links to professional associations. |
| {% endtab %}                  |                                                           |
| {% endtabs %}                 |                                                           |

## Labor Debts (PF98)

Returns the result of issuing a negative certificate of labor debts for a given CPF

**Section:** `pfLaborDebts`

**Required parameter:** `cpf`

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

| Attribute                | Type   | Description                                                                                         |
| ------------------------ | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode               | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                     | Object | Return data                                                                                         |
| data.message             | String | Return message                                                                                      |
| data.status              | String | Status (found/not found)                                                                            |
| data.certificateValidity | String | Certificate validity                                                                                |
| {% endtab %}             |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso.",
    "status": "NADA CONSTA",
    "certificateValidity": "20/06/2023 - 180 (cento e oitenta) dias, contados da data de sua expedição."
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                  | Description                                        |
| --------------------- | -------------------------------------------------- |
| has\_no\_labor\_debts | The rule will be invalid if there are labor debts. |
| {% endtab %}          |                                                    |
| {% endtabs %}         |                                                    |

## Civil Servant (PF34)

Returns aggregated and detailed information of civil servants. This query returns data such as Indicator and Civil Servant details.

**Section:** `pfProfessionData`

**Required parameter:** `cpf`

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

| Attribute                                            | Type    | Description                                                                                         |
| ---------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                                           | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                                 | Object  | Return data                                                                                         |
| data.professions                                     | Array   | Object list with the details of each job found                                                      |
| data.professions\[x].source                          | String  | Source of information                                                                               |
| data.professions\[x].sector                          | String  | Company sector                                                                                      |
| data.professions\[x].state                           | String  | Company State                                                                                       |
| data.professions\[x].country                         | String  | Country in which the profession is practiced                                                        |
| data.professions\[x].companyIdNumber                 | String  | Company identification number (CNPJ)                                                                |
| data.professions\[x].companyName                     | String  | Company Name                                                                                        |
| data.professions\[x].area                            | String  | Area of the company where the person works                                                          |
| data.professions\[x].level                           | String  | Job or position (when available)                                                                    |
| data.professions\[x].status                          | String  | Employment status.                                                                                  |
| data.professions\[x].incomeRange                     | String  | Estimated salary range for this job                                                                 |
| data.professions\[x].income                          | Number  | Estimated income provided by this work                                                              |
| data.professions\[x].startDate                       | Date    | Date of start or admission to work                                                                  |
| data.professions\[x].endDate                         | Date    | Date of termination or withdrawal from employment                                                   |
| data.professions\[x].situation                       | String  | Employee status                                                                                     |
| data.professions\[x].isDead                          | String  | Employee is deceased                                                                                |
| data.professions\[x].companyAdmissionDate            | String  | Date of admission to the company                                                                    |
| data.professions\[x].jobFunction                     | String  | Job Function                                                                                        |
| data.professions\[x].jobRole                         | String  | Position                                                                                            |
| data.professions\[x].servantType                     | String  | Employee Type                                                                                       |
| data.professions\[x].workload                        | String  | Workload                                                                                            |
| data.professions\[x].organType                       | String  | Organ Type                                                                                          |
| data.professions\[x].headBranch                      | String  | Top Rod                                                                                             |
| data.professions\[x].incomeHistory                   | Array   | Payment History                                                                                     |
| data.professions\[x].incomeHistory\[x].income        | String  | Amount received                                                                                     |
| data.professions\[x].incomeHistory\[x].referenceDate | Date    | Reference Date                                                                                      |
| data.professions\[x].averageIncome                   | Number  | Average salary                                                                                      |
| data.professions\[x].maxIncome                       | Number  | Highest amount received                                                                             |
| data.professions\[x].minIncome                       | Number  | Lowest amount received                                                                              |
| data.professions\[x].registrationNumber              | String  | Registration Number                                                                                 |
| data.professions\[x].creationDate                    | Date    | Creation date                                                                                       |
| data.professions\[x].lastUpdateDate                  | Date    | Date of last update                                                                                 |
| data.professions\[x].totalProfessions                | Number  | Total number of occupations held                                                                    |
| data.professions\[x].totalActiveProfessions          | Number  | Total number of active professions                                                                  |
| data.professions\[x].totalIncomeRange                | String  | Income Range                                                                                        |
| data.professions\[x].totalIncome                     | Number  | Total income                                                                                        |
| data.professions\[x].isEmployed                      | Boolean | Indicates whether the person is employed or not                                                     |
| {% endtab %}                                         |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "professions": null,
    "totalProfessions": 0,
    "totalIncomeRange": "SEM INFORMACAO",
    "totalIncome": 0,
    "isEmployed": false
  }
}
```

{% endtab %}
{% endtabs %}


# Register data

## Consultation at Receita Federal

Returns if the consulted CPF is Regular, Irregular, Death and other information from the Receita Federal.

**Section:** `cpf`

**Required parameters:** `cpf, birthDate`

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

| Attribute                     | Type   | Description                                                            |
| ----------------------------- | ------ | ---------------------------------------------------------------------- |
| cpf                           | Object | Object with CPF query details                                          |
| cpf.statusCode                | String | Status Code                                                            |
| cpf.name                      | String | Name of the person at the IRS                                          |
| cpf.socialName                | String | Social name of the person                                              |
| cpf.birthDate                 | String | Date of birth at the Federal Inland Revenue                            |
| cpf.registrationStatusCode    | String | Cadastral situation code                                               |
| cpf.registrationStatusMessage | String | Message Cadastral situation                                            |
| cpf.issueDate                 | String | Date of issuance of the document at the Federal Inland Revenue Service |
| cpf.deathYear                 | String | Death year (if existent)                                               |
| cpf.deathMessage              | String | Message of death                                                       |
| {% endtab %}                  |        |                                                                        |

{% tab title="Example" %}

```json
{
  "cpf": {
    "statusCode": "00",
    "registrationStatusCode": "00",
    "registrationStatusMessage": "REGULAR",
    "name": "JOHN DOE",
    "socialName": "JANE DOE",
    "birthDate": "08/05/1987",
    "issueDate": "14/02/2012",
    "deathYear": "",
    "deathMessage": ""
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                               | Description                                                                                                                                                       |
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| cpf\_query                         | Check if it was possible to consult the CPF at the Receita Federal.                                                                                               |
| cpf\_error\_code                   | Checks that the CPF is in order.                                                                                                                                  |
| cpf\_equal\_name                   | Checks that the name found in the run (parameter/OCR) is the same as the official database.                                                                       |
| cpf\_has\_not\_dead                | The rule will be invalid if the consulted CPF is in a deceased status according to the Basic PF Data or Receita Federal (pfBasicData, cpf, and pfData).           |
| over\_21                           | Checks if the CPF holder is over 21 years old.                                                                                                                    |
| over\_18                           | Checks if the CPF holder is over 18 years old.                                                                                                                    |
| over\_16                           | Checks if the CPF holder is over 16 years old.                                                                                                                    |
| over\_14                           | Checks if the CPF holder is over 14 years old.                                                                                                                    |
| first\_and\_last\_name\_similarity | Checks the similarity between the union of the first and last name sent in the parameters compared to the union of the first name and each surname in the source. |
| {% endtab %}                       |                                                                                                                                                                   |
| {% endtabs %}                      |                                                                                                                                                                   |

## Consultation at Receita Federal - NEW (PF2)

Query the Brazilian Receita Federal Service or private sources (according to availability), and return whether the consulted CPF is in regular, irregular, or deceased status. Its difference from the "cpf" source is that it can be queried without the "birthdate" parameter, and individual rules can be applied for the Receita Federal status: regular, suspended, null, canceled, deceased, and pending regularization.

**Section:** `pfData`

**Required parameter:** `cpf`

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

| Attribute        | Type   | Description                                                                                         |
| ---------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode       | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data             | Object | Return data                                                                                         |
| data.name        | String | Name                                                                                                |
| data.socialName  | String | Social name                                                                                         |
| data.birthDate   | String | Date of birth                                                                                       |
| data.taxIdStatus | String | CPF status in relation to the Internal Revenue Service                                              |
| {% endtab %}     |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "name": "JOHN DOE",
    "socialName": "JANE DOE",
    "taxIdStatus": "REGULAR",
    "birthDate": "08/05/1999"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                             | Description                                                                                                                                             |
| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| does\_not\_exist\_on\_receita\_federal\_database | The rule will be invalid if the CPF is not found in the Receita Federal database.                                                                       |
| is\_not\_alive                                   | The rule will be invalid if the consulted CPF is in a deceased status according to the Basic PF Data or Receita Federal (pfBasicData and pfData).       |
| is\_not\_pendant\_of\_regularization             | The rule will be invalid if the consulted CPF has pending regularization status in the Receita Federal.                                                 |
| is\_not\_cancelled                               | The rule will be invalid if the consulted CPF has canceled registration in the Receita Federal.                                                         |
| is\_not\_suspended                               | The rule will be invalid if the consulted CPF has suspended registration status in the Receita Federal.                                                 |
| is\_not\_null                                    | The rule will be invalid if the consulted CPF has null registration status in the Receita Federal.                                                      |
| over\_18                                         | Checks if the CPF holder is over 18 years old.                                                                                                          |
| over\_16                                         | Checks if the CPF holder is over 16 years old.                                                                                                          |
| over\_14                                         | Checks if the CPF holder is over 14 years old.                                                                                                          |
| cpf\_query                                       | Check if it was possible to consult the CPF at the Receita Federal.                                                                                     |
| cpf\_error\_code                                 | Checks that the CPF is in order.                                                                                                                        |
| cpf\_equal\_name                                 | Checks that the name found in the run (parameter/OCR) is the same as the official database.                                                             |
| cpf\_has\_not\_dead                              | The rule will be invalid if the consulted CPF is in a deceased status according to the Basic PF Data or Receita Federal (pfBasicData, cpf, and pfData). |
| is\_cpf\_regular                                 | The rule will be invalid if the CPF has irregular registration in the Receita Federal.                                                                  |
| invalid\_range\_ages                             | Checks that the CPF holder is within the configured age range.                                                                                          |
| {% endtab %}                                     |                                                                                                                                                         |
| {% endtabs %}                                    |                                                                                                                                                         |

## Basic Data (PF1.1)

Gathers basic information about a CPF.

**Section:** `pfBasicData`

**Required parameter:** `cpf`

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

| Attribute                                      | Type    | Description                                                                                         |
| ---------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                                     | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                           | Object  | Return data                                                                                         |
| data.name                                      | String  | Name                                                                                                |
| data.socialName                                | String  | Social name                                                                                         |
| data.gender                                    | String  | Genre                                                                                               |
| data.birthDate                                 | String  | Date of birth                                                                                       |
| data.birthCountry                              | String  | Country of birth                                                                                    |
| data.motherName                                | String  | Mother's name                                                                                       |
| data.fatherName                                | String  | Father's name                                                                                       |
| data.taxIdNumber                               | String  | CPF number                                                                                          |
| data.taxIdCountry                              | String  | Document country                                                                                    |
| data.alternativeIdNumbers                      | Object  | Alternative document numbers                                                                        |
| data.alternativeIdNumbers.SocialSecurityNumber | String  | Social Security Number                                                                              |
| data.taxIdStatus                               | String  | CPF status in relation to the Internal Revenue Service                                              |
| data.taxIdOrigin                               | String  | Origin of the CPF                                                                                   |
| data.hasObitIndication                         | Boolean | Indicate if there was a death for that person                                                       |
| data.obitIndicationOrigin                      | String  | The source of the death information                                                                 |
| data.obitIndicationYear                        | String  | Year of death indication                                                                            |
| data.taxIdStatusDate                           | String  | Status Query Date                                                                                   |
| data.creationDate                              | String  | Creation date                                                                                       |
| data.lastUpdateDate                            | String  | Last updated                                                                                        |
| data.message                                   | String  | Description of the query status                                                                     |
| {% endtab %}                                   |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "taxIdNumber": "03852939097",
    "taxIdCountry": "BRAZIL",
    "name": "JOHN DOE",
    "socialName": "JANE DOE",
    "gender": "M",
    "birthDate": "1999-05-08T00:00:00Z",
    "birthCountry": "BRASILEIRA",
    "motherName": "MARIA DOE",
    "fatherName": "",
    "taxIdStatus": "REGULAR",
    "taxIdOrigin": "RECEITA FEDERAL",
    "alternativeIdNumbers": {
      "SocialSecurityNumber": "12961902314"
    },
    "hasObitIndication": false,
    "obitIndicationOrigin": "",
    "obitIndicationYear": "",
    "taxIdStatusDate": "2016-02-01T00:00:00Z",
    "creationDate": "2016-02-01T00:00:00Z",
    "lastUpdateDate": "2016-02-01T00:00:00Z"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                 | Description                                                    |
| -------------------- | -------------------------------------------------------------- |
| over\_21             | Checks if the CPF holder is over 21 years old.                 |
| over\_18             | Checks if the CPF holder is over 18 years old.                 |
| over\_16             | Checks if the CPF holder is over 16 years old.                 |
| over\_14             | Checks if the CPF holder is over 14 years old.                 |
| over\_14             | Checks if the CPF holder is over 14 years old.                 |
| cpf\_null            | Checks that the basic data source is returning values.         |
| invalid\_range\_ages | Checks that the CPF holder is within the configured age range. |
| {% endtab %}         |                                                                |
| {% endtabs %}        |                                                                |

## Consultation at Receita Federal - NEW (PF1.2)

Gathers basic information about a CPF.

**Section:** `pfCpfData`

**Required parameters:** `cpf, birthDate`

The `birthDate` parameter accepts the formats `DD/MM/YYYY` or `YYYY-MM-DD`.

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

| Attribute        | Type   | Description                                                                                         |
| ---------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode       | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data             | Object | Return data                                                                                         |
| data.name        | String | Name                                                                                                |
| data.socialName  | String | Social name                                                                                         |
| data.birthDate   | String | Date of birth                                                                                       |
| data.issueDate   | String | CPF issue date at the Federal Revenue (DD/MM/YYYY)                                                  |
| data.taxIdStatus | String | CPF status in relation to the Internal Revenue Service                                              |
| data.taxIdNumber | String | CPF Id number                                                                                       |
| {% endtab %}     |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "taxIdNumber": "03852939097",
    "name": "JOHN DOE",
    "socialName": "JANE DOE",
    "taxIdStatus": "REGULAR",
    "birthDate": "1999-05-08T00:00:00Z",
    "issueDate": "14/02/2013"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                 | Description                                                                             |
| ------------------------------------ | --------------------------------------------------------------------------------------- |
| big\_data\_source\_underage          | Check if the source returned that the holder is under 18 years old.                     |
| cpf\_equal\_name                     | Check if the name found during execution (parameter/OCR) matches the official database. |
| is\_not\_alive                       | Check if the CPF belongs to a deceased holder.                                          |
| is\_not\_pendant\_of\_regularization | Check if the CPF has a pending regularization status.                                   |
| is\_not\_cancelled                   | Check if the CPF is listed as canceled with the Federal Revenue Service.                |
| is\_not\_suspended                   | Check if the CPF is listed as suspended with the Federal Revenue Service.               |
| is\_not\_null                        | Check if the CPF is listed as null with the Federal Revenue Service.                    |
| cpf\_query                           | Check if it was possible to make the inquiry with the Federal Revenue Service or not.   |
| {% endtab %}                         |                                                                                         |
| {% endtabs %}                        |                                                                                         |

## Emails (PF11)

Returns a list of the person's e-mails.

**Section:** `pfEmails`

**Required parameter:** `cpf`

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

| Attribute                  | Type   | Description                                                                                         |
| -------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                 | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                       | Object | Return data                                                                                         |
| items                      | Array  | Emails data                                                                                         |
| items\[x].email            | String | Email address                                                                                       |
| items\[x].type             | String | Email Type                                                                                          |
| items\[x].firstPassageDate | String | Date of first passage                                                                               |
| items\[x].lastPassageDate  | String | Date of last passage                                                                                |
| {% endtab %}               |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "items": [
      {
        "email": "johndoe@email.com",
        "type": "personal",
        "firstPassageDate": "2018-04-22T06:06:56.957Z",
        "lastPassageDate": "2020-08-04T09:17:15.041Z"
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

## Addresses (PF12)

Retorna uma lista com os endereços da pessoa.

**Section:** `pfAddresses`

**Required parameter:** `cpf`

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

| Attribute                              | Type    | Description                                                                                            |
| -------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------ |
| statusCode                             | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code))    |
| message                                | String  | Description of the query status                                                                        |
| data                                   | Array   | Return data                                                                                            |
| data\[x].typology                      | String  | Street Type                                                                                            |
| data\[x].title                         | String  | Title/Definition                                                                                       |
| data\[x].addressMain                   | String  | Name                                                                                                   |
| data\[x].number                        | String  | Number                                                                                                 |
| data\[x].complement                    | String  | Supplement                                                                                             |
| data\[x].neighborhood                  | String  | Neighborhood                                                                                           |
| data\[x].zipCode                       | String  | ZIP CODE                                                                                               |
| data\[x].city                          | String  | City                                                                                                   |
| data\[x].state                         | String  | State                                                                                                  |
| data\[x].country                       | String  | Country                                                                                                |
| data\[x].type                          | String  | Address List                                                                                           |
| data\[x].complementType                | String  | Address type calculated from the address complement                                                    |
| data\[x].householdCode                 | String  | Household code of address                                                                              |
| data\[x].buildingCode                  | String  | Address building code                                                                                  |
| data\[x].householdTotalPassages        | Number  | Number of times this household code has been seen for this entity                                      |
| data\[x].householdBadPassages          | Number  | Number of times this household code has been seen for this entity in a suspicious situation            |
| data\[x].householdCrawlingPassages     | Number  | Quantidade de passagens do household com a entidade que tem como origem uma captura                    |
| data\[x].householdValidationPassages   | Number  | Quantity of household passages with the entity that has a capture as origin                            |
| data\[x].householdQueryPassages        | Number  | Quantity of household's tickets with the entity that originates a query                                |
| data\[x].householdMonthAveragePassages | Number  | Average number of times the household was seen with the entity per month                               |
| data\[x].householdNumberOfEntities     | Number  | Number of distinct entities associated with this household                                             |
| data\[x].buildingTotalPassages         | Number  | Number of times this building code has been viewed for this entity                                     |
| data\[x].buildingBadPassages           | Number  | Number of times this building code has been seen for this entity in a suspicious situation             |
| data\[x].buildingCrawlingPassages      | Number  | Quantity of building passes with the entity that has a capture as origin                               |
| data\[x].buildingValidationPassages    | Number  | Quantity of building passes with the entity that has a validation as origin                            |
| data\[x].buildingQueryPassages         | Number  | Quantity of building passes with the entity that originates a query                                    |
| data\[x].buildingMonthAveragePassages  | Number  | Average number of times the building was seen with the entity per month                                |
| data\[x].buildingNumberOfHouseholds    | Number  | Number of different households associated with this building                                           |
| data\[x].last3MonthsPassages           | Number  | Number of entity passages in the last 3 months                                                         |
| data\[x].last6MonthsPassages           | Number  | Number of entity passages in the last 6 months                                                         |
| data\[x].last12MonthsPassages          | Number  | Number of entity passages in the last 12 months                                                        |
| data\[x].last18MonthsPassages          | Number  | Number of entity passages in the last 18 months                                                        |
| data\[x].priority                      | Number  | Indicates the priority of the address                                                                  |
| data\[x].isMain                        | Boolean | Indicates whether the address is the primary address                                                   |
| data\[x].isRecent                      | Boolean | Indicates whether this address is recent                                                               |
| data\[x].isActive                      | Boolean | Indica se esse endereço está ativo                                                                     |
| data\[x].isRatified                    | Boolean | Indicates whether the address has been ratified with the post office's reference base (DNE or similar) |
| data\[x].firstPassageDate              | String  | Date of the first passage of this household with this entity                                           |
| data\[x].lastPassageDate               | String  | Date of the last passage of this household with this entity                                            |
| data\[x].creationDate                  | String  | Date of first related record                                                                           |
| data\[x].lastUpdateDate                | String  | Last updated address                                                                                   |
| data\[x].hasOptIn                      | Boolean | Indicates if there has been acceptance of orders at that address                                       |
| data\[x].ibgeCode                      | String  | Municipality code                                                                                      |
| data\[x].latitude                      | Number  | Latitude                                                                                               |
| data\[x].longitude                     | Number  | Longitude                                                                                              |
| {% endtab %}                           |         |                                                                                                        |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "items": [
      {
        "typology": "RUA",
        "title": "",
        "addressMain": "XXXXXX XXXXXXX",
        "number": "17",
        "complement": "",
        "neighborhood": "CENTRO",
        "zipCode": "XXXXXXXX",
        "city": "XXXXXXXXXXX",
        "state": "XX",
        "country": "Brazil",
        "type": "WORK",
        "complementType": "",
        "householdCode": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "buildingCode": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "householdTotalPassages": 1,
        "householdBadPassages": 1,
        "householdCrawlingPassages": 1,
        "householdValidationPassages": 1,
        "householdQueryPassages": -1,
        "householdMonthAveragePassages": 1,
        "householdNumberOfEntities": 1,
        "buildingTotalPassages": 1,
        "buildingBadPassages": 1,
        "buildingCrawlingPassages": 1,
        "buildingValidationPassages": 1,
        "buildingQueryPassages": -1,
        "buildingMonthAveragePassages": 1,
        "buildingNumberOfHouseholds": -1,
        "last3MonthsPassages": -1,
        "last6MonthsPassages": -1,
        "last12MonthsPassages": -1,
        "last18MonthsPassages": -1,
        "priority": 1,
        "isMain": true,
        "isRecent": false,
        "isActive": true,
        "isRatified": false,
        "firstPassageDate": "2016-02-01T00:00:00Z",
        "lastPassageDate": "2016-02-01T00:00:00Z",
        "creationDate": "2016-02-01T00:00:00Z",
        "lastUpdateDate": "2016-02-01T00:00:00Z",
        "hasOptIn": false,
        "ibgeCode": "XXXXXX",
        "latitude": -00.00,
        "longitude": -00.00
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

## Phone numbers (PF13)

Returns a list of the person's phone numbers.

**Section:** `pfPhones`

**Required parameter:** `cpf`

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

| Attribute                    | Type    | Description                                                                                         |
| ---------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                   | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                         | Object  | Return data                                                                                         |
| items                        | Array   | Phones data                                                                                         |
| items\[x].number             | String  | Phone Number                                                                                        |
| items\[x].areaCode           | String  | Area code (DDD of the state)                                                                        |
| items\[x].countryCode        | String  | Country Code                                                                                        |
| items\[x].type               | String  | Number's category                                                                                   |
| items\[x].lastPassageDate    | String  | Date of last use                                                                                    |
| items\[x].portabilityHistory | Array   | Porting History                                                                                     |
| items\[x].hasOptIn           | Boolean | Accepts marketing calls                                                                             |
| {% endtab %}                 |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "items": [
      {
        "number": "XXXXXXXXX",
        "areaCode": "11",
        "countryCode": "55",
        "type": "MOBILE",
        "lastPassageDate": "2020-05-12T22:46:23.812Z",
        "portabilityHistory": [],
        "hasOptIn": "false"
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

## ANTT

Consult the ANTT website to identify if the carrier is qualified to perform activities.

**Section:** `antt`

**Required parameter**: `cpf`, `plate`

**Plate formats:** *AAA9999* or *AAA9A999*

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

| Attribute           | Type    | Description                                                                                         |
| ------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode          | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                | Object  | Return data                                                                                         |
| data.hasRegister    | Boolean | Status informing whether it contains a record                                                       |
| data.transporter    | String  | Carrier                                                                                             |
| data.rntrc          | String  | RNTRC Number                                                                                        |
| data.rntrcSituation | String  | Status                                                                                              |
| data.memberSince    | String  | Date of first relationship                                                                          |
| data.expirationDate | String  | Expiration Date                                                                                     |
| data.city           | String  | City                                                                                                |
| data.message        | String  | Message present at registration                                                                     |
| {% endtab %}        |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Não foram encontrados transportadores para o filtro informado."
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                       | Description                                                                                                    |
| -------------------------- | -------------------------------------------------------------------------------------------------------------- |
| has\_no\_participant\_antt | The rule will be invalid if the consulted vehicle and person/company are not authorized to perform activities. |
| {% endtab %}               |                                                                                                                |
| {% endtabs %}              |                                                                                                                |

## Site Data (PF32)

Returns information about the sites and domains that are associated with the queried CPF, either through domain registration or through information contained within the site content itself.

**Section:** `pfDomains`

**Required parameter:** `cpf`

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

| Attribute                   | Type   | Description                                                                                         |
| --------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                  | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                        | Array  | Return data                                                                                         |
| data\[x].hostName           | String | Host Name                                                                                           |
| data\[x].domainName         | String | Domain name                                                                                         |
| data\[x].domainClass        | String | Site Classification                                                                                 |
| data\[x].registrationStatus | String | Registration Status                                                                                 |
| data\[x].registrationDate   | String | Site creation date                                                                                  |
| data\[x].expirationDate     | String | Site Expiration Date                                                                                |
| {% endtab %}                |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": [
    {
      "hostName": "",
      "domainName": "",
      "domainClass": "",
      "registrationStatus": "",
      "registrationDate": "",
      "expirationDate": ""
    }
  ]
}
```

{% endtab %}
{% endtabs %}

## Addresses - NEW (PF77)

Returns an addresses list.

**Section:** `pfAddressesAlt`

**Required parameter:** `cpf`

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

| Attribute                          | Type   | Description                                                                                         |
| ---------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                         | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                               | Object | Return data                                                                                         |
| data.message                       | String | Description of the query status                                                                     |
| data.addresses                     | Array  | The addresses list sorted in descending order according to the level of reliability                 |
| data.addresses\[x].street          | String | Street address                                                                                      |
| data.addresses\[x].number          | String | Address number                                                                                      |
| data.addresses\[x].complement      | String | Address complement                                                                                  |
| data.addresses\[x].neighborhood    | String | Address neighborhood                                                                                |
| data.addresses\[x].zipCode         | String | Zip code                                                                                            |
| data.addresses\[x].city            | String | City                                                                                                |
| data.addresses\[x].state           | String | State                                                                                               |
| data.addresses\[x].country         | String | Country                                                                                             |
| data.addresses\[x].completeAddress | String | Complete address                                                                                    |
| {% endtab %}                       |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "addresses": [
      {
        "street": "Rua Tiradentes",
        "number": "1077",
        "complement": "5º andar",
        "neighborhood": "Centro",
        "zipCode": "95800000",
        "city": "Venâncio Aires",
        "state": "RS",
        "country": "Brasil",
        "completeAddress": "Rua Tiradentes, 1077 - 5º andar - Centro, Venâncio Aires - RS, 95800000"
      },
      {
        "street": "Avenida Marechal Floriano",
        "number": "45",
        "complement": "Sala 801",
        "neighborhood": "Centro",
        "zipCode": "20080901",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "country": "Brasil",
        "completeAddress": "Avenida Marechal Floriano, 45 - Sala 801 - Centro, Rio de Janeiro - RJ, 20080901"
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

## Phone numbers - NEW (PF14)

Returns a list of the person's phone numbers.

\**This resource doesn't validate underage*

**Section:** `pfPhonesAlt`

**Required parameter:** `cpf`

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

| Attribute                | Type   | Description                                                                                         |
| ------------------------ | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode               | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| message                  | String | Description of the query status                                                                     |
| data                     | Object | Return data                                                                                         |
| data.phones              | Array  | Phones data                                                                                         |
| data.phones\[x].number   | String | Phone Number                                                                                        |
| data.phones\[x].areaCode | String | Area code (DDD of the state)                                                                        |
| {% endtab %}             |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "message": "Consulta realizada com sucesso",
  "data": {
    "phones": [
      {
        "number": "999999999",
        "areaCode": "11"
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

## Zip code details - NEW (PF15)

Returns detailed information related to a ZIP code, including street name, district, city, state, and other relevant data.

**Section:** `zipCodeDetails`

**Required parameter:** `cep`

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

| Attribute         | Type   | Description                                                                                         |
| ----------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode        | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data              | Object | Return data                                                                                         |
| data.message      | String | Description of the query status                                                                     |
| data.district     | String | District                                                                                            |
| data.street       | String | Street name                                                                                         |
| data.city         | String | City                                                                                                |
| data.cityCodeIbge | String | City IBGE code                                                                                      |
| data.ufName       | String | State name                                                                                          |
| data.uf           | String | State abbreviation                                                                                  |
| data.ufCodeIbge   | String | State IBGE code                                                                                     |
| {% endtab %}      |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "district": "Centro",
    "street": "Rua Tiradentes",
    "city": "Venâncio Aires",
    "cityCodeIbge": "4322608",
    "ufName": "Rio Grande do Sul",
    "uf": "RS",
    "ufCodeIbge": "43"
  }
}
```

{% endtab %}
{% endtabs %}

## CURP Check (PF18)

Gathers basic information about a CURP (Clave Única de Registro de Población) in Mexico.

**Section:** `mxCurpCheck`

**Required parameter:** `curp`

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

| Attribute                                      | Type    | Description                                                                                                                                                |
| ---------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| statusCode                                     | String  | Query status ([details](https://github.com/combateafraude/public-docs/tree/docs-api/core-api/transactions/background-check/data-structure.md#status-code)) |
| data                                           | Object  | Return data                                                                                                                                                |
| data.name                                      | String  | Name                                                                                                                                                       |
| data.gender                                    | String  | Genre                                                                                                                                                      |
| data.age                                       | Number  | Age                                                                                                                                                        |
| data.birthDate                                 | String  | Date of birth                                                                                                                                              |
| data.birthCountry                              | String  | Country of birth                                                                                                                                           |
| data.motherName                                | String  | Mother's name                                                                                                                                              |
| data.fatherName                                | String  | Father's name                                                                                                                                              |
| data.taxIdNumber                               | String  | CURP number                                                                                                                                                |
| data.taxIdStatus                               | String  | CURP status in relation to the Internal Revenue Service                                                                                                    |
| data.taxIdCountry                              | String  | Document country                                                                                                                                           |
| data.taxIdOrigin                               | String  | Origin of the CURP                                                                                                                                         |
| data.taxIdStatusDate                           | String  | Status Query Date                                                                                                                                          |
| data.alternativeIdNumbers                      | Object  | Alternative document numbers                                                                                                                               |
| data.alternativeIdNumbers.socialSecurityNumber | String  | Social Security Number                                                                                                                                     |
| data.hasObitIndication                         | Boolean | Indicate if there was a death for that person                                                                                                              |
| data.obitIndicationYear                        | String  | Year of death indication                                                                                                                                   |
| data.creationDate                              | String  | Creation date                                                                                                                                              |
| data.lastUpdateDate                            | String  | Last updated                                                                                                                                               |
| data.message                                   | String  | Description of the query status                                                                                                                            |
| {% endtab %}                                   |         |                                                                                                                                                            |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "taxIdNumber": "FOEJ600704HVZXRW36",
    "taxIdStatus": "",
    "taxIdOrigin": "",
    "taxIdCountry": "MEXICO",
    "name": "JOHNNY DOE",
    "gender": "M",
    "age": 26,
    "birthDate": "1999-05-08T00:00:00Z",
    "birthCountry": "MEXICO",
    "motherName": "JANE DOE",
    "fatherName": "JOHN DOE",
    "alternativeIdNumbers": {
      "socialSecurityNumber": ""
    },
    "hasObitIndication": false,
    "obitIndicationYear": "",
    "taxIdStatusDate": "2016-02-01T00:00:00Z",
    "creationDate": "2016-02-01T00:00:00Z",
    "lastUpdateDate": "2016-02-01T00:00:00Z"
  }
}
```

{% endtab %}
{% endtabs %}

## Registry Link - NEW (PF91)

Returns the data submitted by the user. No parameters are required.

**Section:** `registryLinkSource`

**Optional parameter:** `personId, CPF, CNPJ, RG, CNH, name, birthDate, email, phoneNumber, userIp, documentCountry`

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

| Attribute                                 | Type   | Description                                                                                         |
| ----------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data.message                              | String | Description of the query status                                                                     |
| data                                      | Object | Return data                                                                                         |
| data.documentId                           | String | Primary document identifier                                                                         |
| data.documentType                         | String | Primary document type (e.g., PERSONID, CPF, CNPJ, RG, CNH)                                          |
| data.name                                 | String | Name                                                                                                |
| data.birthDate                            | String | Date of birth                                                                                       |
| data.email                                | String | Email address                                                                                       |
| data.phoneNumber                          | String | Phone number                                                                                        |
| data.userIp                               | String | User IP address                                                                                     |
| data.documentCountry                      | String | Document country                                                                                    |
| data.additionalDocuments                  | Array  | List of additional documents                                                                        |
| data.additionalDocuments\[x].documentId   | String | Document identifier                                                                                 |
| data.additionalDocuments\[x].documentType | String | Document type (e.g., CPF, CNPJ, RG, CNH)                                                            |
| {% endtab %}                              |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "documentId": "abc123456789def0",
    "documentType": "PERSONID",
    "name": "JOHN DOE",
    "birthDate": "1999-05-08T00:00:00Z",
    "email": "johndoe@email.com",
    "phoneNumber": "11999999999",
    "userIp": "192.168.0.1",
    "documentCountry": "BR",
    "additionalDocuments": [
			{
				"documentId": "03852939097",
				"documentType": "CPF"
			},
			{
				"documentId": "11222333000181",
				"documentType": "CNPJ"
			},
			{
				"documentId": "123456789",
				"documentType": "RG"
			},
			{
				"documentId": "04567891011",
				"documentType": "CNH"
			}
		]
  }
}
```

{% endtab %}
{% endtabs %}


# Relationships

## Related Persons (PF39)

Returns the name and relationship of people possibly related to this person.

**Section:** `pfPersonalRelationships`

**Required parameter:** `cpf`

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

| Attribute                         | Type   | Description                                                                                         |
| --------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                        | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                              | Array  | Return data                                                                                         |
| data\[x].relatedEntityTaxIdNumber | String | ID document number                                                                                  |
| data\[x].relatedEntityTaxIdType   | String | Type of identification document                                                                     |
| data\[x].relatedEntityName        | String | Name of related person                                                                              |
| data\[x].relationshipType         | String | Relationship Type                                                                                   |
| data\[x].relationshipLevel        | String | Relationship Level                                                                                  |
| {% endtab %}                      |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "items": [
      {
        "relatedEntityTaxIdNumber": "",
        "relatedEntityTaxIdType": "CPF",
        "relatedEntityName": "MARIA DOE",
        "relationshipType": "MOTHER",
        "relationshipLevel": "DIRECT"
      },
      {
        "relatedEntityTaxIdNumber": "01XXXXXXX16",
        "relatedEntityTaxIdType": "CPF",
        "relatedEntityName": "GABRIEL DOE",
        "relationshipType": "BROTHER",
        "relationshipLevel": "DIRECT"
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

## Related Persons' Phone Numbers (PF38)

Returns the phone number and relationship of people possibly related to this person.

**Section:** `pfRelatedPeoplePhones`

**Required parameter:** `cpf`

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

| Attribute                   | Type    | Description                                                                                         |
| --------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                  | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                        | Array   | Return data                                                                                         |
| data\[x].number             | String  | Phone number                                                                                        |
| data\[x].areaCode           | String  | Area code                                                                                           |
| data\[x].countryCode        | String  | Country Code                                                                                        |
| data\[x].type               | String  | Type                                                                                                |
| data\[x].lastPassageDate    | String  | Date of last validation                                                                             |
| data\[x].portabilityHistory | Array   | Porting History                                                                                     |
| data\[x].hasOptIn           | Boolean | Accepts marketing calls                                                                             |
| {% endtab %}                |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": [
    {
      "number": "22112200",
      "areaCode": "54",
      "countryCode": "55",
      "type": "RELATED - 01XXXXXXX16 - BROTHER - WORK",
      "lastPassageDate": "2016-02-01T00:00:00Z",
      "portabilityHistory": [],
      "hasOptIn": false
    }
  ]
}
```

{% endtab %}
{% endtabs %}


# Risk

## Criminal background - Federal Police (PF3)

Issuing a criminal background check with the Federal Police.

**Section:** `pfBackgroundCheckFederalPolice`

**Required parameter:** `cpf, name, motherName, birthDate`

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

| Attribute              | Type   | Description                                   |
| ---------------------- | ------ | --------------------------------------------- |
| statusCode             | String | Query status                                  |
| data                   | Object | Return data                                   |
| data.idNumber          | String | CPF of the person                             |
| data.status            | String | Status of the certificate (found / not found) |
| data.certificateNumber | String | Certificate number                            |
| data.certificateText   | String | Description of the certificate (content)      |
| data.emissionDate      | String | Date of issue of the certificate              |
| data.validity          | String | Validity of the certificate                   |
| {% endtab %}           |        |                                               |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "idNumber": "0XX52XX90XX",
    "certificateText": "A Polícia Federal CERTIFICA, após pesquisa no Sistema Nacional de Informações Criminais - SINIC, que até a presente data,  NÃO CONSTA  decisão judicial condenatória com trânsito em julgado* em nome de  JOHN DOE,  nascido(a) aos 08/05/1999, CPF XXX.XXX.390-XX.",
    "status": "NADA CONSTA",
    "certificateNumber": "141XXXXX2022",
    "emissionDate": "07:48 de 22/12/2022",
    "validity": "90 DAYS"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                   | Description                                                                                              |
| -------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| has\_no\_criminal\_background\_federal | The rule will be invalid if the CPF has criminal records in the Federal Police.                          |
| has\_no\_inconsistent\_data            | The rule will become invalid if there is inconsistency in the data sent for querying the Federal Police. |
| has\_no\_criminal\_background          | Checks if the CPF has criminal records/background.                                                       |
| {% endtab %}                           |                                                                                                          |
| {% endtabs %}                          |                                                                                                          |

## CNJ Deprivation of Freedom Warrant (PF90)

Returns information about the existence of warrants (Arrest, Internment) with the National Council of Justice (CNJ).

**Section:** `pfArrestWarrant`

**Required parameter:** `cpf`

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

| Attribute                          | Type   | Description                                                                  |
| ---------------------------------- | ------ | ---------------------------------------------------------------------------- |
| statusCode                         | String | Query status                                                                 |
| data                               | Object | Return data                                                                  |
| data.message                       | String | Descriptive with query status                                                |
| data.status                        | String | Status related to the existence or not of warrants (exists / does not exist) |
| data.warrants                      | Array  | Warrant List                                                                 |
| data.warrants\[x].warrantNumber    | String | Warrant number                                                               |
| data.warrants\[x].name             | String | Name                                                                         |
| data.warrants\[x].status           | String | Situation                                                                    |
| data.warrants\[x].date             | String | Date                                                                         |
| data.warrants\[x].issuingAuthority | String | Issuing Agency                                                               |
| {% endtab %}                       |        |                                                                              |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso - Não foram encontrados mandados de prisão ou de internação pendentes de cumprimento para: NÚMERO DO DOCUMENTO DE IDENTIFICAÇÃO: XXX52XX90XX. Pesquisa realizada em 22/12/2022 às 07h48",
    "status": "NADA CONSTA",
    "warrants": []
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                 | Description                                                                  |
| -------------------- | ---------------------------------------------------------------------------- |
| has\_arrest\_warrant | Checks the existence of warrants with the National Council of Justice (CNJ). |
| {% endtab %}         |                                                                              |
| {% endtabs %}        |                                                                              |

## Lawsuits (PF48)

It returns detailed information about lawsuits involving individuals or companies. The data source may include information such as: case details, involved parties, accusation details, and procedural history.

**Section:** `pfProcessesAlt`

**Required parameter:** `cpf`

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

| Attribute                                          | Type         | Description                   |
| -------------------------------------------------- | ------------ | ----------------------------- |
| statusCode                                         | String       | Query status                  |
| data                                               | Object       | Return data                   |
| data.message                                       | String       | Description with query status |
| data.total                                         | Number       | Total number of processes     |
| data.results                                       | Array        | Processes list returned       |
| data.results\[x].id                                | String       | Query identifier              |
| data.results\[x].criminalCategory                  | String       | Category of process           |
| data.results\[x].lawsuitClass                      | String       | Class                         |
| data.results\[x].distributionDate                  | String       | Distribution date             |
| data.results\[x].statusDate                        | String       | Status date                   |
| data.results\[x].lawsuitDegree                     | String       | Degree of lawsuit             |
| data.results\[x].physicalLocation                  | String       | Physical location             |
| data.results\[x].oldLawsuitNumber                  | String       | Old Case Number               |
| data.results\[x].judgingBody                       | String       | Trial court                   |
| data.results\[x].lawsuitId                         | String       | Case number                   |
| data.results\[x].isDigitalLawsuit                  | Boolean      | If the case is digital        |
| data.results\[x].lawBranch                         | String       | Branch of Law                 |
| data.results\[x].segment                           | String       | Segment                       |
| data.results\[x].isJusticeSecret                   | Boolean      | If it is a legal secret       |
| data.results\[x].complementaryStatus               | String       | Complementary status          |
| data.results\[x].observationStatus                 | String       | Observation status            |
| data.results\[x].court                             | String       | Court                         |
| data.results\[x].state                             | String       | STATE                         |
| data.results\[x].sourceUnit                        | String       | Unit of origin                |
| data.results\[x].lawsuitUrl                        | String       | Process URL                   |
| data.results\[x].lawsuitValue                      | Object       | Process value return          |
| data.results\[x].lawsuitValue.currency             | String       | Currency (R$, U$, etc)        |
| data.results\[x].lawsuitValue.value                | Number       | Value                         |
| data.results\[x].subjects                          | String Array | Subjects list                 |
| data.results\[x].moves                             | Array        | Process' movement list        |
| data.results\[x].moves\[x].date                    | String       | Date of the movement          |
| data.results\[x].moves\[x].description             | String       | Description of the movement   |
| data.results\[x].actives                           | Array        | Assets list                   |
| data.results\[x].actives\[x].cnpj                  | String       | CNPJ                          |
| data.results\[x].actives\[x].cpf                   | String       | CPF                           |
| data.results\[x].actives\[x].name                  | String       | Name                          |
| data.results\[x].actives\[x].type                  | String       | Type                          |
| data.results\[x].actives\[x].lawyers               | Array        | List of Lawyers               |
| data.results\[x].actives\[x].lawyers\[x].oab       | String       | OAB Number                    |
| data.results\[x].actives\[x].lawyers\[x].name      | String       | Name                          |
| data.results\[x].actives\[x].lawyers\[x].cpf       | String       | CPF                           |
| data.results\[x].passives                          | Array        | List of liabilities           |
| data.results\[x].passives\[x].cnpj                 | String       | CNPJ                          |
| data.results\[x].passives\[x].cpf                  | String       | CPF                           |
| data.results\[x].passives\[x].name                 | String       | Name                          |
| data.results\[x].passives\[x].type                 | String       | Type                          |
| data.results\[x].passives\[x].lawyers              | Array        | List of Lawyers               |
| data.results\[x].passives\[x].lawyers\[x].oab      | String       | OAB Number                    |
| data.results\[x].passives\[x].lawyers\[x].name     | String       | Name                          |
| data.results\[x].passives\[x].lawyers\[x].cpf      | String       | CPF                           |
| data.results\[x].otherParties                      | Array        | Other parties list            |
| data.results\[x].otherParties\[x].cnpj             | String       | CNPJ                          |
| data.results\[x].otherParties\[x].cpf              | String       | CPF                           |
| data.results\[x].otherParties\[x].name             | String       | Name                          |
| data.results\[x].otherParties\[x].type             | String       | Type                          |
| data.results\[x].otherParties\[x].lawyers          | Array        | List of Lawyers               |
| data.results\[x].otherParties\[x].lawyers\[x].oab  | String       | OAB Number                    |
| data.results\[x].otherParties\[x].lawyers\[x].name | String       | Name                          |
| data.results\[x].otherParties\[x].lawyers\[x].cpf  | String       | CPF                           |
| data.results\[x].authorType                        | String       | Author Type                   |
| data.results\[x].authorParty                       | String       | Author Party                  |
| {% endtab %}                                       |              |                               |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "total": 7,
    "results": [
      {
        "id": "XXXXXXXXfdda79638XXXXX",
        "criminalCategory": "XXXXXXXXXXXXXXXXXXXXXXXXXX",
        "lawsuitClass": "ACAO PENAL PROCEDIMENTO ORDINARIO",
        "distributionDate": "2017-11-24",
        "statusDate": "",
        "lawsuitDegree": "1",
        "physicalLocation": "",
        "oldLawsuitNumber": "",
        "judgingBody": "VARA UNICA",
        "lawsuitId": "XXXXXX",
        "isDigitalLawsuit": false,
        "lawBranch": "CIVEL / ADMINISTRATIVO",
        "segment": "JUSTICA ESTADUAL",
        "isJusticeSecret": false,
        "complementaryStatus": "EM ANDAMENTO",
        "observationStatus": "ATIVO",
        "court": "TJ PA",
        "state": "PA",
        "sourceUnit": "XXXXX",
        "subjects": ["XXXXX"],
        "moves": [
          {
            "date": "2018-06-19",
            "description": "NOTIFICACAO DE NAO CUMPRIMENTO DE ALVARA DE SOLTURA"
          },
          {
            "date": "2018-05-25",
            "description": "MANDADO DE INTIMACAO"
          },
          {
            "date": "2018-05-25",
            "description": "ALVARA DE SOLTURA"
          },
          {
            "date": "2018-05-23",
            "description": "A SECRETARIA DE ORIGEM"
          },
          {
            "date": "2018-05-23",
            "description": "DECISAO"
          }
        ],
        "actives": [
          {
            "cnpj": "XXXXXX",
            "name": "MINISTERIO PUBLICO ESTADUAL",
            "type": "PROMOTOR A"
          },
          {
            "cpf": "XXX.XXX.XXX-XX",
            "name": "XXXXXX",
            "type": "VITIMA"
          }
        ],
        "passives": [
          {
            "cpf": "XXX.XXX.XXX-XX",
            "name": "XXXXXX",
            "type": "REU"
          }
        ],
        "otherParties": [
          {
            "cpf": "XXX.XXX.XXX-XX",
            "name": "XXXXXX",
            "type": "AGRAVANTE"
          }
        ],
        "authorType": "REU",
        "authorParty": "PASSIVO"
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                             | Description                                                          |
| ------------------------------------------------ | -------------------------------------------------------------------- |
| has\_no\_processes                               | Checks if the CPF/CNPJ is linked to processes.                       |
| has\_no\_processes\_active\_party                | Check if the CPF is linked to processes as an active party.          |
| has\_no\_processes\_passive\_party               | Check if the CPF is linked to processes as a passive party.          |
| has\_no\_processes\_other\_party                 | Check if the CPF is linked to processes as other parties.            |
| has\_no\_defendant\_processes                    | Checks if the CPF/CNPJ is linked to proceedings as a defendant.      |
| has\_no\_criminal\_processes                     | Checks if the CPF/CNPJ is linked to criminal proceedings.            |
| has\_author\_type\_null\_in\_criminal\_processes | Checks if there is an empty 'authorType' field in any criminal case. |
| {% endtab %}                                     |                                                                      |
| {% endtabs %}                                    |                                                                      |

## Processes with keywords (PF49)

Returns information about lawsuits that the person has, of any type (criminal, civil, labor, ...).

**Section:** `pfProcessesWithKeywords`

**Required parameter:** `cpf`

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

| Attribute                                          | Type         | Description                    |
| -------------------------------------------------- | ------------ | ------------------------------ |
| statusCode                                         | String       | Query status                   |
| data                                               | Object       | Return data                    |
| data.message                                       | String       | Description with query status  |
| data.total                                         | Number       | Total number of processes      |
| data.foundWords                                    | Array        | Keywords found                 |
| data.results                                       | Array        | Processes list returned        |
| data.results\[x].id                                | String       | Query identifier               |
| data.results\[x].matchedWords                      | Array        | Keywords found in this lawsuit |
| data.results\[x].criminalCategory                  | String       | Category of process            |
| data.results\[x].lawsuitClass                      | String       | Class                          |
| data.results\[x].distributionDate                  | String       | Distribution date              |
| data.results\[x].statusDate                        | String       | Status date                    |
| data.results\[x].lawsuitDegree                     | String       | Degree of lawsuit              |
| data.results\[x].physicalLocation                  | String       | Physical location              |
| data.results\[x].oldLawsuitNumber                  | String       | Old Case Number                |
| data.results\[x].judgingBody                       | String       | Trial court                    |
| data.results\[x].lawsuitId                         | String       | Case number                    |
| data.results\[x].isDigitalLawsuit                  | Boolean      | If the case is digital         |
| data.results\[x].lawBranch                         | String       | Branch of Law                  |
| data.results\[x].segment                           | String       | Segment                        |
| data.results\[x].isJusticeSecret                   | Boolean      | If it is a legal secret        |
| data.results\[x].complementaryStatus               | String       | Complementary status           |
| data.results\[x].observationStatus                 | String       | Observation status             |
| data.results\[x].court                             | String       | Court                          |
| data.results\[x].state                             | String       | STATE                          |
| data.results\[x].sourceUnit                        | String       | Unit of origin                 |
| data.results\[x].lawsuitUrl                        | String       | Process URL                    |
| data.results\[x].lawsuitValue                      | Object       | Process value return           |
| data.results\[x].lawsuitValue.currency             | String       | Currency (R$, U$, etc)         |
| data.results\[x].lawsuitValue.value                | Number       | Value                          |
| data.results\[x].subjects                          | String Array | Subjects list                  |
| data.results\[x].moves                             | Array        | Process' movement list         |
| data.results\[x].moves\[x].date                    | String       | Date of the movement           |
| data.results\[x].moves\[x].description             | String       | Description of the movement    |
| data.results\[x].actives                           | Array        | Assets list                    |
| data.results\[x].actives\[x].cnpj                  | String       | CNPJ                           |
| data.results\[x].actives\[x].cpf                   | String       | CPF                            |
| data.results\[x].actives\[x].name                  | String       | Name                           |
| data.results\[x].actives\[x].type                  | String       | Type                           |
| data.results\[x].actives\[x].lawyers               | Array        | List of Lawyers                |
| data.results\[x].actives\[x].lawyers\[x].oab       | String       | OAB Number                     |
| data.results\[x].actives\[x].lawyers\[x].name      | String       | Name                           |
| data.results\[x].actives\[x].lawyers\[x].cpf       | String       | CPF                            |
| data.results\[x].passives                          | Array        | List of liabilities            |
| data.results\[x].passives\[x].cnpj                 | String       | CNPJ                           |
| data.results\[x].passives\[x].cpf                  | String       | CPF                            |
| data.results\[x].passives\[x].name                 | String       | Name                           |
| data.results\[x].passives\[x].type                 | String       | Type                           |
| data.results\[x].passives\[x].lawyers              | Array        | List of Lawyers                |
| data.results\[x].passives\[x].lawyers\[x].oab      | String       | OAB Number                     |
| data.results\[x].passives\[x].lawyers\[x].name     | String       | Name                           |
| data.results\[x].passives\[x].lawyers\[x].cpf      | String       | CPF                            |
| data.results\[x].otherParties                      | Array        | Other parties list             |
| data.results\[x].otherParties\[x].cnpj             | String       | CNPJ                           |
| data.results\[x].otherParties\[x].cpf              | String       | CPF                            |
| data.results\[x].otherParties\[x].name             | String       | Name                           |
| data.results\[x].otherParties\[x].type             | String       | Type                           |
| data.results\[x].otherParties\[x].lawyers          | Array        | List of Lawyers                |
| data.results\[x].otherParties\[x].lawyers\[x].oab  | String       | OAB Number                     |
| data.results\[x].otherParties\[x].lawyers\[x].name | String       | Name                           |
| data.results\[x].otherParties\[x].lawyers\[x].cpf  | String       | CPF                            |
| data.results\[x].authorType                        | String       | Author Type                    |
| data.results\[x].authorParty                       | String       | Author Party                   |
| {% endtab %}                                       |              |                                |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "total": 7,
    "foundWords": [
      "XXXXX"
    ],
    "results": [
      {
        "id": "XXXXXXXXfdda79638XXXXX",
        "matchedWords": [
          "XXXXX"
        ],
        "criminalCategory": "XXXXXXXXXXXXXXXXXXXXXXXXXX",
        "lawsuitClass": "ACAO PENAL PROCEDIMENTO ORDINARIO",
        "distributionDate": "2017-11-24",
        "statusDate": "",
        "lawsuitDegree": "1",
        "physicalLocation": "",
        "oldLawsuitNumber": "",
        "judgingBody": "VARA UNICA",
        "lawsuitId": "XXXXXX",
        "isDigitalLawsuit": false,
        "lawBranch": "CIVEL / ADMINISTRATIVO",
        "segment": "JUSTICA ESTADUAL",
        "isJusticeSecret": false,
        "complementaryStatus": "EM ANDAMENTO",
        "observationStatus": "ATIVO",
        "court": "TJ PA",
        "state": "PA",
        "sourceUnit": "XXXXX",
        "subjects": ["XXXXX"],
        "moves": [
          {
            "date": "2018-06-19",
            "description": "NOTIFICACAO DE NAO CUMPRIMENTO DE ALVARA DE SOLTURA"
          },
          {
            "date": "2018-05-25",
            "description": "MANDADO DE INTIMACAO"
          },
          {
            "date": "2018-05-25",
            "description": "ALVARA DE SOLTURA"
          },
          {
            "date": "2018-05-23",
            "description": "A SECRETARIA DE ORIGEM"
          },
          {
            "date": "2018-05-23",
            "description": "DECISAO"
          }
        ],
        "actives": [
          {
            "cnpj": "XXXXXX",
            "name": "MINISTERIO PUBLICO ESTADUAL",
            "type": "PROMOTOR A"
          },
          {
            "cpf": "XXX.XXX.XXX-XX",
            "name": "XXXXXX",
            "type": "VITIMA"
          }
        ],
        "passives": [
          {
            "cpf": "XXX.XXX.XXX-XX",
            "name": "XXXXXX",
            "type": "REU"
          }
        ],
        "otherParties": [
          {
            "cpf": "XXX.XXX.XXX-XX",
            "name": "XXXXXX",
            "type": "AGRAVANTE"
          }
        ],
        "authorType": "REU",
        "authorParty": "PASSIVO"
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                     | Description                                                                                |
| ------------------------ | ------------------------------------------------------------------------------------------ |
| has\_processes\_keywords | The rule will become invalid if any of the configured keywords are found in the processes. |
| {% endtab %}             |                                                                                            |
| {% endtabs %}            |                                                                                            |

## KYC & Compliance (PF17)

This source includes information necessary to meet regulatory and legal requirements related to know-your-client processes. It provides data on politically exposed persons (PEPs), sanctions, and restrictions, both nationally and internationally. The dataset includes flags indicating whether an individual is a PEP or has any associated restrictions, along with historical records of such situations. If someone was a PEP in the past, the flag will not be marked, but the historical record will still be available for analysis.

list of databases where we consult:

* Acordos de Leniência (Controladoria-Geral da União)
* Banco Central - Inabilitados
* Canada Sanctions
* CEAF
* CEIS
* CEPIM
* CNEP
* COAF
* Conselho Nacional de Justiça
* CVM - Alerta Suspensão
* CVM - Penalidade Temporaria
* CVM - Termo Compromisso
* Embargos do Ibama
* EU
* FBI
* GOVUK
* IMPEDIDOS de Licitar e Contratar Banco
* INTERPOL
* Inidôneos TCU (Tribunal de Contas da União)
* MTE (Trabalho Escravo)
* OFAC
* Processo Administrativo Disciplinar (BSM Supervisão)
* SEAPE-DF
* Tribunal de Contas do Estado de São Paulo
* UNSC

**Section:** `pfKycCompliance`

**Required parameter:** `cpf`

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

| Attribute                                         | Type    | Description                                                                                         |
| ------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                                        | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                              | Object  | Return data                                                                                         |
| data.message                                      | String  | Description of the query status                                                                     |
| data.pepHistory                                   | Array   | List of objects with political exposure history                                                     |
| data.pepHistory\[x].level                         | String  | PEP (Politically Exposed Person) level                                                              |
| data.pepHistory\[x].jobTitle                      | String  | Position                                                                                            |
| data.pepHistory\[x].department                    | String  | Department                                                                                          |
| data.pepHistory\[x].motive                        | String  | Reason                                                                                              |
| data.pepHistory\[x].cpf                           | String  | CPF                                                                                                 |
| data.pepHistory\[x].source                        | String  | Source                                                                                              |
| data.pepHistory\[x].link                          | String  | Link                                                                                                |
| data.pepHistory\[x].startDate                     | String  | Date the person became an SPP                                                                       |
| data.pepHistory\[x].endDate                       | String  | Date the person ceased to be a SPP                                                                  |
| data.pepHistory\[x].creationDate                  | String  | Date created                                                                                        |
| data.pepHistory\[x].lastUpdateDate                | String  | Date last updated                                                                                   |
| data.sanctionsHistory                             | Array   | Object list with sanction and restriction history                                                   |
| data.sanctionsHistory\[x].source                  | String  | Sanction source                                                                                     |
| data.sanctionsHistory\[x].type                    | String  | Type of sanction                                                                                    |
| data.sanctionsHistory\[x].matchRate               | String  | Indication of how closely the name resembles                                                        |
| data.sanctionsHistory\[x].startDate               | String  | Start date                                                                                          |
| data.sanctionsHistory\[x].endDate                 | String  | End Date                                                                                            |
| data.sanctionsHistory\[x].originalName            | String  | Original name associated with the individual                                                        |
| data.sanctionsHistory\[x].sanctionName            | String  | Name registered on the international sanctions list                                                 |
| data.sanctionsHistory\[x].nationalities           | String  | Nationalities associated with the individual                                                        |
| data.sanctionsHistory\[x].image                   | String  | Individual's photo                                                                                  |
| data.sanctionsHistory\[x].height                  | String  | Height of Individual                                                                                |
| data.sanctionsHistory\[x].eyes                    | String  | Eye Color                                                                                           |
| data.sanctionsHistory\[x].hair                    | String  | Hair Color                                                                                          |
| data.sanctionsHistory\[x].distinguishingMarks     | String  | Characteristics                                                                                     |
| data.sanctionsHistory\[x].description             | String  | General Description of Sanction                                                                     |
| data.sanctionsHistory\[x].considerations          | String  | Sanction considerations                                                                             |
| data.isCurrentlyPEP                               | Boolean | Indicates whether the person is currently an EPP                                                    |
| data.isCurrentlySanctioned                        | Boolean | Indicates whether the person is currently under any sanctions                                       |
| data.last30DaysSanctions                          | Number  | Number of sanctions and restrictions encountered during the past 30 days                            |
| data.last90DaysSanctions                          | Number  | Number of sanctions and restrictions encountered during the past 90 days                            |
| data.last180DaysSanctions                         | Number  | Number of sanctions and restrictions encountered during the last 180 days                           |
| data.last365DaysSanctions                         | Number  | Number of sanctions and restrictions encountered during the last 365 days                           |
| data.lastYearPEPOccurence                         | Number  | Number of PEP registrations found in the last year                                                  |
| data.last3YearsPEPOccurence                       | Number  | Number of PEP registers found in the last 3 years                                                   |
| data.last5YearsPEPOccurence                       | Number  | Number of PEP registers found in the last 5 years                                                   |
| data.last5PlusYearsPEPOccurence                   | Number  | Number of PEP records found in the last 5 years or more                                             |
| data.firstPEPOccurenceDate                        | String  | Date of first PEP record found for the individual                                                   |
| data.lastPEPOccurenceDate                         | String  | Date of last record of PEP found for the individual                                                 |
| data.isCurrentlyElectoralDonor                    | Boolean | Indicates whether the person donates to political campaigns                                         |
| data.isHistoricalElectoralDonor                   | Boolean | Indicates whether the person has donated to political campaigns                                     |
| data.totalElectoralDonationsLastTwoElections      | Number  | Number of donations made in the last two election cycles                                            |
| data.totalElectoralDonations                      | Number  | Total amount of donations made                                                                      |
| data.totalElectoralDonationAmountLastTwoElections | Number  | Sum of the amount donated in the last two election cycles                                           |
| data.totalElectoralDonationAmount                 | Number  | Total amount donated                                                                                |
| {% endtab %}                                      |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "pepHistory": [
      {
        "level": "1",
        "jobTitle": "VEREADOR (SUPLENTE)",
        "department": "XX XXXX XX",
        "motive": "CITY EMPLOYEE",
        "source": "TSE",
        "startDate": "2017-01-01T00:00:00Z",
        "endDate": "2025-12-31T00:00:00Z",
        "creationDate": "2022-11-17T01:03:54Z",
        "lastUpdateDate": "2022-11-17T01:03:54Z"
      },
      {
        "level": "1",
        "jobTitle": "VEREADOR",
        "department": "CÂMARA MUNICIPAL DE XXX",
        "motive": "CITY EMPLOYEE",
        "source": "http://caf.io",
        "startDate": "2016-01-01T00:00:00+00:00",
        "endDate": "2025-01-01T00:00:00+00:00",
        "creationDate": "2019-01-21T12:11:02.589Z",
        "lastUpdateDate": "2020-06-18T15:16:09.235Z"
      }
    ],
    "sanctionsHistory": []
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule               | Description                                                   |
| ------------------ | ------------------------------------------------------------- |
| has\_no\_sanctions | Check that no sanctions have been found on restrictive lists. |
| has\_no\_pep       | Checks whether the CPF or CNPJ holder has political exposure. |
| {% endtab %}       |                                                               |

{% tab title="Beta Testing Data" %}

| CPF           | DESCRIPTION                   | StatusCode |
| ------------- | ----------------------------- | ---------- |
| 19321675019   | TIMEOUT                       | 50         |
| 98302514705   | INVALID                       | 02         |
| 23993556011   | UNDER 18 YEARS                | 02         |
| 59872132070   | UNDER 12 YEARS                | 02         |
| 40442820135   | REGULAR                       | 01         |
| 63017285995   | REGULAR                       | 01         |
| 91708635203   | REGULAR                       | 01         |
| 58136053391   | REGULAR                       | 01         |
| 20751061000   | WITH SANCTION                 | 01         |
| 72713429072   | WITH PEPS                     | 01         |
| 46227846023   | IS CURRENTLY ELECTORAL DONOR  | 01         |
| 46227846023   | IS HISTORICAL ELECTORAL DONOR | 01         |
| 30078021057   | WAS PREVIOUSLY SANCTIONED     | 01         |
| {% endtab %}  |                               |            |
| {% endtabs %} |                               |            |

## Related News (PF25)

Returns public news related to this person on the internet. Bearing in mind that as the search is textual and takes the name into account, additional care is required with homonyms.

**Section:** `pfMediaProfileAndExposure`

**Required parameter:** `cpf`

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

| Attribute                                               | Type   | Description                                                                                         |
| ------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                              | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                                    | Object | Return data                                                                                         |
| data.message                                            | String | Description with query status                                                                       |
| data.mediaExposureLevel                                 | String | Media exposure level                                                                                |
| data.celebrityLevel                                     | String | Celebrity level                                                                                     |
| data.unpopularityLevel                                  | String | Level of unpopularity                                                                               |
| data.newsItems                                          | Array  | List of news captured for the entity                                                                |
| data.newsItems\[x].title                                | String | Title of the news                                                                                   |
| data.newsItems\[x].sourceName                           | String | Name of the source responsible for the news                                                         |
| data.newsItems\[x].url                                  | String | URL of the news                                                                                     |
| data.newsItems\[x].sentimentAnalysis                    | Object | Sentiment analysis                                                                                  |
| data.newsItems\[x].sentimentAnalysis.label              | String | Label (positive, negative) attributed to the content in general                                     |
| data.newsItems\[x].sentimentAnalysis.peopleCount        | String | Number of people identified in the content                                                          |
| data.newsItems\[x].sentimentAnalysis.placesCount        | String | Number of places identified in the content                                                          |
| data.newsItems\[x].sentimentAnalysis.organizationsCount | String | Number of companies identified in the content                                                       |
| data.newsItems\[x].sentimentAnalysis.entities           | Object | Dictionary with entity names and labels of the content                                              |
| data.newsItems\[x].categories                           | Array  | List of categories of the news                                                                      |
| data.newsItems\[x].captureDate                          | String | Date in which the news was captured                                                                 |
| data.newsItems\[x].publicationDate                      | String | News publication date                                                                               |
| data.creationDate                                       | String | Creation date                                                                                       |
| data.lastUpdateDate                                     | String | Date of last update                                                                                 |
| {% endtab %}                                            |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "mediaExposureLevel": "G",
    "celebrityLevel": "G",
    "unpopularityLevel": "H",
    "newsItems": [
      {
        "title": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "sourceName": "XXXXXXXXXXX",
        "url": "https://caf.io",
        "sentimentAnalysis": {
          "label": "POSITIVE",
          "peopleCount": "13",
          "placesCount": "3",
          "organizationsCount": "4",
          "entities": {
            "PEOPLE": {
              "XXXX XXXXXXX": {
                "Label": "SLIGHTLY_POSITIVE"
              },
              "XXXX XXXXXXX": {
                "Label": "POSITIVE"
              }
            },
            "PLACES": {
              "BRASIL": {
                "Label": "SLIGHTLY_POSITIVE"
              },
              "AMERICA LATINA": {
                "Label": "SLIGHTLY_POSITIVE"
              }
            },
            "ORGANIZATIONS": {
              "XXXXXXX": {
                "Label": "POSITIVE"
              },
              "XXXXXXX": {
                "Label": "SLIGHTLY_POSITIVE"
              }
            }
          }
        },
        "categories": ["economy"],
        "captureDate": "2018-11-03T07:08:47.138Z",
        "publicationDate": "2014-10-02T08:02:00Z"
      }
    ],
    "creationDate": "2012-09-17T18:42:00Z",
    "lastUpdateDate": "2022-08-04T08:29:08.738Z"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                     | Description                                  |
| ------------------------ | -------------------------------------------- |
| has\_no\_media\_exposure | Checks if the CPF holder has media exposure. |
| {% endtab %}             |                                              |
| {% endtabs %}            |                                              |

## Procedural protocols at CADE

Check the CADE (Administrative Council for Economic Defense) website and check if the CPF consulted has linked procedural protocols.

**Section:** `pfProcessOnCade`

**Required parameter:** `cpf`

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

| Attribute                                         | Type   | Description                                                                                         |
| ------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                        | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                              | Object | Return data                                                                                         |
| data.message                                      | String | Description with query status                                                                       |
| data.proceduralProtocols                          | Array  | List of protocols found for the queried cpf                                                         |
| data.proceduralProtocols\[x].demandOrigin         | String | Query origin                                                                                        |
| data.proceduralProtocols\[x].protocolNumber       | String | Protocol number                                                                                     |
| data.proceduralProtocols\[x].source               | String | Generator Unit                                                                                      |
| data.proceduralProtocols\[x].emissionDate         | String | Date of issue                                                                                       |
| data.proceduralProtocols\[x].documentRequested    | String | Requested document                                                                                  |
| data.proceduralProtocols\[x].documentRequestedUrl | String | Url for the requested document                                                                      |
| {% endtab %}                                      |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso. Não foram encontrados protocolos vinculados ao documento informado."
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                   | Description                                                           |
| ---------------------- | --------------------------------------------------------------------- |
| has\_process\_on\_cade | The rule will be invalid if there are procedural protocols with CADE. |
| {% endtab %}           |                                                                       |
| {% endtabs %}          |                                                                       |

## OFAC Sanctions List

Search the Specially Designated Nationals and Blocked Persons (SDN) List of the Office of Foreign Assets Control (OFAC). The query is made by name and is an international query.

**Section:** `pfOfacSanctionsList`

**Required parameter:** `name`

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

| Attribute                                             | Type   | Description                                                                                         |
| ----------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                            | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                                  | Object | Return data                                                                                         |
| data.message                                          | String | Description with query status                                                                       |
| data.sanctionsList                                    | Array  | List of protocols found for the queried cpf                                                         |
| data.sanctionsList\[x].type                           | String | Type                                                                                                |
| data.sanctionsList\[x].firstName                      | String | First Name                                                                                          |
| data.sanctionsList\[x].lastName                       | String | Last Name                                                                                           |
| data.sanctionsList\[x].title                          | String | Title                                                                                               |
| data.sanctionsList\[x].dateOfBirth                    | String | Date of birth                                                                                       |
| data.sanctionsList\[x].placeOfBirth                   | String | Place of Birth                                                                                      |
| data.sanctionsList\[x].list                           | String | List to which the name belongs                                                                      |
| data.sanctionsList\[x].program                        | String | Program to which the name belongs                                                                   |
| data.sanctionsList\[x].remarks                        | String | Remarks                                                                                             |
| data.sanctionsList\[x].nationality                    | String | Nationality                                                                                         |
| data.sanctionsList\[x].citizenship                    | String | Citizenship                                                                                         |
| data.sanctionsList\[x].identifications                | Array  | List of known identifications of the name informed                                                  |
| data.sanctionsList\[x].identifications\[x].type       | String | Type of identification                                                                              |
| data.sanctionsList\[x].identifications\[x].number     | String | Document number                                                                                     |
| data.sanctionsList\[x].identifications\[x].country    | String | Document's country of origin                                                                        |
| data.sanctionsList\[x].identifications\[x].issueDate  | String | Document date of issue                                                                              |
| data.sanctionsList\[x].identifications\[x].expireDate | String | Document's expiration date                                                                          |
| data.sanctionsList\[x].aliases                        | Array  | List of surnames by which the name entered can also be identified                                   |
| data.sanctionsList\[x].aliases\[x].type               | String | Type of surname                                                                                     |
| data.sanctionsList\[x].aliases\[x].category           | String | Category of surname                                                                                 |
| data.sanctionsList\[x].aliases\[x].name               | String | First or last name (can be false document)                                                          |
| data.sanctionsList\[x].addresses                      | Array  | List of known addresses for the name entered                                                        |
| data.sanctionsList\[x].addresses\[x].address          | String | Address                                                                                             |
| data.sanctionsList\[x].addresses\[x].city             | String | City                                                                                                |
| data.sanctionsList\[x].addresses\[x].stateOrProvince  | String | State or province                                                                                   |
| data.sanctionsList\[x].addresses\[x].postalCode       | String | Postal code (ZIP)                                                                                   |
| data.sanctionsList\[x].addresses\[x].country          | String | Country                                                                                             |
| {% endtab %}                                          |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso. Nenhum resultado encontrado para esta busca."
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                          | Description                                                   |
| ----------------------------- | ------------------------------------------------------------- |
| is\_on\_ofac\_sanctions\_list | Checks if there are any records at OFAC for the name entered. |
| {% endtab %}                  |                                                               |
| {% endtabs %}                 |                                                               |

## Private restriction list (PF78)

Query the presence in the private list of restrictions.

**Section:** `pfDenyListPrivate`

**Required parameter:** `cpf`

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

| Attribute        | Type    | Description                                                                                         |
| ---------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode       | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data             | Object  | Return data                                                                                         |
| data.message     | String  | Descriptive with query status                                                                       |
| data.recordFound | Boolean | Indication of presence in the private restriction list                                              |
| data.cpf         | String  | CPF                                                                                                 |
| data.name        | String  | Name                                                                                                |
| {% endtab %}     |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "recordFound": false
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                | Description                                                             |
| ------------------- | ----------------------------------------------------------------------- |
| its\_on\_deny\_list | The rule will be invalid if the consulted CPF/CNPJ is on the Deny List. |
| {% endtab %}        |                                                                         |
| {% endtabs %}       |                                                                         |

## People Prevented from Betting - Sports Relationship (PF79)

Returns whether the CPF consulted is of a person prevented from betting or with a possible link to a person prevented from betting, providing the relationship level, team, year, activity and other information.

**Section:** `peopleSportRelated`

**Required parameter:** `cpf`

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

| Attribute                    | Type   | Description                                                                                         |
| ---------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                   | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                         | Object | Return data                                                                                         |
| data.message                 | String | Descriptive with query status                                                                       |
| data.sportsRelationshipType  | Array  | Indicates the type of relationships the person has with the sports                                  |
| data.sport                   | Array  | Indicates the type of sport the person found is related to                                          |
| data.documentType            | String | Type of document found                                                                              |
| data.name                    | String | Name of the person related to the sport                                                             |
| data.relationship            | String | Indicates the type of relationship in the case of third parties with the athlete                    |
| data.relationshipDocument    | String | CPF of the person related to the athlete                                                            |
| data.relationshipType        | Array  | Type of athlete's relationship with sport                                                           |
| data.relationshipName        | String | Name of the athlete related to the third person                                                     |
| data.sportsEntity            | String | Indicates the entity with which the athlete is related                                              |
| data.sportLastBondYear       | String | Year of last connection with sport                                                                  |
| data.updateDate              | String | Indicates the date on which the relationship record was updated                                     |
| data.tournaments             | Array  | Tournaments in which the athlete is involved                                                        |
| data.tournaments\[x].team    | String | Team name                                                                                           |
| data.tournaments\[x].year    | String | Tournament year                                                                                     |
| data.tournaments\[x].name    | String | Tournament name                                                                                     |
| data.sportRadarRef           | Array  | Name and IDs associated with the athlete's current club on Sportsradar                              |
| data.sportRadarRef\[x].name  | String | Team name                                                                                           |
| data.sportRadarRef\[x].srIds | Array  | Associated IDs                                                                                      |
| data.sportRadarRef\[x].name  | String | Year                                                                                                |
| {% endtab %}                 |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "code": "01",
  "data": {
    "message": "Consulta realizada com sucesso.",
    "sportsRelationshipType": ["jogador"],
    "sport": ["futebol"],
    "documentType": "cpf",
    "name": "Davi Ruinzinho Duarte",
    "relationship": "",
    "relationshipDocument": "",
    "relationshipType": [],
    "relationshipName": "",
    "sportsEntity": "Tabajara Futebol Clube",
    "sportLastBondYear": "2024",
    "updateDate": "2024-01-01",
    "tournaments": [
      {
        "team": "Tabajara Futebol Clube",
        "year": "2024",
        "name": "Campeonato Brasileiro Serie Z"
      }
    ],
    "sportRadarRef": [
      {
        "name": "Tabajara Futebol Clube",
        "srIds": [32769, 354040],
        "year": "2024"
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                       | Description                                         |
| -------------------------- | --------------------------------------------------- |
| is\_sport\_related\_person | Checks whether the individual is related to sports. |
| {% endtab %}               |                                                     |
| {% endtabs %}              |                                                     |

## People Prevented from Betting - Sports Relationship + Betting Houses + Ministry of Finance (PF80)

This source consolidates information from public sources related to sporting activities, betting houses and data from the Ministry of Finance. It checks whether the CPF entered is associated with other people, identifies the degree of relationship between them and provides additional relevant information.

**Section:** `peopleComplianceBet`

**Required parameter:** `cpf`

**Optional parameter:** `birthDate` *This information is required in some sources to complete the execution of minors*

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

| Attribute                                                                                                  | Type    | Description                                                                                                                                     |
| ---------------------------------------------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| statusCode                                                                                                 | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code))                                             |
| data                                                                                                       | Object  | Return data                                                                                                                                     |
| data.message                                                                                               | String  | Descriptive with query status                                                                                                                   |
| data.queryDate                                                                                             | String  | Date when the query was executed                                                                                                                |
| data.queryId                                                                                               | String  | Unique identifier of the query                                                                                                                  |
| data.results                                                                                               | Array   | Results of the query                                                                                                                            |
| data.results\[x].matchKeys                                                                                 | String  | Keys used for matching the query                                                                                                                |
| data.results\[x].onlineBettingCompliance                                                                   | Object  | Compliance data related to online betting                                                                                                       |
| data.results\[x].onlineBettingCompliance.sportsExposure                                                    | Object  | Exposure details related to sports                                                                                                              |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports                                             | Array   | List of sports related to the query                                                                                                             |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports\[x].sportName                               | String  | Name of the sport                                                                                                                               |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports\[x].region                                  | String  | Region related to the sport                                                                                                                     |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports\[x].totalRelatedEntities                    | Number  | Total number of related entities                                                                                                                |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports\[x].relatedEntities                         | Array   | List of entities related to the sport                                                                                                           |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports\[x].relatedEntities\[x].docNumber           | String  | Document number of the related entity                                                                                                           |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports\[x].relatedEntities\[x].docType             | String  | Document type of the related entity (CPF, RG)                                                                                                   |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports\[x].relatedEntities\[x].relationshipLevel   | String  | Level of relationship with the entity (INDIRECT 1ST LEVEL, INDIRECT 2ND LEVEL, BUSINESS PARTNER)                                                |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports\[x].relatedEntities\[x].institutionName     | String  | Name of the institution                                                                                                                         |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports\[x].relatedEntities\[x].institutionActivity | String  | Activity of the institution                                                                                                                     |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports\[x].relatedEntities\[x].role                | String  | Role of the entity (ASSISTANT COACH, COACH, COUNCIL MEMBER, DIRECTOR, EX-PRESIDENT, MANAGER, PLAYER, PRESIDENT, REFEREE, STAFF, VICE-PRESIDENT) |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports\[x].relatedEntities\[x].isActive            | Boolean | Whether the entity is active                                                                                                                    |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports\[x].relatedEntities\[x].startDate           | String  | Start date of the relationship                                                                                                                  |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports\[x].relatedEntities\[x].endDate             | String  | End date of the relationship                                                                                                                    |
| data.results\[x].onlineBettingCompliance.sportsExposure.sports\[x].relatedEntities\[x].source              | String  | Source of the relationship information                                                                                                          |
| data.results\[x].onlineBettingCompliance.forbiddenBet                                                      | Object  | Data related to forbidden betting                                                                                                               |
| data.results\[x].onlineBettingCompliance.forbiddenBet.name                                                 | String  | Name of the person                                                                                                                              |
| data.results\[x].onlineBettingCompliance.forbiddenBet.age                                                  | String  | Age of the person                                                                                                                               |
| data.results\[x].onlineBettingCompliance.forbiddenBet.isFromMinisterioDaFazenda                            | Boolean | Whether the person is from the Ministry of Finance                                                                                              |
| data.results\[x].onlineBettingCompliance.forbiddenBet.isBookmakerOwner                                     | Boolean | Whether the person is a bookmaker owner                                                                                                         |
| data.results\[x].onlineBettingCompliance.forbiddenBet.bookmakerOwnerMotives                                | Array   | Reasons for being a bookmaker owner                                                                                                             |
| data.results\[x].onlineBettingCompliance.forbiddenBet.bookmakerOwnerMotives\[x].source                     | String  | Source of the information                                                                                                                       |
| data.results\[x].onlineBettingCompliance.forbiddenBet.bookmakerOwnerMotives\[x].cnpj                       | String  | CNPJ of the related company                                                                                                                     |
| data.results\[x].onlineBettingCompliance.forbiddenBet.bookmakerOwnerMotives\[x].companyName                | String  | Name of the related company                                                                                                                     |
| data.results\[x].onlineBettingCompliance.forbiddenBet.bookmakerOwnerMotives\[x].economicActivityCodes      | String  | Economic activity codes of the company                                                                                                          |
| data.results\[x].onlineBettingCompliance.forbiddenBet.bookmakerOwnerMotives\[x].additionalDetails          | Object  | Additional details of the company                                                                                                               |
| data.results\[x].onlineBettingCompliance.forbiddenBet.ministryOfFazendaMotives                             | Object  | Details from the Ministry of Finance                                                                                                            |
| data.evidence                                                                                              | Array   | List of evidence related to the query                                                                                                           |
| data.evidence\[x].id                                                                                       | String  | Unique identifier of the evidence                                                                                                               |
| data.evidence\[x].source                                                                                   | String  | Source of the evidence                                                                                                                          |
| data.status                                                                                                | Object  | Status of the compliance checks                                                                                                                 |
| data.status.onlineBettingCompliance                                                                        | Array   | List of status messages for online betting compliance                                                                                           |
| data.status.onlineBettingCompliance\[x].code                                                               | Number  | Status code of the compliance check                                                                                                             |
| data.status.onlineBettingCompliance\[x].message                                                            | String  | Status message of the compliance check                                                                                                          |
| data.elapsedMilliseconds                                                                                   | Number  | Time taken to execute the query, in milliseconds                                                                                                |
| {% endtab %}                                                                                               |         |                                                                                                                                                 |

{% tab title="Example" %}

```json
{
  "data": {
    "message": "Consulta realizada com sucesso.",
    "results": [
      {
        "matchKeys": "doc{12345678910}",
        "onlineBettingCompliance": {
          "sportsExposure": {
            "sports": [
              {
                "sportName": "SOCCER",
                "region": "EUROPE",
                "totalRelatedEntities": 2,
                "relatedEntities": [
                  {
                    "relationshipLevel": "DIRECT",
                    "institutionName": "Barcelona",
                    "institutionActivity": "CLUBES SOCIAIS, ESPORTIVOS E SIMILARES",
                    "isActive": false,
                    "startDate": "2014-07-01T00:00:00Z",
                    "endDate": "2020-08-30T00:00:00Z",
                    "source": "BIDUEFA"
                  },
                  {
                    "relationshipLevel": "DIRECT",
                    "institutionName": "PSG",
                    "institutionActivity": "CLUBES SOCIAIS, ESPORTIVOS E SIMILARES",
                    "isActive": true,
                    "startDate": "2020-09-01T00:00:00Z",
                    "endDate": null,
                    "source": "BIDLFP"
                  }
                ]
              }
            ]
          },
          "forbiddenBet": {
            "name": "LIONEL SILVA",
            "age": "36",
            "isBookmakerOwner": false,
            "bookmakerOwnerMotives": [],
            "isFromMinisterioDaFazenda": false
          }
        }
      }
    ],
    "status": {
      "onlineBettingCompliance": [
        {
          "code": 0,
          "message": "OK"
        }
      ]
    },
    "elapsedMilliseconds": 123,
    "evidence": [],
    "message": "Consulta realizada com sucesso.",
    "queryDate": "2024-12-10T13:45:00.123Z",
    "queryId": "abcd1234-5678-90ef-ghij-klmnopqrstuv"
  }
}

```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                         | Description                                                                                                                                                                |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| is\_prevented\_from\_betting | Checks if the individual is legally prohibited from placing bets, that is, if they have any connection with betting houses, the sports sector, or the Ministry of Finance. |
| {% endtab %}                 |                                                                                                                                                                            |
| {% endtabs %}                |                                                                                                                                                                            |

## Lawsuits - NEW (PF52)

It returns all available court cases through an expanded query, guaranteeing maximum information coverage.

**Section:** `pfLegalRecordsExtended`

**Required parameter:** `cpf`

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

| Attribute                                                            | Type    | Description                   |
| -------------------------------------------------------------------- | ------- | ----------------------------- |
| statusCode                                                           | String  | Query status                  |
| data                                                                 | Object  | Return data                   |
| data.message                                                         | String  | Description with query status |
| data.lawsuits                                                        | Array   | Processes list returned       |
| data.lawsuits\[x].cnjCode                                            | String  | CNJ code                      |
| data.lawsuits\[x].secrecyLevel                                       | Number  | Secrecy level                 |
| data.lawsuits\[x].amount                                             | Number  | Lawsuit amount                |
| data.lawsuits\[x].area                                               | String  | Lawsuit area                  |
| data.lawsuits\[x].instance                                           | Number  | Lawsuit degree                |
| data.lawsuits\[x].phase                                              | String  | Lawsuit phase                 |
| data.lawsuits\[x].status                                             | String  | Lawsuit status                |
| data.lawsuits\[x].judge                                              | String  | Lawsuit judge                 |
| data.lawsuits\[x].name                                               | String  | Abbreviation of the parties   |
| data.lawsuits\[x].courtAcronym                                       | String  | Court acronym                 |
| data.lawsuits\[x].courtDistrict                                      | String  | Court district                |
| data.lawsuits\[x].state                                              | String  | Lawsuit state                 |
| data.lawsuits\[x].city                                               | String  | Lawsuit city                  |
| data.lawsuits\[x].distributionDate                                   | String  | Distribution date             |
| data.lawsuits\[x].justiceDescription                                 | String  | Justice description           |
| data.lawsuits\[x].isCriminal                                         | Boolean | Criminal lawsuit indication   |
| data.lawsuits\[x].mainPartySide                                      | String  | Side of the searched party    |
| data.lawsuits\[x].lastStep                                           | Object  | Lawsuit last step             |
| data.lawsuits\[x].lastStep.stepId                                    | String  | Last step identifier          |
| data.lawsuits\[x].lastStep.stepDate                                  | String  | Last step date                |
| data.lawsuits\[x].lastStep.content                                   | String  | Last step content             |
| data.lawsuits\[x].lastStep.stepType                                  | String  | Last step type                |
| data.lawsuits\[x].lastStep.stepsCount                                | Number  | Last step count               |
| data.lawsuits\[x].relatedLawsuits                                    | Array   | Related lawsuits              |
| data.lawsuits\[x].relatedLawsuits\[x].code                           | String  | Related lawsuits code         |
| data.lawsuits\[x].relatedLawsuits\[x].instance                       | String  | Related lawsuits instance     |
| data.lawsuits\[x].steps                                              | Array   | Steps                         |
| data.lawsuits\[x].steps\[x].stepDate                                 | String  | Step date                     |
| data.lawsuits\[x].steps\[x].stepType                                 | String  | Step type                     |
| data.lawsuits\[x].steps\[x].content                                  | String  | Step content                  |
| data.lawsuits\[x].steps\[x].private                                  | String  | Step private                  |
| data.lawsuits\[x].subjects                                           | Array   | Subjects                      |
| data.lawsuits\[x].subjects\[x].code                                  | String  | Subject code                  |
| data.lawsuits\[x].subjects\[x].subject                               | String  | Subject description           |
| data.lawsuits\[x].courts                                             | Array   | Courts                        |
| data.lawsuits\[x].courts\[x].code                                    | String  | Court code                    |
| data.lawsuits\[x].courts\[x].court                                   | String  | Court description             |
| data.lawsuits\[x].classifications                                    | Array   | Classifications               |
| data.lawsuits\[x].classifications\[x].code                           | String  | Classification code           |
| data.lawsuits\[x].classifications\[x].classification                 | String  | Classification description    |
| data.lawsuits\[x].parties                                            | Array   | Parties                       |
| data.lawsuits\[x].parties\[x].type                                   | String  | Party type                    |
| data.lawsuits\[x].parties\[x].side                                   | String  | Party side                    |
| data.lawsuits\[x].parties\[x].party                                  | String  | Party description             |
| data.lawsuits\[x].parties\[x].mainDocument                           | String  | Party main document           |
| data.lawsuits\[x].parties\[x].documents                              | Array   | Party Documents               |
| data.lawsuits\[x].parties\[x].documents\[x].documentType             | String  | Party document type           |
| data.lawsuits\[x].parties\[x].documents\[x].document                 | String  | Party document                |
| data.lawsuits\[x].parties\[x].lawyers                                | Array   | Party lawyers                 |
| data.lawsuits\[x].parties\[x].lawyers\[x].name                       | String  | Lawyer name                   |
| data.lawsuits\[x].parties\[x].lawyers\[x].mainDocument               | String  | Lawyers main document         |
| data.lawsuits\[x].parties\[x].lawyers\[x].documents                  | Array   | Lawyers documents             |
| data.lawsuits\[x].parties\[x].lawyers\[x].documents\[x].documentType | String  | Lawyers document type         |
| data.lawsuits\[x].parties\[x].lawyers\[x].documents\[x].document     | String  | Lawyers document              |
| {% endtab %}                                                         |         |                               |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "message": "Consulta realizada com sucesso",
  "data": {
    "lawsuits": [
      {
        "cnjCode": "099999-09.0990.9.99.9900",
        "secrecyLevel": 0,
        "amount": 1000,
        "area": "DIREITO PROCESSUAL CIVIL",
        "status": "Ativo",
        "phase": "Inicial",
        "judge": "",
        "instance": 1,
        "name": "JONH DOE X JANE DOE",
        "courtAcronym": "TJSP",
        "courtDistrict": "VARA DA COMARCA DE SÃO PAULO",
        "state": "sp",
        "city": "SÃO PAULO",
        "distributionDate": "2024-03-12T09:57:51.000Z",
        "justiceDescription": "JUSTIÇA ESTADUAL",
        "isCriminal": false,
        "mainPartySide": "ATIVO",
        "steps": [],
        "subjects": [
          {
            "code": "10671",
            "subject": "Obrigação de Fazer / Não Fazer"
          }
        ],
        "courts": [
          {
            "code": "5117",
            "court": "VARA DA COMARCA DE SÃO PAULO"
          }
        ],
        "classifications": [
          {
            "code": "436",
            "classification": ""
          }
        ],
        "parties": [
          {
            "type": "Réu",
            "side": "Passive",
            "party": "JANE DOE",
            "mainDocument": "99999999999",
            "documents": [
              {
                "documentType": "cpf",
                "document": "99999999999"
              }
            ],
            "lawyers": [
              {
                "name": "JOSE DOE",
                "mainDocument": "",
                "documents": []
              }
            ]
          },
          {
            "type": "Autor",
            "side": "Active",
            "party": "JOHN DOE",
            "mainDocument": "88888888888",
            "documents": [
              {
                "documentType": "cpf",
                "document": "88888888888"
              }
            ],
            "lawyers": [
              {
                "name": "JOÃO DOE",
                "mainDocument": "",
                "documents": []
              }
            ]
          },
          {
            "type": "Advogado",
            "side": "Passive",
            "party": "JOSE DOE",
            "mainDocument": "",
            "documents": [],
            "lawyers": []
          },
          {
            "type": "Advogado",
            "side": "Active",
            "party": "JOÃO DOE",
            "mainDocument": "",
            "documents": [],
            "lawyers": []
          }
        ]
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                             | Description                                                          |
| ------------------------------------------------ | -------------------------------------------------------------------- |
| has\_no\_processes                               | Checks if the CPF/CNPJ is linked to processes.                       |
| has\_no\_processes\_active\_party                | Check if the CPF is linked to processes as an active party.          |
| has\_no\_processes\_passive\_party               | Check if the CPF is linked to processes as a passive party.          |
| has\_no\_processes\_other\_party                 | Check if the CPF is linked to processes as other parties.            |
| has\_no\_defendant\_processes                    | Checks if the CPF/CNPJ is linked to proceedings as a defendant.      |
| has\_no\_criminal\_processes                     | Checks if the CPF/CNPJ is linked to criminal proceedings.            |
| has\_author\_type\_null\_in\_criminal\_processes | Checks if there is an empty 'authorType' field in any criminal case. |
| {% endtab %}                                     |                                                                      |
| {% endtabs %}                                    |                                                                      |

## Lawsuits with Keywords - NEW (PF53)

It returns all available court cases through an expanded query, guaranteeing maximum information coverage.

**Section:** `pfLegalRecordsExtendedKeywords`

**Required parameter:** `cpf`

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

| Attribute                                                            | Type    | Description                    |
| -------------------------------------------------------------------- | ------- | ------------------------------ |
| statusCode                                                           | String  | Query status                   |
| data                                                                 | Object  | Return data                    |
| data.message                                                         | String  | Description with query status  |
| data.foundKeywords                                                   | Array   | Keywords found                 |
| data.lawsuits                                                        | Array   | Processes list returned        |
| data.lawsuits\[x].matchedWords                                       | Array   | Keywords found in this lawsuit |
| data.lawsuits\[x].cnjCode                                            | String  | CNJ code                       |
| data.lawsuits\[x].secrecyLevel                                       | Number  | Secrecy level                  |
| data.lawsuits\[x].amount                                             | Number  | Lawsuit amount                 |
| data.lawsuits\[x].area                                               | String  | Lawsuit area                   |
| data.lawsuits\[x].instance                                           | Number  | Lawsuit degree                 |
| data.lawsuits\[x].phase                                              | String  | Lawsuit phase                  |
| data.lawsuits\[x].status                                             | String  | Lawsuit status                 |
| data.lawsuits\[x].judge                                              | String  | Lawsuit judge                  |
| data.lawsuits\[x].name                                               | String  | Abbreviation of the parties    |
| data.lawsuits\[x].courtAcronym                                       | String  | Court acronym                  |
| data.lawsuits\[x].courtDistrict                                      | String  | Court district                 |
| data.lawsuits\[x].state                                              | String  | Lawsuit state                  |
| data.lawsuits\[x].city                                               | String  | Lawsuit city                   |
| data.lawsuits\[x].distributionDate                                   | String  | Distribution date              |
| data.lawsuits\[x].justiceDescription                                 | String  | Justice description            |
| data.lawsuits\[x].isCriminal                                         | Boolean | Criminal lawsuit indication    |
| data.lawsuits\[x].mainPartySide                                      | String  | Side of the searched party     |
| data.lawsuits\[x].lastStep                                           | Object  | Lawsuit last step              |
| data.lawsuits\[x].lastStep.stepId                                    | String  | Last step identifier           |
| data.lawsuits\[x].lastStep.stepDate                                  | String  | Last step date                 |
| data.lawsuits\[x].lastStep.content                                   | String  | Last step content              |
| data.lawsuits\[x].lastStep.stepType                                  | String  | Last step type                 |
| data.lawsuits\[x].lastStep.stepsCount                                | Number  | Last step count                |
| data.lawsuits\[x].relatedLawsuits                                    | Array   | Related lawsuits               |
| data.lawsuits\[x].relatedLawsuits\[x].code                           | String  | Related lawsuits code          |
| data.lawsuits\[x].relatedLawsuits\[x].instance                       | String  | Related lawsuits instance      |
| data.lawsuits\[x].steps                                              | Array   | Steps                          |
| data.lawsuits\[x].steps\[x].stepDate                                 | String  | Step date                      |
| data.lawsuits\[x].steps\[x].stepType                                 | String  | Step type                      |
| data.lawsuits\[x].steps\[x].content                                  | String  | Step content                   |
| data.lawsuits\[x].steps\[x].private                                  | String  | Step private                   |
| data.lawsuits\[x].subjects                                           | Array   | Subjects                       |
| data.lawsuits\[x].subjects\[x].code                                  | String  | Subject code                   |
| data.lawsuits\[x].subjects\[x].subject                               | String  | Subject description            |
| data.lawsuits\[x].courts                                             | Array   | Courts                         |
| data.lawsuits\[x].courts\[x].code                                    | String  | Court code                     |
| data.lawsuits\[x].courts\[x].court                                   | String  | Court description              |
| data.lawsuits\[x].classifications                                    | Array   | Classifications                |
| data.lawsuits\[x].classifications\[x].code                           | String  | Classification code            |
| data.lawsuits\[x].classifications\[x].classification                 | String  | Classification description     |
| data.lawsuits\[x].parties                                            | Array   | Parties                        |
| data.lawsuits\[x].parties\[x].type                                   | String  | Party type                     |
| data.lawsuits\[x].parties\[x].side                                   | String  | Party side                     |
| data.lawsuits\[x].parties\[x].party                                  | String  | Party description              |
| data.lawsuits\[x].parties\[x].mainDocument                           | String  | Party main document            |
| data.lawsuits\[x].parties\[x].documents                              | Array   | Party Documents                |
| data.lawsuits\[x].parties\[x].documents\[x].documentType             | String  | Party document type            |
| data.lawsuits\[x].parties\[x].documents\[x].document                 | String  | Party document                 |
| data.lawsuits\[x].parties\[x].lawyers                                | Array   | Party lawyers                  |
| data.lawsuits\[x].parties\[x].lawyers\[x].name                       | String  | Lawyer name                    |
| data.lawsuits\[x].parties\[x].lawyers\[x].mainDocument               | String  | Lawyers main document          |
| data.lawsuits\[x].parties\[x].lawyers\[x].documents                  | Array   | Lawyers documents              |
| data.lawsuits\[x].parties\[x].lawyers\[x].documents\[x].documentType | String  | Lawyers document type          |
| data.lawsuits\[x].parties\[x].lawyers\[x].documents\[x].document     | String  | Lawyers document               |
| {% endtab %}                                                         |         |                                |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "message": "Consulta realizada com sucesso",
  "data": {
    "foundKeywords": [
      "Indenização por dano moral"
    ],
    "lawsuits": [
      {
        "type": "lawsuit",
        "matchedWords": [
          "Indenização por dano moral"
        ],
        "cnjCode": "099999-09.0990.9.99.9900",
        "secrecyLevel": 0,
        "amount": 1000,
        "area": "DIREITO PROCESSUAL CIVIL",
        "status": "Ativo",
        "phase": "Inicial",
        "judge": "",
        "instance": 1,
        "name": "JONH DOE X JANE DOE",
        "courtAcronym": "TJSP",
        "courtDistrict": "VARA DA COMARCA DE SÃO PAULO",
        "state": "sp",
        "city": "SÃO PAULO",
        "distributionDate": "2024-03-12T09:57:51.000Z",
        "justiceDescription": "JUSTIÇA ESTADUAL",
        "isCriminal": false,
        "mainPartySide": "ATIVO",
        "steps": [],
        "subjects": [
          {
            "code": "10671",
            "subject": "Obrigação de Fazer / Não Fazer"
          },
          {
            "code": "10001",
            "subject": "Indenização por dano moral"
          }
        ],
        "courts": [
          {
            "code": "5117",
            "court": "VARA DA COMARCA DE SÃO PAULO"
          }
        ],
        "classifications": [
          {
            "code": "436",
            "classification": ""
          }
        ],
        "parties": [
          {
            "type": "Réu",
            "side": "Passive",
            "party": "JANE DOE",
            "mainDocument": "99999999999",
            "documents": [
              {
                "documentType": "cpf",
                "document": "99999999999"
              }
            ],
            "lawyers": [
              {
                "name": "JOSE DOE",
                "mainDocument": "",
                "documents": []
              }
            ]
          },
          {
            "type": "Autor",
            "side": "Active",
            "party": "JOHN DOE",
            "mainDocument": "88888888888",
            "documents": [
              {
                "documentType": "cpf",
                "document": "88888888888"
              }
            ],
            "lawyers": [
              {
                "name": "JOÃO DOE",
                "mainDocument": "",
                "documents": []
              }
            ]
          },
          {
            "type": "Advogado",
            "side": "Passive",
            "party": "JOSE DOE",
            "mainDocument": "",
            "documents": [],
            "lawyers": []
          },
          {
            "type": "Advogado",
            "side": "Active",
            "party": "JOÃO DOE",
            "mainDocument": "",
            "documents": [],
            "lawyers": []
          }
        ]
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                     | Description                                                                                |
| ------------------------ | ------------------------------------------------------------------------------------------ |
| has\_processes\_keywords | The rule will become invalid if any of the configured keywords are found in the processes. |
| {% endtab %}             |                                                                                            |
| {% endtabs %}            |                                                                                            |


# Documents

## VerifAI Docs - File manipulation detection - NEW (PF99)

Returns information about digital manipulations in files, such as social contracts, invoices, and receipts, by analyzing their metadata. For greater accuracy, we recommend you send files in PDF format. Currently, this functionality is available in English and Portuguese, with Spanish as the next language to be added.

**Section**: `pfVerifaiDocs`

**Required files:** `Any file in .pdf, .jpg, or .jpeg format`

**Optional parameter:** `CPF`

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

| Attribute                            | Type             | Description                                                                                                                                                |
| ------------------------------------ | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| statusCode                           | String           | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code))                                                        |
| message                              | String           | Query result descriptive message                                                                                                                           |
| data                                 | Array            | A list with the analysis results for each submitted document                                                                                               |
| data\[x].status                      | String           | Status of the analysis                                                                                                                                     |
| data\[x].analysisTime                | String           | Timestamp of analysis                                                                                                                                      |
| data\[x].queryId                     | String           | Internal ID of the analysis                                                                                                                                |
| data\[x].sha256                      | String           | Sha256 of the input file                                                                                                                                   |
| data\[x].fileType                    | String           | Type of analyzed document                                                                                                                                  |
| data\[x].mimeType                    | String           | Mime type of the input document : `application/pdf`, `image/jpeg`                                                                                          |
| data\[x].score                       | String           | Fraud score produced by the document analysis: `NORMAL`, `TRUSTED`, `WARNING`, `HIGH_RISK`                                                                 |
| data\[x].decision                    | String           | Level of risk associated with the analyzed document: `LOW_RISK`, `MEDIUM_RISK`, `HIGH_RISK`                                                                |
| data\[x].numPages                    | String           | Number of pages in submitted document                                                                                                                      |
| data\[x].fileName                    | String           | File name                                                                                                                                                  |
| data\[x].submissionId                | String           | Document unique identifier                                                                                                                                 |
| data\[x].reason                      | Object           | Details object describing the reason for the decision                                                                                                      |
| data\[x].reason.value                | String           | Reason label                                                                                                                                               |
| data\[x].reason.label                | String           | Reason description                                                                                                                                         |
| data\[x].sampleMetadata              | Object           | Metadata of an analyzed document                                                                                                                           |
| data\[x].sampleMetadata.producer     | String           | Document produce                                                                                                                                           |
| data\[x].sampleMetadata.creator      | String           | Document creator                                                                                                                                           |
| data\[x].sampleMetadata.creationDate | String           | Document creation date                                                                                                                                     |
| data\[x].sampleMetadata.modDate      | String           | Document modification date                                                                                                                                 |
| data\[x].sampleMetadata.author       | String           | Document author                                                                                                                                            |
| data\[x].sampleMetadata.title        | String           | Document title                                                                                                                                             |
| data\[x].sampleMetadata.keywords     | String           | Document keywords                                                                                                                                          |
| data\[x].sampleMetadata.subject      | String           | Document subject                                                                                                                                           |
| data\[x].indicators                  | Array of objects | Detailed information about the specific results of the analysis. This field contains detailed observations that the system was able to make about the file |
| data\[x].indicators\[x].type         | String           | Type of a quality indicator: `RISK`, `TRUST`, `INFO`                                                                                                       |
| data\[x].indicators\[x].category     | String           | Category of indicator                                                                                                                                      |
| data\[x].indicators\[x].title        | String           | Indicator title                                                                                                                                            |
| data\[x].indicators\[x].description  | String           | Description of the indicator                                                                                                                               |
| data\[x].indicators\[x].origin       | String           | Indicator origin: `fraud`, `quality`                                                                                                                       |
| data\[x].documentClass               | Object           | The type of file submitted for analysis                                                                                                                    |
| data\[x].documentClass.id            | String           | Document type ID                                                                                                                                           |
| data\[x].documentClass.type          | String           | Document type                                                                                                                                              |
| data\[x].documentClass.detailedType  | String           | Document type detailed                                                                                                                                     |
| {% endtab %}                         |                  |                                                                                                                                                            |

{% tab title="Example" %}

```json
{
  "pfVerifaiDocs": {
    "statusCode": "01",
    "data": [
      {
        "status": "SUCCESS",
        "analysisTime": "2025-07-01T19:39:20.605088Z",
        "deploymentVersion": "4f59fea5",
        "queryId": "3512299f-8385-4152-93c2-eaa2dea85983-6864382d16941a000265d233-conta-internet-20-05",
        "fileType": "pdf",
        "mimeType": "application/pdf",
        "sha256": "63d5d349a6610d048c05a620aa3f7afbda3be2686c6791418ac8c7d2b099db71",
        "score": "HIGH_RISK",
        "sampleMetadata": {
          "producer": "Producer 1.91a ",
          "creator": "Dox PDF",
          "creationDate": "2024-12-20T09:41:35+01:00",
          "modDate": "2025-01-09T17:48:56+01:00",
          "author": "Document Designer Development Group",
          "title": "Vivo conta 20/05/2025",
          "keywords": "Ver 6.0",
          "subject": "Internet"
        },
        "indicators": [
          {
            "type": "RISK",
            "category": "document_structure",
            "title": "Known document with unexpected patterns",
            "description": "We’ve seen many documents like this from Telefonica Brasil S.A., and this one stands out - in the wrong way. Its structure, layout, and other elements don’t follow the expected pattern. These clues strongly suggest the document was modified, recreated, or produced using different software.",
            "origin": "fraud"
          },
          {
            "type": "RISK",
            "category": "modifications",
            "title": "Content was modified",
            "description": "This document was produced in several versions. This version of the document differs from the original.",
            "origin": "fraud"
          },
          {
            "type": "RISK",
            "category": "modifications",
            "title": "Edited using editor",
            "description": "This document contains tags used by PDF editors, which indicate modifications of the document.",
            "origin": "fraud"
          },
          {
            "type": "TRUST",
            "category": "visual_appearance",
            "title": "Telefonica Brasil S.A. logo",
            "description": "This document contains a logo commonly associated with Telefonica Brasil S.A., suggesting it was issued by that utility.",
            "origin": "fraud"
          },
          {
            "type": "RISK",
            "category": "metadata_modifications",
            "title": "Evidence of modification based on document metadata",
            "description": "Time of creation is 2024-12-20T08:41:35+00:00 but the time of modification is 2025-01-09T16:48:56+00:00. This may indicate that the document was updated or modified. The time span between creation and modification is 20 days, 8:07:21.",
            "origin": "fraud"
          },
          {
            "type": "RISK",
            "category": "modifications",
            "title": "Anomalous fonts",
            "description": "Some of the fonts in use here are not typically used by the issuer in this kind of document.",
            "origin": "fraud"
          },
          {
            "type": "RISK",
            "category": "anomalous_metadata",
            "title": "Document has anomalous metadata",
            "description": "The metadata (creator, producer, etc.) differs from the typical document from the same issuer. ",
            "origin": "fraud"
          }
        ],
        "documentClass": {
          "id": "utility_bill_vivo",
          "type": "utility_bill",
          "documentClassType": "UtilityBillDocumentClass",
          "detailedType": "internet_mobile_television"
        },
        "numPages": 3,
        "fileName": "conta-internet-20-05.pdf",
        "submissionId": "bdd50bc4-fa5c-46ba-a9d6-5c715af98daa",
        "decision": "HIGH_RISK",
        "reason": {
            "value": "DIGITAL_MODIFICATION_HIGH_CONFIDENCE",
            "label": "Document contains traces of digital modification, likely with fraudulent intent"
        }
      },
      {
          "status": "SUCCESS",
          "analysisTime": "2025-07-02T13:11:30.099104Z",
          "deploymentVersion": "4f59fea5",
          "queryId": "49dc9bda-fa86-41c0-9c9c-8a8cff5e6ecd-68652fdfdf165d00021c9f44-comprovante-pix",
          "fileType": "pdf",
          "mimeType": "application/pdf",
          "sha256": "55662b513518cf0bedf695febedbfd489924b1ec92de3aabfdc6dcf97e2822dc",
          "score": "NORMAL",
          "sampleMetadata": {
            "producer": "mPDF 7.1.9",
            "creator": null,
            "creationDate": "2019-11-29T06:33:40+03:00",
            "modDate": "2019-11-29T06:33:40+03:00",
            "author": null,
            "title": "Tiny",
            "keywords": null,
            "subject": null
          },
          "indicators": [
            {
              "indicatorId": "is_pdf_unmodified_per_metadata",
              "type": "TRUST",
              "category": "authenticity",
              "title": "No modification in document metadata",
              "description": "Timestamps in this document's metadata do not indicate that the file was incrementally updated or modified.",
              "origin": "fraud"
            },
            {
              "indicatorId": "has_mpdf_metadata",
              "type": "INFO",
              "category": "known_creator",
              "title": "Saved in mPDF",
              "description": "The document was processed and saved in mPDF - software library (PHP language) for generating PDF files from HTML documents.",
              "origin": "fraud"
            }
          ],
          "documentClass": {
            "id": "unknown",
            "type": "unknown",
            "documentClassType": "DocumentClass"
          },
          "numPages": 1,
          "fileName": "comprovante-pix.pdf",
          "submissionId": "a441c5d6-b2d2-4fef-8aaa-799ae7308f4b",
          "decision": "LOW_RISK",
          "reason": {
              "value": "NO_DIGITAL_MODIFICATION",
              "label": "Document shows no signs of digital modification"
          }
        }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                  | Description                                                                         |
| ------------------------------------- | ----------------------------------------------------------------------------------- |
| verifai\_docs\_available\_analysis    | Checks if analysis results are available for the submitted documents.               |
| verifai\_docs\_analysis\_medium\_risk | Checks whether the analysis result of any submitted document indicates medium risk. |
| verifai\_docs\_analysis\_high\_risk   | Checks whether the analysis result of any submitted document indicates high risk.   |
| {% endtab %}                          |                                                                                     |
| {% endtabs %}                         |                                                                                     |


# Adverse Media

The Adverse Media datasource is a data source containing information about events or activities adverse to individuals, organizations, companies, or governmental entities. These data sources include news, media reports, legal publications, investigative journalism, and other types of content addressing issues such as crimes, scandals, lawsuits, corruption, human rights violations, sanctions, among others. Adverse Media datasources are used in risk analysis processes, background investigations, due diligence, and compliance to assist in assessing potential risks associated with individuals or entities in commercial transactions, investments, hiring, or other interactions.

**Section**: `kycAdverseMediaLatamCountries or kycAdverseMediaEmergingCountries`

Each Adverse Media query can have two sections for each category, one Latam and one Emerging Countries. These categories are defined based on the country where you (Certta Client) are legally based.

**Latam:** We use the term "Latam," but it may not necessarily be from Latin America; we have included other countries in the list, but we continue to use the same service name, check the list below with the names of all countries included.

South Africa, Angola, Algeria, Benin, Botswana, Burkina Faso, Burundi, Cape Verde, Chad, Comoros, Democratic Republic of the Congo, Republic of the Congo, Ivory Coast, Djibouti, Egypt, Eritrea, Ethiopia, Gabon, Gambia, Ghana, Guinea, Equatorial Guinea, Lesotho, Liberia, Libya, Madagascar, Malawi, Mali, Morocco, Mauritius, Mauritania, Mayotte, Mozambique, Namibia, Niger, Nigeria, Kenya, Cameroon, Reunion, Rwanda, Western Sahara, Saint Helena, Sao Tome and Principe, Senegal, Sierra Leone, Seychelles, Somalia, Eswatini, Sudan, South Sudan, Tanzania, Togo, Tunisia, Uganda, Zambia, Zimbabwe, Central African Republic, and Guinea-Bissau.

**Section for customers who belong to the “Latam” group of countries:**

**- kycAdverseMediaLatamCountries**

**Emerging countries:** We use the term "Emerging countries," but it may not necessarily consist only of Emerging Countries; we have included other countries in the list, but we continue to use the same service name.

Anguilla, Antigua and Barbuda, Aruba, Bahamas, Barbados, Belize, Bermuda, Canada, Costa Rica, Cuba, Curaçao, Dominica, El Salvador, United States, Grenada, Greenland, Guadeloupe, Guatemala, Haiti, Honduras, Cayman Islands, United States Distant Islands, Turks and Caicos Islands, British Virgin Islands, U.S. Virgin Islands, Jamaica, Martinique, Mexico, Montserrat, Nicaragua, Caribbean Netherlands, Panama, Puerto Rico, Dominican Republic, Saint Pierre and Miquelon, Saint Lucia, Saint Barthélemy, Saint Kitts and Nevis, Saint Martin, Saint Vincent and the Grenadines, Saint Martin, Trinidad and Tobago, Argentina, Bolivia, Brazil, Chile, Colombia, Ecuador, Guyana, French Guiana, Falkland Islands, Paraguay, Peru, Suriname, Uruguay, Venezuela, Antarctica, South Georgia and the South Sandwich Islands, Bouvet Island, Heard Island and McDonald Islands, French Southern and Antarctic Lands, Afghanistan, Saudi Arabia, Armenia, Azerbaijan, Bahrain, Bangladesh, Brunei, Bhutan, Cambodia, Qatar, Kazakhstan, China, Singapore, North Korea, South Korea, United Arab Emirates, Philippines, Georgia, Hong Kong, Yemen, Christmas Island, India, Indonesia, Iran, Iraq, Israel, Japan, Jordan, Kuwait, Laos, Lebanon, Macau, Malaysia, Maldives, Myanmar (Burma), Mongolia, Nepal, Oman, Pakistan, Kyrgyzstan, Syria, Sri Lanka, Thailand, Taiwan, Tajikistan, British Indian Ocean Territory, Palestinian Territories, Turkmenistan, Uzbekistan, Vietnam, East Timor, Russia, Turkey, Bosnia and Herzegovina, Albania, Germany, Andorra, Austria, Belgium, Belarus, Bulgaria, Cyprus, Holy See, Croatia, Denmark, Slovakia, Slovenia, Spain, Estonia, Finland, France, Gibraltar, Greece, Guernsey, Netherlands, Hungary, Isle of Man, Åland Islands, Faroe Islands, Ireland, Iceland, Italy, Jersey, Latvia, Liechtenstein, Lithuania, Luxembourg, North Macedonia, Malta, Moldova, Monaco, Montenegro, Norway, Poland, Portugal, United Kingdom, Czech Republic, Romania, San Marino, Serbia, Sweden, Switzerland, Svalbard and Jan Mayen, Ukraine, Kosovo, Australia, Fiji, Guam, Norfolk Island, Cocos (Keeling) Islands, Cook Islands, Northern Mariana Islands, Marshall Islands, Pitcairn Islands, Solomon Islands, Micronesia, Nauru, Niue, New Caledonia, New Zealand, Palau, French Polynesia, Kiribati, Samoa, American Samoa, Tokelau, Tonga, Tuvalu, Vanuatu, Wallis and Futuna, Papua New Guinea.

**Section for customers who belong to the “Emerging Countries” group of countries:**

**- kycAdverseMediaEmergingCountries**

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

| Attribute    | Type   | Description                      | Mandatory |
| ------------ | ------ | -------------------------------- | --------- |
| name         | string | Full name of the individual.     | Yes       |
| birthDate    | string | Date of birth of the individual. | Yes       |
| countryCode  | string | Country code of the individual.  | Yes       |
| {% endtab %} |        |                                  |           |

{% tab title="Example body" %}

```javascript
body: JSON.stringify({
  workflowId: "6644843a90k8762k25929376",
  parameters: {
    name: "Vladimir Vladimirovitch Putin",
    birthDate: "07/10/1952",
    countryCode: "RU",
  },
});
```

{% endtab %}
{% endtabs %}

**Note:** Some fields returned by this API are optional and their presence cannot be guaranteed.

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

| Attribute                                                        | Type    | Description                                                                                                                                                                              |
| ---------------------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| data                                                             | object  | Object containing the main data.                                                                                                                                                         |
| data.riskLevel                                                   | string  | Risk level associated with the entity.                                                                                                                                                   |
| data.clientRef                                                   | string  | Client reference related to the hit.                                                                                                                                                     |
| data.blacklistHits                                               | array   | List of hits found in blacklist searches.                                                                                                                                                |
| data.hits                                                        | array   | List of matches found.                                                                                                                                                                   |
| data.hits\[].doc                                                 | object  | Object containing information associated with the hit.                                                                                                                                   |
| data.hits\[].doc.types                                           | array   | List of news types related to the hit.                                                                                                                                                   |
| data.hits\[].doc.associates                                      | array   | List of associates found.                                                                                                                                                                |
| data.hits\[].doc.associates\[].name                              | string  | Name of the associated entity.                                                                                                                                                           |
| data.hits\[].doc.associates\[].association                       | string  | Type of association with the entity (spouse, brother, etc.).                                                                                                                             |
| data.hits\[].doc.sources                                         | array   | List of information sources, which can be state or private organizations.                                                                                                                |
| data.hits\[].doc.keywords                                        | array   | List of keywords related to the hit.                                                                                                                                                     |
| data.hits\[].doc.sourceNotes                                     | object  | Additional notes from sources related to the hit.                                                                                                                                        |
| data.hits\[].doc.sourceNotes.$type                               | object  | This type need to be replaced by any source of information (companyAm, complyAdvantageAdverseMedia, etc.).                                                                               |
| data.hits\[].doc.sourceNotes.$type.name                          | string  | Name of the organization or position.                                                                                                                                                    |
| data.hits\[].doc.sourceNotes.$type.amlTypes                      | array   | This list contains types of adverse media provided by the source (adverse-media-terrorism, adverse-media-v2-cybercrime, adverse-media-fraud, etc.).                                      |
| data.hits\[].doc.sourceNotes.$type.countryCodes                  | array   | Countries related to information.                                                                                                                                                        |
| data.hits\[].doc.sourceNotes.$type.url                           | string  | Link to the source of information.                                                                                                                                                       |
| data.hits\[].doc.entityType                                      | string  | Type of entity (person, company, etc.).                                                                                                                                                  |
| data.hits\[].doc.media                                           | array   | List of media related to the hit. (news, websites, etc.).                                                                                                                                |
| data.hits\[].doc.media\[].date                                   | string  | Timestamp indicating when the news was published.                                                                                                                                        |
| data.hits\[].doc.media\[].title                                  | string  | News title.                                                                                                                                                                              |
| data.hits\[].doc.media\[].snippet                                | string  | Text with a preview of the news subject.                                                                                                                                                 |
| data.hits\[].doc.media\[].url                                    | string  | Link to full news.                                                                                                                                                                       |
| data.hits\[].doc.birthDate                                       | array   | List of possible birth dates related to the hit.                                                                                                                                         |
| data.hits\[].doc.createdAt                                       | string  | Timestamp indicating when the hit was created.                                                                                                                                           |
| data.hits\[].doc.countryCodes                                    | array   | Related countries of hit.                                                                                                                                                                |
| data.hits\[].doc.assets                                          | array   | List of files related to the entity.                                                                                                                                                     |
| data.hits\[].doc.assets\[].publicUrl                             | string  | Public link of file.                                                                                                                                                                     |
| data.hits\[].doc.assets\[].source                                | string  | Source of information.                                                                                                                                                                   |
| data.hits\[].doc.assets\[].type                                  | string  | Type of file (picture, etc.).                                                                                                                                                            |
| data.hits\[].doc.assets\[].url                                   | string  | File link.                                                                                                                                                                               |
| data.hits\[].doc.aka                                             | array   | List of all aka related to the entity.                                                                                                                                                   |
| data.hits\[].doc.aka\[].name                                     | string  | Aka name.                                                                                                                                                                                |
| data.hits\[].doc.name                                            | string  | Entity name of hit.                                                                                                                                                                      |
| data.hits\[].doc.deathDate                                       | string  | List of death dates related to the entity.                                                                                                                                               |
| data.hits\[].doc.id                                              | string  | Unique identifier of the main record.                                                                                                                                                    |
| data.hits\[].doc.fields                                          | object  | This field contains all detailed information about each type of information related to the hit.                                                                                          |
| data.hits\[].doc.fields.$type                                    | object  | This type needs to be replaced by a category, which will be named after some type of news reported in the types array, such as "adverseMediaV2Terrorism". This type can also be "other". |
| data.hits\[].doc.fields.$type.$information                       | array   | This information needs to be replaced with any name that references the origin of this information (complyadvantageAdverseMedia, companyAm, etc.).                                       |
| data.hits\[].doc.fields.$type.$information\[].name               | string  | Indicates the type of information (Country, date of birth, other info, etc.).                                                                                                            |
| data.hits\[].doc.fields.$type.$information\[].value              | string  | Field where the value of the information is, which can be text, link, date of birth, etc.                                                                                                |
| data.hits\[].doc.fields.$type.$information\[].tag                | string  | Internal tag with tabulated values ​​for the category of each information (date\_of\_birth, related\_url, country\_names, etc.).                                                         |
| data.hits\[].score                                               | number  | Indicates the hit score value.                                                                                                                                                           |
| data.hits\[].matchStatus                                         | string  | Indicates the hit status (potential\_match, true\_positive, etc.).                                                                                                                       |
| data.hits\[].isWhiteListed                                       | boolean | Indicates if the hit is in a white list.                                                                                                                                                 |
| data.hits\[].matchTypes                                          | array   | List of match types for each hit. (aka\_exact, year\_of\_birth, etc.).                                                                                                                   |
| data.hits\[].matchTypesDetails                                   | array   | Details of name matches, sources, and secondary matches for each entity. In this field, all hit information is analyzed individually, to classify them according to their relevance.     |
| data.hits\[].matchTypesDetails\[].nameMatches                    | array   | Information about each entity, including query terms and match types.                                                                                                                    |
| data.hits\[].matchTypesDetails\[].nameMatches\[].matchTypes      | array   | Classification of matches for the respective information (exact\_match, partial\_match, etc.).                                                                                           |
| data.hits\[].matchTypesDetails\[].nameMatches\[].queryTerm       | string  | The specific query term used for the match. (name, date, etc.).                                                                                                                          |
| data.hits\[].matchTypesDetails\[].amlTypes                       | array   | Type of news associated with each match (adverse-media-terrorism, adverse-media-v2-cybercrime, adverse-media-fraud, etc.).                                                               |
| data.hits\[].matchTypesDetails\[].sources                        | array   | Sources of hit information.                                                                                                                                                              |
| data.hits\[].matchTypesDetails\[].secondaryMatches               | array   | Additional matches related to each individual information.                                                                                                                               |
| data.hits\[].matchTypesDetails\[].secondaryMatches\[].matchTypes | array   | Classification of secondary matches for the respective information (exact\_match, partial\_match, etc.).                                                                                 |
| data.hits\[].matchTypesDetails\[].secondaryMatches\[].queryTerm  | string  | The specific query term used for the secondary match. (name, date, etc.).                                                                                                                |
| data.hits\[].matchTypesDetails\[].matchingName                   | string  | The full name of each matched individual (Ex: Nicolás Maduro Moros).                                                                                                                     |
| data.createdAt                                                   | string  | Timestamp indicating when the record was created.                                                                                                                                        |
| data.ref                                                         | string  | Reference identifier associated with the record.                                                                                                                                         |
| data.matchStatus                                                 | string  | Final status of the query (no\_match, false\_positive, potential\_match, true\_positive, unknown, true\_positive\_approve, true\_positive\_reject).                                      |
| data.totalHits                                                   | number  | Total number of hits associated with the record.                                                                                                                                         |
| data.cached                                                      | boolean | Indicates whether the record is cached.                                                                                                                                                  |
| data.totalBlacklistHits                                          | number  | Total number of hits in the blacklist associated with the record.                                                                                                                        |
| data.shareUrl                                                    | string  | URL for sharing the record.                                                                                                                                                              |
| data.id                                                          | number  | Unique identifier of the record.                                                                                                                                                         |
| data.totalMatches                                                | number  | Total number of matches associated with the record.                                                                                                                                      |
| data.updatedAt                                                   | string  | Timestamp indicating when the record was updated.                                                                                                                                        |
| statusCode                                                       | string  | References the status of this query only, not the entire transaction. [Check our status guide](/caf-api/connect/transactions/background-check)                                           |
| {% endtab %}                                                     |         |                                                                                                                                                                                          |

{% tab title="Example" %}

```json
{
  "data": {
    "riskLevel": "unknown",
    "clientRef": "caf-Vladimir Vladimirovitch Putin",
    "blacklistHits": [],
    "hits": [
      {
        "matchTypes": ["aka_exact", "year_of_birth"],
        "doc": {
          "types": [
            "adverse-media",
            "adverse-media-v2-cybercrime",
            "adverse-media-v2-financial-aml-cft",
            "adverse-media-v2-financial-difficulty",
            "adverse-media-v2-fraud-linked",
            "adverse-media-v2-general-aml-cft",
            "adverse-media-v2-narcotics-aml-cft",
            "adverse-media-v2-other-financial",
            "adverse-media-v2-other-minor",
            "adverse-media-v2-other-serious",
            "adverse-media-v2-property",
            "adverse-media-v2-regulatory",
            "adverse-media-v2-terrorism",
            "adverse-media-v2-violence-aml-cft",
            "adverse-media-v2-violence-non-aml-cft"
          ],
          "associates": [
            {
              "name": "ABRAMCHENKO Victoria Valerievna",
              "association": "підлеглий"
            },
            {
              "name": "ABRAMOVICH Roman Arkadyevich",
              "association": "partner"
            },
            {
              "name": "AMELCHENKOVA / ZANKO Olga Nikolaevna",
              "association": "соратник"
            },
            {
              "name": "ANISIMOV Vasily Vasilievich",
              "association": "partner"
            },
            {
              "name": "AVDEEV Alexey Yurevich",
              "association": "підлеглий"
            },
            {
              "name": "AVEN Petr Olegovich",
              "association": "partner"
            },
            {
              "name": "AZIMOV Rakhim Azizboevich",
              "association": "соратник"
            },
            {
              "name": "Albert Putin",
              "association": "sibling"
            },
            {
              "name": "BABAKOV Alexander Mikhailovich",
              "association": "соратник"
            },
            {
              "name": "BAKHMETIEV / BAKHMETYEV Vitaly Viktorovich",
              "association": "соратник"
            },
            {
              "name": "BELOUSOV Andrey Removich",
              "association": "підлеглий"
            },
            {
              "name": "BICHAEV Artem Aleksandrovich",
              "association": "підлеглий"
            },
            {
              "name": "BLAVATNIK Leonid / Len / Leonardo Valentinovich",
              "association": "друг"
            },
            {
              "name": "BOGDANCHIKOV Sergei Mikhailovich",
              "association": "друг"
            },
            {
              "name": "BONDAREV Viktor Nikolayevich",
              "association": "колишній керівник"
            },
            {
              "name": "BORISOV Yury Ivanovich",
              "association": "підлеглий"
            },
            {
              "name": "BORTNIKOV Aleksandr Vasilievich",
              "association": "підлеглий"
            },
            {
              "name": "CHEMEZOV Sergey Viktorovich",
              "association": "соратник"
            },
            {
              "name": "DMITRIEV Kirill Aleksandrovich",
              "association": "partner"
            },
            {
              "name": "DRONOV Yaroslav Yuriyovych",
              "association": "Дронов Ярослав Юрійович, відомий під псевдонімом SHAMAN, 25 грудня 2023 року став довіреною особою Путіна Володимира Володимировича виборах президента Російської Федерації 2024, тим самим підтримуючи продовження геноциду та війни на території України."
            },
            {
              "name": "ERNST Konstantin Lvovich",
              "association": "partner"
            },
            {
              "name": "FAASSEN Jorrit Joost",
              "association": "зять"
            },
            {
              "name": "FADZAEV Arsen Suleymanovich",
              "association": "довірена особа"
            },
            {
              "name": "FETISOV Vyacheslav Aleksandrovich",
              "association": "друг"
            },
            {
              "name": "FRIDMAN Mikhail Maratovich",
              "association": "partner"
            },
            {
              "name": "GILMUTDINOV Ildar Irekovich",
              "association": "підлеглий"
            },
            {
              "name": "GOLIKOVA Tatyana Alekseevna",
              "association": "підлеглий"
            },
            {
              "name": "GORELOV Dmitrii Vladimirovich",
              "association": "друг"
            },
            {
              "name": "GROMOV Aleksey Alekseevich",
              "association": "підлеглий"
            },
            {
              "name": "GURTSKAIA Diana Gudaevna",
              "association": "довірена особа"
            },
            {
              "name": "GUTSAN Alexander Vladimirovich",
              "association": "підлеглий"
            },
            {
              "name": "Graceful",
              "association": "Property in the interest of"
            },
            {
              "name": "IVANAYEV Andrey Sergeyevich",
              "association": "partner"
            },
            {
              "name": "IVANOV Sergey Borisovich",
              "association": "підлеглий"
            },
            {
              "name": "Ironstone Marine Investments",
              "association": "Providing support"
            },
            {
              "name": "KABAYEVA Alina Maratovna",
              "association": "коханка"
            },
            {
              "name": "KANDYBOVICH Sergei Lvovich",
              "association": "довірена особа"
            },
            {
              "name": "KASTYUKEVICH Igor Yurievich",
              "association": "підлеглий"
            },
            {
              "name": "KHAN German Borisovich",
              "association": "друг"
            },
            {
              "name": "KHMARIN Victor Victorovich",
              "association": "друг"
            },
            {
              "name": "KLEBANOV Ilia Iosifovich",
              "association": "колега"
            },
            {
              "name": "KOLBIN Petro Viktorovych",
              "association": "друг"
            },
            {
              "name": "KOLBIN Vladimir Petrovich",
              "association": "друг"
            },
            {
              "name": "KOMAROV Igor Anatolyevich",
              "association": "підлеглий"
            },
            {
              "name": "KOSTIN Andrey Leonidovich",
              "association": "partner"
            },
            {
              "name": "KOSTYUKOV Igor Olegovich",
              "association": "підлеглий"
            },
            {
              "name": "KRIVONOGIKH Svetlana Alexandrovna",
              "association": "коханка"
            },
            {
              "name": "KUZMICHEV Alexey Viktorovich",
              "association": "ділові відносини"
            },
            {
              "name": "KUZNETSOV Mikhail Mikhailovich",
              "association": "підлеглий"
            },
            {
              "name": "Katerina Tikhonova",
              "association": "child"
            },
            {
              "name": "LITVINENKO Vladimir Stefanovich",
              "association": "соратник"
            },
            {
              "name": "Lyudmila Aleksandrovna Ocheretnaya",
              "association": "former spouse"
            },
            {
              "name": "Lyudmila Aleksandrovna Ocheretnaya",
              "association": "spouse"
            },
            {
              "name": "Lyudmila Putina",
              "association": "spouse"
            },
            {
              "name": "Lyudmila Shkrebneva",
              "association": "former spouse"
            },
            {
              "name": "MAGOMEDOV Dzhambulat Musaevich",
              "association": "довірена особа"
            },
            {
              "name": "MAMEDOV Alexey Khamrakulovich",
              "association": "підлеглий"
            },
            {
              "name": "MARKOV Sergei Alexandrovich",
              "association": "соратник"
            },
            {
              "name": "MEDVEDCHUK Viktor Volodymyrovich",
              "association": "кум"
            },
            {
              "name": "MELNICHENKO Andrey Igorevich",
              "association": "друг"
            },
            {
              "name": "MILLER / MILLIER Alexey Borisovich",
              "association": "друг"
            },
            {
              "name": "MIZINTSEV Mikhail Yevgenyevich",
              "association": "підлеглий"
            },
            {
              "name": "MURUGOV Viacheslav Aleksandrovich",
              "association": "довірена особа"
            },
            {
              "name": "Maria Vorontsova",
              "association": "child"
            },
            {
              "name": "Mariya Putina",
              "association": "child"
            },
            {
              "name": "NARUSOVA Lyudmila Borisovna",
              "association": "знайома"
            },
            {
              "name": "NEVALENNAIA Galina Ivanovna",
              "association": "довірена особа"
            },
            {
              "name": "NOVAK Alexander Valentinovich",
              "association": "підлеглий"
            },
            {
              "name": "O'Neill Assets Corporation",
              "association": "Providing support"
            },
            {
              "name": "OCHERETNAYA Lyudmila Alexandrovna",
              "association": "колишня дружина"
            },
            {
              "name": "OSEEVSKY Mikhail Eduardovich",
              "association": "partner"
            },
            {
              "name": "OSIPOV Igor Vladimirovich",
              "association": "підлеглий"
            },
            {
              "name": "OVERCHUK Alexey Logvinovich",
              "association": "підлеглий"
            },
            {
              "name": "Olympia",
              "association": "Property in the interest of"
            },
            {
              "name": "PIROG Dmitry Yurievich",
              "association": "підлеглий"
            },
            {
              "name": "PODNOSOVA Irina Leonidovna",
              "association": "соратник"
            },
            {
              "name": "PORYVAI Natalia Vladimirovna",
              "association": "соратник"
            },
            {
              "name": "PUTIN Igor Aleksandrovich",
              "association": "двоюрідний брат"
            },
            {
              "name": "PUTIN Mikhail Evgenevich",
              "association": "двоюрідний племінник"
            },
            {
              "name": "PUTIN Roman Igorevich",
              "association": "двоюрідний племінник"
            },
            {
              "name": "PUTINA / PODGUZOVA Vera Alexandrovna",
              "association": "двоюрідна племінниця"
            },
            {
              "name": "PUTINA / TIKHONOVA Katerina / Ekaterina Vladimirovna",
              "association": "дочка"
            },
            {
              "name": "PUTINA / VORONTSOVA / FAASSEN Maria Vladimirovna",
              "association": "дочка"
            },
            {
              "name": "RAGIMOV Ilgam Mamedgasanovich",
              "association": "друг"
            },
            {
              "name": "RAHIMKULOV Megdet Nigmatovich",
              "association": "соратник"
            },
            {
              "name": "ROLDUGIN Sergei Pavlovich",
              "association": "кум"
            },
            {
              "name": "ROTENBERG Igor Arkadyevich",
              "association": "partner"
            },
            {
              "name": "RUDNOV Sergei Olegovich",
              "association": "друг"
            },
            {
              "name": "SALYUKOV Oleg Leonydovych",
              "association": "підлеглий"
            },
            {
              "name": "SCHRÖDER Gerhard Fritz Kurt",
              "association": "ділові відносини"
            },
            {
              "name": "SECHIN Igor Ivanovich",
              "association": "друг"
            },
            {
              "name": "SERYSHEV Anatoly Anatolyevich",
              "association": "ділові відносини"
            },
            {
              "name": "SHAFIGULLIN Airat Radinovich",
              "association": "радник"
            },
            {
              "name": "SHAMALOV Kirill Nikolaevich",
              "association": "зять"
            },
            {
              "name": "SHAMALOV Nikolay Terentievich",
              "association": "друг"
            },
            {
              "name": "SHCHEGOLEV Igor Olegovich",
              "association": "підлеглий"
            },
            {
              "name": "SHELOMOV Mikhail Lvovich",
              "association": "двоюрідний племінник"
            },
            {
              "name": "SIMONYAN Margarita Simonovna",
              "association": "partner"
            },
            {
              "name": "SMIRNOV Vladimir Alekseevich",
              "association": "соратник"
            },
            {
              "name": "TIMCHENKO Gennady Nikolayevich",
              "association": "знайомий"
            },
            {
              "name": "TRABER Ilya Ilyich",
              "association": "друг"
            },
            {
              "name": "TRUTNEV Yury Petrovich",
              "association": "помічник"
            },
            {
              "name": "TSIVILEV Sergey Evgenievich",
              "association": "родич"
            },
            {
              "name": "TSOMAEVA / SHKREBNEVA Olga Alexandrovna",
              "association": "своячка"
            },
            {
              "name": "YATSKYN Andrei Vladimirovich",
              "association": "колишній підлеглий"
            },
            {
              "name": "YEVMENOV Nikolay Anatolyevich",
              "association": "підлеглий"
            },
            {
              "name": "Yekaterina Putina",
              "association": "child"
            },
            {
              "name": "ZHURAVLYOV Alexander Alexandrovich",
              "association": "підлеглий"
            },
            {
              "name": "ZOLOTOV Viktor Vasiliyevich",
              "association": "підлеглий"
            },
            {
              "name": "Воронцова Мария Владимировна",
              "association": "child"
            }
          ],
          "sources": ["company-am", "complyadvantage-adverse-media"],
          "keywords": [],
          "sourceNotes": {
            "complyadvantageAdverseMedia": {
              "amlTypes": [
                "adverse-media",
                "adverse-media-v2-cybercrime",
                "adverse-media-v2-financial-aml-cft",
                "adverse-media-v2-financial-difficulty",
                "adverse-media-v2-fraud-linked",
                "adverse-media-v2-general-aml-cft",
                "adverse-media-v2-narcotics-aml-cft",
                "adverse-media-v2-other-financial",
                "adverse-media-v2-other-minor",
                "adverse-media-v2-other-serious",
                "adverse-media-v2-property",
                "adverse-media-v2-regulatory",
                "adverse-media-v2-terrorism",
                "adverse-media-v2-violence-aml-cft",
                "adverse-media-v2-violence-non-aml-cft"
              ],
              "name": "ComplyAdvantage Adverse Media",
              "countryCodes": [
                "BE",
                "BR",
                "CA",
                "CF",
                "ES",
                "FR",
                "GB",
                "IR",
                "JP",
                "KN",
                "LB",
                "MD",
                "MX",
                "MY",
                "NG",
                "NL",
                "PL",
                "QA",
                "RU",
                "SG",
                "UA",
                "US",
                "ZA"
              ]
            },
            "companyAm": {
              "amlTypes": ["adverse-media", "adverse-media-v2-other-minor"],
              "name": "company AM",
              "countryCodes": ["AU", "CZ"]
            }
          },
          "entityType": "person",
          "media": [
            {
              "date": "2024-05-07T00:00:00Z",
              "snippet": "- Oil tycoon Mikhail Khodorkovsky, who is Russia's richest man and seen as a potential challenger to Putin, is arrested and later sentenced to 10...",
              "title": "(no title)",
              "url": "https://halifax.citynews.ca/2024/05/07/key-events-of-vladimir-putins-24-years-in-power-in-russia/amp/"
            },
            {
              "date": "2024-05-20T00:00:00Z",
              "snippet": "The court, based in The Hague, has no police force, but those named in warrants could be arrested if they travel to one of its...",
              "title": "Biden Declares Israel's Military Operation in Gaza 'Is Not Genocide' - The New York Times",
              "url": "https://www.nytimes.com/live/2024/05/20/world/israel-gaza-war-hamas-rafah/a-prosecutor-is-alleging-israeli-officials-have-used-starvation-as-a-weapon-of-war-heres-what-the-charge-entails"
            },
            {
              "date": "2024-05-22T00:00:00Z",
              "snippet": "Khan said in his announcement that he had reasonable grounds to believe that Israeli Prime Minister Benjamin Netanyahu, Israel's defense chief and three Hamas leaders...",
              "title": "Blinken says he'll work with US Congress on potential ICC sanctions - Hawaii Tribune-Herald",
              "url": "https://www.hawaiitribune-herald.com/2024/05/22/nation-world-news/blinken-says-hell-work-with-us-congress-on-potential-icc-sanctions/amp/%7B%7Blink/"
            },
            {
              "date": "2023-09-24T00:00:00Z",
              "snippet": "Por isso, em março, o Tribunal Penal Internacional (TPI) emitiu um mandado de prisão para o presidente russo, Vladimir Putin, e outra funcionária, acusando-os de...",
              "title": "Entenda o rapto de crianças ucranianas citado por Zelensky na ONU e que embasa ordem de prisão contra Putin | Ucrânia e Rússia | G1",
              "url": "https://g1.globo.com/google/amp/mundo/ucrania-russia/noticia/2023/09/24/entenda-o-rapto-de-criancas-ucranianas-citado-por-zelensky-na-onu-e-que-embasa-ordem-de-prisao-contra-putin.ghtml"
            },
            {
              "date": "2023-07-21T00:00:00Z",
              "snippet": "Last November, he pulled out of the G20 summit in Indonesia because Western leaders had threatened to stage a walkout if he attended. Director-General in...",
              "title": "Government and DA agree not to proceed with Putin application",
              "url": "https://www.iol.co.za/news/politics/government-and-da-agree-not-to-proceed-with-putin-application-03b73baf-1f14-4a97-af14-773a95574f75"
            },
            {
              "date": "2023-06-21T00:00:00Z",
              "snippet": "Political Views Tatarinova said that in her interactions with Zabugorsky, he did not appear to be overtly political in person, never quite showing where he...",
              "title": "He Said He Fled Russia. Then He Returned, Amid A Massive Clampdown, And Denounced America On State TV. What Happened?",
              "url": "https://www.rferl.org/amp/russia-zabugorsky-denouncing-america-clampdown/32469127.html"
            },
            {
              "date": "2024-05-13T00:00:00Z",
              "snippet": "A softly-spoken former bank clerk has stepped into the shoes of Vladimir Putin's propagandist warlord, three years after she was released from a Virginia jail...",
              "title": "How a convicted woman US felon has become Putin's new mouthpiece | Daily Mail Online",
              "url": "https://www.dailymail.co.uk/galleries/article-13411497/How-convicted-woman-felon-Putins-new-mouthpiece.html?ico=topics_pagination_desktop"
            },
            {
              "date": "2023-08-23T00:00:00Z",
              "snippet": "This year, there is an awkward situation prevailing within the group over Russian President Vladimir Putin. Putin is facing war crimes charges for allegedly deporting...",
              "title": "How cohesive are the bricks of BRICS to shake the US-led global order? | The Business Standard",
              "url": "https://www.tbsnews.net/features/panorama/how-cohesive-are-bricks-brics-shake-us-led-global-order-687022?amp"
            },
            {
              "date": "2024-05-21T00:00:00Z",
              "snippet": "Her trip had not been announced for security reasons. During a visit to one of Ukraine's largest power stations, which was destroyed by Russia last...",
              "title": "In Kyiv, Top German Diplomat Urges Allies To Protect Ukraine's Skies",
              "url": "https://www.rferl.org/amp/ukraine-war-baerbock-german-kyiv-visit/32957061.html"
            },
            {
              "date": "2024-03-28T00:00:00Z",
              "snippet": ": \"[I am] Kara-Murza, Vladimir Vladimirovich, date of birth September 7, 1981, convicted under criminal code articles 284.1 part one, 207.3 part two, 275. Start...",
              "title": "Inside Putin's nightmare Arctic gulag - where prisoners are regularly stripped naked in -2C - World News - Mirror Online",
              "url": "https://www.mirror.co.uk/news/world-news/inside-putins-nightmare-arctic-gulag-32458490?int_campaign=continue_reading_button&int_medium=amp&int_source=amp_continue_reading"
            },
            {
              "date": "2023-04-18T00:00:00Z",
              "snippet": ": ICC judges issue arrest warrants against Vladimir Vladimirovich Putin and Maria Alekseyevna Lvova-Belova (March 17, 2023), https :",
              "title": "Intl Court Ruling on Iranian Assets Affects Arbitration Award Enf",
              "url": "https://natlawreview.com/article/decision-international-court-justice-certain-iranian-assets?amp"
            },
            {
              "date": "2024-05-22T00:00:00Z",
              "snippet": "Early in his tenure he resumed investigations into the Taliban while dropping those into alleged crimes by the US and other western nations in the...",
              "title": "Karim Khan chose to act when Israel's leadership is at its most isolated and vulnerable - The Jewish Chronicle",
              "url": "https://www.thejc.com/lets-talk/analysis/karim-khan-chose-to-act-when-israels-leadership-is-at-its-most-isolated-and-vulnerable-qsrt36pt"
            },
            {
              "date": "2023-12-04T00:00:00Z",
              "snippet": "A Câmara de Pré-Julgamento II do TPI considerou que os dois acusados são responsáveis pelo crime de guerra de deportação ilegal de crianças de áreas...",
              "title": "Lula diz que Brasil convidará Putin para reunião do G20 no Rio, em 2024: 'Se ele comparecer, sabe o que pode acontecer' | Política | G1",
              "url": "https://g1.globo.com/google/amp/politica/noticia/2023/12/04/lula-diz-que-brasil-convidara-putin-para-reunioes-do-brics-e-do-g20-se-ele-comparecer-sabe-o-que-pode-acontecer.ghtml"
            },
            {
              "date": "2023-12-04T00:00:00Z",
              "snippet": "O presidente russo foi acusado de ser o responsável por deportação ilegal de crianças em áreas ocupadas da Ucrânia para a Rússia. \"O Sr. Vladimir...",
              "title": "Lula diz que Putin será chamado pelo Brasil para reunião do G20 no Rio",
              "url": "https://fanoticias.com.br/lula-diz-que-putin-sera-chamado-pelo-brasil-para-reuniao-do-g20-no-rio/"
            },
            {
              "date": "2024-05-21T00:00:00Z",
              "snippet": "One of his first acts as prosecutor, which took many by surprise, was to \"deprioritize\" an investigation into abuse of prisoners by American forces in...",
              "title": "More Than 800,000 Have Fled Rafah, UN Official Says: Israel-Hamas War Latest Updates - The New York Times",
              "url": "https://www.nytimes.com/live/2024/05/21/world/israel-gaza-war-hamas-rafah"
            },
            {
              "date": "2023-04-22T00:00:00Z",
              "snippet": "Alexie needed treatment from doctors in Germany to recover. And when he returned to Russia, President Putin had him imprisoned for violating probation (on an...",
              "title": "More reports about Mad Vlad Putin - Santa Barbara News-Press",
              "url": "https://newspress.com/more-reports-about-mad-vlad-putin/"
            },
            {
              "date": "2024-03-13T00:00:00Z",
              "snippet": "We're ready,\" Mr. Putin said. In the interview, Mr. Putin also denied having considered using weapons of mass destruction in Ukraine in the fall of...",
              "title": "Putin Plays Down Threat of Nuclear War in Pre-Election State TV Interview - The New York Times",
              "url": "https://www.nytimes.com/2024/03/13/world/europe/russia-putin-nuclear-war-ukraine.html"
            },
            {
              "date": "2024-03-22T00:00:00Z",
              "snippet": "which is four times bigger than Chernobyl. Putin, 71, unleashed hell on civilians using a deadly arsenal of 88 missiles and 66 drones -",
              "title": "Putin made chilling NUCLEAR threat when he emptied arsenal for biggest ever blitz...he can 'smell weakness', experts warn",
              "url": "https://www.thesun.co.uk/news/26860486/putin-nuclear-threat-emptied-arsenal-ukraine/amp/"
            },
            {
              "date": "2024-03-22T00:00:00Z",
              "snippet": "which is four times bigger than Chernobyl. Putin, 71, unleashed hell on civilians using a deadly arsenal of 88 missiles and 66 drones -",
              "title": "Putin made chilling NUCLEAR threat when he emptied arsenal for biggest ever blitz...he can 'smell weakness', experts warn | The Sun",
              "url": "https://www.thesun.co.uk/news/26860486/putin-nuclear-threat-emptied-arsenal-ukraine/"
            },
            {
              "date": "2024-05-07T00:00:00Z",
              "snippet": "The 71-year-old took the oath of office in a ceremony in the Kremlin, with several thousand people including senior Russian politicians and other high-ranking guests...",
              "title": "Putin sworn in for 5th term as Russian president — National Accord Newspaper",
              "url": "https://www.nationalaccordnewspaper.com/putin-sworn-in-for-5th-term-as-russian-president/"
            },
            {
              "date": "2024-05-22T00:00:00Z",
              "snippet": "And last month, Kyiv, through Qatari mediators, passed Moscow a list of 561 children whose return Ukrainian authorities are seeking. In March 2023, the International...",
              "title": "Russia Returns 6 Children to Ukraine With Qatar's Mediation  - The Moscow Times",
              "url": "https://www.themoscowtimes.com/2024/05/22/russia-returns-6-children-to-ukraine-with-qatars-mediation-a85192"
            },
            {
              "date": "2023-06-23T00:00:00Z",
              "snippet": "That Khodorkovsky would criticize the Kremlin is no surprise. He is a former oil tycoon who publicly broke with Putin in 2003 and was later...",
              "title": "Russia-Ukraine War: Russian Generals Accuse Mercenary Leader of Trying to Mount a Coup - The New York Times",
              "url": "https://www.nytimes.com/live/2023/06/23/world/russia-ukraine-news"
            },
            {
              "date": "2024-01-24T00:00:00Z",
              "snippet": "But we should take a step back from Russia's multibillion-dollar propaganda machine's feedlot and look at the facts and logic. Putin has proven to be...",
              "title": "Russian invasion: Why we should never negotiate with terrorists",
              "url": "https://www.dailymaverick.co.za/opinionista/2024-01-25-russian-invasion-why-we-should-never-negotiate-with-terrorists/"
            },
            {
              "date": "2024-03-24T00:00:00Z",
              "snippet": "to occupying a portion of eastern and southern Ukraine, the war is grinding on with Ukraine's counteroffensive since last summer now struggling. Putin earlier today...",
              "title": "Some victims of Moscow shooting in critical condition, authorities say – as it happened | Moscow concert hall attack | The Guardian",
              "url": "https://www.theguardian.com/world/live/2024/mar/23/moscow-concert-attack-crocus-city-hall-shooting-russia-live-updates?filterKeyEvents=false"
            },
            {
              "date": "2023-03-21T00:00:00Z",
              "snippet": "On March 17, The International Criminal Court (ICC) issued arrest warrants indicting the president of the Russian Federation, Vladimir Vladimirovich Putin, for alleged war crimes...",
              "title": "The (Ukrainian) kids aren't alright: The ICC issues historic arrest warrant for Putin's war crimes on Ukrainian children | The Brock Press",
              "url": "https://brockpress.com/the-ukrainian-kids-arent-alright-the-icc-issues-historic-arrest-warrant-for-putins-war-crimes-on-ukrainian-children/"
            },
            {
              "date": "2023-05-05T00:00:00Z",
              "snippet": "Bere Telegram kontuan argitaratutako bideo batean, «Wagnerreko borrokalarien eta komandantziaren izenean, 2023ko maiatzaren 10ean Bakhmut hiriko posizioak Defentsa Ministerioko unitateei entregatzera eta, zauriak miazkatzeko, gureak...",
              "title": "Wagner taldeak Bakhmutetik erretiratuko dela ohartarazi du | Mundo | GARA Euskal Herriko egunkaria",
              "url": "https://www.naiz.eus/es/hemeroteca/gara/editions/2023-05-06/hemeroteca_articles/amp/wagner-taldeak-bakhmutetik-erretiratuko-dela-ohartarazi-du"
            },
            {
              "date": "2023-07-20T00:00:00Z",
              "snippet": "But as a member of the ICC, it is in theory obligated to execute the warrant for arrest. According to a press release issued by...",
              "title": "Why Putin won't go to South Africa for the BRICS summit in August | The Indian Express",
              "url": "https://indianexpress.com/article/explained/explained-global/why-putin-wont-go-to-south-africa-for-the-brics-summit-in-august-8850401/"
            },
            {
              "date": "2023-03-20T00:00:00Z",
              "snippet": "Formal talks were scheduled for Tuesday, the Kremlin said. Xi's visit comes three days after Putin was made the subject of an arrest warrant by...",
              "title": "Xi Jinping says China ready to 'stand guard over world order' on Moscow visit | Russia | The Guardian",
              "url": "https://www.theguardian.com/world/2023/mar/20/xi-jinping-vladimir-putin-moscow-ukraine-war"
            },
            {
              "date": "2023-04-17T00:00:00Z",
              "snippet": "Vladimir Kara-Murza, destacado defensor ruso de los derechos humanos y crítico con el Kremlin, fue sentenciado este lunes a 25 años de prisión por el...",
              "title": "Última hora y noticias en vivo de la guerra de Rusia en Ucrania",
              "url": "https://cnnespanol.cnn.com/2023/04/17/ultima-hora-noticias-vivo-guerra-rusia-ucrania-orix-33/amp/"
            },
            {
              "date": "2024-01-16T00:00:00Z",
              "snippet": "В отношении него составили протокол, который позднее аннулировали. После задержания Владимир Владимирович написал заявление в Центральный районный суд. Он потребовал 100 тысяч рублей за действия...",
              "title": "В Новосибирске скончался судившийся с МВД ветеран ВОВ Владимир Степанов | ОБЩЕСТВО | АиФ Новосибирск",
              "url": "https://nsk.aif.ru/amp/society/v_novosibirske_skonchalsya_sudivshiysya_s_mvd_veteran_vov_vladimir_stepanov"
            }
          ],
          "birthDate": ["1952", "1953", "1988"],
          "createdAt": "2017-11-03T00:38:00Z",
          "countryCodes": [
            "AU",
            "CZ",
            "BE",
            "BR",
            "CA",
            "CF",
            "ES",
            "FR",
            "GB",
            "IR",
            "JP",
            "KN",
            "LB",
            "MD",
            "MX",
            "MY",
            "NG",
            "NL",
            "PL",
            "QA",
            "RU",
            "SG",
            "UA",
            "US",
            "ZA"
          ],
          "assets": [
            {
              "publicUrl": "http://complyadvantage-asset-development.s3.amazonaws.com/3e61820f-94d2-4846-a000-923812d19c72.jpg",
              "source": "complyadvantage",
              "type": "picture",
              "url": "http://structure.mil.ru/images/putin_170x240.jpg"
            }
          ],
          "aka": [
            {
              "name": "Путин Владимир Владимир"
            },
            {
              "name": "Vladimir Vladimirovich Putin"
            },
            {
              "name": "Putin Vladimir"
            },
            {
              "name": "Владимир Владимир Путин"
            },
            {
              "name": "Путин Владимир Путин"
            },
            {
              "name": "Valadimir Putin"
            },
            {
              "name": "Vladimir Vladimirovitch"
            },
            {
              "name": "Valdimir Putin"
            },
            {
              "name": "Vladimir Putin"
            },
            {
              "name": "Vlad Putin"
            },
            {
              "name": "Путин Владимир"
            },
            {
              "name": "Vladimir V. Poutine"
            },
            {
              "name": "Vladimir Vladimirovitch Putin"
            },
            {
              "name": "Vladimr Putin'"
            },
            {
              "name": "Владимир Владимирович"
            },
            {
              "name": "Vladymir Putin"
            },
            {
              "name": "Wladimir Putin"
            },
            {
              "name": "Путин Владимир Владимирович"
            },
            {
              "name": "Vladaimir Putin"
            },
            {
              "name": "Vladimir Putiin"
            },
            {
              "name": "Владимира Путина"
            },
            {
              "name": "Vladmir Putin"
            },
            {
              "name": "V. Poutine"
            },
            {
              "name": "Vladimir V. Putin"
            },
            {
              "name": "Vladimir PutinA"
            },
            {
              "name": "Vladimiro Putin"
            },
            {
              "name": "Vladimir Vladiminovich Putin"
            },
            {
              "name": "Vladimir Putini"
            },
            {
              "name": "Vladimir Vladimirovic Putin"
            },
            {
              "name": "Vladimar Putin"
            }
          ],
          "name": "Vladimir Vladimirovitch Putin",
          "deathDate": [],
          "id": "LIZCQ58HX6MYKMO",
          "fields": {
            "other": {
              "countries": [
                {
                  "name": "Countries",
                  "value": "Australia, Belgium, Brazil, Canada, Central African Republic, Czech Republic, France, Iran, Japan, Lebanon, Malaysia, Mexico, Netherlands, Nigeria, Poland, Qatar, Republic of Moldova, Russian Federation, Saint Kitts and Nevis, Singapore, South Africa, Spain, Ukraine, United Kingdom, United States",
                  "tag": "country_names"
                }
              ]
            },
            "adverseMediaV2FinancialAmlCft": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ]
            },
            "adverseMedia": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ],
              "companyAm": [
                {
                  "name": "Country",
                  "value": "Australia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Australia"
                },
                {
                  "name": "Country",
                  "value": "Czech Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Czech Republic"
                }
              ]
            },
            "adverseMediaV2GeneralAmlCft": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ]
            },
            "adverseMediaV2Terrorism": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ]
            },
            "adverseMediaV2OtherMinor": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ],
              "companyAm": [
                {
                  "name": "Country",
                  "value": "Australia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Australia"
                },
                {
                  "name": "Country",
                  "value": "Czech Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Czech Republic"
                }
              ]
            },
            "adverseMediaV2NarcoticsAmlCft": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ]
            },
            "adverseMediaV2ViolenceAmlCft": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ]
            },
            "adverseMediaV2ViolenceNonAmlCft": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ]
            },
            "adverseMediaV2Cybercrime": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ]
            },
            "adverseMediaV2FraudLinked": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ]
            },
            "adverseMediaV2Property": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ]
            },
            "adverseMediaV2FinancialDifficulty": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ]
            },
            "adverseMediaV2OtherSerious": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ]
            },
            "adverseMediaV2Regulatory": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ]
            },
            "adverseMediaV2OtherFinancial": {
              "complyadvantageAdverseMedia": [
                {
                  "name": "Country",
                  "value": "Belgium"
                },
                {
                  "name": "Original Country Text",
                  "value": "Belgium, Poland"
                },
                {
                  "name": "Country",
                  "value": "Brazil"
                },
                {
                  "name": "Original Country Text",
                  "value": "Brazil"
                },
                {
                  "name": "Country",
                  "value": "Canada"
                },
                {
                  "name": "Original Country Text",
                  "value": "Canada, Russia"
                },
                {
                  "name": "Country",
                  "value": "Central African Republic"
                },
                {
                  "name": "Original Country Text",
                  "value": "Central African Republic, France"
                },
                {
                  "name": "Country",
                  "value": "France"
                },
                {
                  "name": "Country",
                  "value": "Iran"
                },
                {
                  "name": "Original Country Text",
                  "value": "Iran, Japan, United Kingdom, United States"
                },
                {
                  "name": "Country",
                  "value": "Japan"
                },
                {
                  "name": "Original Country Text",
                  "value": "Japan"
                },
                {
                  "name": "Country",
                  "value": "Lebanon"
                },
                {
                  "name": "Original Country Text",
                  "value": "Lebanon, Netherlands, Nigeria, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Malaysia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Malaysia, Singapore"
                },
                {
                  "name": "Country",
                  "value": "Mexico"
                },
                {
                  "name": "Original Country Text",
                  "value": "Mexico, United States"
                },
                {
                  "name": "Country",
                  "value": "Netherlands"
                },
                {
                  "name": "Country",
                  "value": "Nigeria"
                },
                {
                  "name": "Country",
                  "value": "Poland"
                },
                {
                  "name": "Country",
                  "value": "Qatar"
                },
                {
                  "name": "Original Country Text",
                  "value": "International, Qatar, Ukraine, United States"
                },
                {
                  "name": "Country",
                  "value": "Republic of Moldova"
                },
                {
                  "name": "Original Country Text",
                  "value": "Moldova, Russia, Ukraine"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, Ukraine"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia, United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Original Country Text",
                  "value": "Saint Kitts and Nevis"
                },
                {
                  "name": "Country",
                  "value": "Singapore"
                },
                {
                  "name": "Country",
                  "value": "South Africa"
                },
                {
                  "name": "Original Country Text",
                  "value": "South Africa"
                },
                {
                  "name": "Country",
                  "value": "Spain"
                },
                {
                  "name": "Original Country Text",
                  "value": "Spain"
                },
                {
                  "name": "Country",
                  "value": "Ukraine"
                },
                {
                  "name": "Country",
                  "value": "United Kingdom"
                },
                {
                  "name": "Country",
                  "value": "United States"
                },
                {
                  "name": "Original Country Text",
                  "value": "United States"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1953",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1988",
                  "tag": "date_of_birth"
                }
              ]
            }
          },
          "updatedAt": "2024-05-23T19:00:54Z"
        },
        "score": 2,
        "matchStatus": "potential_match",
        "isWhitelisted": false,
        "matchTypesDetails": [
          {
            "nameMatches": [
              {
                "matchTypes": ["equivalent_name"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": [
              "adverse-media",
              "adverse-media-financial-crime",
              "adverse-media-fraud",
              "adverse-media-general",
              "adverse-media-narcotics",
              "adverse-media-sexual-crime",
              "adverse-media-terrorism",
              "adverse-media-v2-cybercrime",
              "adverse-media-v2-financial-aml-cft",
              "adverse-media-v2-financial-difficulty",
              "adverse-media-v2-fraud-linked",
              "adverse-media-v2-general-aml-cft",
              "adverse-media-v2-narcotics-aml-cft",
              "adverse-media-v2-other-financial",
              "adverse-media-v2-other-minor",
              "adverse-media-v2-other-serious",
              "adverse-media-v2-property",
              "adverse-media-v2-regulatory",
              "adverse-media-v2-terrorism",
              "adverse-media-v2-violence-aml-cft",
              "adverse-media-v2-violence-non-aml-cft",
              "adverse-media-violent-crime"
            ],
            "sources": ["ComplyAdvantage Adverse Media"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Vladmir Putin"
          },
          {
            "nameMatches": [
              {
                "matchTypes": ["equivalent_name"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": [
              "adverse-media",
              "adverse-media-financial-crime",
              "adverse-media-fraud",
              "adverse-media-general",
              "adverse-media-narcotics",
              "adverse-media-sexual-crime",
              "adverse-media-terrorism",
              "adverse-media-v2-cybercrime",
              "adverse-media-v2-financial-aml-cft",
              "adverse-media-v2-financial-difficulty",
              "adverse-media-v2-fraud-linked",
              "adverse-media-v2-general-aml-cft",
              "adverse-media-v2-narcotics-aml-cft",
              "adverse-media-v2-other-financial",
              "adverse-media-v2-other-minor",
              "adverse-media-v2-other-serious",
              "adverse-media-v2-property",
              "adverse-media-v2-regulatory",
              "adverse-media-v2-terrorism",
              "adverse-media-v2-violence-aml-cft",
              "adverse-media-v2-violence-non-aml-cft",
              "adverse-media-violent-crime"
            ],
            "sources": ["ComplyAdvantage Adverse Media"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Vladimr Putin"
          },
          {
            "nameMatches": [
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "vladimirovitch"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              }
            ],
            "amlTypes": [
              "adverse-media",
              "adverse-media-financial-crime",
              "adverse-media-fraud",
              "adverse-media-general",
              "adverse-media-narcotics",
              "adverse-media-sexual-crime",
              "adverse-media-terrorism",
              "adverse-media-v2-cybercrime",
              "adverse-media-v2-financial-aml-cft",
              "adverse-media-v2-financial-difficulty",
              "adverse-media-v2-fraud-linked",
              "adverse-media-v2-general-aml-cft",
              "adverse-media-v2-narcotics-aml-cft",
              "adverse-media-v2-other-financial",
              "adverse-media-v2-other-minor",
              "adverse-media-v2-other-serious",
              "adverse-media-v2-property",
              "adverse-media-v2-regulatory",
              "adverse-media-v2-terrorism",
              "adverse-media-v2-violence-aml-cft",
              "adverse-media-v2-violence-non-aml-cft",
              "adverse-media-violent-crime"
            ],
            "sources": ["ComplyAdvantage Adverse Media"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Vladimir Vladimirovitch Putin"
          },
          {
            "nameMatches": [
              {
                "matchTypes": ["equivalent_name"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": [
              "adverse-media",
              "adverse-media-financial-crime",
              "adverse-media-fraud",
              "adverse-media-general",
              "adverse-media-narcotics",
              "adverse-media-sexual-crime",
              "adverse-media-terrorism",
              "adverse-media-v2-cybercrime",
              "adverse-media-v2-financial-aml-cft",
              "adverse-media-v2-financial-difficulty",
              "adverse-media-v2-fraud-linked",
              "adverse-media-v2-general-aml-cft",
              "adverse-media-v2-narcotics-aml-cft",
              "adverse-media-v2-other-financial",
              "adverse-media-v2-other-minor",
              "adverse-media-v2-other-serious",
              "adverse-media-v2-property",
              "adverse-media-v2-regulatory",
              "adverse-media-v2-terrorism",
              "adverse-media-v2-violence-aml-cft",
              "adverse-media-v2-violence-non-aml-cft",
              "adverse-media-violent-crime"
            ],
            "sources": ["ComplyAdvantage Adverse Media"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Valdimir Putin"
          },
          {
            "nameMatches": [
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": [
              "adverse-media",
              "adverse-media-financial-crime",
              "adverse-media-fraud",
              "adverse-media-general",
              "adverse-media-narcotics",
              "adverse-media-sexual-crime",
              "adverse-media-terrorism",
              "adverse-media-v2-cybercrime",
              "adverse-media-v2-financial-aml-cft",
              "adverse-media-v2-financial-difficulty",
              "adverse-media-v2-fraud-linked",
              "adverse-media-v2-general-aml-cft",
              "adverse-media-v2-narcotics-aml-cft",
              "adverse-media-v2-other-financial",
              "adverse-media-v2-other-minor",
              "adverse-media-v2-other-serious",
              "adverse-media-v2-property",
              "adverse-media-v2-regulatory",
              "adverse-media-v2-terrorism",
              "adverse-media-v2-violence-aml-cft",
              "adverse-media-v2-violence-non-aml-cft",
              "adverse-media-violent-crime"
            ],
            "sources": ["ComplyAdvantage Adverse Media"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Vladimir Putin"
          },
          {
            "nameMatches": [
              {
                "matchTypes": ["equivalent_name"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": [
              "adverse-media",
              "adverse-media-financial-crime",
              "adverse-media-fraud",
              "adverse-media-general",
              "adverse-media-narcotics",
              "adverse-media-sexual-crime",
              "adverse-media-terrorism",
              "adverse-media-v2-cybercrime",
              "adverse-media-v2-financial-aml-cft",
              "adverse-media-v2-financial-difficulty",
              "adverse-media-v2-fraud-linked",
              "adverse-media-v2-general-aml-cft",
              "adverse-media-v2-narcotics-aml-cft",
              "adverse-media-v2-other-financial",
              "adverse-media-v2-other-minor",
              "adverse-media-v2-other-serious",
              "adverse-media-v2-property",
              "adverse-media-v2-regulatory",
              "adverse-media-v2-terrorism",
              "adverse-media-v2-violence-aml-cft",
              "adverse-media-v2-violence-non-aml-cft",
              "adverse-media-violent-crime"
            ],
            "sources": ["ComplyAdvantage Adverse Media"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Vlad Putin"
          },
          {
            "nameMatches": [
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": [
              "adverse-media",
              "adverse-media-financial-crime",
              "adverse-media-fraud",
              "adverse-media-general",
              "adverse-media-narcotics",
              "adverse-media-sexual-crime",
              "adverse-media-terrorism",
              "adverse-media-v2-cybercrime",
              "adverse-media-v2-financial-aml-cft",
              "adverse-media-v2-financial-difficulty",
              "adverse-media-v2-fraud-linked",
              "adverse-media-v2-general-aml-cft",
              "adverse-media-v2-narcotics-aml-cft",
              "adverse-media-v2-other-financial",
              "adverse-media-v2-other-minor",
              "adverse-media-v2-other-serious",
              "adverse-media-v2-property",
              "adverse-media-v2-regulatory",
              "adverse-media-v2-terrorism",
              "adverse-media-v2-violence-aml-cft",
              "adverse-media-v2-violence-non-aml-cft",
              "adverse-media-violent-crime"
            ],
            "sources": ["ComplyAdvantage Adverse Media"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Putin Vladimir"
          }
        ]
      }
    ],
    "createdAt": "2024-05-23 19:36:21",
    "ref": "1716492981-dBfqBtL_",
    "matchStatus": "potential_match",
    "totalHits": 1,
    "cached": false,
    "totalBlacklistHits": 0,
    "shareUrl": "https://app.us.complyadvantage.com/public/search/1716492981-dBfqBtL_/7b3b3ee11900",
    "id": 586037604,
    "totalMatches": 1,
    "updatedAt": "2024-05-23 19:36:21"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                  | Description                                                 |
| --------------------- | ----------------------------------------------------------- |
| Adverse Media matched | Indicates whether the individual has adverse media related. |
| {% endtab %}          |                                                             |
| {% endtabs %}         |                                                             |


# PEPs

The PEPs datasource is a data source containing information about Politically Exposed Persons (PEPs). PEPs are individuals who currently hold or have held significant public or political positions in governments, international organizations, state-owned enterprises, or political parties. These data sources are used in due diligence and compliance processes, especially in financial and business sectors, to identify and mitigate risks of money laundering, corruption, and terrorism financing. Information contained in PEPs datasources includes individuals' names, their political positions or roles, as well as any relevant associations that may pose a potential risk to an organization.

This service classifies each PEP at a certain level, which indicates the severity of the exposure.

**pep-class-1:** Heads of State Members of the national executive Members of national legislatures Senior military and law enforcement officials High-ranking officials of national agencies Members of central bank boards Senior officials of the judiciary (national level) High-ranking officials of high-level political parties.

**pep-class-2:** Members of the Boards of International Organizations (IOs) and International Sports Federations Ambassadors, high commissioners, and other high-level diplomatic positions Members of the regional executive Members of regional legislatures Senior officials in the regional judiciary.

**pep-class-3:** Senior managers and board members of state-owned companies and organizations.

**pep-class-4:** Mayors and local government officials (sub-regional level).

**Section**: `kycPepsLatamCountries or kycPepsEmergingCountries`

Each PEPs query can have two sections for each category, one Latam and one Emerging Countries. These categories are defined based on the country where you (Certta Client) are legally based.

**Latam:** We use the term "Latam," but it may not necessarily be from Latin America; we have included other countries in the list, but we continue to use the same service name, check the list below with the names of all countries included.

South Africa, Angola, Algeria, Benin, Botswana, Burkina Faso, Burundi, Cape Verde, Chad, Comoros, Democratic Republic of the Congo, Republic of the Congo, Ivory Coast, Djibouti, Egypt, Eritrea, Ethiopia, Gabon, Gambia, Ghana, Guinea, Equatorial Guinea, Lesotho, Liberia, Libya, Madagascar, Malawi, Mali, Morocco, Mauritius, Mauritania, Mayotte, Mozambique, Namibia, Niger, Nigeria, Kenya, Cameroon, Reunion, Rwanda, Western Sahara, Saint Helena, Sao Tome and Principe, Senegal, Sierra Leone, Seychelles, Somalia, Eswatini, Sudan, South Sudan, Tanzania, Togo, Tunisia, Uganda, Zambia, Zimbabwe, Central African Republic, and Guinea-Bissau.

**Section for customers who belong to the “Latam” group of countries:**

**- kycPepsLatamCountries**

**Emerging countries:** We use the term "Emerging countries," but it may not necessarily consist only of Emerging Countries; we have included other countries in the list, but we continue to use the same service name.

Anguilla, Antigua and Barbuda, Aruba, Bahamas, Barbados, Belize, Bermuda, Canada, Costa Rica, Cuba, Curaçao, Dominica, El Salvador, United States, Grenada, Greenland, Guadeloupe, Guatemala, Haiti, Honduras, Cayman Islands, United States Distant Islands, Turks and Caicos Islands, British Virgin Islands, U.S. Virgin Islands, Jamaica, Martinique, Mexico, Montserrat, Nicaragua, Caribbean Netherlands, Panama, Puerto Rico, Dominican Republic, Saint Pierre and Miquelon, Saint Lucia, Saint Barthélemy, Saint Kitts and Nevis, Saint Martin, Saint Vincent and the Grenadines, Saint Martin, Trinidad and Tobago, Argentina, Bolivia, Brazil, Chile, Colombia, Ecuador, Guyana, French Guiana, Falkland Islands, Paraguay, Peru, Suriname, Uruguay, Venezuela, Antarctica, South Georgia and the South Sandwich Islands, Bouvet Island, Heard Island and McDonald Islands, French Southern and Antarctic Lands, Afghanistan, Saudi Arabia, Armenia, Azerbaijan, Bahrain, Bangladesh, Brunei, Bhutan, Cambodia, Qatar, Kazakhstan, China, Singapore, North Korea, South Korea, United Arab Emirates, Philippines, Georgia, Hong Kong, Yemen, Christmas Island, India, Indonesia, Iran, Iraq, Israel, Japan, Jordan, Kuwait, Laos, Lebanon, Macau, Malaysia, Maldives, Myanmar (Burma), Mongolia, Nepal, Oman, Pakistan, Kyrgyzstan, Syria, Sri Lanka, Thailand, Taiwan, Tajikistan, British Indian Ocean Territory, Palestinian Territories, Turkmenistan, Uzbekistan, Vietnam, East Timor, Russia, Turkey, Bosnia and Herzegovina, Albania, Germany, Andorra, Austria, Belgium, Belarus, Bulgaria, Cyprus, Holy See, Croatia, Denmark, Slovakia, Slovenia, Spain, Estonia, Finland, France, Gibraltar, Greece, Guernsey, Netherlands, Hungary, Isle of Man, Åland Islands, Faroe Islands, Ireland, Iceland, Italy, Jersey, Latvia, Liechtenstein, Lithuania, Luxembourg, North Macedonia, Malta, Moldova, Monaco, Montenegro, Norway, Poland, Portugal, United Kingdom, Czech Republic, Romania, San Marino, Serbia, Sweden, Switzerland, Svalbard and Jan Mayen, Ukraine, Kosovo, Australia, Fiji, Guam, Norfolk Island, Cocos (Keeling) Islands, Cook Islands, Northern Mariana Islands, Marshall Islands, Pitcairn Islands, Solomon Islands, Micronesia, Nauru, Niue, New Caledonia, New Zealand, Palau, French Polynesia, Kiribati, Samoa, American Samoa, Tokelau, Tonga, Tuvalu, Vanuatu, Wallis and Futuna, Papua New Guinea.

**Section for customers who belong to the “Emerging Countries” group of countries:**

**- kycPepsEmergingCountries**

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

| Attribute    | Type   | Description                      | Mandatory |
| ------------ | ------ | -------------------------------- | --------- |
| name         | string | Full name of the individual.     | Yes       |
| birthDate    | string | Date of birth of the individual. | Yes       |
| countryCode  | string | Country code of the individual.  | Yes       |
| {% endtab %} |        |                                  |           |

{% tab title="Example body" %}

```javascript
body: JSON.stringify({
  workflowId: "6644843a90k8762k25929376",
  parameters: {
    name: "Vladimir Vladimirovitch Putin",
    birthDate: "07/10/1952",
    countryCode: "RU",
  },
});
```

{% endtab %}
{% endtabs %}

**Note:** Some fields returned by this API are optional and their presence cannot be guaranteed.

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

| Attribute                                                        | Type    | Description                                                                                                                                                                                       |
| ---------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| data                                                             | object  | Object containing the main data.                                                                                                                                                                  |
| data.riskLevel                                                   | string  | Risk level associated with the entity.                                                                                                                                                            |
| data.clientRef                                                   | string  | Client reference related to the hit.                                                                                                                                                              |
| data.blacklistHits                                               | array   | List of hits found in blacklist searches.                                                                                                                                                         |
| data.hits                                                        | array   | List of matches found.                                                                                                                                                                            |
| data.hits\[].doc                                                 | object  | Object containing information associated with the hit.                                                                                                                                            |
| data.hits\[].doc.types                                           | array   | List of types of information related to the hit.                                                                                                                                                  |
| data.hits\[].doc.associates                                      | array   | List of associates found.                                                                                                                                                                         |
| data.hits\[].doc.associates\[].name                              | string  | Name of the associated entity.                                                                                                                                                                    |
| data.hits\[].doc.associates\[].association                       | string  | Type of association with the entity (spouse, brother, etc.).                                                                                                                                      |
| data.hits\[].doc.sources                                         | array   | List of information sources, which can be state or private organizations and positions.                                                                                                           |
| data.hits\[].doc.keywords                                        | array   | List of keywords related to the hit.                                                                                                                                                              |
| data.hits\[].doc.sourceNotes                                     | object  | Additional notes from sources related to the hit.                                                                                                                                                 |
| data.hits\[].doc.sourceNotes                                     | object  | This object contains each type of source reported in “sources” with the respective information for each organization or position.                                                                 |
| data.hits\[].doc.sourceNotes.$type                               | object  | This type need to be replaced by any source of information or position (usCiaWorldLeaders, complyadvantage, eurasianEconomicUnionLeadership, russianPresident, etc.).                             |
| data.hits\[].doc.sourceNotes.$type.name                          | string  | Name of the organization or position.                                                                                                                                                             |
| data.hits\[].doc.sourceNotes.$type.amlTypes                      | array   | Types of related information of entity. This list contains the pep classes for each information (pep-class-1, pep-class-2, etc.).                                                                 |
| data.hits\[].doc.sourceNotes.$type.countryCodes                  | array   | Countries related to information.                                                                                                                                                                 |
| data.hits\[].doc.sourceNotes.$type.url                           | string  | Link to the source of information.                                                                                                                                                                |
| data.hits\[].doc.entityType                                      | string  | Type of entity (person, company, etc.).                                                                                                                                                           |
| data.hits\[].doc.media                                           | array   | List of media related to the hit. (news, websites, etc.).                                                                                                                                         |
| data.hits\[].doc.birthDate                                       | array   | List of possible birth dates related to the hit.                                                                                                                                                  |
| data.hits\[].doc.createdAt                                       | string  | Timestamp indicating when the hit was created.                                                                                                                                                    |
| data.hits\[].doc.countryCodes                                    | array   | Related countries of hit.                                                                                                                                                                         |
| data.hits\[].doc.assets                                          | array   | List of files related to the entity.                                                                                                                                                              |
| data.hits\[].doc.assets\[].publicUrl                             | string  | Public link of file.                                                                                                                                                                              |
| data.hits\[].doc.assets\[].source                                | string  | Source of information.                                                                                                                                                                            |
| data.hits\[].doc.assets\[].type                                  | string  | Type of file (picture, etc.).                                                                                                                                                                     |
| data.hits\[].doc.assets\[].url                                   | string  | File link.                                                                                                                                                                                        |
| data.hits\[].doc.aka                                             | array   | List of all aka related to the entity.                                                                                                                                                            |
| data.hits\[].doc.aka\[].name                                     | string  | Aka name.                                                                                                                                                                                         |
| data.hits\[].doc.name                                            | string  | Entity name of hit.                                                                                                                                                                               |
| data.hits\[].doc.deathDate                                       | string  | List of death dates related to the entity.                                                                                                                                                        |
| data.hits\[].doc.id                                              | string  | Unique identifier of the main record.                                                                                                                                                             |
| data.hits\[].doc.fields                                          | object  | This field contains all detailed information about each type of information related to the hit.                                                                                                   |
| data.hits\[].doc.fields.$type                                    | object  | This type needs to be replaced by a category, which will be named "pepClass" or "other".                                                                                                          |
| data.hits\[].doc.fields.$type.$information                       | array   | This information needs to be replaced with any name that references the origin of this information (usCiaWorldLeaders, complyadvantage, eurasianEconomicUnionLeadership, russianPresident, etc.). |
| data.hits\[].doc.fields.$type.$information\[].name               | string  | Indicates the type of information (Country, date of birth, other info, etc.).                                                                                                                     |
| data.hits\[].doc.fields.$type.$information\[].value              | string  | Field where the value of the information is, which can be text, link, date of birth, etc.                                                                                                         |
| data.hits\[].doc.fields.$type.$information\[].tag                | string  | Internal tag with tabulated values for the category of each information (date\_of\_birth, related\_url, country\_names, etc.).                                                                    |
| data.hits\[].score                                               | number  | Indicates the hit score value.                                                                                                                                                                    |
| data.hits\[].matchStatus                                         | string  | Indicates the hit status (potential\_match, true\_positive, etc.).                                                                                                                                |
| data.hits\[].isWhiteListed                                       | boolean | Indicates if the hit is in a white list.                                                                                                                                                          |
| data.hits\[].matchTypes                                          | array   | List of match types for each hit. (aka\_exact, year\_of\_birth, etc.).                                                                                                                            |
| data.hits\[].matchTypesDetails                                   | array   | Details of name matches, sources, and secondary matches for each entity. In this field, all hit information is analyzed individually, to classify them according to their relevance.              |
| data.hits\[].matchTypesDetails\[].nameMatches                    | array   | Information about each entity, including query terms and match types.                                                                                                                             |
| data.hits\[].matchTypesDetails\[].nameMatches\[].matchTypes      | array   | Classification of matches for the respective information (exact\_match, partial\_match, etc.).                                                                                                    |
| data.hits\[].matchTypesDetails\[].nameMatches\[].queryTerm       | string  | The specific query term used for the match. (name, date, etc.).                                                                                                                                   |
| data.hits\[].matchTypesDetails\[].amlTypes                       | array   | Type of classification associated with each match (pep-class-1, pep-class-2, etc.).                                                                                                               |
| data.hits\[].matchTypesDetails\[].sources                        | array   | Sources of hit information.                                                                                                                                                                       |
| data.hits\[].matchTypesDetails\[].secondaryMatches               | array   | Additional matches related to each individual information.                                                                                                                                        |
| data.hits\[].matchTypesDetails\[].secondaryMatches\[].matchTypes | array   | Classification of secondary matches for the respective information (exact\_match, partial\_match, etc.).                                                                                          |
| data.hits\[].matchTypesDetails\[].secondaryMatches\[].queryTerm  | string  | The specific query term used for the secondary match. (name, date, etc.).                                                                                                                         |
| data.hits\[].matchTypesDetails\[].matchingName                   | string  | The full name of each matched individual (Ex: Nicolás Maduro Moros).                                                                                                                              |
| data.createdAt                                                   | string  | Timestamp indicating when the record was created.                                                                                                                                                 |
| data.ref                                                         | string  | Reference identifier associated with the record.                                                                                                                                                  |
| data.matchStatus                                                 | string  | Final status of the query (no\_match, false\_positive, potential\_match, true\_positive, unknown, true\_positive\_approve, true\_positive\_reject).                                               |
| data.totalHits                                                   | number  | Total number of hits associated with the record.                                                                                                                                                  |
| data.cached                                                      | boolean | Indicates whether the record is cached.                                                                                                                                                           |
| data.totalBlacklistHits                                          | number  | Total number of hits in the blacklist associated with the record.                                                                                                                                 |
| data.shareUrl                                                    | string  | URL for sharing the record.                                                                                                                                                                       |
| data.id                                                          | number  | Unique identifier of the record.                                                                                                                                                                  |
| data.totalMatches                                                | number  | Total number of matches associated with the record.                                                                                                                                               |
| data.updatedAt                                                   | string  | Timestamp indicating when the record was updated.                                                                                                                                                 |
| statusCode                                                       | string  | References the status of this query only, not the entire transaction. [Check our status guide](/caf-api/connect/transactions/background-check)                                                    |
| {% endtab %}                                                     |         |                                                                                                                                                                                                   |

{% tab title="Example" %}

```json
{
  "data": {
    "riskLevel": "unknown",
    "clientRef": "caf-Vladimir Vladimirovitch Putin",
    "blacklistHits": [],
    "hits": [
      {
        "matchTypes": ["aka_exact", "name_variations_removal", "year_of_birth"],
        "doc": {
          "types": ["pep", "pep-class-1", "pep-class-2"],
          "associates": [
            {
              "name": "ABRAMCHENKO Victoria Valerievna",
              "association": "підлеглий"
            },
            {
              "name": "ABRAMOVICH Roman Arkadyevich",
              "association": "partner"
            },
            {
              "name": "AMELCHENKOVA / ZANKO Olga Nikolaevna",
              "association": "соратник"
            },
            {
              "name": "ANISIMOV Vasily Vasilievich",
              "association": "partner"
            },
            {
              "name": "AVDEEV Alexey Yurevich",
              "association": "підлеглий"
            },
            {
              "name": "AVEN Petr Olegovich",
              "association": "partner"
            },
            {
              "name": "AZIMOV Rakhim Azizboevich",
              "association": "соратник"
            },
            {
              "name": "Albert Putin",
              "association": "sibling"
            },
            {
              "name": "BABAKOV Alexander Mikhailovich",
              "association": "соратник"
            },
            {
              "name": "BAKHMETIEV / BAKHMETYEV Vitaly Viktorovich",
              "association": "соратник"
            },
            {
              "name": "BELOUSOV Andrey Removich",
              "association": "підлеглий"
            },
            {
              "name": "BICHAEV Artem Aleksandrovich",
              "association": "підлеглий"
            },
            {
              "name": "BLAVATNIK Leonid / Len / Leonardo Valentinovich",
              "association": "друг"
            },
            {
              "name": "BOGDANCHIKOV Sergei Mikhailovich",
              "association": "друг"
            },
            {
              "name": "BONDAREV Viktor Nikolayevich",
              "association": "колишній керівник"
            },
            {
              "name": "BORISOV Yury Ivanovich",
              "association": "підлеглий"
            },
            {
              "name": "BORTNIKOV Aleksandr Vasilievich",
              "association": "підлеглий"
            },
            {
              "name": "CHEMEZOV Sergey Viktorovich",
              "association": "соратник"
            },
            {
              "name": "DMITRIEV Kirill Aleksandrovich",
              "association": "partner"
            },
            {
              "name": "DRONOV Yaroslav Yuriyovych",
              "association": "Дронов Ярослав Юрійович, відомий під псевдонімом SHAMAN, 25 грудня 2023 року став довіреною особою Путіна Володимира Володимировича виборах президента Російської Федерації 2024, тим самим підтримуючи продовження геноциду та війни на території України."
            },
            {
              "name": "ERNST Konstantin Lvovich",
              "association": "partner"
            },
            {
              "name": "FAASSEN Jorrit Joost",
              "association": "зять"
            },
            {
              "name": "FADZAEV Arsen Suleymanovich",
              "association": "довірена особа"
            },
            {
              "name": "FETISOV Vyacheslav Aleksandrovich",
              "association": "друг"
            },
            {
              "name": "FRIDMAN Mikhail Maratovich",
              "association": "partner"
            },
            {
              "name": "GILMUTDINOV Ildar Irekovich",
              "association": "підлеглий"
            },
            {
              "name": "GOLIKOVA Tatyana Alekseevna",
              "association": "підлеглий"
            },
            {
              "name": "GORELOV Dmitrii Vladimirovich",
              "association": "друг"
            },
            {
              "name": "GROMOV Aleksey Alekseevich",
              "association": "підлеглий"
            },
            {
              "name": "GURTSKAIA Diana Gudaevna",
              "association": "довірена особа"
            },
            {
              "name": "GUTSAN Alexander Vladimirovich",
              "association": "підлеглий"
            },
            {
              "name": "Graceful",
              "association": "Property in the interest of"
            },
            {
              "name": "IVANAYEV Andrey Sergeyevich",
              "association": "partner"
            },
            {
              "name": "IVANOV Sergey Borisovich",
              "association": "підлеглий"
            },
            {
              "name": "Ironstone Marine Investments",
              "association": "Providing support"
            },
            {
              "name": "KABAYEVA Alina Maratovna",
              "association": "коханка"
            },
            {
              "name": "KANDYBOVICH Sergei Lvovich",
              "association": "довірена особа"
            },
            {
              "name": "KASTYUKEVICH Igor Yurievich",
              "association": "підлеглий"
            },
            {
              "name": "KHAN German Borisovich",
              "association": "друг"
            },
            {
              "name": "KHMARIN Victor Victorovich",
              "association": "друг"
            },
            {
              "name": "KLEBANOV Ilia Iosifovich",
              "association": "колега"
            },
            {
              "name": "KOLBIN Petro Viktorovych",
              "association": "друг"
            },
            {
              "name": "KOLBIN Vladimir Petrovich",
              "association": "друг"
            },
            {
              "name": "KOMAROV Igor Anatolyevich",
              "association": "підлеглий"
            },
            {
              "name": "KOSTIN Andrey Leonidovich",
              "association": "partner"
            },
            {
              "name": "KOSTYUKOV Igor Olegovich",
              "association": "підлеглий"
            },
            {
              "name": "KRIVONOGIKH Svetlana Alexandrovna",
              "association": "коханка"
            },
            {
              "name": "KUZMICHEV Alexey Viktorovich",
              "association": "ділові відносини"
            },
            {
              "name": "KUZNETSOV Mikhail Mikhailovich",
              "association": "підлеглий"
            },
            {
              "name": "Katerina Tikhonova",
              "association": "child"
            },
            {
              "name": "LITVINENKO Vladimir Stefanovich",
              "association": "соратник"
            },
            {
              "name": "Lyudmila Aleksandrovna Ocheretnaya",
              "association": "former spouse"
            },
            {
              "name": "Lyudmila Aleksandrovna Ocheretnaya",
              "association": "spouse"
            },
            {
              "name": "Lyudmila Putina",
              "association": "spouse"
            },
            {
              "name": "Lyudmila Shkrebneva",
              "association": "former spouse"
            },
            {
              "name": "MAGOMEDOV Dzhambulat Musaevich",
              "association": "довірена особа"
            },
            {
              "name": "MAMEDOV Alexey Khamrakulovich",
              "association": "підлеглий"
            },
            {
              "name": "MARKOV Sergei Alexandrovich",
              "association": "соратник"
            },
            {
              "name": "MEDVEDCHUK Viktor Volodymyrovich",
              "association": "кум"
            },
            {
              "name": "MELNICHENKO Andrey Igorevich",
              "association": "друг"
            },
            {
              "name": "MILLER / MILLIER Alexey Borisovich",
              "association": "друг"
            },
            {
              "name": "MIZINTSEV Mikhail Yevgenyevich",
              "association": "підлеглий"
            },
            {
              "name": "MURUGOV Viacheslav Aleksandrovich",
              "association": "довірена особа"
            },
            {
              "name": "Maria Vorontsova",
              "association": "child"
            },
            {
              "name": "Mariya Putina",
              "association": "child"
            },
            {
              "name": "NARUSOVA Lyudmila Borisovna",
              "association": "знайома"
            },
            {
              "name": "NEVALENNAIA Galina Ivanovna",
              "association": "довірена особа"
            },
            {
              "name": "NOVAK Alexander Valentinovich",
              "association": "підлеглий"
            },
            {
              "name": "O'Neill Assets Corporation",
              "association": "Providing support"
            },
            {
              "name": "OCHERETNAYA Lyudmila Alexandrovna",
              "association": "колишня дружина"
            },
            {
              "name": "OSEEVSKY Mikhail Eduardovich",
              "association": "partner"
            },
            {
              "name": "OSIPOV Igor Vladimirovich",
              "association": "підлеглий"
            },
            {
              "name": "OVERCHUK Alexey Logvinovich",
              "association": "підлеглий"
            },
            {
              "name": "Olympia",
              "association": "Property in the interest of"
            },
            {
              "name": "PIROG Dmitry Yurievich",
              "association": "підлеглий"
            },
            {
              "name": "PODNOSOVA Irina Leonidovna",
              "association": "соратник"
            },
            {
              "name": "PORYVAI Natalia Vladimirovna",
              "association": "соратник"
            },
            {
              "name": "PUTIN Igor Aleksandrovich",
              "association": "двоюрідний брат"
            },
            {
              "name": "PUTIN Mikhail Evgenevich",
              "association": "двоюрідний племінник"
            },
            {
              "name": "PUTIN Roman Igorevich",
              "association": "двоюрідний племінник"
            },
            {
              "name": "PUTINA / PODGUZOVA Vera Alexandrovna",
              "association": "двоюрідна племінниця"
            },
            {
              "name": "PUTINA / TIKHONOVA Katerina / Ekaterina Vladimirovna",
              "association": "дочка"
            },
            {
              "name": "PUTINA / VORONTSOVA / FAASSEN Maria Vladimirovna",
              "association": "дочка"
            },
            {
              "name": "RAGIMOV Ilgam Mamedgasanovich",
              "association": "друг"
            },
            {
              "name": "RAHIMKULOV Megdet Nigmatovich",
              "association": "соратник"
            },
            {
              "name": "ROLDUGIN Sergei Pavlovich",
              "association": "кум"
            },
            {
              "name": "ROTENBERG Igor Arkadyevich",
              "association": "partner"
            },
            {
              "name": "RUDNOV Sergei Olegovich",
              "association": "друг"
            },
            {
              "name": "SALYUKOV Oleg Leonydovych",
              "association": "підлеглий"
            },
            {
              "name": "SCHRÖDER Gerhard Fritz Kurt",
              "association": "ділові відносини"
            },
            {
              "name": "SECHIN Igor Ivanovich",
              "association": "друг"
            },
            {
              "name": "SERYSHEV Anatoly Anatolyevich",
              "association": "ділові відносини"
            },
            {
              "name": "SHAFIGULLIN Airat Radinovich",
              "association": "радник"
            },
            {
              "name": "SHAMALOV Kirill Nikolaevich",
              "association": "зять"
            },
            {
              "name": "SHAMALOV Nikolay Terentievich",
              "association": "друг"
            },
            {
              "name": "SHCHEGOLEV Igor Olegovich",
              "association": "підлеглий"
            },
            {
              "name": "SHELOMOV Mikhail Lvovich",
              "association": "двоюрідний племінник"
            },
            {
              "name": "SIMONYAN Margarita Simonovna",
              "association": "partner"
            },
            {
              "name": "SMIRNOV Vladimir Alekseevich",
              "association": "соратник"
            },
            {
              "name": "TIMCHENKO Gennady Nikolayevich",
              "association": "знайомий"
            },
            {
              "name": "TRABER Ilya Ilyich",
              "association": "друг"
            },
            {
              "name": "TRUTNEV Yury Petrovich",
              "association": "помічник"
            },
            {
              "name": "TSIVILEV Sergey Evgenievich",
              "association": "родич"
            },
            {
              "name": "TSOMAEVA / SHKREBNEVA Olga Alexandrovna",
              "association": "своячка"
            },
            {
              "name": "YATSKYN Andrei Vladimirovich",
              "association": "колишній підлеглий"
            },
            {
              "name": "YEVMENOV Nikolay Anatolyevich",
              "association": "підлеглий"
            },
            {
              "name": "Yekaterina Putina",
              "association": "child"
            },
            {
              "name": "ZHURAVLYOV Alexander Alexandrovich",
              "association": "підлеглий"
            },
            {
              "name": "ZOLOTOV Viktor Vasiliyevich",
              "association": "підлеглий"
            },
            {
              "name": "Воронцова Мария Владимировна",
              "association": "child"
            }
          ],
          "sources": [
            "complyadvantage",
            "eurasian-economic-union-leadership",
            "russia-president",
            "russia-security-council-leadership",
            "russia-state-council-leadership",
            "us-cia-world-leaders"
          ],
          "keywords": [],
          "sourceNotes": {
            "usCiaWorldLeaders": {
              "name": "Central Intelligence Agency Foreign Governments Leadership",
              "countryCodes": ["RU"],
              "amlTypes": ["pep-class-1"],
              "url": "https://www.cia.gov/resources/world-leaders/foreign-governments/"
            },
            "complyadvantage": {
              "amlTypes": ["pep", "pep-class-1"],
              "name": "ComplyAdvantage PEP Data",
              "countryCodes": ["RU"]
            },
            "russiaPresident": {
              "name": "Russia President",
              "countryCodes": ["RU"],
              "amlTypes": ["pep-class-1"],
              "url": "http://putin.kremlin.ru/bio"
            },
            "russiaStateCouncilLeadership": {
              "name": "Russia State Council Leadership",
              "countryCodes": ["RU"],
              "amlTypes": ["pep-class-1"],
              "url": "http://www.kremlin.ru/structure/state-council"
            },
            "russiaSecurityCouncilLeadership": {
              "name": "Russia Security Council Leadership",
              "countryCodes": ["RU"],
              "amlTypes": ["pep-class-1"],
              "url": "http://www.kremlin.ru/structure/security-council"
            },
            "eurasianEconomicUnionLeadership": {
              "name": "Eurasian Economic Union Leadership",
              "countryCodes": ["RU"],
              "amlTypes": ["pep-class-2"],
              "url": "http://www.eaeunion.org/"
            }
          },
          "entityType": "person",
          "media": [],
          "birthDate": ["1952", "1952-07-10", "1952-10-07"],
          "createdAt": "2024-05-17T11:01:44Z",
          "countryCodes": ["RU"],
          "assets": [
            {
              "publicUrl": "http://complyadvantage-asset-development.s3.amazonaws.com/3e61820f-94d2-4846-a000-923812d19c72.jpg",
              "source": "complyadvantage",
              "type": "picture",
              "url": "http://structure.mil.ru/images/putin_170x240.jpg"
            }
          ],
          "aka": [
            {
              "name": "Vladimir Vladimirovich Putin"
            },
            {
              "name": "Putin Vladimir Vladimirovich"
            },
            {
              "name": "Vladimir Putin"
            },
            {
              "name": "Poutine Vladimir Vladimirovich"
            },
            {
              "name": "Владимир Путин"
            },
            {
              "name": "Путин Владимир Владимирович"
            }
          ],
          "name": "Vladimir Putin",
          "deathDate": [],
          "id": "0B0W202J9DBQURT",
          "fields": {
            "pepClass2": {
              "eurasianEconomicUnionLeadership": [
                {
                  "name": "Original Country Text",
                  "value": "International"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Political Position",
                  "value": "Member of the Eurasian Economic Union Leadership",
                  "tag": "political_position"
                },
                {
                  "name": "Chamber",
                  "value": "Eurasian Economic Union Leadership"
                },
                {
                  "name": "Institution Type",
                  "value": "International Organization"
                },
                {
                  "name": "Locationurl",
                  "value": "http://www.eaeunion.org/?lang=kk"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "http://www.eaeunion.org/?lang=kk"
                }
              ]
            },
            "pepClass1": {
              "usCiaWorldLeaders": [
                {
                  "name": "Original Country Text",
                  "value": "International"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Chamber",
                  "value": "National Government"
                },
                {
                  "name": "Institution Type",
                  "value": "National Cabinet"
                },
                {
                  "name": "Other Info",
                  "value": "Pres."
                },
                {
                  "name": "Locationurl",
                  "value": "https://www.cia.gov/resources/world-leaders/foreign-governments/russia"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://www.cia.gov/resources/world-leaders/foreign-governments/russia"
                }
              ],
              "complyadvantage": [
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russian Federation"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-07-10",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Political Position",
                  "value": "Президент Российской Федерации – Верховный Главнокомандующий Вооруженными Силами Российской Федерации",
                  "tag": "political_position"
                },
                {
                  "name": "Chamber",
                  "value": "Ministry of Defence"
                },
                {
                  "name": "Related URL",
                  "value": "Www.Mil.Ru",
                  "tag": "related_url"
                },
                {
                  "name": "Locationurl",
                  "value": "https://dbpedia.org/data/Vladimir_Putin.json"
                },
                {
                  "name": "Locationurl",
                  "value": "https://dbpedia.org/page/Maria_Vorontsova"
                },
                {
                  "name": "Locationurl",
                  "value": "https://en.wikipedia.org/wiki/Vladimir_Putin"
                },
                {
                  "name": "Locationurl",
                  "value": "https://www.google.com/search?hl=en-us&q=Poutine+Vladimir+Vladimirovich+Russian+Federation+year+of+birth&ucbcb=1"
                },
                {
                  "name": "Locationurl",
                  "value": "https://www.google.com/search?hl=en-us&q=who+is+Poutine+Vladimir+Vladimirovich&ucbcb=1"
                },
                {
                  "name": "Locationurl",
                  "value": "https://www.google.com/search?hl=en-us&q=who+is+Putin+Vladimir+Vladimirovich&ucbcb=1"
                },
                {
                  "name": "Locationurl",
                  "value": "https://www.google.com/search?hl=en-us&q=who+is+Vladimir+Putin&ucbcb=1"
                },
                {
                  "name": "Picture URL Internal",
                  "value": "http://complyadvantage-asset-development.s3.amazonaws.com/3e61820f-94d2-4846-a000-923812d19c72.jpg"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "http://structure.mil.ru/management/leader.htm"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://dbpedia.org/data/Vladimir_Putin.json"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://dbpedia.org/page/Maria_Vorontsova"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://en.wikipedia.org/wiki/Vladimir_Putin"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://www.google.com/search?hl=en-us&q=Poutine+Vladimir+Vladimirovich+Russian+Federation+year+of+birth&ucbcb=1"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://www.google.com/search?hl=en-us&q=who+is+Poutine+Vladimir+Vladimirovich&ucbcb=1"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://www.google.com/search?hl=en-us&q=who+is+Putin+Vladimir+Vladimirovich&ucbcb=1"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://www.google.com/search?hl=en-us&q=who+is+Vladimir+Putin&ucbcb=1"
                }
              ],
              "russiaPresident": [
                {
                  "name": "Original Place of Birth Text",
                  "value": "Leningrad"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russian Federation"
                },
                {
                  "name": "Active Start Date",
                  "value": "2018-03-18",
                  "tag": "active_start_date"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Political Position",
                  "value": "President",
                  "tag": "political_position"
                },
                {
                  "name": "Chamber",
                  "value": "Presidency"
                },
                {
                  "name": "Institution Type",
                  "value": "Head of State"
                },
                {
                  "name": "Locationurl",
                  "value": "http://en.putin.kremlin.ru/bio/page-0"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "http://en.putin.kremlin.ru/bio/page-0"
                }
              ],
              "russiaStateCouncilLeadership": [
                {
                  "name": "Original Place of Birth Text",
                  "value": "Ленинграде"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Active Start Date",
                  "value": "2018-03-18",
                  "tag": "active_start_date"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Political Position",
                  "value": "Senior Government Official",
                  "tag": "political_position"
                },
                {
                  "name": "Chamber",
                  "value": "State Council"
                },
                {
                  "name": "Function",
                  "value": "Председатель Государственного Совета"
                },
                {
                  "name": "Institution Type",
                  "value": "Agency under Office of the Head of State"
                },
                {
                  "name": "Other Info",
                  "value": "Президент Российской Федерации"
                },
                {
                  "name": "Locationurl",
                  "value": "http://www.kremlin.ru/catalog/persons/54/biography"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "http://www.kremlin.ru/catalog/persons/54/biography"
                }
              ],
              "russiaSecurityCouncilLeadership": [
                {
                  "name": "Original Place of Birth Text",
                  "value": "Ленинграде"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Political Position",
                  "value": "Senior Government Official",
                  "tag": "political_position"
                },
                {
                  "name": "Chamber",
                  "value": "Security Council"
                },
                {
                  "name": "Function",
                  "value": "Председатель Совета Безопасности"
                },
                {
                  "name": "Institution Type",
                  "value": "Agency under Office of the Head of State"
                },
                {
                  "name": "Other Info",
                  "value": "Президент Российской Федерации"
                },
                {
                  "name": "Locationurl",
                  "value": "http://www.kremlin.ru/catalog/persons/54/biography"
                }
              ]
            },
            "pep": {
              "complyadvantage": [
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russian Federation"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-07-10",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Political Position",
                  "value": "Президент Российской Федерации – Верховный Главнокомандующий Вооруженными Силами Российской Федерации",
                  "tag": "political_position"
                },
                {
                  "name": "Chamber",
                  "value": "Ministry of Defence"
                },
                {
                  "name": "Related URL",
                  "value": "Www.Mil.Ru",
                  "tag": "related_url"
                },
                {
                  "name": "Locationurl",
                  "value": "https://dbpedia.org/data/Vladimir_Putin.json"
                },
                {
                  "name": "Locationurl",
                  "value": "https://dbpedia.org/page/Maria_Vorontsova"
                },
                {
                  "name": "Locationurl",
                  "value": "https://en.wikipedia.org/wiki/Vladimir_Putin"
                },
                {
                  "name": "Locationurl",
                  "value": "https://www.google.com/search?hl=en-us&q=Poutine+Vladimir+Vladimirovich+Russian+Federation+year+of+birth&ucbcb=1"
                },
                {
                  "name": "Locationurl",
                  "value": "https://www.google.com/search?hl=en-us&q=who+is+Poutine+Vladimir+Vladimirovich&ucbcb=1"
                },
                {
                  "name": "Locationurl",
                  "value": "https://www.google.com/search?hl=en-us&q=who+is+Putin+Vladimir+Vladimirovich&ucbcb=1"
                },
                {
                  "name": "Locationurl",
                  "value": "https://www.google.com/search?hl=en-us&q=who+is+Vladimir+Putin&ucbcb=1"
                },
                {
                  "name": "Picture URL Internal",
                  "value": "http://complyadvantage-asset-development.s3.amazonaws.com/3e61820f-94d2-4846-a000-923812d19c72.jpg"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "http://structure.mil.ru/management/leader.htm"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://dbpedia.org/data/Vladimir_Putin.json"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://dbpedia.org/page/Maria_Vorontsova"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://en.wikipedia.org/wiki/Vladimir_Putin"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://www.google.com/search?hl=en-us&q=Poutine+Vladimir+Vladimirovich+Russian+Federation+year+of+birth&ucbcb=1"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://www.google.com/search?hl=en-us&q=who+is+Poutine+Vladimir+Vladimirovich&ucbcb=1"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://www.google.com/search?hl=en-us&q=who+is+Putin+Vladimir+Vladimirovich&ucbcb=1"
                },
                {
                  "name": "Related Url",
                  "tag": "related_url",
                  "locale": "en",
                  "value": "https://www.google.com/search?hl=en-us&q=who+is+Vladimir+Putin&ucbcb=1"
                }
              ]
            },
            "other": {
              "countries": [
                {
                  "name": "Countries",
                  "value": "Russian Federation",
                  "tag": "country_names"
                }
              ]
            }
          },
          "updatedAt": "2024-05-20T16:18:34Z"
        },
        "score": 2,
        "matchStatus": "potential_match",
        "isWhitelisted": false,
        "matchTypesDetails": [
          {
            "nameMatches": [
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": ["pep", "pep-class-1"],
            "sources": ["ComplyAdvantage PEP Data"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Vladimir Putin"
          },
          {
            "nameMatches": [
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": ["pep", "pep-class-1"],
            "sources": ["Russia President"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Vladimir Putin"
          },
          {
            "nameMatches": [
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": ["pep", "pep-class-1"],
            "sources": ["ComplyAdvantage PEP Data"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Vladimir Putin"
          },
          {
            "nameMatches": [
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": ["pep", "pep-class-1"],
            "sources": ["ComplyAdvantage PEP Data"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Vladimir Putin"
          },
          {
            "nameMatches": [
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": ["pep", "pep-class-2"],
            "sources": ["Eurasian Economic Union Leadership"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Vladimir Putin"
          }
        ]
      }
    ],
    "createdAt": "2024-05-20 16:48:36",
    "ref": "1716223716-5f_EHogz",
    "matchStatus": "potential_match",
    "totalHits": 1,
    "cached": false,
    "totalBlacklistHits": 0,
    "shareUrl": "https://app.us.complyadvantage.com/public/search/1716223716-5f_EHogz/c11a3b608117",
    "id": 584828374,
    "totalMatches": 1,
    "updatedAt": "2024-05-20 16:48:36"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule          | Description                                                       |
| ------------- | ----------------------------------------------------------------- |
| PEPs matched  | Indicates whether the individual is a politically exposed person. |
| {% endtab %}  |                                                                   |
| {% endtabs %} |                                                                   |


# Warnings

The Warnings datasource is a data source containing information about individuals internationally sought by Interpol. Interpol (International Criminal Police Organization) maintains a database of international arrest warrants issued by judicial authorities of its member countries. These warrants are issued for individuals wanted for suspicion or accusation of serious crimes such as terrorism, drug trafficking, financial crimes, violent crimes, among others. The information contained in Interpol's lists includes the names of wanted individuals, their photographs, physical descriptions, details of the crimes they are wanted for, and other relevant information to facilitate their identification and location on a global scale. These lists are used by law enforcement authorities, security agencies, and other entities responsible for law enforcement worldwide for the capture and extradition of international fugitives.

**Section**: `kycWarningsLatamCountries or kycWarningsEmergingCountries`

Each Warnings query can have two sections for each category, one Latam and one Emerging Countries. These categories are defined based on the country where you (Certta Client) are legally based.

**Latam:** We use the term "Latam," but it may not necessarily be from Latin America; we have included other countries in the list, but we continue to use the same service name, check the list below with the names of all countries included.

South Africa, Angola, Algeria, Benin, Botswana, Burkina Faso, Burundi, Cape Verde, Chad, Comoros, Democratic Republic of the Congo, Republic of the Congo, Ivory Coast, Djibouti, Egypt, Eritrea, Ethiopia, Gabon, Gambia, Ghana, Guinea, Equatorial Guinea, Lesotho, Liberia, Libya, Madagascar, Malawi, Mali, Morocco, Mauritius, Mauritania, Mayotte, Mozambique, Namibia, Niger, Nigeria, Kenya, Cameroon, Reunion, Rwanda, Western Sahara, Saint Helena, Sao Tome and Principe, Senegal, Sierra Leone, Seychelles, Somalia, Eswatini, Sudan, South Sudan, Tanzania, Togo, Tunisia, Uganda, Zambia, Zimbabwe, Central African Republic, and Guinea-Bissau.

**Section for customers who belong to the “Latam” group of countries:**

**- kycWarningsLatamCountries**

**Emerging countries:** We use the term "Emerging countries," but it may not necessarily consist only of Emerging Countries; we have included other countries in the list, but we continue to use the same service name.

Anguilla, Antigua and Barbuda, Aruba, Bahamas, Barbados, Belize, Bermuda, Canada, Costa Rica, Cuba, Curaçao, Dominica, El Salvador, United States, Grenada, Greenland, Guadeloupe, Guatemala, Haiti, Honduras, Cayman Islands, United States Distant Islands, Turks and Caicos Islands, British Virgin Islands, U.S. Virgin Islands, Jamaica, Martinique, Mexico, Montserrat, Nicaragua, Caribbean Netherlands, Panama, Puerto Rico, Dominican Republic, Saint Pierre and Miquelon, Saint Lucia, Saint Barthélemy, Saint Kitts and Nevis, Saint Martin, Saint Vincent and the Grenadines, Saint Martin, Trinidad and Tobago, Argentina, Bolivia, Brazil, Chile, Colombia, Ecuador, Guyana, French Guiana, Falkland Islands, Paraguay, Peru, Suriname, Uruguay, Venezuela, Antarctica, South Georgia and the South Sandwich Islands, Bouvet Island, Heard Island and McDonald Islands, French Southern and Antarctic Lands, Afghanistan, Saudi Arabia, Armenia, Azerbaijan, Bahrain, Bangladesh, Brunei, Bhutan, Cambodia, Qatar, Kazakhstan, China, Singapore, North Korea, South Korea, United Arab Emirates, Philippines, Georgia, Hong Kong, Yemen, Christmas Island, India, Indonesia, Iran, Iraq, Israel, Japan, Jordan, Kuwait, Laos, Lebanon, Macau, Malaysia, Maldives, Myanmar (Burma), Mongolia, Nepal, Oman, Pakistan, Kyrgyzstan, Syria, Sri Lanka, Thailand, Taiwan, Tajikistan, British Indian Ocean Territory, Palestinian Territories, Turkmenistan, Uzbekistan, Vietnam, East Timor, Russia, Turkey, Bosnia and Herzegovina, Albania, Germany, Andorra, Austria, Belgium, Belarus, Bulgaria, Cyprus, Holy See, Croatia, Denmark, Slovakia, Slovenia, Spain, Estonia, Finland, France, Gibraltar, Greece, Guernsey, Netherlands, Hungary, Isle of Man, Åland Islands, Faroe Islands, Ireland, Iceland, Italy, Jersey, Latvia, Liechtenstein, Lithuania, Luxembourg, North Macedonia, Malta, Moldova, Monaco, Montenegro, Norway, Poland, Portugal, United Kingdom, Czech Republic, Romania, San Marino, Serbia, Sweden, Switzerland, Svalbard and Jan Mayen, Ukraine, Kosovo, Australia, Fiji, Guam, Norfolk Island, Cocos (Keeling) Islands, Cook Islands, Northern Mariana Islands, Marshall Islands, Pitcairn Islands, Solomon Islands, Micronesia, Nauru, Niue, New Caledonia, New Zealand, Palau, French Polynesia, Kiribati, Samoa, American Samoa, Tokelau, Tonga, Tuvalu, Vanuatu, Wallis and Futuna, Papua New Guinea.

**Section for customers who belong to the “Emerging Countries” group of countries:**

**- kycWarningsEmergingCountries**

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

| Attribute    | Type   | Description                      | Mandatory |
| ------------ | ------ | -------------------------------- | --------- |
| name         | string | Full name of the individual.     | Yes       |
| birthDate    | string | Date of birth of the individual. | Yes       |
| countryCode  | string | Country code of the individual.  | Yes       |
| {% endtab %} |        |                                  |           |

{% tab title="Example body" %}

```javascript
body: JSON.stringify({
  workflowId: "6644843a90k8762k25929376",
  parameters: {
    name: "Vladimir Vladimirovitch Putin",
    birthDate: "07/10/1952",
    countryCode: "RU",
  },
});
```

{% endtab %}
{% endtabs %}

**Note:** Some fields returned by this API are optional and their presence cannot be guaranteed.

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

| Attribute                                                        | Type    | Description                                                                                                                                                                                       |
| ---------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| data                                                             | object  | Object containing the main data.                                                                                                                                                                  |
| data.riskLevel                                                   | string  | Risk level associated with the entity.                                                                                                                                                            |
| data.clientRef                                                   | string  | Client reference related to the hit.                                                                                                                                                              |
| data.blacklistHits                                               | array   | List of hits found in blacklist searches.                                                                                                                                                         |
| data.hits                                                        | array   | List of matches found.                                                                                                                                                                            |
| data.hits\[].doc                                                 | object  | Object containing information associated with the hit.                                                                                                                                            |
| data.hits\[].doc.types                                           | array   | List of types of information related to the hit.                                                                                                                                                  |
| data.hits\[].doc.associates                                      | array   | List of associates found.                                                                                                                                                                         |
| data.hits\[].doc.associates\[].name                              | string  | Name of the associated entity.                                                                                                                                                                    |
| data.hits\[].doc.associates\[].association                       | string  | Type of association with the entity (spouse, brother, etc.).                                                                                                                                      |
| data.hits\[].doc.sources                                         | array   | List of sources of sanctions applied to the hit.                                                                                                                                                  |
| data.hits\[].doc.keywords                                        | array   | List of keywords related to the hit.                                                                                                                                                              |
| data.hits\[].doc.sourceNotes                                     | object  | Additional notes from sources related to the hit.                                                                                                                                                 |
| data.hits\[].doc.sourceNotes                                     | object  | This object contains each type of source reported in "sources" with the respective information for each sanction applied.                                                                         |
| data.hits\[].doc.sourceNotes.$type                               | object  | This type need to be replaced by any applied sanctions list variation (specialEconomicMeasuresAct, europeSanctionsList, ofacSdnList, monacoEconomicSanctions, etc.).                              |
| data.hits\[].doc.sourceNotes.$type.name                          | string  | Name of the organization responsible for the sanctions list.                                                                                                                                      |
| data.hits\[].doc.sourceNotes.$type.listingStartedUtc             | string  | Date of publication of the sanction.                                                                                                                                                              |
| data.hits\[].doc.sourceNotes.$type.amlTypes                      | array   | Types of related information of entity.                                                                                                                                                           |
| data.hits\[].doc.sourceNotes.$type.countryCodes                  | array   | Related countries of list.                                                                                                                                                                        |
| data.hits\[].doc.sourceNotes.$type.url                           | string  | Link to the list of sanctions applied.                                                                                                                                                            |
| data.hits\[].doc.entityType                                      | string  | Type of entity (person, company, etc.).                                                                                                                                                           |
| data.hits\[].doc.media                                           | array   | List of media related to the hit. (news, websites, etc.).                                                                                                                                         |
| data.hits\[].doc.birthDate                                       | array   | List of possible birth dates related to the hit.                                                                                                                                                  |
| data.hits\[].doc.createdAt                                       | string  | Timestamp indicating when the hit was created.                                                                                                                                                    |
| data.hits\[].doc.countryCodes                                    | array   | Related countries of hit.                                                                                                                                                                         |
| data.hits\[].doc.assets                                          | array   | List of files related to the entity.                                                                                                                                                              |
| data.hits\[].doc.assets\[].publicUrl                             | string  | Public link of file.                                                                                                                                                                              |
| data.hits\[].doc.assets\[].source                                | string  | Source of information.                                                                                                                                                                            |
| data.hits\[].doc.assets\[].type                                  | string  | Type of file (picture, etc.).                                                                                                                                                                     |
| data.hits\[].doc.assets\[].url                                   | string  | File link.                                                                                                                                                                                        |
| data.hits\[].doc.aka                                             | array   | List of all aka related to the entity.                                                                                                                                                            |
| data.hits\[].doc.aka\[].name                                     | string  | Aka name.                                                                                                                                                                                         |
| data.hits\[].doc.name                                            | string  | Entity name of hit.                                                                                                                                                                               |
| data.hits\[].doc.deathDate                                       | string  | List of death dates related to the entity.                                                                                                                                                        |
| data.hits\[].doc.id                                              | string  | Unique identifier of the main record.                                                                                                                                                             |
| data.hits\[].doc.fields                                          | object  | This field contains all detailed information about each type of information related to the hit.                                                                                                   |
| data.hits\[].doc.fields.$type                                    | object  | This type needs to be replaced by a category, which will be named "sanction" or "other".                                                                                                          |
| data.hits\[].doc.fields.$type.$information                       | array   | This information needs to be replaced with any name that references the origin of this information (specialEconomicMeasuresAct, europeSanctionsList, ofacSdnList, monacoEconomicSanctions, etc.). |
| data.hits\[].doc.fields.$type.$information\[].name               | string  | Indicates the type of information (Sanction type, date of birth, other info, etc.).                                                                                                               |
| data.hits\[].doc.fields.$type.$information\[].value              | string  | Field where the value of the information is, which can be text, link, date of birth, etc.                                                                                                         |
| data.hits\[].doc.fields.$type.$information\[].tag                | string  | Internal tag with tabulated values for the category of each information (date\_of\_birth, related\_url, country\_names, etc.).                                                                    |
| data.hits\[].score                                               | number  | Indicates the hit score value.                                                                                                                                                                    |
| data.hits\[].matchStatus                                         | string  | Indicates the hit status (potential\_match, true\_positive, etc.).                                                                                                                                |
| data.hits\[].isWhiteListed                                       | boolean | Indicates if the hit is in a white list.                                                                                                                                                          |
| data.hits\[].matchTypes                                          | array   | List of match types for each hit. (aka\_exact, year\_of\_birth, etc.).                                                                                                                            |
| data.hits\[].matchTypesDetails                                   | array   | Details of name matches, sources, and secondary matches for each entity. In this field, all hit information is analyzed individually, to classify them according to their relevance.              |
| data.hits\[].matchTypesDetails\[].nameMatches                    | array   | Information about each entity, including query terms and match types.                                                                                                                             |
| data.hits\[].matchTypesDetails\[].nameMatches\[].matchTypes      | array   | Classification of matches for the respective information (exact\_match, partial\_match, etc.).                                                                                                    |
| data.hits\[].matchTypesDetails\[].nameMatches\[].queryTerm       | string  | The specific query term used for the match. (name, date, etc.).                                                                                                                                   |
| data.hits\[].matchTypesDetails\[].amlTypes                       | array   | Type of information associated with each match (sanction).                                                                                                                                        |
| data.hits\[].matchTypesDetails\[].sources                        | array   | Sources where each individual is listed for sanctions.                                                                                                                                            |
| data.hits\[].matchTypesDetails\[].secondaryMatches               | array   | Additional matches related to each individual information.                                                                                                                                        |
| data.hits\[].matchTypesDetails\[].secondaryMatches\[].matchTypes | array   | Classification of secondary matches for the respective information (exact\_match, partial\_match, etc.).                                                                                          |
| data.hits\[].matchTypesDetails\[].secondaryMatches\[].queryTerm  | string  | The specific query term used for the secondary match. (name, date, etc.).                                                                                                                         |
| data.hits\[].matchTypesDetails\[].matchingName                   | string  | The full name of each matched individual (Ex: Nicolás Maduro Moros).                                                                                                                              |
| data.createdAt                                                   | string  | Timestamp indicating when the record was created.                                                                                                                                                 |
| data.ref                                                         | string  | Reference identifier associated with the record.                                                                                                                                                  |
| data.matchStatus                                                 | string  | Final status of the query (no\_match, false\_positive, potential\_match, true\_positive, unknown, true\_positive\_approve, true\_positive\_reject).                                               |
| data.totalHits                                                   | number  | Total number of hits associated with the record.                                                                                                                                                  |
| data.cached                                                      | boolean | Indicates whether the record is cached.                                                                                                                                                           |
| data.totalBlacklistHits                                          | number  | Total number of hits in the blacklist associated with the record.                                                                                                                                 |
| data.shareUrl                                                    | string  | URL for sharing the record.                                                                                                                                                                       |
| data.id                                                          | number  | Unique identifier of the record.                                                                                                                                                                  |
| data.totalMatches                                                | number  | Total number of matches associated with the record.                                                                                                                                               |
| data.updatedAt                                                   | string  | Timestamp indicating when the record was updated.                                                                                                                                                 |
| statusCode                                                       | string  | References the status of this query only, not the entire transaction. [Check our status guide](/caf-api/connect/transactions/background-check)                                                    |
| {% endtab %}                                                     |         |                                                                                                                                                                                                   |

{% tab title="Example" %}

```json
{
  "data": {
    "riskLevel": "unknown",
    "clientRef": "caf-Vladimir Vladimirovitch Putin",
    "blacklistHits": [],
    "hits": [
      {
        "matchTypes": ["aka_exact", "name_variations_removal", "year_of_birth"],
        "doc": {
          "types": ["warning"],
          "associates": [
            {
              "name": "ABRAMCHENKO Victoria Valerievna",
              "association": "підлеглий"
            },
            {
              "name": "ABRAMOVICH Roman Arkadyevich",
              "association": "partner"
            },
            {
              "name": "AMELCHENKOVA / ZANKO Olga Nikolaevna",
              "association": "соратник"
            },
            {
              "name": "ANISIMOV Vasily Vasilievich",
              "association": "partner"
            },
            {
              "name": "AVDEEV Alexey Yurevich",
              "association": "підлеглий"
            },
            {
              "name": "AVEN Petr Olegovich",
              "association": "partner"
            },
            {
              "name": "AZIMOV Rakhim Azizboevich",
              "association": "соратник"
            },
            {
              "name": "Albert Putin",
              "association": "sibling"
            },
            {
              "name": "BABAKOV Alexander Mikhailovich",
              "association": "соратник"
            },
            {
              "name": "BAKHMETIEV / BAKHMETYEV Vitaly Viktorovich",
              "association": "соратник"
            },
            {
              "name": "BELOUSOV Andrey Removich",
              "association": "підлеглий"
            },
            {
              "name": "BICHAEV Artem Aleksandrovich",
              "association": "підлеглий"
            },
            {
              "name": "BLAVATNIK Leonid / Len / Leonardo Valentinovich",
              "association": "друг"
            },
            {
              "name": "BOGDANCHIKOV Sergei Mikhailovich",
              "association": "друг"
            },
            {
              "name": "BONDAREV Viktor Nikolayevich",
              "association": "колишній керівник"
            },
            {
              "name": "BORISOV Yury Ivanovich",
              "association": "підлеглий"
            },
            {
              "name": "BORTNIKOV Aleksandr Vasilievich",
              "association": "підлеглий"
            },
            {
              "name": "CHEMEZOV Sergey Viktorovich",
              "association": "соратник"
            },
            {
              "name": "DMITRIEV Kirill Aleksandrovich",
              "association": "partner"
            },
            {
              "name": "DRONOV Yaroslav Yuriyovych",
              "association": "Дронов Ярослав Юрійович, відомий під псевдонімом SHAMAN, 25 грудня 2023 року став довіреною особою Путіна Володимира Володимировича виборах президента Російської Федерації 2024, тим самим підтримуючи продовження геноциду та війни на території України."
            },
            {
              "name": "ERNST Konstantin Lvovich",
              "association": "partner"
            },
            {
              "name": "FAASSEN Jorrit Joost",
              "association": "зять"
            },
            {
              "name": "FADZAEV Arsen Suleymanovich",
              "association": "довірена особа"
            },
            {
              "name": "FETISOV Vyacheslav Aleksandrovich",
              "association": "друг"
            },
            {
              "name": "FRIDMAN Mikhail Maratovich",
              "association": "partner"
            },
            {
              "name": "GILMUTDINOV Ildar Irekovich",
              "association": "підлеглий"
            },
            {
              "name": "GOLIKOVA Tatyana Alekseevna",
              "association": "підлеглий"
            },
            {
              "name": "GORELOV Dmitrii Vladimirovich",
              "association": "друг"
            },
            {
              "name": "GROMOV Aleksey Alekseevich",
              "association": "підлеглий"
            },
            {
              "name": "GURTSKAIA Diana Gudaevna",
              "association": "довірена особа"
            },
            {
              "name": "GUTSAN Alexander Vladimirovich",
              "association": "підлеглий"
            },
            {
              "name": "Graceful",
              "association": "Property in the interest of"
            },
            {
              "name": "IVANAYEV Andrey Sergeyevich",
              "association": "partner"
            },
            {
              "name": "IVANOV Sergey Borisovich",
              "association": "підлеглий"
            },
            {
              "name": "Ironstone Marine Investments",
              "association": "Providing support"
            },
            {
              "name": "KABAYEVA Alina Maratovna",
              "association": "коханка"
            },
            {
              "name": "KANDYBOVICH Sergei Lvovich",
              "association": "довірена особа"
            },
            {
              "name": "KASTYUKEVICH Igor Yurievich",
              "association": "підлеглий"
            },
            {
              "name": "KHAN German Borisovich",
              "association": "друг"
            },
            {
              "name": "KHMARIN Victor Victorovich",
              "association": "друг"
            },
            {
              "name": "KLEBANOV Ilia Iosifovich",
              "association": "колега"
            },
            {
              "name": "KOLBIN Petro Viktorovych",
              "association": "друг"
            },
            {
              "name": "KOLBIN Vladimir Petrovich",
              "association": "друг"
            },
            {
              "name": "KOMAROV Igor Anatolyevich",
              "association": "підлеглий"
            },
            {
              "name": "KOSTIN Andrey Leonidovich",
              "association": "partner"
            },
            {
              "name": "KOSTYUKOV Igor Olegovich",
              "association": "підлеглий"
            },
            {
              "name": "KRIVONOGIKH Svetlana Alexandrovna",
              "association": "коханка"
            },
            {
              "name": "KUZMICHEV Alexey Viktorovich",
              "association": "ділові відносини"
            },
            {
              "name": "KUZNETSOV Mikhail Mikhailovich",
              "association": "підлеглий"
            },
            {
              "name": "Katerina Tikhonova",
              "association": "child"
            },
            {
              "name": "LITVINENKO Vladimir Stefanovich",
              "association": "соратник"
            },
            {
              "name": "Lyudmila Aleksandrovna Ocheretnaya",
              "association": "former spouse"
            },
            {
              "name": "Lyudmila Aleksandrovna Ocheretnaya",
              "association": "spouse"
            },
            {
              "name": "Lyudmila Putina",
              "association": "spouse"
            },
            {
              "name": "Lyudmila Shkrebneva",
              "association": "former spouse"
            },
            {
              "name": "MAGOMEDOV Dzhambulat Musaevich",
              "association": "довірена особа"
            },
            {
              "name": "MAMEDOV Alexey Khamrakulovich",
              "association": "підлеглий"
            },
            {
              "name": "MARKOV Sergei Alexandrovich",
              "association": "соратник"
            },
            {
              "name": "MEDVEDCHUK Viktor Volodymyrovich",
              "association": "кум"
            },
            {
              "name": "MELNICHENKO Andrey Igorevich",
              "association": "друг"
            },
            {
              "name": "MILLER / MILLIER Alexey Borisovich",
              "association": "друг"
            },
            {
              "name": "MIZINTSEV Mikhail Yevgenyevich",
              "association": "підлеглий"
            },
            {
              "name": "MURUGOV Viacheslav Aleksandrovich",
              "association": "довірена особа"
            },
            {
              "name": "Maria Vorontsova",
              "association": "child"
            },
            {
              "name": "Mariya Putina",
              "association": "child"
            },
            {
              "name": "NARUSOVA Lyudmila Borisovna",
              "association": "знайома"
            },
            {
              "name": "NEVALENNAIA Galina Ivanovna",
              "association": "довірена особа"
            },
            {
              "name": "NOVAK Alexander Valentinovich",
              "association": "підлеглий"
            },
            {
              "name": "O'Neill Assets Corporation",
              "association": "Providing support"
            },
            {
              "name": "OCHERETNAYA Lyudmila Alexandrovna",
              "association": "колишня дружина"
            },
            {
              "name": "OSEEVSKY Mikhail Eduardovich",
              "association": "partner"
            },
            {
              "name": "OSIPOV Igor Vladimirovich",
              "association": "підлеглий"
            },
            {
              "name": "OVERCHUK Alexey Logvinovich",
              "association": "підлеглий"
            },
            {
              "name": "Olympia",
              "association": "Property in the interest of"
            },
            {
              "name": "PIROG Dmitry Yurievich",
              "association": "підлеглий"
            },
            {
              "name": "PODNOSOVA Irina Leonidovna",
              "association": "соратник"
            },
            {
              "name": "PORYVAI Natalia Vladimirovna",
              "association": "соратник"
            },
            {
              "name": "PUTIN Igor Aleksandrovich",
              "association": "двоюрідний брат"
            },
            {
              "name": "PUTIN Mikhail Evgenevich",
              "association": "двоюрідний племінник"
            },
            {
              "name": "PUTIN Roman Igorevich",
              "association": "двоюрідний племінник"
            },
            {
              "name": "PUTINA / PODGUZOVA Vera Alexandrovna",
              "association": "двоюрідна племінниця"
            },
            {
              "name": "PUTINA / TIKHONOVA Katerina / Ekaterina Vladimirovna",
              "association": "дочка"
            },
            {
              "name": "PUTINA / VORONTSOVA / FAASSEN Maria Vladimirovna",
              "association": "дочка"
            },
            {
              "name": "RAGIMOV Ilgam Mamedgasanovich",
              "association": "друг"
            },
            {
              "name": "RAHIMKULOV Megdet Nigmatovich",
              "association": "соратник"
            },
            {
              "name": "ROLDUGIN Sergei Pavlovich",
              "association": "кум"
            },
            {
              "name": "ROTENBERG Igor Arkadyevich",
              "association": "partner"
            },
            {
              "name": "RUDNOV Sergei Olegovich",
              "association": "друг"
            },
            {
              "name": "SALYUKOV Oleg Leonydovych",
              "association": "підлеглий"
            },
            {
              "name": "SCHRÖDER Gerhard Fritz Kurt",
              "association": "ділові відносини"
            },
            {
              "name": "SECHIN Igor Ivanovich",
              "association": "друг"
            },
            {
              "name": "SERYSHEV Anatoly Anatolyevich",
              "association": "ділові відносини"
            },
            {
              "name": "SHAFIGULLIN Airat Radinovich",
              "association": "радник"
            },
            {
              "name": "SHAMALOV Kirill Nikolaevich",
              "association": "зять"
            },
            {
              "name": "SHAMALOV Nikolay Terentievich",
              "association": "друг"
            },
            {
              "name": "SHCHEGOLEV Igor Olegovich",
              "association": "підлеглий"
            },
            {
              "name": "SHELOMOV Mikhail Lvovich",
              "association": "двоюрідний племінник"
            },
            {
              "name": "SIMONYAN Margarita Simonovna",
              "association": "partner"
            },
            {
              "name": "SMIRNOV Vladimir Alekseevich",
              "association": "соратник"
            },
            {
              "name": "TIMCHENKO Gennady Nikolayevich",
              "association": "знайомий"
            },
            {
              "name": "TRABER Ilya Ilyich",
              "association": "друг"
            },
            {
              "name": "TRUTNEV Yury Petrovich",
              "association": "помічник"
            },
            {
              "name": "TSIVILEV Sergey Evgenievich",
              "association": "родич"
            },
            {
              "name": "TSOMAEVA / SHKREBNEVA Olga Alexandrovna",
              "association": "своячка"
            },
            {
              "name": "YATSKYN Andrei Vladimirovich",
              "association": "колишній підлеглий"
            },
            {
              "name": "YEVMENOV Nikolay Anatolyevich",
              "association": "підлеглий"
            },
            {
              "name": "Yekaterina Putina",
              "association": "child"
            },
            {
              "name": "ZHURAVLYOV Alexander Alexandrovich",
              "association": "підлеглий"
            },
            {
              "name": "ZOLOTOV Viktor Vasiliyevich",
              "association": "підлеглий"
            },
            {
              "name": "Воронцова Мария Владимировна",
              "association": "child"
            }
          ],
          "sources": ["united-nations-dprk-panel-of-experts-reports"],
          "keywords": [],
          "sourceNotes": {
            "unitedNationsDprkPanelOfExpertsReports": {
              "name": "United Nations DPRK Panel of Experts Reports",
              "listingStartedUtc": "2024-05-17T00:00:00Z",
              "countryCodes": ["RU"],
              "amlTypes": ["warning"],
              "url": "https://www.un.org/securitycouncil/sanctions/1718/panel_experts/reports"
            }
          },
          "entityType": "person",
          "media": [],
          "birthDate": [],
          "createdAt": "2017-11-03T00:38:00Z",
          "countryCodes": ["RU"],
          "assets": [
            {
              "publicUrl": "http://complyadvantage-asset-development.s3.amazonaws.com/3e61820f-94d2-4846-a000-923812d19c72.jpg",
              "source": "complyadvantage",
              "type": "picture",
              "url": "http://structure.mil.ru/images/putin_170x240.jpg"
            }
          ],
          "aka": [
            {
              "name": "Vladimir Putin"
            }
          ],
          "name": "Vladimir Putin",
          "deathDate": [],
          "id": "LIZCQ58HX6MYKMO",
          "fields": {
            "warning": {
              "unitedNationsDprkPanelOfExpertsReports": [
                {
                  "name": "Nationality",
                  "value": "Russian Federation"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russian Federation"
                },
                {
                  "name": "Activation Date",
                  "value": "2024-03-07 00:00:00"
                },
                {
                  "name": "Reason",
                  "value": "Prseident of the Russian Federation, who gifted weapons to Kim Jong Un during his visit to Russia in September 2023."
                },
                {
                  "name": "Related URL",
                  "value": "https://daccess-ods.un.org/access.nsf/Get?OpenAgent&DS=S/2024/215&Lang=E",
                  "tag": "related_url"
                }
              ]
            },
            "other": {
              "countries": [
                {
                  "name": "Countries",
                  "value": "Russian Federation",
                  "tag": "country_names"
                }
              ]
            }
          },
          "updatedAt": "2024-05-23T23:13:20Z"
        },
        "score": 2,
        "matchStatus": "potential_match",
        "isWhitelisted": false,
        "matchTypesDetails": [
          {
            "nameMatches": [
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": ["warning"],
            "sources": ["United Nations DPRK Panel of Experts Reports"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Vladimir Putin"
          }
        ]
      }
    ],
    "createdAt": "2024-05-24 01:41:55",
    "ref": "1716514915-qjnss5m3",
    "matchStatus": "potential_match",
    "totalHits": 1,
    "cached": false,
    "totalBlacklistHits": 0,
    "shareUrl": "https://app.us.complyadvantage.com/public/search/1716514915-qjnss5m3/d9b9f120478e",
    "id": 586127138,
    "totalMatches": 1,
    "updatedAt": "2024-05-24 01:41:55"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule             | Description                                           |
| ---------------- | ----------------------------------------------------- |
| Warnings matched | Indicates whether the entity is on any interpol list. |
| {% endtab %}     |                                                       |
| {% endtabs %}    |                                                       |


# Sanctions

Sanctions is a data source that contains information about entities (such as individuals, organizations, companies, countries, etc.) that are subject to legal, economic, or commercial sanctions. These data sources are typically compiled and maintained by government agencies, regulatory authorities, international organizations, or specialized companies in compliance and surveillance services. Information in sanctions datasources includes the names of sanctioned entities, descriptions of imposed sanctions, reasons for sanctions, and other relevant information to aid in identifying and mitigating risks associated with financial transactions, international trade, and other activities.

**Section**: `kycSanctionsLatamCountries or kycSanctionsEmergingCountries`

Each Sanctions query can have two sections for each category, one Latam and one Emerging Countries. These categories are defined based on the country where you (Certta Client) are legally based.

**Latam:** We use the term "Latam," but it may not necessarily be from Latin America; we have included other countries in the list, but we continue to use the same service name, check the list below with the names of all countries included.

South Africa, Angola, Algeria, Benin, Botswana, Burkina Faso, Burundi, Cape Verde, Chad, Comoros, Democratic Republic of the Congo, Republic of the Congo, Ivory Coast, Djibouti, Egypt, Eritrea, Ethiopia, Gabon, Gambia, Ghana, Guinea, Equatorial Guinea, Lesotho, Liberia, Libya, Madagascar, Malawi, Mali, Morocco, Mauritius, Mauritania, Mayotte, Mozambique, Namibia, Niger, Nigeria, Kenya, Cameroon, Reunion, Rwanda, Western Sahara, Saint Helena, Sao Tome and Principe, Senegal, Sierra Leone, Seychelles, Somalia, Eswatini, Sudan, South Sudan, Tanzania, Togo, Tunisia, Uganda, Zambia, Zimbabwe, Central African Republic, and Guinea-Bissau.

**Section for customers who belong to the “Latam” group of countries:**

**- kycSanctionsLatamCountries**

**Emerging countries:** We use the term "Emerging countries," but it may not necessarily consist only of Emerging Countries; we have included other countries in the list, but we continue to use the same service name.

Anguilla, Antigua and Barbuda, Aruba, Bahamas, Barbados, Belize, Bermuda, Canada, Costa Rica, Cuba, Curaçao, Dominica, El Salvador, United States, Grenada, Greenland, Guadeloupe, Guatemala, Haiti, Honduras, Cayman Islands, United States Distant Islands, Turks and Caicos Islands, British Virgin Islands, U.S. Virgin Islands, Jamaica, Martinique, Mexico, Montserrat, Nicaragua, Caribbean Netherlands, Panama, Puerto Rico, Dominican Republic, Saint Pierre and Miquelon, Saint Lucia, Saint Barthélemy, Saint Kitts and Nevis, Saint Martin, Saint Vincent and the Grenadines, Saint Martin, Trinidad and Tobago, Argentina, Bolivia, Brazil, Chile, Colombia, Ecuador, Guyana, French Guiana, Falkland Islands, Paraguay, Peru, Suriname, Uruguay, Venezuela, Antarctica, South Georgia and the South Sandwich Islands, Bouvet Island, Heard Island and McDonald Islands, French Southern and Antarctic Lands, Afghanistan, Saudi Arabia, Armenia, Azerbaijan, Bahrain, Bangladesh, Brunei, Bhutan, Cambodia, Qatar, Kazakhstan, China, Singapore, North Korea, South Korea, United Arab Emirates, Philippines, Georgia, Hong Kong, Yemen, Christmas Island, India, Indonesia, Iran, Iraq, Israel, Japan, Jordan, Kuwait, Laos, Lebanon, Macau, Malaysia, Maldives, Myanmar (Burma), Mongolia, Nepal, Oman, Pakistan, Kyrgyzstan, Syria, Sri Lanka, Thailand, Taiwan, Tajikistan, British Indian Ocean Territory, Palestinian Territories, Turkmenistan, Uzbekistan, Vietnam, East Timor, Russia, Turkey, Bosnia and Herzegovina, Albania, Germany, Andorra, Austria, Belgium, Belarus, Bulgaria, Cyprus, Holy See, Croatia, Denmark, Slovakia, Slovenia, Spain, Estonia, Finland, France, Gibraltar, Greece, Guernsey, Netherlands, Hungary, Isle of Man, Åland Islands, Faroe Islands, Ireland, Iceland, Italy, Jersey, Latvia, Liechtenstein, Lithuania, Luxembourg, North Macedonia, Malta, Moldova, Monaco, Montenegro, Norway, Poland, Portugal, United Kingdom, Czech Republic, Romania, San Marino, Serbia, Sweden, Switzerland, Svalbard and Jan Mayen, Ukraine, Kosovo, Australia, Fiji, Guam, Norfolk Island, Cocos (Keeling) Islands, Cook Islands, Northern Mariana Islands, Marshall Islands, Pitcairn Islands, Solomon Islands, Micronesia, Nauru, Niue, New Caledonia, New Zealand, Palau, French Polynesia, Kiribati, Samoa, American Samoa, Tokelau, Tonga, Tuvalu, Vanuatu, Wallis and Futuna, Papua New Guinea.

**Section for customers who belong to the “Emerging Countries” group of countries:**

**- kycSanctionsEmergingCountries**

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

| Attribute    | Type   | Description                      | Mandatory |
| ------------ | ------ | -------------------------------- | --------- |
| name         | string | Full name of the individual.     | Yes       |
| birthDate    | string | Date of birth of the individual. | Yes       |
| countryCode  | string | Country code of the individual.  | Yes       |
| {% endtab %} |        |                                  |           |

{% tab title="Example body" %}

```javascript
body: JSON.stringify({
  workflowId: "6644843a90k8762k25929376",
  parameters: {
    name: "Vladimir Vladimirovitch Putin",
    birthDate: "07/10/1952",
    countryCode: "RU",
  },
});
```

{% endtab %}
{% endtabs %}

**Note:** Some fields returned by this API are optional and their presence cannot be guaranteed.

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

| Attribute                                                        | Type    | Description                                                                                                                                                                                       |
| ---------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| data                                                             | object  | Object containing the main data.                                                                                                                                                                  |
| data.riskLevel                                                   | string  | Risk level associated with the entity.                                                                                                                                                            |
| data.clientRef                                                   | string  | Client reference related to the hit.                                                                                                                                                              |
| data.blacklistHits                                               | array   | List of hits found in blacklist searches.                                                                                                                                                         |
| data.hits                                                        | array   | List of matches found.                                                                                                                                                                            |
| data.hits\[].doc                                                 | object  | Object containing information associated with the hit.                                                                                                                                            |
| data.hits\[].doc.types                                           | array   | List of types of information related to the hit.                                                                                                                                                  |
| data.hits\[].doc.associates                                      | array   | List of associates found.                                                                                                                                                                         |
| data.hits\[].doc.associates\[].name                              | string  | Name of the associated entity.                                                                                                                                                                    |
| data.hits\[].doc.associates\[].association                       | string  | Type of association with the entity (spouse, brother, etc.).                                                                                                                                      |
| data.hits\[].doc.sources                                         | array   | List of sources of sanctions applied to the hit.                                                                                                                                                  |
| data.hits\[].doc.keywords                                        | array   | List of keywords related to the hit.                                                                                                                                                              |
| data.hits\[].doc.sourceNotes                                     | object  | Additional notes from sources related to the hit.                                                                                                                                                 |
| data.hits\[].doc.sourceNotes                                     | object  | This object contains each type of source reported in "sources" with the respective information for each sanction applied.                                                                         |
| data.hits\[].doc.sourceNotes.$type                               | object  | This type need to be replaced by any applied sanctions list variation (specialEconomicMeasuresAct, europeSanctionsList, ofacSdnList, monacoEconomicSanctions, etc.).                              |
| data.hits\[].doc.sourceNotes.$type.name                          | string  | Name of the organization responsible for the sanctions list.                                                                                                                                      |
| data.hits\[].doc.sourceNotes.$type.listingStartedUtc             | string  | Date of publication of the sanction.                                                                                                                                                              |
| data.hits\[].doc.sourceNotes.$type.amlTypes                      | array   | Types of related information of entity.                                                                                                                                                           |
| data.hits\[].doc.sourceNotes.$type.countryCodes                  | array   | Related countries of list.                                                                                                                                                                        |
| data.hits\[].doc.sourceNotes.$type.url                           | string  | Link to the list of sanctions applied.                                                                                                                                                            |
| data.hits\[].doc.entityType                                      | string  | Type of entity (person, company, etc.).                                                                                                                                                           |
| data.hits\[].doc.media                                           | array   | List of media related to the hit. (news, websites, etc.).                                                                                                                                         |
| data.hits\[].doc.birthDate                                       | array   | List of possible birth dates related to the hit.                                                                                                                                                  |
| data.hits\[].doc.createdAt                                       | string  | Timestamp indicating when the hit was created.                                                                                                                                                    |
| data.hits\[].doc.countryCodes                                    | array   | Related countries of hit.                                                                                                                                                                         |
| data.hits\[].doc.assets                                          | array   | List of files related to the entity.                                                                                                                                                              |
| data.hits\[].doc.assets\[].publicUrl                             | string  | Public link of file.                                                                                                                                                                              |
| data.hits\[].doc.assets\[].source                                | string  | Source of information.                                                                                                                                                                            |
| data.hits\[].doc.assets\[].type                                  | string  | Type of file (picture, etc.).                                                                                                                                                                     |
| data.hits\[].doc.assets\[].url                                   | string  | File link.                                                                                                                                                                                        |
| data.hits\[].doc.aka                                             | array   | List of all aka related to the entity.                                                                                                                                                            |
| data.hits\[].doc.aka\[].name                                     | string  | Aka name.                                                                                                                                                                                         |
| data.hits\[].doc.name                                            | string  | Entity name of hit.                                                                                                                                                                               |
| data.hits\[].doc.deathDate                                       | string  | List of death dates related to the entity.                                                                                                                                                        |
| data.hits\[].doc.id                                              | string  | Unique identifier of the main record.                                                                                                                                                             |
| data.hits\[].doc.fields                                          | object  | This field contains all detailed information about each type of information related to the hit.                                                                                                   |
| data.hits\[].doc.fields.$type                                    | object  | This type needs to be replaced by a category, which will be named "sanction" or "other".                                                                                                          |
| data.hits\[].doc.fields.$type.$information                       | array   | This information needs to be replaced with any name that references the origin of this information (specialEconomicMeasuresAct, europeSanctionsList, ofacSdnList, monacoEconomicSanctions, etc.). |
| data.hits\[].doc.fields.$type.$information\[].name               | string  | Indicates the type of information (Sanction type, date of birth, other info, etc.).                                                                                                               |
| data.hits\[].doc.fields.$type.$information\[].value              | string  | Field where the value of the information is, which can be text, link, date of birth, etc.                                                                                                         |
| data.hits\[].doc.fields.$type.$information\[].tag                | string  | Internal tag with tabulated values for the category of each information (date\_of\_birth, related\_url, country\_names, etc.).                                                                    |
| data.hits\[].score                                               | number  | Indicates the hit score value.                                                                                                                                                                    |
| data.hits\[].matchStatus                                         | string  | Indicates the hit status (potential\_match, true\_positive, etc.).                                                                                                                                |
| data.hits\[].isWhiteListed                                       | boolean | Indicates if the hit is in a white list.                                                                                                                                                          |
| data.hits\[].matchTypes                                          | array   | List of match types for each hit. (aka\_exact, year\_of\_birth, etc.).                                                                                                                            |
| data.hits\[].matchTypesDetails                                   | array   | Details of name matches, sources, and secondary matches for each entity. In this field, all hit information is analyzed individually, to classify them according to their relevance.              |
| data.hits\[].matchTypesDetails\[].nameMatches                    | array   | Information about each entity, including query terms and match types.                                                                                                                             |
| data.hits\[].matchTypesDetails\[].nameMatches\[].matchTypes      | array   | Classification of matches for the respective information (exact\_match, partial\_match, etc.).                                                                                                    |
| data.hits\[].matchTypesDetails\[].nameMatches\[].queryTerm       | string  | The specific query term used for the match. (name, date, etc.).                                                                                                                                   |
| data.hits\[].matchTypesDetails\[].amlTypes                       | array   | Type of information associated with each match (sanction).                                                                                                                                        |
| data.hits\[].matchTypesDetails\[].sources                        | array   | Sources where each individual is listed for sanctions.                                                                                                                                            |
| data.hits\[].matchTypesDetails\[].secondaryMatches               | array   | Additional matches related to each individual information.                                                                                                                                        |
| data.hits\[].matchTypesDetails\[].secondaryMatches\[].matchTypes | array   | Classification of secondary matches for the respective information (exact\_match, partial\_match, etc.).                                                                                          |
| data.hits\[].matchTypesDetails\[].secondaryMatches\[].queryTerm  | string  | The specific query term used for the secondary match. (name, date, etc.).                                                                                                                         |
| data.hits\[].matchTypesDetails\[].matchingName                   | string  | The full name of each matched individual (Ex: Nicolás Maduro Moros).                                                                                                                              |
| data.createdAt                                                   | string  | Timestamp indicating when the record was created.                                                                                                                                                 |
| data.ref                                                         | string  | Reference identifier associated with the record.                                                                                                                                                  |
| data.matchStatus                                                 | string  | Final status of the query (no\_match, false\_positive, potential\_match, true\_positive, unknown, true\_positive\_approve, true\_positive\_reject).                                               |
| data.totalHits                                                   | number  | Total number of hits associated with the record.                                                                                                                                                  |
| data.cached                                                      | boolean | Indicates whether the record is cached.                                                                                                                                                           |
| data.totalBlacklistHits                                          | number  | Total number of hits in the blacklist associated with the record.                                                                                                                                 |
| data.shareUrl                                                    | string  | URL for sharing the record.                                                                                                                                                                       |
| data.id                                                          | number  | Unique identifier of the record.                                                                                                                                                                  |
| data.totalMatches                                                | number  | Total number of matches associated with the record.                                                                                                                                               |
| data.updatedAt                                                   | string  | Timestamp indicating when the record was updated.                                                                                                                                                 |
| statusCode                                                       | string  | References the status of this query only, not the entire transaction. [Check our status guide](/caf-api/connect/transactions/background-check)                                                    |
| {% endtab %}                                                     |         |                                                                                                                                                                                                   |

{% tab title="Example" %}

```json
{
  "data": {
    "riskLevel": "unknown",
    "clientRef": "caf-Vladimir Vladimirovitch Putin",
    "blacklistHits": [],
    "hits": [
      {
        "matchTypes": ["aka_exact", "name_variations_removal", "year_of_birth"],
        "doc": {
          "types": ["sanction"],
          "associates": [
            {
              "name": "ABRAMCHENKO Victoria Valerievna",
              "association": "підлеглий"
            },
            {
              "name": "ABRAMOVICH Roman Arkadyevich",
              "association": "partner"
            },
            {
              "name": "AMELCHENKOVA / ZANKO Olga Nikolaevna",
              "association": "соратник"
            },
            {
              "name": "ANISIMOV Vasily Vasilievich",
              "association": "partner"
            },
            {
              "name": "AVDEEV Alexey Yurevich",
              "association": "підлеглий"
            },
            {
              "name": "AVEN Petr Olegovich",
              "association": "partner"
            },
            {
              "name": "AZIMOV Rakhim Azizboevich",
              "association": "соратник"
            },
            {
              "name": "Albert Putin",
              "association": "sibling"
            },
            {
              "name": "BABAKOV Alexander Mikhailovich",
              "association": "соратник"
            },
            {
              "name": "BAKHMETIEV / BAKHMETYEV Vitaly Viktorovich",
              "association": "соратник"
            },
            {
              "name": "BELOUSOV Andrey Removich",
              "association": "підлеглий"
            },
            {
              "name": "BICHAEV Artem Aleksandrovich",
              "association": "підлеглий"
            },
            {
              "name": "BLAVATNIK Leonid / Len / Leonardo Valentinovich",
              "association": "друг"
            },
            {
              "name": "BOGDANCHIKOV Sergei Mikhailovich",
              "association": "друг"
            },
            {
              "name": "BONDAREV Viktor Nikolayevich",
              "association": "колишній керівник"
            },
            {
              "name": "BORISOV Yury Ivanovich",
              "association": "підлеглий"
            },
            {
              "name": "BORTNIKOV Aleksandr Vasilievich",
              "association": "підлеглий"
            },
            {
              "name": "CHEMEZOV Sergey Viktorovich",
              "association": "соратник"
            },
            {
              "name": "DMITRIEV Kirill Aleksandrovich",
              "association": "partner"
            },
            {
              "name": "DRONOV Yaroslav Yuriyovych",
              "association": "Дронов Ярослав Юрійович, відомий під псевдонімом SHAMAN, 25 грудня 2023 року став довіреною особою Путіна Володимира Володимировича виборах президента Російської Федерації 2024, тим самим підтримуючи продовження геноциду та війни на території України."
            },
            {
              "name": "ERNST Konstantin Lvovich",
              "association": "partner"
            },
            {
              "name": "FAASSEN Jorrit Joost",
              "association": "зять"
            },
            {
              "name": "FADZAEV Arsen Suleymanovich",
              "association": "довірена особа"
            },
            {
              "name": "FETISOV Vyacheslav Aleksandrovich",
              "association": "друг"
            },
            {
              "name": "FRIDMAN Mikhail Maratovich",
              "association": "partner"
            },
            {
              "name": "GILMUTDINOV Ildar Irekovich",
              "association": "підлеглий"
            },
            {
              "name": "GOLIKOVA Tatyana Alekseevna",
              "association": "підлеглий"
            },
            {
              "name": "GORELOV Dmitrii Vladimirovich",
              "association": "друг"
            },
            {
              "name": "GROMOV Aleksey Alekseevich",
              "association": "підлеглий"
            },
            {
              "name": "GURTSKAIA Diana Gudaevna",
              "association": "довірена особа"
            },
            {
              "name": "GUTSAN Alexander Vladimirovich",
              "association": "підлеглий"
            },
            {
              "name": "Graceful",
              "association": "Property in the interest of"
            },
            {
              "name": "IVANAYEV Andrey Sergeyevich",
              "association": "partner"
            },
            {
              "name": "IVANOV Sergey Borisovich",
              "association": "підлеглий"
            },
            {
              "name": "Ironstone Marine Investments",
              "association": "Providing support"
            },
            {
              "name": "KABAYEVA Alina Maratovna",
              "association": "коханка"
            },
            {
              "name": "KANDYBOVICH Sergei Lvovich",
              "association": "довірена особа"
            },
            {
              "name": "KASTYUKEVICH Igor Yurievich",
              "association": "підлеглий"
            },
            {
              "name": "KHAN German Borisovich",
              "association": "друг"
            },
            {
              "name": "KHMARIN Victor Victorovich",
              "association": "друг"
            },
            {
              "name": "KLEBANOV Ilia Iosifovich",
              "association": "колега"
            },
            {
              "name": "KOLBIN Petro Viktorovych",
              "association": "друг"
            },
            {
              "name": "KOLBIN Vladimir Petrovich",
              "association": "друг"
            },
            {
              "name": "KOMAROV Igor Anatolyevich",
              "association": "підлеглий"
            },
            {
              "name": "KOSTIN Andrey Leonidovich",
              "association": "partner"
            },
            {
              "name": "KOSTYUKOV Igor Olegovich",
              "association": "підлеглий"
            },
            {
              "name": "KRIVONOGIKH Svetlana Alexandrovna",
              "association": "коханка"
            },
            {
              "name": "KUZMICHEV Alexey Viktorovich",
              "association": "ділові відносини"
            },
            {
              "name": "KUZNETSOV Mikhail Mikhailovich",
              "association": "підлеглий"
            },
            {
              "name": "Katerina Tikhonova",
              "association": "child"
            },
            {
              "name": "LITVINENKO Vladimir Stefanovich",
              "association": "соратник"
            },
            {
              "name": "Lyudmila Aleksandrovna Ocheretnaya",
              "association": "former spouse"
            },
            {
              "name": "Lyudmila Aleksandrovna Ocheretnaya",
              "association": "spouse"
            },
            {
              "name": "Lyudmila Putina",
              "association": "spouse"
            },
            {
              "name": "Lyudmila Shkrebneva",
              "association": "former spouse"
            },
            {
              "name": "MAGOMEDOV Dzhambulat Musaevich",
              "association": "довірена особа"
            },
            {
              "name": "MAMEDOV Alexey Khamrakulovich",
              "association": "підлеглий"
            },
            {
              "name": "MARKOV Sergei Alexandrovich",
              "association": "соратник"
            },
            {
              "name": "MEDVEDCHUK Viktor Volodymyrovich",
              "association": "кум"
            },
            {
              "name": "MELNICHENKO Andrey Igorevich",
              "association": "друг"
            },
            {
              "name": "MILLER / MILLIER Alexey Borisovich",
              "association": "друг"
            },
            {
              "name": "MIZINTSEV Mikhail Yevgenyevich",
              "association": "підлеглий"
            },
            {
              "name": "MURUGOV Viacheslav Aleksandrovich",
              "association": "довірена особа"
            },
            {
              "name": "Maria Vorontsova",
              "association": "child"
            },
            {
              "name": "Mariya Putina",
              "association": "child"
            },
            {
              "name": "NARUSOVA Lyudmila Borisovna",
              "association": "знайома"
            },
            {
              "name": "NEVALENNAIA Galina Ivanovna",
              "association": "довірена особа"
            },
            {
              "name": "NOVAK Alexander Valentinovich",
              "association": "підлеглий"
            },
            {
              "name": "O'Neill Assets Corporation",
              "association": "Providing support"
            },
            {
              "name": "OCHERETNAYA Lyudmila Alexandrovna",
              "association": "колишня дружина"
            },
            {
              "name": "OSEEVSKY Mikhail Eduardovich",
              "association": "partner"
            },
            {
              "name": "OSIPOV Igor Vladimirovich",
              "association": "підлеглий"
            },
            {
              "name": "OVERCHUK Alexey Logvinovich",
              "association": "підлеглий"
            },
            {
              "name": "Olympia",
              "association": "Property in the interest of"
            },
            {
              "name": "PIROG Dmitry Yurievich",
              "association": "підлеглий"
            },
            {
              "name": "PODNOSOVA Irina Leonidovna",
              "association": "соратник"
            },
            {
              "name": "PORYVAI Natalia Vladimirovna",
              "association": "соратник"
            },
            {
              "name": "PUTIN Igor Aleksandrovich",
              "association": "двоюрідний брат"
            },
            {
              "name": "PUTIN Mikhail Evgenevich",
              "association": "двоюрідний племінник"
            },
            {
              "name": "PUTIN Roman Igorevich",
              "association": "двоюрідний племінник"
            },
            {
              "name": "PUTINA / PODGUZOVA Vera Alexandrovna",
              "association": "двоюрідна племінниця"
            },
            {
              "name": "PUTINA / TIKHONOVA Katerina / Ekaterina Vladimirovna",
              "association": "дочка"
            },
            {
              "name": "PUTINA / VORONTSOVA / FAASSEN Maria Vladimirovna",
              "association": "дочка"
            },
            {
              "name": "RAGIMOV Ilgam Mamedgasanovich",
              "association": "друг"
            },
            {
              "name": "RAHIMKULOV Megdet Nigmatovich",
              "association": "соратник"
            },
            {
              "name": "ROLDUGIN Sergei Pavlovich",
              "association": "кум"
            },
            {
              "name": "ROTENBERG Igor Arkadyevich",
              "association": "partner"
            },
            {
              "name": "RUDNOV Sergei Olegovich",
              "association": "друг"
            },
            {
              "name": "SALYUKOV Oleg Leonydovych",
              "association": "підлеглий"
            },
            {
              "name": "SCHRÖDER Gerhard Fritz Kurt",
              "association": "ділові відносини"
            },
            {
              "name": "SECHIN Igor Ivanovich",
              "association": "друг"
            },
            {
              "name": "SERYSHEV Anatoly Anatolyevich",
              "association": "ділові відносини"
            },
            {
              "name": "SHAFIGULLIN Airat Radinovich",
              "association": "радник"
            },
            {
              "name": "SHAMALOV Kirill Nikolaevich",
              "association": "зять"
            },
            {
              "name": "SHAMALOV Nikolay Terentievich",
              "association": "друг"
            },
            {
              "name": "SHCHEGOLEV Igor Olegovich",
              "association": "підлеглий"
            },
            {
              "name": "SHELOMOV Mikhail Lvovich",
              "association": "двоюрідний племінник"
            },
            {
              "name": "SIMONYAN Margarita Simonovna",
              "association": "partner"
            },
            {
              "name": "SMIRNOV Vladimir Alekseevich",
              "association": "соратник"
            },
            {
              "name": "TIMCHENKO Gennady Nikolayevich",
              "association": "знайомий"
            },
            {
              "name": "TRABER Ilya Ilyich",
              "association": "друг"
            },
            {
              "name": "TRUTNEV Yury Petrovich",
              "association": "помічник"
            },
            {
              "name": "TSIVILEV Sergey Evgenievich",
              "association": "родич"
            },
            {
              "name": "TSOMAEVA / SHKREBNEVA Olga Alexandrovna",
              "association": "своячка"
            },
            {
              "name": "YATSKYN Andrei Vladimirovich",
              "association": "колишній підлеглий"
            },
            {
              "name": "YEVMENOV Nikolay Anatolyevich",
              "association": "підлеглий"
            },
            {
              "name": "Yekaterina Putina",
              "association": "child"
            },
            {
              "name": "ZHURAVLYOV Alexander Alexandrovich",
              "association": "підлеглий"
            },
            {
              "name": "ZOLOTOV Viktor Vasiliyevich",
              "association": "підлеглий"
            },
            {
              "name": "Воронцова Мария Владимировна",
              "association": "child"
            }
          ],
          "sources": [
            "belgium-consolidated-list-of-the-national-and-european-sanctions",
            "dfat-australia-list",
            "europe-sanctions-list",
            "hm-treasury-list",
            "liechtenstein-international-sanctions",
            "ministry-of-finance-japan-economic-sanctions-list",
            "monaco-economic-sanctions",
            "new-zealand-ministry-of-foreign-affairs-and-trade-russia-sanctions-act",
            "ofac-sdn-list",
            "sanction-related-entities",
            "special-economic-measures-act",
            "swiss-seco-list",
            "tresor-direction-generale",
            "ukraine-national-agency-on-corruption-prevention-sanctions",
            "ukraine-sanctions-national-security-and-defense-council-nsdc-special-economic-and-other-restrictive-measures-persons"
          ],
          "keywords": [],
          "sourceNotes": {
            "monacoEconomicSanctions": {
              "name": "Monaco Economic Sanctions",
              "listingStartedUtc": "2022-02-26T00:00:00Z",
              "amlTypes": ["sanction"],
              "url": "https://geldefonds.gouv.mc/liste-nationale-de-gel-des-fonds"
            },
            "specialEconomicMeasuresAct": {
              "name": "DFATD Canada Special Economic Measures Act Designations",
              "listingStartedUtc": "2022-03-02T00:00:00Z",
              "amlTypes": ["sanction"],
              "url": "https://www.international.gc.ca/world-monde/international_relations-relations_internationales/sanctions/consolidated-consolide.aspx?lang=eng"
            },
            "dfatAustraliaList": {
              "name": "DFAT Australia Consolidated Sanctions List",
              "listingStartedUtc": "2022-03-01T00:00:00Z",
              "countryCodes": ["RU"],
              "amlTypes": ["sanction"],
              "url": "https://www.dfat.gov.au/international-relations/security/sanctions/consolidated-list"
            },
            "tresorDirectionGenerale": {
              "name": "France Tresor Direction Generale Liste Unique de Gels",
              "listingStartedUtc": "2022-02-26T00:00:00Z",
              "amlTypes": ["sanction"],
              "url": "https://gels-avoirs.dgtresor.gouv.fr/"
            },
            "belgiumConsolidatedListOfTheNationalAndEuropeanSanctions": {
              "name": "Belgium Consolidated List of the National and European Sanctions",
              "listingStartedUtc": "2022-02-25T00:00:00Z",
              "countryCodes": ["RU"],
              "amlTypes": ["sanction"],
              "url": "https://finance.belgium.be/en/control-financial-instruments-and-institutions/compliance/financial-sanctions"
            },
            "europeSanctionsList": {
              "name": "EU External Action Service - Consolidated list of Sanctions",
              "listingStartedUtc": "2022-02-25T00:00:00Z",
              "countryCodes": ["RU"],
              "amlTypes": ["sanction"],
              "url": "https://webgate.ec.europa.eu/fsd/fsf#!/files"
            },
            "hmTreasuryList": {
              "name": "United Kingdom HM Treasury Office of Financial Sanctions Implementation Consolidated List",
              "listingStartedUtc": "2022-02-25T00:00:00Z",
              "countryCodes": ["RU"],
              "amlTypes": ["sanction"],
              "url": "https://www.gov.uk/government/publications/financial-sanctions-consolidated-list-of-targets"
            },
            "ukraineSanctionsNationalSecurityAndDefenseCouncilNsdcSpecialEconomicAndOtherRestrictiveMeasuresPersons": {
              "name": "Ukraine Sanctions National Security and Defense Council (NSDC) Special Economic and Other Restrictive Measures – Persons",
              "listingStartedUtc": "2022-06-09T00:00:00Z",
              "amlTypes": ["sanction"],
              "url": "https://www.rnbo.gov.ua/ua/Ukazy/?ACT=line&LNG=1&CATS=18&DTF=&DTT=&S=%D1%81%D0%B0%D0%BD%D0%BA%D1%86%D1%96%D1%97"
            },
            "ministryOfFinanceJapanEconomicSanctionsList": {
              "name": "Ministry of Finance Japan Economic Sanctions List",
              "listingStartedUtc": "2022-03-01T00:00:00Z",
              "amlTypes": ["sanction"],
              "url": "https://www.mof.go.jp/international_policy/gaitame_kawase/gaitame/economic_sanctions/list.html"
            },
            "ukraineNationalAgencyOnCorruptionPreventionSanctions": {
              "name": "Ukraine National Agency on Corruption Prevention Sanctions",
              "countryCodes": ["RU"],
              "amlTypes": ["sanction"],
              "url": "https://sanctions.nazk.gov.ua/en/sanction-lists/"
            },
            "ofacSdnList": {
              "name": "OFAC SDN List",
              "listingStartedUtc": "2022-02-25T00:00:00Z",
              "countryCodes": ["RU"],
              "amlTypes": ["sanction"],
              "url": "http://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx"
            },
            "liechtensteinInternationalSanctions": {
              "name": "Liechtenstein International Sanctions",
              "listingStartedUtc": "2022-03-10T00:00:00Z",
              "countryCodes": ["RU"],
              "amlTypes": ["sanction"],
              "url": "https://www.gesetze.li/konso/gebietssystematik?lrstart=946"
            },
            "newZealandMinistryOfForeignAffairsAndTradeRussiaSanctionsAct": {
              "name": "New Zealand Ministry of Foreign Affairs and Trade Russia Sanctions Act",
              "listingStartedUtc": "2022-03-18T00:00:00Z",
              "amlTypes": ["sanction"],
              "url": "https://www.mfat.govt.nz/en/countries-and-regions/europe/ukraine/russian-invasion-of-ukraine/sanctions/"
            },
            "sanctionRelatedEntities": {
              "name": "Sanction Related Entities",
              "listingStartedUtc": "2024-01-30T00:00:00Z",
              "amlTypes": ["sanction"],
              "url": "https://complyadvantage.helpsite.com/articles/92431-what-is-the-sanction-related-entities-list-source/?pw=1MDB2018"
            },
            "swissSecoList": {
              "name": "Switzerland SECO List",
              "listingStartedUtc": "2022-02-28T00:00:00Z",
              "countryCodes": ["RU"],
              "amlTypes": ["sanction"],
              "url": "https://www.seco.admin.ch/seco/en/home/Aussenwirtschaftspolitik_Wirtschaftliche_Zusammenarbeit/Wirtschaftsbeziehungen/exportkontrollen-und-sanktionen/sanktionen-embargos.html"
            }
          },
          "entityType": "person",
          "media": [],
          "birthDate": ["1952-10-07", "1952"],
          "createdAt": "2024-05-01T15:14:23Z",
          "countryCodes": ["RU"],
          "assets": [
            {
              "publicUrl": "http://complyadvantage-asset-development.s3.amazonaws.com/3e61820f-94d2-4846-a000-923812d19c72.jpg",
              "source": "complyadvantage",
              "type": "picture",
              "url": "http://structure.mil.ru/images/putin_170x240.jpg"
            }
          ],
          "aka": [
            {
              "name": "Vladimir Vladimirovich Putin"
            },
            {
              "name": "Владимир Путин"
            },
            {
              "name": "Putin Vladimir Vladimirovich"
            },
            {
              "name": "Владимир Владимирович Путин"
            },
            {
              "name": "Putin Vladimir Vladimirovitj"
            },
            {
              "name": "Poutine Vladimir Vladimirovich"
            },
            {
              "name": "Путин Владимир Владимирович"
            },
            {
              "name": "Путін Володимир Володимирович"
            },
            {
              "name": "Пу́Тин Влади́мир Влади́мирович"
            },
            {
              "name": "ウラジーミル・プーチン"
            },
            {
              "name": "Vladimir Putin"
            }
          ],
          "name": "Vladimir Putin",
          "deathDate": [],
          "id": "WM4L9QEL4JJY8EG",
          "fields": {
            "sanction": {
              "monacoEconomicSanctions": [
                {
                  "name": "Original Place of Birth Text",
                  "value": "Léningrad, aujourd'hui Saint-Pétersbourg : RUSSIE"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Designation Act",
                  "value": "(UE) 2022/332 du 25/02/2022; DM 2022-15 du 26/02/2022"
                },
                {
                  "name": "Designation Date",
                  "value": "2022-02-26"
                },
                {
                  "name": "Function",
                  "value": "président de la Fédération de Russie"
                },
                {
                  "name": "Issuing Authority",
                  "value": "Ministre d'État"
                },
                {
                  "name": "Program",
                  "value": "UE Ukraine intégrité territoriale - R (UE) 269/2014"
                },
                {
                  "name": "Reason",
                  "value": "Vladimir Poutine est le président de la Fédération de Russie. Le 22 février 2022, il a signé un décret reconnaissant l'\"indépendance et la souveraineté\" des zones des oblasts ukrainiens de Donetsk et de Louhansk non contrôlées par le gouvernement, et a ordonné le déploiement des forces armées russes dans ces zones. Le 24 février 2022, il a ordonné le lancement d'une opération militaire en Ukraine et les forces armées russes ont commencé à attaquer l'Ukraine. Cette attaque est une violation flagrante de l'intégrité territoriale, de la souveraineté et de l'indépendance de l'Ukraine. Vladimir Poutine est responsable d'actions compromettant l'intégrité territoriale, la souveraineté et l'indépendance de l'Ukraine, ou la stabilité ou la sécurité en Ukraine, et soutient activement ces actions."
                }
              ],
              "specialEconomicMeasuresAct": [
                {
                  "name": "Date of Birth",
                  "value": "1952",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Program",
                  "value": "Russia"
                }
              ],
              "tresorDirectionGenerale": [
                {
                  "name": "Original Place of Birth Text",
                  "value": "Léningrad, aujourd'hui Saint-Pétersbourg, RUSSIE"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Gender",
                  "value": "male"
                },
                {
                  "name": "Designation Act",
                  "value": "(UE) 2022/332 du 25/02/2022 (UE Ukraine intégrité territoriale - R (UE) 269/2014)"
                },
                {
                  "name": "Reason",
                  "value": "Vladimir Poutine est le président de la Fédération de Russie. Le 22 février 2022, il a signé un décret reconnaissant l'\"indépendance et la souveraineté\" des zones des oblasts ukrainiens de Donetsk et de Louhansk non contrôlées par le gouvernement, et a ordonné le déploiement des forces armées russes dans ces zones. Le 24 février 2022, il a ordonné le lancement d'une opération militaire en Ukraine et les forces armées russes ont commencé à attaquer l'Ukraine. Cette attaque est une violation flagrante de l'intégrité territoriale, de la souveraineté et de l'indépendance de l'Ukraine. Vladimir Poutine est responsable d'actions compromettant l'intégrité territoriale, la souveraineté et l'indépendance de l'Ukraine, ou la stabilité ou la sécurité en Ukraine, et soutient activement ces actions."
                },
                {
                  "name": "Related URL",
                  "value": "https://gels-avoirs.dgtresor.gouv.fr/Gels/RegistreDetail?idRegistre=4271",
                  "tag": "related_url"
                },
                {
                  "name": "Title",
                  "value": "président de la Fédération de Russie"
                }
              ],
              "dfatAustraliaList": [
                {
                  "name": "Place of Birth",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Place of Birth Text",
                  "value": "Saint Petersburg, Russia"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Other Information",
                  "value": "President of the Russian Federation"
                },
                {
                  "name": "Program",
                  "value": "Autonomous (Russia)"
                }
              ],
              "belgiumConsolidatedListOfTheNationalAndEuropeanSanctions": [
                {
                  "name": "Place of Birth",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Place of Birth Text",
                  "value": "Leningrad (now Saint-Petersburg), RUSSIAN FEDERATION"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Gender",
                  "value": "male"
                },
                {
                  "name": "Designation Act",
                  "value": "2022/332 (OJ L53)"
                },
                {
                  "name": "Designation Date",
                  "value": "2022-02-25"
                },
                {
                  "name": "Function",
                  "value": "President of the Russian Federation"
                },
                {
                  "name": "Listing Id",
                  "value": "EU.7510.16"
                },
                {
                  "name": "Program",
                  "value": "UKR"
                },
                {
                  "name": "Related URL",
                  "value": "https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=uriserv%3AOJ.L_.2022.053.01.0001.01.ENG&toc=OJ%3AL%3A2022%3A053%3ATOC",
                  "tag": "related_url"
                }
              ],
              "hmTreasuryList": [
                {
                  "name": "Nationality",
                  "value": "Russian Federation"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Place of Birth",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Place of Birth Text",
                  "value": "St Petersburg (then Leningrad), Russia"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Gender",
                  "value": "male"
                },
                {
                  "name": "Address",
                  "value": "Moscow, Russia"
                },
                {
                  "name": "Amended On",
                  "value": "2023-03-21"
                },
                {
                  "name": "Designation Date",
                  "value": "2022-02-25"
                },
                {
                  "name": "Function",
                  "value": "President of the Russian Federation"
                },
                {
                  "name": "Listing Id",
                  "value": "14196"
                },
                {
                  "name": "Listing Origin",
                  "value": "UK"
                },
                {
                  "name": "Other Information",
                  "value": "(UK Sanctions List Ref):RUS0251"
                },
                {
                  "name": "Program",
                  "value": "Russia"
                },
                {
                  "name": "Reason",
                  "value": "Vladimir Vladimirovich Putin is the President of the Russian Federation, carrying ultimate authority for the policy of the Russian government and Russian armed forces. In February 2022, Putin ordered Russian military forces to launch an invasion of Ukraine, undermining and threatening the territorial integrity, sovereignty or independence of Ukraine."
                }
              ],
              "europeSanctionsList": [
                {
                  "name": "Place of Birth",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Place of Birth Text",
                  "value": "Leningrad (now Saint-Petersburg), RUSSIAN FEDERATION"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Gender",
                  "value": "male"
                },
                {
                  "name": "Amended On",
                  "value": "2022-02-25"
                },
                {
                  "name": "Designation Act",
                  "value": "2022/332 (OJ L53)"
                },
                {
                  "name": "Designation Date",
                  "value": "25-02-2022"
                },
                {
                  "name": "Function",
                  "value": "President of the Russian Federation"
                },
                {
                  "name": "Issuing Authority",
                  "value": "European Union"
                },
                {
                  "name": "Listing Id",
                  "value": "EU.7510.16"
                },
                {
                  "name": "Program",
                  "value": "UKR"
                },
                {
                  "name": "Related URL",
                  "value": "https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=uriserv%3AOJ.L_.2022.053.01.0001.01.ENG&toc=OJ%3AL%3A2022%3A053%3ATOC",
                  "tag": "related_url"
                }
              ],
              "ukraineSanctionsNationalSecurityAndDefenseCouncilNsdcSpecialEconomicAndOtherRestrictiveMeasuresPersons": [
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Designation Date",
                  "value": "2022-06-09 00:00:00"
                },
                {
                  "name": "Other Information",
                  "value": "Путін Володимир Володимирович (російською мовою - Путин Владимир Владимирович, латинськими літерами - Putin Vladimir Vladimirovich) народився 7 жовтня 1952 р. у м. Санкт-Петербурзі, Російська Федерація, громадянин Російської Федерації, Президент Російської Федерації"
                },
                {
                  "name": "Reason",
                  "value": "РІШЕННЯ Ради національної безпеки і оборони України від 9 червня 2022 року Про застосування персональних спеціальних економічних та інших обмежувальних заходів (санкцій)"
                },
                {
                  "name": "Related URL",
                  "value": "https://www.rnbo.gov.ua/ua/Ukazy/5524.html",
                  "tag": "related_url"
                },
                {
                  "name": "Sanction Type",
                  "value": "1) блокування активів - тимчасове обмеження права особи користуватися та розпоряджатися належним їй майном; 2) обмеження торговельних операцій у частині заборони експортно-імпортних операцій, операцій із переробки; 3) повне припинення транзиту ресурсів, польотів та перевезень територією України; 4) запобігання виведенню капіталів за межі України; 5) зупинення виконання економічних та фінансових зобов'язань; 6) анулювання або зупинення ліцензій та інших дозволів, одержання (наявність) яких є умовою для здійснення певного виду діяльності, зокрема, анулювання чи зупинення дії спеціальних дозволів на користування надрами; 7) заборона участі у приватизації, оренді державного майна резидентами іноземної держави та особами, які прямо чи опосередковано контролюються резидентами іноземної держави або діють в їх інтересах; 8) заборона користування радіочастотним ресурсом України; 9) припинення надання електронних комунікаційних послуг і вико ..."
                }
              ],
              "ministryOfFinanceJapanEconomicSanctionsList": [
                {
                  "name": "Original Place of Birth Text",
                  "value": "レニングラード(現サンクトペテルブルク)(ロシア)"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Issuing Authority",
                  "value": "Ministry of Finance of Japan"
                },
                {
                  "name": "Program",
                  "value": "資産凍結等の措置の対象となるロシア連邦の団体及び個人(個人)"
                },
                {
                  "name": "Related URL",
                  "value": "https://www.mof.go.jp/international_policy/gaitame_kawase/gaitame/economic_sanctions/",
                  "tag": "related_url"
                },
                {
                  "name": "Title",
                  "value": "President of the Russian Federation"
                },
                {
                  "name": "Title",
                  "value": "ロシア連邦大統領"
                }
              ],
              "ukraineNationalAgencyOnCorruptionPreventionSanctions": [
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "RUS"
                },
                {
                  "name": "Place of Birth",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Place of Birth Text",
                  "value": "Moscow, Russia"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Function",
                  "value": "President of the Russian Federation"
                },
                {
                  "name": "Issuing Authority",
                  "value": "Ukraine Ministry of Foreign Affairs"
                },
                {
                  "name": "Other Information",
                  "value": "Also sanctioned by European Union since 2022-02-25 https://eur-lex.europa.eu/eli/dec/2014/145; Also sanctioned by Great Britain since 2022-02-25 https://assets.publishing.service.gov.uk/government/uploads/system/uploads/attachment_data/file/1085379/Russia.pdf; Also sanctioned by USA since 2022-02-25 https://home.treasury.gov/policy-issues/financial-sanctions/recent-actions/20220225_33; Also sanctioned by Canada since 2022-02-28 https://gazette.gc.ca/rp-pr/p2/2022/2022-03-16/html/sor-dors32-eng.html; Also sanctioned by Switzerland since 2022-03-04; Also sanctioned by Australia since 2022-02-28 https://www.dfat.gov.au/international-relations/security/sanctions/consolidated-list; Also sanctioned by Japan since 2022-03-01 https://www.meti.go.jp/policy/external_economy/trade_control/01_seido/04_seisai/downloadCrimea/20220301press_russia.pdf; Also sanctioned by Ukraine since 2022-06-09 https://www.president.gov.ua/documents/4002022-42813; Also sanctioned by New Zealand since 2022-04-05;"
                },
                {
                  "name": "Reason",
                  "value": "On 22 February 2022, he signed a decree recognising the \"independence and sovereignty\" of the non-government-controlled areas of the Donetsk and Luhansk oblasts of Ukraine, and ordered the Russian armed forces into those areas. On 24 February 2022, he ordered a military operation in Ukraine and Russian armed forces began an attack on Ukraine. That attack is a blatant violation of the territorial integrity, sovereignty and independence of Ukraine. Vladimir Putin is responsible for and actively supporting actions undermining the territorial integrity, sovereignty and independence of Ukraine, as well as stability and security in Ukraine."
                },
                {
                  "name": "Registration Number",
                  "value": "itn: 711813038431"
                },
                {
                  "name": "Related URL",
                  "value": "https://sanctions.nazk.gov.ua/en/api/v4/person/880",
                  "tag": "related_url"
                }
              ],
              "ofacSdnList": [
                {
                  "name": "Nationality",
                  "value": "Russian Federation"
                },
                {
                  "name": "Country",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Country Text",
                  "value": "Russia"
                },
                {
                  "name": "Place of Birth",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Place of Birth Text",
                  "value": "Leningrad, Russia"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Gender",
                  "value": "male"
                },
                {
                  "name": "Address",
                  "value": "Bocharov Ruchey, Sochi, Russia"
                },
                {
                  "name": "Address",
                  "value": "Kremlin, Moscow, Russia"
                },
                {
                  "name": "Address",
                  "value": "Novo-Ogaryevo, Moscow Region, Russia"
                },
                {
                  "name": "Address",
                  "value": "Valdai, Novgorod Region, Russia"
                },
                {
                  "name": "Designation Date",
                  "value": "2022-02-25"
                },
                {
                  "name": "Legal Basis",
                  "value": "Executive Order 14024 (Russia)"
                },
                {
                  "name": "List Name",
                  "value": "SDN List"
                },
                {
                  "name": "Listing Id",
                  "value": "OFAC-35096"
                },
                {
                  "name": "Program",
                  "value": "RUSSIA-EO14024"
                },
                {
                  "name": "Sanction Type",
                  "value": "Block"
                },
                {
                  "name": "Title",
                  "value": "President of the Russian Federation"
                }
              ],
              "liechtensteinInternationalSanctions": [
                {
                  "name": "Place of Birth",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Place of Birth Text",
                  "value": "Leningrad (jetzt Sankt-Petersburg), UdSSR (jetzt Russische Föderation)"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Designation Date",
                  "value": "2022-03-10 00:00:00"
                },
                {
                  "name": "Function",
                  "value": "Präsident der Russischen Föderation"
                },
                {
                  "name": "Issuing Authority",
                  "value": "Liechtensteinischen Landesverwaltung"
                },
                {
                  "name": "Other Information",
                  "value": "Vladimir Putin ist Präsident der Russischen Föderation. Am 22. Februar 2022 hat er ein Dekret unterzeichnet, mit dem die \"Unabhängigkeit und Souveränität\" der nicht von der Regierung kontrollierten Gebiete der ukrainischen Regionen Donezk und Luhansk anerkannt wurde, und russische Streitkräfte in diese Gebiete entsandt. Am 24. Februar 2022 hat er eine Militäroperation in der Ukraine angeordnet, und russische Streitkräfte haben die Ukraine angegriffen. Ein derartiger Angriff ist eine eklatante Verletzung der territorialen Unversehrtheit, Souveränität und Unabhängigkeit der Ukraine. Vladimir Putin ist verantwortlich für Handlungen, die die territoriale Unversehrtheit, Souveränität und Unabhängigkeit der Ukraine sowie die Stabilität oder Sicherheit in der Ukraine untergraben, und unterstützt aktiv solche Handlungen."
                },
                {
                  "name": "Program",
                  "value": "Verordnung vom 10. März 2022 über Massnahmen im Zusammenhang mit der Situation in der Ukraine"
                },
                {
                  "name": "Related URL",
                  "value": "https://www.gesetze.li/konso/2022045000",
                  "tag": "related_url"
                }
              ],
              "newZealandMinistryOfForeignAffairsAndTradeRussiaSanctionsAct": [
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Amended On",
                  "value": "2022-04-05"
                },
                {
                  "name": "Designation Date",
                  "value": "2022-03-18"
                },
                {
                  "name": "Function",
                  "value": "President of the Russian Federation"
                },
                {
                  "name": "Legal Basis",
                  "value": "Russia Sanctions Act 2022"
                },
                {
                  "name": "Other Info",
                  "value": "Sanctioned"
                },
                {
                  "name": "Reason",
                  "value": "President of the Russian Federation"
                },
                {
                  "name": "Related URL",
                  "value": "https://www.mfat.govt.nz/en/countries-and-regions/europe/ukraine/russian-invasion-of-ukraine/sanctions/",
                  "tag": "related_url"
                },
                {
                  "name": "Sanction Type",
                  "value": "Aircraft Ban"
                },
                {
                  "name": "Sanction Type",
                  "value": "Asset Freeze"
                },
                {
                  "name": "Sanction Type",
                  "value": "Dealing with Securities"
                },
                {
                  "name": "Sanction Type",
                  "value": "Service Prohibition"
                },
                {
                  "name": "Sanction Type",
                  "value": "Ship Ban"
                },
                {
                  "name": "Sanction Type",
                  "value": "Travel Ban"
                }
              ],
              "sanctionRelatedEntities": [
                {
                  "name": "Other Info",
                  "value": "Vladimir Vladimirovich Putin is related to Graceful who is a sanctioned entity listed on OFAC SDN List"
                },
                {
                  "name": "Other Info",
                  "value": "Vladimir Vladimirovich Putin is related to Ironstone Marine Investments who is a sanctioned entity listed on OFAC SDN List"
                },
                {
                  "name": "Other Info",
                  "value": "Vladimir Vladimirovich Putin is related to O'Neill Assets Corporation who is a sanctioned entity listed on OFAC SDN List. Sanction Source Snippet: Other Information: Organization Type - Activities of holding companies, Other Information: Target Type - Private Company"
                },
                {
                  "name": "Other Info",
                  "value": "Vladimir Vladimirovich Putin is related to Olympia who is a sanctioned entity listed on OFAC SDN List"
                },
                {
                  "name": "Related URL",
                  "value": "https://ofac.treasury.gov/specially-designated-nationals-list-data-formats-data-schemas",
                  "tag": "related_url"
                }
              ],
              "swissSecoList": [
                {
                  "name": "Place of Birth",
                  "value": "Russian Federation"
                },
                {
                  "name": "Original Place of Birth Text",
                  "value": "Saint-Petersburg, Russian Federation"
                },
                {
                  "name": "Date of Birth",
                  "value": "1952-10-07",
                  "tag": "date_of_birth"
                },
                {
                  "name": "Gender",
                  "value": "male"
                },
                {
                  "name": "Amended On",
                  "value": "2022-03-04"
                },
                {
                  "name": "Designation Date",
                  "value": "2022-02-28"
                },
                {
                  "name": "Listing Origin",
                  "value": "EU"
                },
                {
                  "name": "Other Information",
                  "value": "Function: President of the Russian Federation"
                },
                {
                  "name": "Other Information",
                  "value": "NOT SUBJECT TO TRAVEL RESTRICTIONS ACCORDING TO ARTICLE 29(1)"
                },
                {
                  "name": "Program",
                  "value": "Ordinance of 4 March 2022 on measures related to the situation in Ukraine (RS 946.231.176.72), annexes 2, 8, 9, 10, 11, 12,13, 14, 15 and 25"
                },
                {
                  "name": "Reason",
                  "value": "On 22 Feb 2022, he signed a decree recognising the \"independence and sovereignty\" of the non-government-controlled areas of the Donetsk and Luhansk oblasts of Ukraine, and ordered the Russian armed forces into those areas."
                },
                {
                  "name": "Reason",
                  "value": "On 24 Feb 2022, he ordered a military operation in Ukraine and Russian armed forces began an attack on Ukraine. That attack is a blatant violation of the territorial integrity, sovereignty and independence of Ukraine."
                },
                {
                  "name": "Reason",
                  "value": "Vladimir Putin is responsible for and actively supporting actions undermining the territorial integrity, sovereignty and independence of Ukraine, as well as stability and security in Ukraine."
                },
                {
                  "name": "Reason",
                  "value": "Vladimir Putin is the President of the Russian Federation."
                },
                {
                  "name": "Reason",
                  "value": "Vladimir Putin is the President of the Russian Federation. On 22 Feb 2022, he signed a decree recognising the \"independence and sovereignty\" of the non-government-controlled areas of the Donetsk and Luhansk oblasts of Ukraine, and ordered the Russian armed forces into those areas. On 24 Feb 2022, he ordered a military operation in Ukraine and Russian armed forces began an attack on Ukraine. That attack is a blatant violation of the territorial integrity, sovereignty and independence of Ukraine. Vladimir Putin is responsible for and actively supporting actions undermining the territorial integrity, sovereignty and independence of Ukraine, as well as stability and security in Ukraine."
                },
                {
                  "name": "Sanction Type",
                  "value": "Art. 15 para. 1 and 4 (Financial sanctions) and art. 29 para. 1 (Travel ban), annexe 8"
                }
              ]
            },
            "other": {
              "countries": [
                {
                  "name": "Countries",
                  "value": "Russian Federation",
                  "tag": "country_names"
                }
              ]
            }
          },
          "updatedAt": "2024-05-16T00:27:40Z"
        },
        "score": 2,
        "matchStatus": "potential_match",
        "isWhitelisted": false,
        "matchTypesDetails": [
          {
            "nameMatches": [
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": ["sanction"],
            "sources": ["Ministry of Finance Japan Economic Sanctions List"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Vladimir Putin"
          },
          {
            "nameMatches": [
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": ["sanction"],
            "sources": [
              "United Kingdom HM Treasury Office of Financial Sanctions Implementation Consolidated List"
            ],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Vladimir Putin"
          },
          {
            "nameMatches": [
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "vladimir"
              },
              {
                "matchTypes": ["exact_match"],
                "queryTerm": "putin"
              },
              {
                "matchTypes": ["name_variations_removal"],
                "queryTerm": "vladimirovitch"
              }
            ],
            "amlTypes": ["sanction"],
            "sources": ["OFAC SDN List"],
            "secondaryMatches": [
              {
                "matchTypes": ["exact_birth_year_match"],
                "queryTerm": "1952"
              }
            ],
            "matchingName": "Vladimir Putin"
          }
        ]
      }
    ],
    "createdAt": "2024-05-16 15:21:33",
    "ref": "1715872893-_NH49ork",
    "matchStatus": "potential_match",
    "totalHits": 1,
    "cached": false,
    "totalBlacklistHits": 0,
    "shareUrl": "https://app.us.complyadvantage.com/public/search/1715872893-_NH49ork/db3ddc3c950f",
    "id": 583714360,
    "totalMatches": 1,
    "updatedAt": "2024-05-16 15:21:33"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule              | Description                                         |
| ----------------- | --------------------------------------------------- |
| Sanctions matched | Indicates whether the entity has sanctions applied. |
| {% endtab %}      |                                                     |
| {% endtabs %}     |                                                     |


# Global identity verification

The query functions to verify if a person's basic data is consistent. In other words, it assesses whether the name, date of birth, address, phone number, and document number indeed belong to that person. Through this verification, the query validates the provided set of data and classifies the reliability of the information as reliable, sufficient, or unreliable.

To indicate an individual's trustworthiness, there are several possible combinations of data to evaluate the reliability score, which can vary between 10, 20, or 30.

![](https://3218940882-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVxCOSyBojfSIE5fcpfH%2Fuploads%2Fgit-blob-e12d3d95665559f34874673ca5c6f0fd36836f19%2Ftable.png?alt=media)

**Section**: `globalIdentityVerifications`

**Supported Countries:** Argentina, Australia\*, Austria, Belgium, Brazil, Canada\*, China, Chile, Colombia, Czechia, Denmark, Finland, France, Germany, Ghana, Gibraltar, Greece, Hong Kong\*, India\*, Indonesia, Ireland, Italy, Japan, Kenya, Luxembourg, Malaysia, Mexico, Netherlands, New Zealand, Nigeria, Norway, Philippines, Poland, Portugal, Singapore, Slovakia, South Africa, Spain, Sweden, Switzerland, Turkey, United Kingdom, United States and Vietnam.

**Note:** Australia, Canada, Hong Kong, and India require authorization for consultation before being able to access the data (Onboarding process).

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

| Attribute    | Type   | Description                                            | Mandatory                       |
| ------------ | ------ | ------------------------------------------------------ | ------------------------------- |
| name         | string | Full name of the individual.                           | Yes                             |
| birthDate    | string | Date of birth of the individual.                       | Yes                             |
| address      | string | Address of the individual.                             | Yes                             |
| phoneNumber  | string | Phone number of the individual.                        | Yes                             |
| nationalId   | string | A government-issued identification number or document. | Yes/No (Depends on the country) |
| zipCode      | string | Zip code of the individual's address.                  | Yes                             |
| countryCode  | string | Country code of the individual.                        | Yes                             |
| dateFormat   | string | Date format of Birth Date.                             | No                              |
| {% endtab %} |        |                                                        |                                 |

{% tab title="Example body" %}

```javascript
body: JSON.stringify({
  workflowId: "6644843a90k8762k25929376",
  parameters: {
    name: "Mariana Oliveira",
    birthDate: "23/04/1995",
    phoneNumber: "+5551998765432",
    address: "Rua das Flores, 123",
    zipCode: "12345678",
    nationalId: "9876543210",
    countryCode: "BR",
    dateFormat: "dd/MM/yyyy",
  },
});
```

{% endtab %}
{% endtabs %}

**Note:** Some fields returned by this API are optional and their presence cannot be guaranteed.

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

| Attribute              | Type   | Description                                                                                                                                    |
| ---------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| data                   | object | Object containing the main data.                                                                                                               |
| data.detailList        | string | Details related to the query.                                                                                                                  |
| data.adaptation        | string | Indicator of adaptation.                                                                                                                       |
| data.messages          | array  | List of messages providing details on the level of matches for each piece of data.                                                             |
| data.messages\[].value | string | Indicates the match level of the data (Full match, No match, Partial match, etc.).                                                             |
| data.messages\[].code  | string | Code indicating the type of data analyzed (FIRSTNAME, COMPLETENAME, PHONENUMBER, etc.).                                                        |
| data.detailCode        | string | Detailed code specific to the process or request.                                                                                              |
| data.query             | object | Information about the performed query.                                                                                                         |
| data.query.options     | string | Internal value indicating the search type of the query.                                                                                        |
| data.reliability       | string | Indicator of reliability (10, 20, 30).                                                                                                         |
| data.statusCode        | string | Transaction status. Check our status guide.                                                                                                    |
| statusCode             | string | References the status of this query only, not the entire transaction. [Check our status guide](/caf-api/connect/transactions/background-check) |
| {% endtab %}           |        |                                                                                                                                                |

{% tab title="Example" %}

```json
{
  "data": {
    "detailList": "",
    "adaptation": "0",
    "messages": [
      {
        "value": "Full match was made on Complete Name",
        "code": "1MT-BR-GVT2-COMPLETENAME"
      },
      {
        "value": "Full match was made on First Initial",
        "code": "1MT-BR-GVT2-FIRSTINITIAL"
      },
      {
        "value": "Full match was made on First Name/Given Name",
        "code": "1MT-BR-GVT2-FIRSTNAME"
      },
      {
        "value": "Full match was made on Last Name/Surname ",
        "code": "1MT-BR-GVT2-LASTNAME"
      },
      {
        "value": "Full match was made on Postal Code/Zip Code",
        "code": "1MT-BR-GVT2-POSTALCODE"
      },
      {
        "value": "Full match was made on State/Province",
        "code": "1MT-BR-GVT2-PROVINCE"
      },
      {
        "value": "Datasource does not contain element Sub Premise Descriptors provided in Address Lines",
        "code": "4MT-BR-GVT2-SUBPREMISE"
      },
      {
        "value": "Datasource does not contain element Phone Number",
        "code": "4MT-BR-GVT2-PHONENUMBER"
      },
      {
        "value": "Partial match made on element Address Lines",
        "code": "3MT-BR-GVT2-ADDRESS"
      },
      {
        "value": "Full match was made on Date of Birth",
        "code": "1MT-BR-GVT2-DATEOFBIRTH"
      },
      {
        "value": "Full match was made on Day of Birth",
        "code": "1MT-BR-GVT2-DAYOFBIRTH"
      },
      {
        "value": "Full match was made on Month of Birth",
        "code": "1MT-BR-GVT2-MONTHOFBIRTH"
      },
      {
        "value": "Full match was made on Year of Birth",
        "code": "1MT-BR-GVT2-YEAROFBIRTH"
      },
      {
        "value": "Full match was made on Last Name/Surname",
        "code": "1AU-400-LASTNAME"
      },
      {
        "value": "Full match was made on First Name/Given Name",
        "code": "1AU-350-FIRSTNAME"
      },
      {
        "value": "Full match was made on First Initial",
        "code": "1AU-375-FIRSTINITIAL"
      },
      {
        "value": "Full match was made on Complete Name",
        "code": "1AU-425-COMPLETENAME"
      },
      {
        "value": "Full match was made on Year of Birth",
        "code": "1AU-625-YEAROFBIRTH"
      },
      {
        "value": "Full match was made on Month of Birth",
        "code": "1AU-600-MONTHOFBIRTH"
      },
      {
        "value": "Full match was made on Day of Birth",
        "code": "1AU-575-DAYOFBIRTH"
      },
      {
        "value": "Full match was made on Date of Birth",
        "code": "1AU-550-DATEOFBIRTH"
      },
      {
        "value": "Partial match made on element Address Lines",
        "code": "3AU-200-ADDRESS"
      },
      {
        "value": "No match was made on Street/Thoroughfare",
        "code": "2AU-075-THOROUGHFARE"
      },
      {
        "value": "No match was made on House Number/Street Number",
        "code": "2AU-050-HOUSENUMBER"
      },
      {
        "value": "No match was made on District",
        "code": "2AU-225-DISTRICT"
      },
      {
        "value": "Full match was made on State/Province",
        "code": "1AU-325-PROVINCE"
      },
      {
        "value": "Full match was made on Postal Code/Zip Code",
        "code": "1AU-275-POSTALCODE"
      },
      {
        "value": "Full Match for 1+1 verification",
        "code": "1MT-BR-MATCHED-1+1"
      },
      {
        "value": "1AU-275-POSTALCODE;1AU-325-PROVINCE;1AU-350-FIRSTNAME;1AU-375-FIRSTINITIAL;1AU-400-LASTNAME;1AU-425-COMPLETENAME;1AU-550-DATEOFBIRTH;1AU-575-DAYOFBIRTH;1AU-600-MONTHOFBIRTH;1AU-625-YEAROFBIRTH;1MT-BR-GVT2-COMPLETENAME;1MT-BR-GVT2-DATEOFBIRTH;1MT-BR-GVT2-DAYOFBIRTH;1MT-BR-GVT2-FIRSTINITIAL;1MT-BR-GVT2-FIRSTNAME;1MT-BR-GVT2-LASTNAME;1MT-BR-GVT2-MONTHOFBIRTH;1MT-BR-GVT2-POSTALCODE;1MT-BR-GVT2-PROVINCE;1MT-BR-GVT2-YEAROFBIRTH;1MT-BR-MATCHED-1+1;2AU-050-HOUSENUMBER;2AU-075-THOROUGHFARE;2AU-225-DISTRICT;3AU-200-ADDRESS;3MT-BR-GVT2-ADDRESS;4MT-BR-GVT2-PHONENUMBER;4MT-BR-GVT2-SUBPREMISE;",
        "code": "Codes"
      }
    ],
    "detailCode": "WS-2253205.2024.4.27.17.1.51.23",
    "query": {
      "options": "identityverify;messageverbose"
    },
    "reliability": "10"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                    | Description                                                                                                                    |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Basic information with reliable match   | Indicates whether the individual's basic information (name, address, dob, document number and phone number) matches.           |
| Basic information with sufficient match | Indicates whether the individual's basic information (name, address, dob, document number and phone number) partially matches. |
| {% endtab %}                            |                                                                                                                                |
| {% endtabs %}                           |                                                                                                                                |


# Global identity double verification

The query functions to verify if a person's basic data is consistent. In other words, it assesses whether the name, date of birth, address, phone number, and document number indeed belong to that person.

Global Identity Verification 2x2 has an extra layer of validations because when querying a person through this service, the person will be checked against two different data sources in a single query. In other words, the basic data will be sent to two different providers and must be approved by both for the data to be considered reliable, sufficient, or insufficient.

To indicate the reliability of an individual, there are some possible combinations of data that take into account the results of both sources to define the final reliability score.

![](https://3218940882-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVxCOSyBojfSIE5fcpfH%2Fuploads%2Fgit-blob-1ec6d8115a95cfd1b6b59b9c37ecbe20029c0fcf%2Ftable2x2.png?alt=media)

**Section**: `globalIdentityVerifications2x2`

**Supported countries:** Argentina, Australia\*, Austria, Belgium, Brazil, Canada\*, China, Denmark, Finland, France, Germany, Hong Kong\*, India\*, Italy, Mexico, Netherlands, Norway, Portugal, South Africa, Spain, Sweden, Switzerland, United Kingdom and United States.

**Note:** Australia, Canada, Hong Kong and India require authorization for consultation before being able to access the data (Onboarding process).

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

| Attribute    | Type   | Description                                            | Mandatory                       |
| ------------ | ------ | ------------------------------------------------------ | ------------------------------- |
| name         | string | Full name of the individual.                           | Yes                             |
| birthDate    | string | Date of birth of the individual.                       | Yes                             |
| address      | string | Address of the individual.                             | Yes                             |
| phoneNumber  | string | Phone number of the individual.                        | Yes                             |
| nationalId   | string | A government-issued identification number or document. | Yes/No (Depends on the country) |
| zipCode      | string | Zip code of the individual's address.                  | Yes                             |
| countryCode  | string | Country code of the individual.                        | Yes                             |
| dateFormat   | string | Date format of Birth Date.                             | No                              |
| {% endtab %} |        |                                                        |                                 |

{% tab title="Example body" %}

```javascript
body: JSON.stringify({
  workflowId: "6644843a90k8762k25929376",
  parameters: {
    name: "Mariana Oliveira",
    birthDate: "23/04/1995",
    phoneNumber: "+5551998765432",
    address: "Rua das Flores, 123",
    zipCode: "12345678",
    nationalId: "9876543210",
    countryCode: "BR",
    dateFormat: "dd/MM/yyyy",
  },
});
```

{% endtab %}
{% endtabs %}

**Note:** Some fields returned by this API are optional and their presence cannot be guaranteed.

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

| Attribute              | Type   | Description                                                                                                                                    |
| ---------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| data                   | object | Object containing the main data.                                                                                                               |
| data.detailList        | string | Details related to the query.                                                                                                                  |
| data.adaptation        | string | Indicator of adaptation.                                                                                                                       |
| data.messages          | array  | List of messages providing details on the level of matches for each piece of data.                                                             |
| data.messages\[].value | string | Indicates the match level of the data (Full match, No match, Partial match, etc.).                                                             |
| data.messages\[].code  | string | Code indicating the type of data analyzed (FIRSTNAME, COMPLETENAME, PHONENUMBER, etc.).                                                        |
| data.detailCode        | string | Detailed code specific to the process or request.                                                                                              |
| data.query             | object | Information about the performed query.                                                                                                         |
| data.query.options     | string | Internal value indicating the search type of the query.                                                                                        |
| data.reliability       | string | Indicator of reliability (10, 20, 30).                                                                                                         |
| data.statusCode        | string | Transaction status. Check our status guide.                                                                                                    |
| statusCode             | string | References the status of this query only, not the entire transaction. [Check our status guide](/caf-api/connect/transactions/background-check) |
| {% endtab %}           |        |                                                                                                                                                |

{% tab title="Example" %}

```json
{
  "data": {
    "detailList": "",
    "adaptation": "0",
    "messages": [
      {
        "value": "0;0;0;3;3;0;3;0;3;3;0;3;3;0;3;3;3;3;0;0;0;0;0;4;3",
        "code": "TEL7"
      },
      {
        "value": "1;1;1;3;3;1;3;2;3;0;0;4;3;0;3;0;0;3;0;1;1;1;1;4;3",
        "code": "GVT2"
      },
      {
        "value": "Full match was made on Complete Name",
        "code": "1MT-BR-GVT2-COMPLETENAME"
      },
      {
        "value": "Full match was made on First Initial",
        "code": "1MT-BR-GVT2-FIRSTINITIAL"
      },
      {
        "value": "Full match was made on First Name/Given Name",
        "code": "1MT-BR-GVT2-FIRSTNAME"
      },
      {
        "value": "Full match was made on Last Name/Surname ",
        "code": "1MT-BR-GVT2-LASTNAME"
      },
      {
        "value": "Full match was made on Postal Code/Zip Code",
        "code": "1MT-BR-GVT2-POSTALCODE"
      },
      {
        "value": "Full match was made on State/Province",
        "code": "1MT-BR-GVT2-PROVINCE"
      },
      {
        "value": "Datasource does not contain element Sub Premise Descriptors provided in Address Lines",
        "code": "4MT-BR-GVT2-SUBPREMISE"
      },
      {
        "value": "Datasource does not contain element Phone Number",
        "code": "4MT-BR-GVT2-PHONENUMBER"
      },
      {
        "value": "Partial match made on element Address Lines",
        "code": "3MT-BR-GVT2-ADDRESS"
      },
      {
        "value": "Full match was made on Date of Birth",
        "code": "1MT-BR-GVT2-DATEOFBIRTH"
      },
      {
        "value": "Full match was made on Day of Birth",
        "code": "1MT-BR-GVT2-DAYOFBIRTH"
      },
      {
        "value": "Full match was made on Month of Birth",
        "code": "1MT-BR-GVT2-MONTHOFBIRTH"
      },
      {
        "value": "Full match was made on Year of Birth",
        "code": "1MT-BR-GVT2-YEAROFBIRTH"
      },
      {
        "value": "Full match was made on Complete Name",
        "code": "1AU-425-COMPLETENAME"
      },
      {
        "value": "Full match was made on First Initial",
        "code": "1AU-375-FIRSTINITIAL"
      },
      {
        "value": "Full match was made on First Name/Given Name",
        "code": "1AU-350-FIRSTNAME"
      },
      {
        "value": "Full match was made on Last Name/Surname ",
        "code": "1AU-400-LASTNAME"
      },
      {
        "value": "Full match was made on Postal Code/Zip Code",
        "code": "1AU-275-POSTALCODE"
      },
      {
        "value": "Full match was made on State/Province",
        "code": "1AU-325-PROVINCE"
      },
      {
        "value": "Full match was made on Date of Birth",
        "code": "1AU-550-DATEOFBIRTH"
      },
      {
        "value": "Full match was made on Day of Birth",
        "code": "1AU-575-DAYOFBIRTH"
      },
      {
        "value": "Full match was made on Month of Birth",
        "code": "1AU-600-MONTHOFBIRTH"
      },
      {
        "value": "Full match was made on Year of Birth",
        "code": "1AU-625-YEAROFBIRTH"
      },
      {
        "value": "Partial match made on element Address Lines",
        "code": "3AU-200-ADDRESS"
      },
      {
        "value": "1AU-275-POSTALCODE;1AU-325-PROVINCE;1AU-350-FIRSTNAME;1AU-375-FIRSTINITIAL;1AU-400-LASTNAME;1AU-425-COMPLETENAME;1AU-550-DATEOFBIRTH;1AU-575-DAYOFBIRTH;1AU-600-MONTHOFBIRTH;1AU-625-YEAROFBIRTH;1MT-BR-GVT2-COMPLETENAME;1MT-BR-GVT2-DATEOFBIRTH;1MT-BR-GVT2-DAYOFBIRTH;1MT-BR-GVT2-FIRSTINITIAL;1MT-BR-GVT2-FIRSTNAME;1MT-BR-GVT2-LASTNAME;1MT-BR-GVT2-MONTHOFBIRTH;1MT-BR-GVT2-POSTALCODE;1MT-BR-GVT2-PROVINCE;1MT-BR-GVT2-YEAROFBIRTH;3AU-200-ADDRESS;3MT-BR-GVT2-ADDRESS;4MT-BR-GVT2-PHONENUMBER;4MT-BR-GVT2-SUBPREMISE;GVT2;TEL7;",
        "code": "Codes"
      },
      {
        "value": "GVT2-ND",
        "code": "MatchCodes"
      },
      {
        "value": "Full Match for 1+1 verification",
        "code": "1MT-BR-MATCHED-1+1"
      }
    ],
    "detailCode": "WS-9055217.2024.4.28.16.42.15.908",
    "query": {
      "options": "identityverify;messageverbose"
    },
    "reliability": "20"
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                                          | Description                                                                                                                    |
| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Basic information with reliable match - double verification   | Indicates whether the individual's basic information (name, address, dob, document number and phone number) matches.           |
| Basic information with sufficient match - double verification | Indicates whether the individual's basic information (name, address, dob, document number and phone number) partially matches. |
| {% endtab %}                                                  |                                                                                                                                |
| {% endtabs %}                                                 |                                                                                                                                |


# KYB

{% content-ref url="/pages/O0ZXu1YRsaQ730t9M4bh" %}
[Financial](/caf-api/connect/transactions/background-check/kyb/financial)
{% endcontent-ref %}

{% content-ref url="/pages/C4pl2GVSIqqX0BwBnDMN" %}
[Labor](/caf-api/connect/transactions/background-check/kyb/labor)
{% endcontent-ref %}

{% content-ref url="/pages/21uACYm7B6pb89o6V0kr" %}
[Register data](/caf-api/connect/transactions/background-check/kyb/register-data)
{% endcontent-ref %}

{% content-ref url="/pages/MalvNM79J1TURsH1dIz5" %}
[Risk](/caf-api/connect/transactions/background-check/kyb/risk)
{% endcontent-ref %}


# Financial

## PGFN Debtor's List (PJ94)

Returns if the queried CNPJ is registered in active debts with PGFN.

**Section:** `pjPgfnDebtors`

**Required parameter:** `cnpj`

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

| Attribute      | Type    | Description                                                                                         |
| -------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode     | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data           | Object  | Return data                                                                                         |
| data.message   | String  | Query result descriptive message                                                                    |
| data.hasDebts  | Boolean | Debt status (true/false)                                                                            |
| data.debtValue | String  | Amount owed to PGFN                                                                                 |
| {% endtab %}   |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "",
  "data": {
    "message": "",
    "hasDebts": "",
    "debtValue": ""
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                 | Description                                                |
| -------------------- | ---------------------------------------------------------- |
| has\_debts\_on\_pgfn | The rule will be invalid if there are debts with the PGFN. |
| {% endtab %}         |                                                            |
| {% endtabs %}        |                                                            |

## Associated CVM (PJ65)

Returns information of CNPJ that have relation with financial market

**Section:** `pjAssociatedCvm`

**Required parameter:** `cnpj`

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

| Attribute                                     | Type   | Description                                                                                         |
| --------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                    | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                          | Object | Return data                                                                                         |
| data.message                                  | String | Descriptive with query status                                                                       |
| data.associates                               | Array  | Describes the data of the Registration Types at the Comissão de Valores Mobiliarios                 |
| data.associates\[x].name                      | String | Name of the individual                                                                              |
| data.associates\[x].type                      | String | Type of registration                                                                                |
| data.associates\[x].recordDate                | String | Date of registration                                                                                |
| data.associates\[x].situation                 | String | Cadastro Status                                                                                     |
| data.associates\[x].directors                 | Array  | List of objects that contain data about directors                                                   |
| data.associates\[x].directors\[x].name        | String | Name of the company in which the CPF is a director                                                  |
| data.associates\[x].directors\[x].startDate   | String | Beginning date of the position as director                                                          |
| data.associates\[x].directors\[x].instruction | String | Instruction of the director in the company                                                          |
| {% endtab %}                                  |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "",
  "data": "",
  "message": "",
  "associates": [
    {
      "name": "",
      "type": "",
      "recordDate": "",
      "situation": "",
      "directors": [
        {
          "name": "",
          "startDate": "",
          "instruction": ""
        }
      ]
    }
  ]
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                      | Description                                                                        |
| ------------------------- | ---------------------------------------------------------------------------------- |
| has\_no\_participant\_cvm | The rule will be invalid if the consulted CPF/CNPJ is not registered with the CVM. |
| {% endtab %}              |                                                                                    |
| {% endtabs %}             |                                                                                    |

## Temporary Penalties at CVM (PJ93)

Consult the list of CVM's Temporary Penalties if the participant is temporarily prevented from operating in the capital markets due to a decision in a Sanctioning Administrative Proceeding.

**Section:** `pjPenaltiesOnCvm`

**Required parameter:** `name`

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

| Attribute                                | Type   | Description                                                                                         |
| ---------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                               | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                     | Object | Return data                                                                                         |
| data.message                             | String | Description with query status                                                                       |
| data.listOfSetences                      | Array  | List of members set/punished                                                                        |
| data.listOfSetences\[x].processNumber    | String | Process Number                                                                                      |
| data.listOfSetences\[x].name             | String | Participant                                                                                         |
| data.listOfSetences\[x].decisionType     | String | Type of Decision                                                                                    |
| data.listOfSetences\[x].judgementDate    | String | Date of CVM Sentencing                                                                              |
| data.listOfSetences\[x].effectiveDate    | String | Effective Date of Penalty                                                                           |
| data.listOfSetences\[x].timeOfWithdrawal | String | Removal Time                                                                                        |
| {% endtab %}                             |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "",
  "data": {
    "message": "",
    "listOfSetences": [
      {
        ".processNumber": "",
        ".name": "",
        ".decisionType": "",
        ".judgementDate": "",
        ".effectiveDate": "",
        ".timeOfWithdrawal": ""
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                    | Description                                                                         |
| ----------------------- | ----------------------------------------------------------------------------------- |
| has\_penalties\_on\_cvm | The rule will be invalid if the CPF is temporarily barred from acting with the CVM. |
| {% endtab %}            |                                                                                     |
| {% endtabs %}           |                                                                                     |

## Ownership Interest in Company (PJ90)

Returns the percentage of participation of the partners in a company.

**Section:** `pjCompanyOwnersPercentage`

**Required parameter:** `cnpj`

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

| Attribute                            | Type   | Description                                                                                         |
| ------------------------------------ | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                           | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                 | Object | Return data                                                                                         |
| data.message                         | String | Descriptive with query status                                                                       |
| data.companyShares                   | Array  | Estimated income value                                                                              |
| data.companyShares\[x].cnpj          | String | CNPJ                                                                                                |
| data.companyShares\[x].cpf           | String | CPF                                                                                                 |
| data.companyShares\[x].corporateName | String | Company name                                                                                        |
| data.companyShares\[x].totalShare    | String | Percentage of participation                                                                         |
| {% endtab %}                         |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "companyShares": [
      {
        "cnpj": "XXXXX6900XXXXX",
        "cpf": "XXX7007XXX",
        "corporateName": "CORPORATE NAME",
        "totalShare": "X5.X0"
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                  | Description                                                             |
| --------------------- | ----------------------------------------------------------------------- |
| has\_no\_total\_share | The rule will be invalid if the participation value is null or invalid. |
| {% endtab %}          |                                                                         |
| {% endtabs %}         |                                                                         |

## Credit Information System (PJ96)

Returns a person's credit information.

**Section:** `pjCreditOperationsSCR`

**Required parameters:** `cnpj, PJ`

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

| Attribute                                                          | Type   | Description                                                                                                                                                                                    |
| ------------------------------------------------------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| statusCode                                                         | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code))                                                                                            |
| data                                                               | Object | Return data                                                                                                                                                                                    |
| data.message                                                       | String | Description with query status                                                                                                                                                                  |
| data.clientCode                                                    | String | CNPJ                                                                                                                                                                                           |
| data.registrationDate                                              | Date   | Registration date                                                                                                                                                                              |
| data.baseDate                                                      | Date   | Base date for consultation                                                                                                                                                                     |
| data.assumedCoobligation                                           | Number | Co-obligation assumed in cession of credit by client                                                                                                                                           |
| data.receivedCoobligation                                          | Number | Co-obligation received in credit assignment                                                                                                                                                    |
| data.processedDocumentsPercentage                                  | Number | Percentage of the 3040 documents expected for the base date and that have already been incorporated to the SCR database in the Central Bank, not considering the exempt financial institutions |
| data.processedVolumePercentage                                     | Number | Percentage of the volume expected for the base date and which are already incorporated to the SCR database at the Central Bank, not considering the exempted financial institutions            |
| data.totalOfInstituions                                            | String | Number of financial institutions (FIs) where the client has operations                                                                                                                         |
| data.totalOfTransactions                                           | String | Number of operations of the client in the SFN                                                                                                                                                  |
| data.totalDisagreementTransactions                                 | String | Number of operations marked with a manifestation of disagreement                                                                                                                               |
| data.totalSubJudiceTransactions                                    | String | Number of operations marked with sub judice                                                                                                                                                    |
| data.fullLiabilityDisagreement                                     | String | Total responsibility of operations marked with manifestation of disagreement                                                                                                                   |
| data.fullLiabilitySubJudice                                        | String | Total liability of operations under judgement                                                                                                                                                  |
| data.indirectVendorRisk                                            | String | Indirect risk assumed by the client in vendor operations                                                                                                                                       |
| data.operationSumaryList                                           | Array  | List containing summary of operations                                                                                                                                                          |
| data.operationSumaryList\[x].modalityCategoryCode                  | String | Operation modality code                                                                                                                                                                        |
| data.operationSumaryList\[x].modalityCategoryDescription           | String | Description of the operation modality code                                                                                                                                                     |
| data.operationSumaryList\[x].modalitySubCategoryCode               | String | Subcategory code                                                                                                                                                                               |
| data.operationSumaryList\[x].modalitySubCategoryDescription        | String | Description of the subcategory indicator                                                                                                                                                       |
| data.operationSumaryList\[x].listOfDebts                           | Array  | Due date list                                                                                                                                                                                  |
| data.operationSumaryList\[x].listOfDebts\[x].expirationCode        | String | Maturity indicator                                                                                                                                                                             |
| data.operationSumaryList\[x].listOfDebts\[x].expirationDescription | String | Description of due date indicator                                                                                                                                                              |
| data.operationSumaryList\[x].listOfDebts\[x].value                 | String | Due date value                                                                                                                                                                                 |
| {% endtab %}                                                       |        |                                                                                                                                                                                                |

{% tab title="Example" %}

```json
{
  "statusCode": "",
  "data": {
    "message": "",
    "clientCode": "",
    "registrationDate": "2000-00-00T00:00:00.000Z",
    "baseDate": "2000-00-00T00:00:00.000Z",
    "assumedCoobligation": 00,
    "receivedCoobligation": 00,
    "processedDocumentsPercentage": 00,
    "processedVolumePercentage": 00,
    "totalOfInstituions": "",
    "totalOfTransactions": "",
    "totalDisagreementTransactions": "",
    "totalSubJudiceTransactions": "",
    "fullLiabilityDisagreement": "",
    "fullLiabilitySubJudice": "",
    "indirectVendorRisk": "",
    "operationSumaryList": [
      {
        "modalityCategoryCode": "",
        "modalityCategoryDescription": "",
        "modalitySubCategoryCode": "",
        "modalitySubCategoryDescription": "",
        "listOfDebts": [
          {
            "expirationCode": "",
            "expirationDescription": "",
            "value": ""
          }
        ]
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

## Credit Score - NEW (PJ87)

Returns the credit score of a company based on their behavior, the score will estimate the proability of default and how risky the profile is, related to credit

**Section:** `pjCreditScore`

**Required parameter:** `cnpj`

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

| Attribute         | Type    | Description                                                                                         |
| ----------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode        | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| message           | String  | Descriptive with query status                                                                       |
| data              | Object  | Return data                                                                                         |
| data.score        | Integer | Consumer Score rating                                                                               |
| data.scoreMessage | String  | Context of recommendation for decision-making                                                       |
| {% endtab %}      |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "message": "Consulta realizada com sucesso.",
  "data": {
    "score": 777,
    "scoreMessage":
      "De cada 1000 empresas classificadas nesta classe de score, é provável que na média 37 apresente débitos no mercado nos próximos 12 meses.",
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                     | Description                                                                     |
| ------------------------ | ------------------------------------------------------------------------------- |
| credit\_score\_available | The rule will become invalid if the credit score is unavailable.                |
| credit\_score\_below     | The rule will become invalid if the credit score is below the defined value.    |
| credit\_score\_over      | The rule will become invalid if the credit score is above the defined value.    |
| credit\_score\_between   | The rule will become invalid if the credit score is between the defined values. |
| {% endtab %}             |                                                                                 |
| {% endtabs %}            |                                                                                 |

## Credit Profile - NEW (PJ88)

Return a comprehensive evaluation of a business's financial health by providing its credit score and presenting a detailed financial profile. Drawing on an extensive range of data, including registered debts, inquiry history, protests, returns, and banking activity, as well as supplementary data such as affiliations with other companies and records of bankruptcy or judicial recovery, it delivers a predictive analysis of the company's current and future payment capacity. This solution enables access to a reliable and complete financial overview of the business, making it ideal for credit decisions and risk analysis, offering clear insights to mitigate risks and maximize financial opportunities.

Data blocks will only be returned if information is available.

**Section:** `pjCreditProfileDetails`

**Required parameter:** `cnpj`

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

| Attribute                                                                                                                                         | Type    | Description                                                                                         |
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                                                                                                                                        | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| message                                                                                                                                           | String  | Descriptive with query status                                                                       |
| data                                                                                                                                              | Object  | Return data                                                                                         |
| data.civilActions                                                                                                                                 | Object  | A block providing a consolidated view of civil action records                                       |
| data.civilActions.totalActions                                                                                                                    | String  | Civil actions total quantity                                                                        |
| data.civilActions.totalValue                                                                                                                      | String  | Civil actions total value                                                                           |
| data.civilActions.firstValue                                                                                                                      | String  | First civil actions value                                                                           |
| data.civilActions.firstDate                                                                                                                       | String  | First civil actions date                                                                            |
| data.civilActions.highestValue                                                                                                                    | String  | Highest civil actions value                                                                         |
| data.civilActions.highestDate                                                                                                                     | String  | Highest civil actions value                                                                         |
| data.civilActions.latestOccurrences                                                                                                               | Array   | A list containing information on the last civil actions occurrences                                 |
| data.civilActions.latestOccurrences\[x].defendant                                                                                                 | String  | Defendant name                                                                                      |
| data.civilActions.latestOccurrences\[x].action                                                                                                    | String  | Civil action title                                                                                  |
| data.civilActions.latestOccurrences\[x].document                                                                                                  | String  | Document                                                                                            |
| data.civilActions.latestOccurrences\[x].courtDistrict                                                                                             | String  | Court district                                                                                      |
| data.civilActions.latestOccurrences\[x].state                                                                                                     | String  | State                                                                                               |
| data.civilActions.latestOccurrences\[x].court                                                                                                     | String  | Court                                                                                               |
| data.civilActions.latestOccurrences\[x].plaintiff                                                                                                 | String  | Civil action author                                                                                 |
| data.civilActions.latestOccurrences\[x].lawsuitNumber                                                                                             | String  | Civil action number                                                                                 |
| data.civilActions.latestOccurrences\[x].distribution                                                                                              | String  | Distribution                                                                                        |
| data.civilActions.latestOccurrences\[x].amount                                                                                                    | String  | Amount                                                                                              |
| data.administrators                                                                                                                               | Object  | A list containing detailed information on each company administrators                               |
| data.administrators.name                                                                                                                          | String  | Name                                                                                                |
| data.administrators.cpf                                                                                                                           | String  | CPF                                                                                                 |
| data.administrators.entry                                                                                                                         | String  | Entry date                                                                                          |
| data.administrators.mandate                                                                                                                       | String  | Indeterminado                                                                                       |
| data.administrators.position                                                                                                                      | String  | Position                                                                                            |
| data.administrators.cpfStatus                                                                                                                     | String  | CPF status                                                                                          |
| data.administrators.debtIndicator                                                                                                                 | String  | Debt indicator                                                                                      |
| data.administrators.fraudIndicator                                                                                                                | String  | Fraud indicator                                                                                     |
| data.administrators.documentRestrictions                                                                                                          | Object  | Document restrictions documents                                                                     |
| data.administrators.documentRestrictions.pendingRestrictions                                                                                      | Object  | Pending restrictions                                                                                |
| data.administrators.documentRestrictions.pendingRestrictions.quantity                                                                             | String  | Total quantity                                                                                      |
| data.administrators.documentRestrictions.pendingRestrictions.last                                                                                 | String  | Date of the last register                                                                           |
| data.administrators.documentRestrictions.pendingRestrictions.amount                                                                               | String  | Amount                                                                                              |
| data.administrators.documentRestrictions.nonSufficientFundsChecks                                                                                 | Object  | Non sufficient funds on bank checks                                                                 |
| data.administrators.documentRestrictions.nonSufficientFundsChecks.quantity                                                                        | String  | Total quantity                                                                                      |
| data.administrators.documentRestrictions.nonSufficientFundsChecks.last                                                                            | String  | Date of the last register                                                                           |
| data.administrators.documentRestrictions.nonSufficientFundsChecks.amount                                                                          | String  | Amount                                                                                              |
| data.administrators.documentRestrictions.protests                                                                                                 | Object  | Protests                                                                                            |
| data.administrators.documentRestrictions.protests.quantity                                                                                        | String  | Total quantity                                                                                      |
| data.administrators.documentRestrictions.protests.last                                                                                            | String  | Date of the last register                                                                           |
| data.administrators.documentRestrictions.protests.amount                                                                                          | String  | Amount                                                                                              |
| data.administrators.documentRestrictions.judicialActions                                                                                          | Object  | Judicial actions                                                                                    |
| data.administrators.documentRestrictions.judicialActions.quantity                                                                                 | String  | Total quantity                                                                                      |
| data.administrators.documentRestrictions.judicialActions.last                                                                                     | String  | Date of the last register                                                                           |
| data.administrators.documentRestrictions.judicialActions.amount                                                                                   | String  | Amount                                                                                              |
| data.administrators.documentRestrictions.bankruptciesAndJudicialRecoveries                                                                        | Object  | Bankruptcies and judicial recoveries                                                                |
| data.administrators.documentRestrictions.bankruptciesAndJudicialRecoveries.quantity                                                               | String  | Total quantity                                                                                      |
| data.administrators.documentRestrictions.bankruptciesAndJudicialRecoveries.last                                                                   | String  | Date of the last register                                                                           |
| data.administrators.documentRestrictions.bankruptciesAndJudicialRecoveries.amount                                                                 | String  | Amount                                                                                              |
| data.administrators.documentRestrictions.inquiries                                                                                                | Object  | Inquiries                                                                                           |
| data.administrators.documentRestrictions.inquiries.quantity                                                                                       | String  | Total quantity                                                                                      |
| data.administrators.documentRestrictions.inquiries.last                                                                                           | String  | Date of the last register                                                                           |
| data.administrators.documentRestrictions.inquiries.amount                                                                                         | String  | Amount                                                                                              |
| data.fraudAlert                                                                                                                                   | Object  | Fraud alert                                                                                         |
| data.fraudAlert.message                                                                                                                           | String  | Fraud alert message                                                                                 |
| data.userReportedReturnedChecks                                                                                                                   | Object  | A block providing a consolidated view of user reported returned bank checks                         |
| data.userReportedReturnedChecks.totalQuantity                                                                                                     | String  | Total quantity                                                                                      |
| data.userReportedReturnedChecks.initialPeriod                                                                                                     | String  | Initial period                                                                                      |
| data.userReportedReturnedChecks.finalPeriod                                                                                                       | String  | Final period                                                                                        |
| data.userReportedReturnedChecks.latestOccurrences                                                                                                 | Array   | A list containing information on the last user reported returned bank checks occurrences            |
| data.userReportedReturnedChecks.latestOccurrences\[x].informer                                                                                    | String  | Informer                                                                                            |
| data.userReportedReturnedChecks.latestOccurrences\[x].bank                                                                                        | String  | Bank                                                                                                |
| data.userReportedReturnedChecks.latestOccurrences\[x].agency                                                                                      | String  | Agency                                                                                              |
| data.userReportedReturnedChecks.latestOccurrences\[x].initialChecks                                                                               | String  | Initial bank checks                                                                                 |
| data.userReportedReturnedChecks.latestOccurrences\[x].finalChecks                                                                                 | String  | Final bank checks                                                                                   |
| data.userReportedReturnedChecks.latestOccurrences\[x].occurrenceDate                                                                              | String  | Occurrence date                                                                                     |
| data.userReportedReturnedChecks.latestOccurrences\[x].registrationDate                                                                            | String  | Registration date                                                                                   |
| data.userReportedReturnedChecks.latestOccurrences\[x].reason                                                                                      | String  | Reason                                                                                              |
| data.userReportedReturnedChecks.latestOccurrences\[x].city                                                                                        | String  | City                                                                                                |
| data.userReportedReturnedChecks.latestOccurrences\[x].state                                                                                       | String  | State                                                                                               |
| data.nonSufficientFundsChecks                                                                                                                     | Object  | A block providing a consolidated view of non sufficient funds on bank checks                        |
| data.nonSufficientFundsChecks.totalNsfChecks                                                                                                      | String  | Total quantity                                                                                      |
| data.nonSufficientFundsChecks.totalRelatedNames                                                                                                   | String  | Total related names                                                                                 |
| data.nonSufficientFundsChecks.latestOccurrences                                                                                                   | Array   | A list containing information on the last non sufficient funds on bank checks occurrences           |
| data.nonSufficientFundsChecks.latestOccurrences\[x].name                                                                                          | String  | Name                                                                                                |
| data.nonSufficientFundsChecks.latestOccurrences\[x].lastDate                                                                                      | String  | Date of the occurrence                                                                              |
| data.nonSufficientFundsChecks.latestOccurrences\[x].bankNumber                                                                                    | String  | Bank number                                                                                         |
| data.nonSufficientFundsChecks.latestOccurrences\[x].bankName                                                                                      | String  | Bank name                                                                                           |
| data.nonSufficientFundsChecks.latestOccurrences\[x].agency                                                                                        | String  | Agency                                                                                              |
| data.nonSufficientFundsChecks.latestOccurrences\[x].reason                                                                                        | String  | Reason                                                                                              |
| data.nonSufficientFundsChecks.latestOccurrences\[x].quantity                                                                                      | String  | Total quantity                                                                                      |
| data.revokedChecks                                                                                                                                | Object  | A block providing a consolidated view of revoked bank checks                                        |
| data.revokedChecks.total                                                                                                                          | String  | Total quantity                                                                                      |
| data.revokedChecks.initialPeriod                                                                                                                  | String  | Initial period                                                                                      |
| data.revokedChecks.finalPeriod                                                                                                                    | String  | Final period                                                                                        |
| data.revokedChecks.latestOccurrences                                                                                                              | Array   | A list containing information on the last revoked bank checks occurrences                           |
| data.revokedChecks.latestOccurrences\[x].date                                                                                                     | String  | Suspention date                                                                                     |
| data.revokedChecks.latestOccurrences\[x].bank                                                                                                     | String  | Bank                                                                                                |
| data.revokedChecks.latestOccurrences\[x].agency                                                                                                   | String  | Agency                                                                                              |
| data.revokedChecks.latestOccurrences\[x].checks                                                                                                   | String  | Bank checks                                                                                         |
| data.revokedChecks.latestOccurrences\[x].occurrenceDate                                                                                           | String  | Occurrence date                                                                                     |
| data.futureCommitment                                                                                                                             | Object  | A block providing a consolidated view of future commitments                                         |
| data.futureCommitment.commitmentsList                                                                                                             | Array   | A list containing period and score of commitments                                                   |
| data.futureCommitment.commitmentsList \[x].period                                                                                                 | String  | Commitment period                                                                                   |
| data.futureCommitment.commitmentsList \[x].score                                                                                                  | String  | Commitment score                                                                                    |
| data.futureCommitment.creditList                                                                                                                  | Array   | A list containing period and score of credits                                                       |
| data.futureCommitment.creditList\[x].period                                                                                                       | String  | Commitment period                                                                                   |
| data.futureCommitment.creditList\[x].score                                                                                                        | String  | Commitment score                                                                                    |
| data.creditObtained                                                                                                                               | Object  | A block providing a consolidated view of credit obtained                                            |
| data.creditObtained.score                                                                                                                         | String  | Credit obtained score                                                                               |
| data.creditObtained.behaviorIndicatorList                                                                                                         | Array   | A list containing period and score of behavior indicator                                            |
| data.creditObtained.behaviorIndicatorList\[x].monthYear                                                                                           | String  | Month and year                                                                                      |
| data.creditObtained.behaviorIndicatorList\[x].monthlyScore                                                                                        | String  | Monthly score                                                                                       |
| data.otherInformation                                                                                                                             | Object  | A block providing a consolidated view on other information                                          |
| data.otherInformation.supplierRelationshipDuration                                                                                                | String  | A list containing period and values of supplier relationship                                        |
| data.otherInformation.supplierRelationshipDuration\[x].period                                                                                     | String  | Period                                                                                              |
| data.otherInformation.supplierRelationshipDuration\[x].amount                                                                                     | String  | Amount                                                                                              |
| data.otherInformation.importantEvents                                                                                                             | Array   | A list containing information about important events                                                |
| data.otherInformation.importantEvents\[x].indicator                                                                                               | String  | Indicator                                                                                           |
| data.otherInformation.importantEvents\[x].period                                                                                                  | String  | Period                                                                                              |
| data.otherInformation.importantEvents\[x].score                                                                                                   | String  | Score                                                                                               |
| data.latePayment                                                                                                                                  | Object  | A block providing a consolidated view on late payments                                              |
| data.latePayment.latePayment6to15DaysPeriod                                                                                                       | Array   | A list containing information late payment from 6 to 15 days                                        |
| data.latePayment.latePayment6to15DaysPeriod\[x].monthYear                                                                                         | String  | Month and year                                                                                      |
| data.latePayment.latePayment6to15DaysPeriod\[x].monthlyScore                                                                                      | String  | Monthly score                                                                                       |
| data.latePayment.latePayment16to30DaysPeriod                                                                                                      | Array   | A list containing information late payment from 16 to 30 days                                       |
| data.latePayment.latePayment16to30DaysPeriod\[x].monthYear                                                                                        | String  | Month and year                                                                                      |
| data.latePayment.latePayment16to30DaysPeriod\[x].monthlyScore                                                                                     | String  | Monthly score                                                                                       |
| data.latePayment.latePayment31to60DaysPeriod                                                                                                      | Array   | A list containing information late payment from 31 to 60 days                                       |
| data.latePayment.latePayment31to60DaysPeriod\[x].monthYear                                                                                        | String  | Month and year                                                                                      |
| data.latePayment.latePayment31to60DaysPeriod\[x].monthlyScore                                                                                     | String  | Monthly score                                                                                       |
| data.latePayment.latePaymentover60DaysPeriod                                                                                                      | Array   | A list containing information late payment over 60 days                                             |
| data.latePayment.latePaymentover60DaysPeriod\[x].monthYear                                                                                        | String  | Month and year                                                                                      |
| data.latePayment.latePaymentover60DaysPeriod\[x].monthlyScore                                                                                     | String  | Monthly score                                                                                       |
| data.latePayment.latePaymentaverageDelayDays                                                                                                      | Array   | A list containing information late payment average delay days                                       |
| data.latePayment.latePaymentaverageDelayDays\[x].monthYear                                                                                        | String  | Month and year                                                                                      |
| data.latePayment.latePaymentaverageDelayDays\[x].monthlyScore                                                                                     | String  | Monthly score                                                                                       |
| data.onTimePayment                                                                                                                                | Array   | A list containing information of on time payment                                                    |
| data.onTimePayment\[x].monthYear                                                                                                                  | String  | Month and year                                                                                      |
| data.onTimePayment\[x].monthlyScore                                                                                                               | String  | Monthly score                                                                                       |
| data.commitments                                                                                                                                  | Object  | A block providing a consolidated view on commitments                                                |
| data.commitments.score                                                                                                                            | String  | Commitments score                                                                                   |
| data.commitments.behaviorIndicatorList                                                                                                            | Array   | A list containing period and score of behavior indicator                                            |
| data.commitments.behaviorIndicatorList\[x].monthYear                                                                                              | String  | Month and year                                                                                      |
| data.commitments.behaviorIndicatorList\[x].monthlyScore                                                                                           | String  | Monthly score                                                                                       |
| data.inquiries                                                                                                                                    | Object  | A block providing a consolidated view on inquiries                                                  |
| data.inquiries.totalQuantity                                                                                                                      | String  | Total quantity                                                                                      |
| data.inquiries.initialPeriod                                                                                                                      | String  | Initial period                                                                                      |
| data.inquiries.finalPeriod                                                                                                                        | String  | Final period                                                                                        |
| data.inquiries.monthlyInquiries                                                                                                                   | Array   | A list containing period and quantity of inquiries                                                  |
| data.inquiries.monthlyInquiries\[x].monthYear                                                                                                     | String  | Month and year                                                                                      |
| data.inquiries.monthlyInquiries\[x].quantity                                                                                                      | String  | Total inquiries                                                                                     |
| data.inquiries.recentInquiries                                                                                                                    | Array   | A list containing information about recent inquiries                                                |
| data.inquiries.recentInquiries\[x].date                                                                                                           | String  | Inquiry date                                                                                        |
| data.inquiries.recentInquiries\[x].companyName                                                                                                    | String  | Company name                                                                                        |
| data.inquiries.recentInquiries\[x].cnpj                                                                                                           | String  | CNPJ                                                                                                |
| data.decision                                                                                                                                     | String  | Negotiation Suggestion with the company                                                             |
| data.bankruptciesAndJudicialRecoveries                                                                                                            | Object  | A block providing a consolidated view of bankruptcies and judicial recoveries                       |
| data.bankruptciesAndJudicialRecoveries.totalQuantity                                                                                              | String  | Total quantity                                                                                      |
| data.bankruptciesAndJudicialRecoveries.initialPeriod                                                                                              | String  | Initial period                                                                                      |
| data.bankruptciesAndJudicialRecoveries.finalPeriod                                                                                                | String  | Final period                                                                                        |
| data.bankruptciesAndJudicialRecoveries.latestOccurrences                                                                                          | Array   | A list containing information on the last revoked bank checks occurrences                           |
| data.bankruptciesAndJudicialRecoveries.latestOccurrences\[x].occurrenceType                                                                       | String  | Occurrence type                                                                                     |
| data.bankruptciesAndJudicialRecoveries.latestOccurrences\[x].date                                                                                 | String  | Date                                                                                                |
| data.bankruptciesAndJudicialRecoveries.latestOccurrences\[x].city                                                                                 | String  | City                                                                                                |
| data.bankruptciesAndJudicialRecoveries.latestOccurrences\[x].state                                                                                | String  | State                                                                                               |
| data.bankruptciesAndJudicialRecoveries.latestOccurrences\[x].court                                                                                | String  | Court                                                                                               |
| data.completeIdentification                                                                                                                       | Object  | A block providing a consolidated view of the company identification                                 |
| data.completeIdentification.cnpj                                                                                                                  | String  | CNPJ                                                                                                |
| data.completeIdentification.companyName                                                                                                           | String  | Company name                                                                                        |
| data.completeIdentification.tradingName                                                                                                           | String  | Trading name                                                                                        |
| data.completeIdentification.cnpjStatus                                                                                                            | String  | CNPJ status                                                                                         |
| data.completeIdentification.statusDate                                                                                                            | String  | Status Date                                                                                         |
| data.completeIdentification.federalRevenueInquiryDate                                                                                             | String  | Federal revenue inquiry date                                                                        |
| data.completeIdentification.nireNumber                                                                                                            | String  | NIRE number                                                                                         |
| data.completeIdentification.nireFederativeUnit                                                                                                    | String  | NIRE state                                                                                          |
| data.completeIdentification.stateRegistration                                                                                                     | String  | State registration                                                                                  |
| data.completeIdentification.stateRegistrationFederativeUnit                                                                                       | String  | State registration state                                                                            |
| data.completeIdentification.foundationDate                                                                                                        | String  | Opening date                                                                                        |
| data.completeIdentification.sintegraStatus                                                                                                        | String  | Sintegra status                                                                                     |
| data.completeIdentification.sintegraInquiryDate                                                                                                   | String  | Sintegra inquiry date                                                                               |
| data.completeIdentification.legalNatureCode                                                                                                       | String  | Legal nature code                                                                                   |
| data.completeIdentification.legalNature                                                                                                           | String  | Legal nature                                                                                        |
| data.completeIdentification.segment                                                                                                               | String  | segment                                                                                             |
| data.completeIdentification.initialCapitalCurrency                                                                                                | String  | Initial capital currency                                                                            |
| data.completeIdentification.initialCapital                                                                                                        | String  | Initial capital                                                                                     |
| data.completeIdentification.registrationDate                                                                                                      | String  | Registration date                                                                                   |
| data.completeIdentification.agency                                                                                                                | String  | Agency                                                                                              |
| data.completeIdentification.currentCapitalCurrency                                                                                                | String  | Current capital currency                                                                            |
| data.completeIdentification.currentCapital                                                                                                        | String  | Current capital                                                                                     |
| data.completeIdentification.capitalChangeDate                                                                                                     | String  | Capital change date                                                                                 |
| data.completeIdentification.currentAgency                                                                                                         | String  | Current agency                                                                                      |
| data.completeIdentification.primaryBusinessActivity                                                                                               | Object  | Primary business activity                                                                           |
| data.completeIdentification.primaryBusinessActivity.activity                                                                                      | String  | Activity                                                                                            |
| data.completeIdentification.primaryBusinessActivity.cnae                                                                                          | String  | CNAE code                                                                                           |
| data.completeIdentification.secondaryBusinessActivity                                                                                             | Object  | Secondary business activity                                                                         |
| data.completeIdentification.secondaryBusinessActivity.activity                                                                                    | String  | Activity                                                                                            |
| data.completeIdentification.secondaryBusinessActivity.cnae                                                                                        | String  | CNAE code                                                                                           |
| data.completeIdentification.otherBusinessActivities                                                                                               | Object  | Other business activity                                                                             |
| data.completeIdentification.otherBusinessActivities.activity                                                                                      | String  | Activity                                                                                            |
| data.completeIdentification.otherBusinessActivities.cnae                                                                                          | String  | CNAE code                                                                                           |
| data.completeIdentification.branchQuantity                                                                                                        | String  | Branch quantity                                                                                     |
| data.completeIdentification.branches                                                                                                              | String  | Branches list                                                                                       |
| data.completeIdentification.fgts                                                                                                                  | Object  | FGTS                                                                                                |
| data.completeIdentification.fgts.status                                                                                                           | String  | FGTS status                                                                                         |
| data.completeIdentification.fgts.validityDate                                                                                                     | String  | Validity date                                                                                       |
| data.completeIdentification.fgts.inquiryDate                                                                                                      | String  | Inquiry date                                                                                        |
| data.completeLocation                                                                                                                             | Object  | A block providing a consolidated view of the company location                                       |
| data.completeLocation.headOffice                                                                                                                  | Object  | A block providing a consolidated view of the company head office                                    |
| data.completeLocation.headOffice.headOfficeAddress                                                                                                | String  | Address                                                                                             |
| data.completeLocation.headOffice.headOfficeComplement                                                                                             | String  | Complement                                                                                          |
| data.completeLocation.headOffice.headOfficeIbgeCode                                                                                               | String  | IbgeCode                                                                                            |
| data.completeLocation.headOffice.headOfficeNeighborhood                                                                                           | String  | Neighborhood                                                                                        |
| data.completeLocation.headOffice.headOfficeZipCode                                                                                                | String  | Postal code                                                                                         |
| data.completeLocation.headOffice.headOfficeCity                                                                                                   | String  | City                                                                                                |
| data.completeLocation.headOffice.headOfficeState                                                                                                  | String  | State                                                                                               |
| data.completeLocation.headOffice.headOffice                                                                                                       | Object  | A block providing a list of company head office phone numbers                                       |
| data.completeLocation.headOffice.headOffice.phoneNumber                                                                                           | String  | Phone number                                                                                        |
| data.completeLocation.headOffice.branch                                                                                                           | Array   | A list containing information on the company branchs                                                |
| data.completeLocation.headOffice.branch\[x].branchAddress                                                                                         | String  | Address                                                                                             |
| data.completeLocation.headOffice.branch\[x].branchComplement                                                                                      | String  | Complement                                                                                          |
| data.completeLocation.headOffice.branch\[x].branchIbgeCode                                                                                        | String  | IbgeCode                                                                                            |
| data.completeLocation.headOffice.branch\[x].branchNeighborhood                                                                                    | String  | Neighborhood                                                                                        |
| data.completeLocation.headOffice.branch\[x].branchZipCode                                                                                         | String  | Postal code                                                                                         |
| data.completeLocation.headOffice.branch\[x].branchCity                                                                                            | String  | City                                                                                                |
| data.completeLocation.headOffice.branch\[x].branchState                                                                                           | String  | State                                                                                               |
| data.completeLocation.headOffice.branch\[x].branchPhone                                                                                           | Object  | A block providing a list of company branch phone numbers                                            |
| data.completeLocation.headOffice.branch\[x].branchPhone.phoneNumber                                                                               | String  | Phone number                                                                                        |
| data.consultedCompanyParticipations                                                                                                               | Array   | A list containing information on consulted companies participations                                 |
| data.consultedCompanyParticipations.participatedCompanyName                                                                                       | String  | Company name                                                                                        |
| data.consultedCompanyParticipations.participatedCnpj                                                                                              | String  | CNPJ                                                                                                |
| data.consultedCompanyParticipations.cnpjStatus                                                                                                    | String  | CNPJ status                                                                                         |
| data.consultedCompanyParticipations.participation                                                                                                 | String  | Participation percentage                                                                            |
| data.consultedCompanyParticipations.entry                                                                                                         | String  | Entry date                                                                                          |
| data.consultedCompanyParticipations.debtIndicator                                                                                                 | String  | Debt indicator                                                                                      |
| data.consultedCompanyParticipations.fraudIndicator                                                                                                | String  | Fraud indicator                                                                                     |
| data.consultedCompanyParticipations.documentRestrictions                                                                                          | Object  | Document restrictions documents                                                                     |
| data.consultedCompanyParticipations.documentRestrictions.pendingRestrictions                                                                      | Object  | Pending restrictions                                                                                |
| data.consultedCompanyParticipations.documentRestrictions.pendingRestrictions.quantity                                                             | String  | Total quantity                                                                                      |
| data.consultedCompanyParticipations.documentRestrictions.pendingRestrictions.last                                                                 | String  | Date of the last register                                                                           |
| data.consultedCompanyParticipations.documentRestrictions.pendingRestrictions.amount                                                               | String  | Amount                                                                                              |
| data.consultedCompanyParticipations.documentRestrictions.nonSufficientFundsChecks                                                                 | Object  | Non sufficient funds on bank checks                                                                 |
| data.consultedCompanyParticipations.documentRestrictions.nonSufficientFundsChecks.quantity                                                        | String  | Total quantity                                                                                      |
| data.consultedCompanyParticipations.documentRestrictions.nonSufficientFundsChecks.last                                                            | String  | Date of the last register                                                                           |
| data.consultedCompanyParticipations.documentRestrictions.nonSufficientFundsChecks.amount                                                          | String  | Amount                                                                                              |
| data.consultedCompanyParticipations.documentRestrictions.protests                                                                                 | Object  | Protests                                                                                            |
| data.consultedCompanyParticipations.documentRestrictions.protests.quantity                                                                        | String  | Total quantity                                                                                      |
| data.consultedCompanyParticipations.documentRestrictions.protests.last                                                                            | String  | Date of the last register                                                                           |
| data.consultedCompanyParticipations.documentRestrictions.protests.amount                                                                          | String  | Amount                                                                                              |
| data.consultedCompanyParticipations.documentRestrictions.judicialActions                                                                          | Object  | Judicial actions                                                                                    |
| data.consultedCompanyParticipations.documentRestrictions.judicialActions.quantity                                                                 | String  | Total quantity                                                                                      |
| data.consultedCompanyParticipations.documentRestrictions.judicialActions.last                                                                     | String  | Date of the last register                                                                           |
| data.consultedCompanyParticipations.documentRestrictions.judicialActions.amount                                                                   | String  | Amount                                                                                              |
| data.consultedCompanyParticipations.documentRestrictions.bankruptciesAndJudicialRecoveries                                                        | Object  | Bankruptcies and judicial recoveries                                                                |
| data.consultedCompanyParticipations.documentRestrictions.bankruptciesAndJudicialRecoveries.quantity                                               | String  | Total quantity                                                                                      |
| data.consultedCompanyParticipations.documentRestrictions.bankruptciesAndJudicialRecoveries.last                                                   | String  | Date of the last register                                                                           |
| data.consultedCompanyParticipations.documentRestrictions.bankruptciesAndJudicialRecoveries.amount                                                 | String  | Amount                                                                                              |
| data.consultedCompanyParticipations.documentRestrictions.inquiries                                                                                | Object  | Inquiries                                                                                           |
| data.consultedCompanyParticipations.documentRestrictions.inquiries.quantity                                                                       | String  | Total quantity                                                                                      |
| data.consultedCompanyParticipations.documentRestrictions.inquiries.last                                                                           | String  | Date of the last register                                                                           |
| data.consultedCompanyParticipations.documentRestrictions.inquiries.amount                                                                         | String  | Amount                                                                                              |
| data.participationsInOtherCompanies                                                                                                               | Array   | A list containing information on participations in other companies                                  |
| data.participationsInOtherCompanies\[x].participatedCompanyName                                                                                   | String  | Company name                                                                                        |
| data.participationsInOtherCompanies\[x].participatedCnpj                                                                                          | String  | CNPJ                                                                                                |
| data.participationsInOtherCompanies\[x].cnpjStatus                                                                                                | String  | CNPJ status                                                                                         |
| data.participationsInOtherCompanies\[x].participation                                                                                             | String  | Participation percentage                                                                            |
| data.participationsInOtherCompanies\[x].entry                                                                                                     | String  | Entry date                                                                                          |
| data.participationsInOtherCompanies\[x].debtIndicator                                                                                             | String  | Debt indicator                                                                                      |
| data.participationsInOtherCompanies\[x].fraudIndicator                                                                                            | String  | Fraud indicator                                                                                     |
| data.partnerAdministratorParticipationsInOtherCompanies                                                                                           | Array   | A list containing information on partners or administrators participations in other companies       |
| data.partnerAdministratorParticipationsInOtherCompanies.partnerName                                                                               | String  | Name                                                                                                |
| data.partnerAdministratorParticipationsInOtherCompanies.cpf                                                                                       | String  | CPF                                                                                                 |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners                                                                     | Array   | A list containing details on partners participations                                                |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].companyName                                                     | String  | Company name                                                                                        |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].cnpj                                                            | String  | CNPJ                                                                                                |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].cnpjStatus                                                      | String  | CNPJ status                                                                                         |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].participation                                                   | String  | Participation percentage                                                                            |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].entry                                                           | String  | Entry date                                                                                          |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].debtIndicator                                                   | String  | Debt indicator                                                                                      |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].fraudIndicator                                                  | String  | Fraud indicator                                                                                     |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions                                            | Object  | Document restrictions documents                                                                     |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.pendingRestrictions                        | Object  | Pending restrictions                                                                                |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.pendingRestrictions.quantity               | String  | Total quantity                                                                                      |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.pendingRestrictions.last                   | String  | Date of the last register                                                                           |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.pendingRestrictions.amount                 | String  | Amount                                                                                              |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.nonSufficientFundsChecks                   | Object  | Non sufficient funds on bank checks                                                                 |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.nonSufficientFundsChecks.quantity          | String  | Total quantity                                                                                      |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.nonSufficientFundsChecks.last              | String  | Date of the last register                                                                           |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.nonSufficientFundsChecks.amount            | String  | Amount                                                                                              |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.protests                                   | Object  | Protests                                                                                            |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.protests.quantity                          | String  | Total quantity                                                                                      |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.protests.last                              | String  | Date of the last register                                                                           |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.protests.amount                            | String  | Amount                                                                                              |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.judicialActions                            | Object  | Judicial actions                                                                                    |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.judicialActions.quantity                   | String  | Total quantity                                                                                      |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.judicialActions.last                       | String  | Date of the last register                                                                           |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.judicialActions.amount                     | String  | Amount                                                                                              |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.bankruptciesAndJudicialRecoveries          | Object  | Bankruptcies and judicial recoveries                                                                |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.bankruptciesAndJudicialRecoveries.quantity | String  | Total quantity                                                                                      |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.bankruptciesAndJudicialRecoveries.last     | String  | Date of the last register                                                                           |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.bankruptciesAndJudicialRecoveries.amount   | String  | Amount                                                                                              |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.inquiries                                  | Object  | Inquiries                                                                                           |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.inquiries.quantity                         | String  | Total quantity                                                                                      |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.inquiries.last                             | String  | Date of the last register                                                                           |
| data.partnerAdministratorParticipationsInOtherCompanies.participatingPartners\[x].documentRestrictions.inquiries.amount                           | String  | Amount                                                                                              |
| data.pendingRestrictions                                                                                                                          | Object  | A block providing a consolidated view on pending restrictions                                       |
| data.pendingRestrictions.totalPending                                                                                                             | String  | Total pendings                                                                                      |
| data.pendingRestrictions.totalCreditors                                                                                                           | String  | Total creditors                                                                                     |
| data.pendingRestrictions.amount                                                                                                                   | String  | Amount                                                                                              |
| data.pendingRestrictions.initialPeriod                                                                                                            | String  | Initial period                                                                                      |
| data.pendingRestrictions.finalPeriod                                                                                                              | String  | Final period                                                                                        |
| data.pendingRestrictions.firstValue                                                                                                               | String  | First pending value                                                                                 |
| data.pendingRestrictions.firstDate                                                                                                                | String  | First pending date                                                                                  |
| data.pendingRestrictions.highestValue                                                                                                             | String  | Highest pending value                                                                               |
| data.pendingRestrictions.highestDate                                                                                                              | String  | Highest pending date                                                                                |
| data.pendingRestrictions.latestOccurrences                                                                                                        | Array   | A list containing information on the last pending restrictions                                      |
| data.pendingRestrictions.latestOccurrences\[x].informer                                                                                           | String  | Informer                                                                                            |
| data.pendingRestrictions.latestOccurrences\[x].type                                                                                               | String  | Type                                                                                                |
| data.pendingRestrictions.latestOccurrences\[x].city                                                                                               | String  | City                                                                                                |
| data.pendingRestrictions.latestOccurrences\[x].state                                                                                              | String  | State                                                                                               |
| data.pendingRestrictions.latestOccurrences\[x].originDocument                                                                                     | String  | Document origin                                                                                     |
| data.pendingRestrictions.latestOccurrences\[x].debitDate                                                                                          | String  | Debit date                                                                                          |
| data.pendingRestrictions.latestOccurrences\[x].availableAt                                                                                        | String  | available at                                                                                        |
| data.pendingRestrictions.latestOccurrences\[x].amount                                                                                             | String  | Amount                                                                                              |
| data.protests                                                                                                                                     | Object  | A block providing a consolidated view on protests                                                   |
| data.protests.totalProtests                                                                                                                       | String  | Total protests                                                                                      |
| data.protests.totalValue                                                                                                                          | String  | Protests total value                                                                                |
| data.protests.firstValue                                                                                                                          | String  | First protest value                                                                                 |
| data.protests.firstDate                                                                                                                           | String  | First protest date                                                                                  |
| data.protests.highestValue                                                                                                                        | String  | Highest protest value                                                                               |
| data.protests.highestDate                                                                                                                         | String  | Highest protest date                                                                                |
| data.protests.latestOccurrences                                                                                                                   | Array   | A list containing information on the last protests                                                  |
| data.protests.latestOccurrences\[x].date                                                                                                          | String  | Date                                                                                                |
| data.protests.latestOccurrences\[x].dueDate                                                                                                       | String  | Due date                                                                                            |
| data.protests.latestOccurrences\[x].notaryOffice                                                                                                  | String  | Notary office                                                                                       |
| data.protests.latestOccurrences\[x].city                                                                                                          | String  | City                                                                                                |
| data.protests.latestOccurrences\[x].state                                                                                                         | String  | State                                                                                               |
| data.protests.latestOccurrences\[x].amount                                                                                                        | String  | Amount                                                                                              |
| data.score                                                                                                                                        | Object  | Credit score                                                                                        |
| data.score.score                                                                                                                                  | Integer | Score rating                                                                                        |
| data.score.scoreMessage                                                                                                                           | String  | Context of recommendation for decision-making                                                       |
| data.score.probability                                                                                                                            | String  | Probability                                                                                         |
| data.score.numericalClassification                                                                                                                | String  | Numerical classification                                                                            |
| data.score.alphabeticalClassification                                                                                                             | String  | Alphabetical classification                                                                         |
| data.partners                                                                                                                                     | Object  | A block providing a consolidated view on partners                                                   |
| data.partners.companyName                                                                                                                         | String  | Company name                                                                                        |
| data.partners.cpfCnpj                                                                                                                             | String  | CNP/CNPJ                                                                                            |
| data.partners.documentType                                                                                                                        | String  | Document type                                                                                       |
| data.partners.documentStatus                                                                                                                      | String  | Document status                                                                                     |
| data.partners.participation                                                                                                                       | String  | Participation percentage                                                                            |
| data.partners.entryDate                                                                                                                           | String  | Entry date                                                                                          |
| data.partners.signsForCompany                                                                                                                     | String  | Signs for company                                                                                   |
| data.partners.debtIndicator                                                                                                                       | String  | Debt indicator                                                                                      |
| data.partners.fraudIndicator                                                                                                                      | String  | Fraud indicator                                                                                     |
| data.partners.documentRestrictions                                                                                                                | Object  | Document restrictions documents                                                                     |
| data.partners.documentRestrictions.pendingRestrictions                                                                                            | Object  | Pending restrictions                                                                                |
| data.partners.documentRestrictions.pendingRestrictions.quantity                                                                                   | String  | Total quantity                                                                                      |
| data.partners.documentRestrictions.pendingRestrictions.last                                                                                       | String  | Date of the last register                                                                           |
| data.partners.documentRestrictions.pendingRestrictions.amount                                                                                     | String  | Amount                                                                                              |
| data.partners.documentRestrictions.nonSufficientFundsChecks                                                                                       | Object  | Non sufficient funds on bank checks                                                                 |
| data.partners.documentRestrictions.nonSufficientFundsChecks.quantity                                                                              | String  | Total quantity                                                                                      |
| data.partners.documentRestrictions.nonSufficientFundsChecks.last                                                                                  | String  | Date of the last register                                                                           |
| data.partners.documentRestrictions.nonSufficientFundsChecks.amount                                                                                | String  | Amount                                                                                              |
| data.partners.documentRestrictions.protests                                                                                                       | Object  | Protests                                                                                            |
| data.partners.documentRestrictions.protests.quantity                                                                                              | String  | Total quantity                                                                                      |
| data.partners.documentRestrictions.protests.last                                                                                                  | String  | Date of the last register                                                                           |
| data.partners.documentRestrictions.protests.amount                                                                                                | String  | Amount                                                                                              |
| data.partners.documentRestrictions.judicialActions                                                                                                | Object  | Judicial actions                                                                                    |
| data.partners.documentRestrictions.judicialActions.quantity                                                                                       | String  | Total quantity                                                                                      |
| data.partners.documentRestrictions.judicialActions.last                                                                                           | String  | Date of the last register                                                                           |
| data.partners.documentRestrictions.judicialActions.amount                                                                                         | String  | Amount                                                                                              |
| data.partners.documentRestrictions.bankruptciesAndJudicialRecoveries                                                                              | Object  | Bankruptcies and judicial recoveries                                                                |
| data.partners.documentRestrictions.bankruptciesAndJudicialRecoveries.quantity                                                                     | String  | Total quantity                                                                                      |
| data.partners.documentRestrictions.bankruptciesAndJudicialRecoveries.last                                                                         | String  | Date of the last register                                                                           |
| data.partners.documentRestrictions.bankruptciesAndJudicialRecoveries.amount                                                                       | String  | Amount                                                                                              |
| data.partners.documentRestrictions.inquiries                                                                                                      | Object  | Inquiries                                                                                           |
| data.partners.documentRestrictions.inquiries.quantity                                                                                             | String  | Total quantity                                                                                      |
| data.partners.documentRestrictions.inquiries.last                                                                                                 | String  | Date of the last register                                                                           |
| data.partners.documentRestrictions.inquiries.amount                                                                                               | String  | Amount                                                                                              |
| data.consumerStatus                                                                                                                               | Object  | Consumer status                                                                                     |
| data.consumerStatus.message                                                                                                                       | String  | Consumer status message                                                                             |
| {% endtab %}                                                                                                                                      |         |                                                                                                     |

{% tab title="Example" %}

```json
{
      "code": "01",
      "message": "Consulta realizada com sucesso.",
      "data": {
        "civilActions": {
          "totalActions": "1",
          "totalValue": "3290.61",
          "firstValue": "3290.61",
          "firstDate": "14/07/2022",
          "highestValue": "3290.61",
          "highestDate": "14/07/2022",
          "latestOccurrences": [
            {
              "defendant": "TPS Seguradora SA Falido em Liquidação",
              "action": "Ação executiva municipal",
              "document": "00273078000180",
              "courtDistrict": "São Paulo",
              "state": "SP",
              "court": "1",
              "plaintiff": "Municipio de São Paulo",
              "lawsuitNumber": "0015292312023",
              "distribution": "20/07/2023",
              "amount": "3290.61"
            }
          ]
        },
        "administrators": [
          {
            "name": "Guilherme Joaquim Mateus Cardoso",
            "cpf": "74146649889",
            "entry": "21/08/2023",
            "mandate": "Indeterminado",
            "position": "Diretor",
            "cpfStatus": "Regular",
            "debtIndicator": "Não",
            "fraudIndicator": "Não"
          },
          {
            "name": "Martin Edson Kaique Lopes",
            "cpf": "96819721803",
            "mandate": "Indeterminado",
            "position": "Diretor",
            "cpfStatus": "Regular",
            "debtIndicator": "Não",
            "fraudIndicator": "Sim"
          }
        ],
        "fraudAlert": {
          "message": "Foi informado e enviados documentos pelo responsável pela empresa, documentos que comprovam que o CNPJ consultado foi usado indevidamente no mercado. Como precaução, indicamos entrar em contato com a empresa antes de finalizar qualquer negociação."
        },
        "futureCommitment": {
          "commitmentsList": [
            {
              "period": "Até 30 dias",
              "score": "90"
            },
            {
              "period": "De 31 a 60 Dias",
              "score": "77"
            },
            {
              "period": "De 61 a 90 Dias",
              "score": "70"
            },
            {
              "period": "Acima de 91 Dias",
              "score": "75"
            }
          ],
          "creditList": [
            {
              "period": "Pontuação",
              "score": "99"
            },
            {
              "period": "Até 30 dias",
              "score": "100"
            },
            {
              "period": "De 31 a 60 Dias",
              "score": "90"
            },
            {
              "period": "De 61 a 90 Dias",
              "score": "85"
            },
            {
              "period": "Acima de 91 Dias",
              "score": "85"
            }
          ]
        },
        "creditObtained": {
          "score": "75",
          "behaviorIndicatorList": [
            {
              "monthYear": "mai/2024",
              "monthlyScore": "100"
            },
            {
              "monthYear": "jun/2024",
              "monthlyScore": "100"
            },
            {
              "monthYear": "jul/2024",
              "monthlyScore": "99"
            },
            {
              "monthYear": "ago/2024",
              "monthlyScore": "98"
            },
            {
              "monthYear": "set/2024",
              "monthlyScore": "95"
            }
          ]
        },
        "otherInformation": {
          "supplierRelationshipDuration": [
            {
              "period": "Até 6 meses",
              "amount": "0"
            },
            {
              "period": "De 7 a 12 meses",
              "amount": "0"
            },
            {
              "period": "De 1 a 2 anos",
              "amount": "0"
            },
            {
              "period": "De 3 a 5 anos",
              "amount": "0"
            },
            {
              "period": "De 6 a 10 anos",
              "amount": "0"
            },
            {
              "period": "Mais de 10 anos",
              "amount": "0"
            }
          ],
          "importantEvents": [
            {
              "indicator": "Última Compra",
              "period": "out/2024",
              "score": "349"
            },
            {
              "indicator": "Maior Fatura",
              "period": "nov/2024",
              "score": "468"
            },
            {
              "indicator": "Maior Crédito",
              "period": "jun/2024",
              "score": "615"
            }
          ]
        },
        "latePayment": {
          "latePayment6to15DaysPeriod": [
            {
              "monthYear": "mai/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "jun/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "jul/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "ago/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "set/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "out/2024",
              "monthlyScore": "95"
            }
          ],
          "latePayment16to30DaysPeriod": [
            {
              "monthYear": "mai/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "jun/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "jul/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "ago/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "set/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "out/2024",
              "monthlyScore": "95"
            }
          ],
          "latePayment31to60DaysPeriod": [
            {
              "monthYear": "mai/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "jun/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "jul/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "ago/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "set/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "out/2024",
              "monthlyScore": "95"
            }
          ],
          "latePaymentOver60DaysPeriod": [
            {
              "monthYear": "mai/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "jun/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "jul/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "ago/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "set/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "out/2024",
              "monthlyScore": "95"
            }
          ],
          "latePaymentAverageDelayDays": [
            {
              "monthYear": "mai/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "jun/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "jul/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "ago/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "set/2024",
              "monthlyScore": "95"
            },
            {
              "monthYear": "out/2024",
              "monthlyScore": "95"
            }
          ]
        },
        "onTimePayment": [
          {
            "monthYear": "mai/2024",
            "monthlyScore": "99"
          },
          {
            "monthYear": "jun/2024",
            "monthlyScore": "99"
          },
          {
            "monthYear": "jul/2024",
            "monthlyScore": "99"
          },
          {
            "monthYear": "ago/2024",
            "monthlyScore": "99"
          },
          {
            "monthYear": "set/2024",
            "monthlyScore": "99"
          },
          {
            "monthYear": "out/2024",
            "monthlyScore": "99"
          }
        ],
        "commitments": {
          "score": "100",
          "behaviorIndicatorList": [
            {
              "monthYear": "dez/2022",
              "monthlyScore": "100"
            },
            {
              "monthYear": "dez/2023",
              "monthlyScore": "100"
            }
          ]
        },
        "inquiries": {
          "totalQuantity": "1141",
          "initialPeriod": "01/10/2023",
          "finalPeriod": "01/09/2024",
          "monthlyInquiries": [
            {
              "monthYear": "102024",
              "quantity": "21"
            },
            {
              "monthYear": "092024",
              "quantity": "0"
            },
            {
              "monthYear": "082024",
              "quantity": "2"
            }
          ],
          "recentInquiries": [
            {
              "date": "17/10/2024",
              "companyName": "Banco Itaú",
              "cnpj": "60701190000104"
            },
            {
              "date": "26/09/2024",
              "companyName": "Desk Contábil Ltda",
              "cnpj": "73653459000168"
            }
          ]
        },
        "decision": "Negociação Recomendada",
        "bankruptciesAndJudicialRecoveries": {
          "totalQuantity": "2",
          "initialPeriod": "11/06/2013",
          "finalPeriod": "02/10/2014",
          "latestOccurrences": [
            {
              "occurrenceType": "Recuperação Judicial Requerida",
              "date": "11/06/2019",
              "city": "São Paulo",
              "state": "SP",
              "court": "2"
            },
            {
              "occurrenceType": "Recuperação Judicial Deferida",
              "date": "19/06/2019",
              "city": "São Paulo",
              "state": "SP",
              "court": "2"
            }
          ]
        },
        "completeIdentification": {
          "cnpj": "00000000000191",
          "companyName": "Credit Mais Empréstimos Ltda",
          "tradingName": "Credit Mais",
          "cnpjStatus": "Ativo",
          "statusDate": "15/11/2024",
          "federalRevenueInquiryDate": "15/01/2020",
          "nireNumber": "53300000638",
          "nireFederativeUnit": "SP",
          "stateRegistration": "702863768851",
          "stateRegistrationFederativeUnit": "SP",
          "foundationDate": "15/01/2020",
          "sintegraStatus": "ATIVO",
          "sintegraInquiryDate": "12/11/2024",
          "legalNatureCode": "2054",
          "legalNature": "Sociedade Anonima Fechada",
          "segment": "Crédito e Sistema Financeiro",
          "moeda_capital_inicial": "R$",
          "initialCapital": "6000000.00",
          "registrationDate": "13/03/2020",
          "agency": "São Paulo",
          "currentCapitalCurrency": "R$",
          "currentCapital": "67000000000.00",
          "capitalChangeDate": "31/07/2020",
          "currentAgency": "São Paulo",
          "primaryBusinessActivity": {
            "activity": "BANCOS MULTIPLOS COM CARTEIRA COMERCIAL",
            "cnae": "6422-1/00"
          },
          "secondaryBusinessActivity": {
            "activity": "OUTRAS ATIV SERVS FINANCEIROS N ESPECIFI",
            "cnae": "6499-9/99"
          },
          "otherBusinessActivities": {
            "activity": "OUTRAS ATIV SERVS FINANCEIROS N ESPECIFI",
            "cnae": "6499-9/00"
          },
          "branchQuantity": "7690",
          "branches": "Porto Alegre/RS",
          "fgts": {
            "status": "VENCIDO",
            "validityDate": "01/10/2024 - 30/10/2024",
            "inquiryDate": "04/11/2024"
          }
        },
        "completeLocation": {
          "headOffice": {
            "headOfficeAddress": "Rua Antônio Naves Prado",
            "headOfficeComplement": "701",
            "headOfficeIbgeCode": "3550308",
            "headOfficeNeighborhood": "Jardim Paris",
            "headOfficeZipCode": "05794220",
            "headOfficeCity": "São Paulo",
            "headOfficeState": "SP",
            "headOfficePhone": {
              "phoneNumber": "(11)27967089"
            }
          },
          "branch": [
            {
              "branchAddress": "Avenida Bahia",
              "branchComplement": "203",
              "branchIbgeCode": "4314902",
              "branchNeighborhood": "Navegantes",
              "branchZipCode": "90240550",
              "branchCity": "Porto Alegre",
              "branchState": "RS",
              "branchPhone": {
                "phoneNumber": "(51)38049879"
              }
            }
          ]
        },
        "consultedCompanyParticipations": [
          {
            "participatedCompanyName": "Click Fotografias ME",
            "participatedCnpj": "06516137000180",
            "cnpjStatus": "CANCELADO",
            "participation": "50%",
            "entry": "25/07/2022",
            "debtIndicator": "S",
            "fraudIndicator": "N",
            "documentRestrictions": {
              "pendingRestrictions": {
                "quantity": "0",
                "last": "01/01/2019",
                "amount": "0.00"
              },
              "nonSufficientFundsChecks": {
                "quantity": "10",
                "last": "09/09/2013",
                "amount": "534.85"
              },
              "protests": {
                "quantity": "0",
                "last": "01/01/2019",
                "amount": "0.00"
              },
              "judicialActions": {
                "quantity": "1",
                "last": "21/11/2018",
                "amount": "20.00"
              },
              "bankruptciesAndJudicialRecoveries": {
                "quantity": "0",
                "last": "01/01/2019",
                "amount": "0.00"
              },
              "inquiries": {
                "quantity": "5",
                "last": "19/11/2018",
                "amount": "1000.00"
              }
            }
          }
        ],
        "participationsInOtherCompanies": [
          {
            "participatedCompanyName": "Eloá e Augusto Assessoria Jurídica Ltda",
            "participatedCnpj": "90540877000168",
            "cnpjStatus": "ATIVO",
            "participation": "30%",
            "entry": "01/01/2019",
            "debtIndicator": "N",
            "fraudIndicator": "N"
          }
        ],
        "partners": [
          {
            "companyName": "Augusto Julio Aragão",
            "documentType": "CPF",
            "cpfCnpj": "27385493815",
            "documentStatus": "Inapto",
            "participation": "30.00",
            "entryDate": "17/10/2018",
            "signsForCompany": "N",
            "debtIndicator": "Sim",
            "fraudIndicator": "Não"
          },
          {
            "companyName": "Sueli da Nobrega Farias",
            "documentType": "CNPJ",
            "cpfCnpj": "92020956000173",
            "documentStatus": "Apto",
            "participation": "35.00",
            "entryDate": "01/01/2020",
            "signsForCompany": "S",
            "debtIndicator": "Não",
            "fraudIndicator": "Não"
          }
        ],
        "partnerAdministratorParticipationsInOtherCompanies": [
          {
            "partnerName": "Augusto Julio Aragão",
            "cpf": "27385493815",
            "participatingPartners": [
              {
                "companyName": "Test Drive Locações de Automóveis Ltda",
                "cnpj": "45036714000198",
                "cnpjStatus": "Ativo",
                "participation": "50.00",
                "entry": "09/01/2019",
                "debtIndicator": "Não",
                "fraudIndicator": "Não"
              },
              {
                "companyName": "Augusto Advocacia ME",
                "cnpj": "92020956000173",
                "cnpjStatus": "Inapto",
                "participation": "100,00",
                "entry": "12/06/2012",
                "debtIndicator": "Sim",
                "fraudIndicator": "Não"
              }
            ]
          }
        ],
        "pendingRestrictions": {
          "totalPending": "1",
          "totalCreditors": "1",
          "amount": "12345.00",
          "initialPeriod": "01/01/2022",
          "finalPeriod": "24/08/2026",
          "firstValue": "12345.00",
          "firstDate": "01/01/2022",
          "highestValue": "22222.22",
          "highestDate": "01/01/2022",
          "latestOccurrences": [
            {
              "informer": "Banco Itaú S/A",
              "type": "Outros",
              "city": "São Paulo",
              "state": "SP",
              "originDocument": "CT0000123",
              "debitDate": "01/01/2022",
              "availableAt": "24/08/2026",
              "amount": "12345.00"
            }
          ]
        },
        "protests": {
          "totalProtests": "2",
          "totalValue": "79608.41",
          "firstDate": "16/02/2022",
          "firstValue": "7019.51",
          "highestDate": "22/12/2023",
          "highestValue": "36294.45",
          "latestOccurrences": [
            {
              "date": "18/01/2024",
              "dueDate": "27/07/2023",
              "notaryOffice": "9",
              "city": "São Paulo",
              "state": "SP",
              "amount": "7019.51"
            },
            {
              "date": "20/04/2023",
              "dueDate": "02/02/2022",
              "notaryOffice": "7",
              "city": "Campos dos Goytacazes",
              "state": "RJ",
              "amount": "36294.45"
            }
          ]
        },
        "score": {
          "score": "807",
          "scoreMessage": "De cada 100 empresas classificadas nesta classe de score, é provável que 4 apresentem débitos no mercado nos próximos 12 meses.",
          "probability": "4.0",
          "numericalClassification": "4",
          "alphabeticalClassification": "A"
        },
        "consumerStatus": {
          "message": "CONSUMIDOR PARTICIPANTE DO CADASTRO POSITIVO COM INFORMAÇÃO"
        }
      }
    }
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                     | Description                                                                     |
| ------------------------ | ------------------------------------------------------------------------------- |
| credit\_score\_available | The rule will become invalid if the credit score is unavailable.                |
| credit\_score\_below     | The rule will become invalid if the credit score is below the defined value.    |
| credit\_score\_over      | The rule will become invalid if the credit score is above the defined value.    |
| credit\_score\_between   | The rule will become invalid if the credit score is between the defined values. |
| {% endtab %}             |                                                                                 |
| {% endtabs %}            |                                                                                 |


# Labor

## Labor Debts (PJ98)

Returns the result of the issue of the Labor Debt Clearance Certificate for a given CNPJ

**Section:** `pjLaborDebts`

**Required parameter:** `cnpj`

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

| Attribute                | Type   | Description                                                                                         |
| ------------------------ | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode               | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                     | Object | Return data                                                                                         |
| data.message             | String | Return message                                                                                      |
| data.status              | String | Status ("CONSTA", "NADA CONSTA")                                                                    |
| data.certificateNumber   | String | Certificate number                                                                                  |
| data.certificateValidity | String | Certificate validity                                                                                |
| {% endtab %}             |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "X0",
  "data": {
    "message": "Message",
    "status": "CONSTA",
    "certificateNumber": "X0",
    "certificateValidity": ""
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                  | Description                                        |
| --------------------- | -------------------------------------------------- |
| has\_no\_labor\_debts | The rule will be invalid if there are labor debts. |
| {% endtab %}          |                                                    |
| {% endtabs %}         |                                                    |


# Register data

## Basic Data (PJ1)

Information contained in the company's CNPJ Card with the IRS.

**Section:** `pjData`

**Required parameter:** `cnpj`

**Optional parameter:** `qsa`

{% hint style="info" %}
The `qsa` parameter is necessary for the `qsa_consistent` rule but is not required for the other rules.
{% endhint %}

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

| Atributo                                 | Tipo    | Descrição                                                                                           |
| ---------------------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                               | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                     | Object  | Return data                                                                                         |
| data.registrationNumber                  | String  | Record number                                                                                       |
| data.openingDate                         | String  | Opening date                                                                                        |
| data.officialName                        | String  | Official name                                                                                       |
| data.fantasyName                         | String  | Trading name                                                                                        |
| data.companySize                         | String  | Company size                                                                                        |
| data.mainActivity                        | String  | Main business activity                                                                              |
| data.secondaryActivities                 | Array   | List of secondary activities                                                                        |
| data.secondaryActivities\[x].code        | String  | Activity code                                                                                       |
| data.secondaryActivities\[x].description | String  | Activity description                                                                                |
| data.legalNature                         | String  | Nature                                                                                              |
| data.isMei                               | Boolean | Indicative if the CNPJ is MEI                                                                       |
| data.address                             | Object  | Address                                                                                             |
| data.address.street                      | String  | Street                                                                                              |
| data.address.number                      | String  | Number                                                                                              |
| data.address.complement                  | String  | Complement                                                                                          |
| data.address.zipCode                     | String  | ZIP CODE                                                                                            |
| data.address.neighborhood                | String  | Neighborhood                                                                                        |
| data.address.city                        | String  | City                                                                                                |
| data.address.state                       | String  | State                                                                                               |
| data.companyEmail                        | String  | E-mail                                                                                              |
| data.phoneNumber                         | String  | Telephone                                                                                           |
| data.jointStock                          | String  | Capital stock                                                                                       |
| data.status                              | String  | Company Activity Status                                                                             |
| data.statusOrigin                        | String  | Origin of Company Activity Inquiry                                                                  |
| data.statusDate                          | Date    | Date of company activity inquiry                                                                    |
| data.QSA                                 | Array   | List of partners                                                                                    |
| data.QSA\[x].name                        | String  | Name                                                                                                |
| data.QSA\[x].cpf                         | String  | cpf                                                                                                 |
| data.QSA\[x].function                    | String  | Activity/function                                                                                   |
| data.QSA\[x].functionCode                | String  | Activity/function code                                                                              |
| data.QSA\[x].isLegalRepresentative       | Boolean | Legal representative indication                                                                     |
| data.QSA\[x].personType                  | String  | Type of person in the company                                                                       |
| data.QSA\[x].cnpj                        | String  | CNPJ of the company                                                                                 |
| {% endtab %}                             |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Message",
    "registrationNumber": "XXXXX6450XXXXX",
    "fantasyName": "TRADING NAME",
    "status": "ATIVA",
    "statusDate": "2000-00-00T00:00:00.000Z",
    "openingDate": "00/00/2000",
    "mainActivity": "XXX00XX - Main Activity",
    "mainActivityCode": "XXX00XX",
    "mainActivityDescription": "Main Activity Description",
    "secondaryActivities": [
      {
        "code": "XX015XX",
        "description": "Secondary Activities Description"
      }
    ],
    "address": {
      "state": "UF",
      "city": "CITY",
      "zipCode": "XXX00XXX",
      "street": "STREET",
      "neighborhood": "NEIGHBORHOOD",
      "number": "X7X",
      "complement": "COMPLEMENT"
    },
    "phoneNumber": "00(0X) XXX00XXX",
    "companyEmail": "company@mail.com",
    "jointStock": "R$ 0X.X00,00",
    "officialName": "OFFICIAL NAME",
    "legalNature": "X00X - Legal Nature",
    "legalNatureCode": "X00X",
    "legalNatureDescription": "Legal Nature",
    "isMei": true,
    "companySize": "COMPANY SIZE",
    "qsa": [
      {
        "name": "JOHN DOE",
        "cpf": "**000000**",
        "function": "Function",
        "functionCode": "X0",
        "isLegalRepresentative": true
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| authentic\_cnpj\_number                           | Check that the CNPJ number is authentic.                                                                                                                                                                                                                                                                                                                                                                                         |
| active\_cnpj\_number                              | Check that the CNPJ is active with the Receita Federal.                                                                                                                                                                                                                                                                                                                                                                          |
| is\_not\_me\_company                              | Checks that the size of the company is not ME according to the Receita Federal.                                                                                                                                                                                                                                                                                                                                                  |
| qsa\_pj\_data\_not\_empty                         | Check the corporate structure published by Receita Federal.                                                                                                                                                                                                                                                                                                                                                                      |
| is\_company\_lifetime\_greater\_than\_six\_months | The rule will be invalid if the company's lifespan is less than 6 months.                                                                                                                                                                                                                                                                                                                                                        |
| has\_at\_least\_one\_cnae                         | The rule will be invalid if the company does not have any corresponding CNAEs as defined in the extra rule settings.                                                                                                                                                                                                                                                                                                             |
| minimum\_company\_lifetime                        | Checks that the company's lifespan is longer than the minimum required.                                                                                                                                                                                                                                                                                                                                                          |
| has\_at\_least\_one\_legal\_nature                | The rule will be invalid if the company does not have a corresponding Legal Nature as defined in the extra rule settings.                                                                                                                                                                                                                                                                                                        |
| qsa\_consistent                                   | The rule will be invalid if the QSA information provided in attributes differs from the QSA information provided in the Federal Revenue Service consultation. To use this rule, the [Create Transaction API](https://docs.caf.io/api/core-api/available-resources/transaction) attributes must include the field: `"qsa": [ {"name": "first partner", "cpf": "00000000000"}, {"name": "second partner", "cpf": "11111111111"} ]` |
| qsa\_with\_company\_partner                       | Check if the company has a Legal Person in its corporate structure.                                                                                                                                                                                                                                                                                                                                                              |
| {% endtab %}                                      |                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| {% endtabs %}                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                  |

## Basic Public Data (PJ2)

Detailed information about the CNPJ (Corporate Taxpayer ID) consulted from the public data of the Federal Revenue Service.

**Section:** `pjPublicData`

**Required parameter:** `cnpj`

**Optional parameter:** `qsa`

{% hint style="info" %}
The `qsa` parameter is necessary for the `qsa_consistent` rule but is not required for the other rules.
{% endhint %}

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

| Atributo                                 | Tipo    | Descrição                                                                                           |
| ---------------------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                               | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                     | Object  | Return data                                                                                         |
| data.registrationNumber                  | String  | Record number                                                                                       |
| data.openingDate                         | String  | Opening date                                                                                        |
| data.officialName                        | String  | Official name                                                                                       |
| data.fantasyName                         | String  | Trading name                                                                                        |
| data.companySize                         | String  | Company size                                                                                        |
| data.mainActivity                        | String  | Main business activity                                                                              |
| data.secondaryActivities                 | Array   | List of secondary activities                                                                        |
| data.secondaryActivities\[x].code        | String  | Activity code                                                                                       |
| data.secondaryActivities\[x].description | String  | Activity description                                                                                |
| data.legalNature                         | String  | Nature                                                                                              |
| data.isMei                               | Boolean | Indicative if the CNPJ is MEI                                                                       |
| data.address                             | Object  | Address                                                                                             |
| data.address.street                      | String  | Street                                                                                              |
| data.address.number                      | String  | Number                                                                                              |
| data.address.complement                  | String  | Complement                                                                                          |
| data.address.zipCode                     | String  | ZIP CODE                                                                                            |
| data.address.neighborhood                | String  | Neighborhood                                                                                        |
| data.address.city                        | String  | City                                                                                                |
| data.address.state                       | String  | State                                                                                               |
| data.companyEmail                        | String  | E-mail                                                                                              |
| data.phoneNumber                         | String  | Telephone                                                                                           |
| data.jointStock                          | String  | Capital stock                                                                                       |
| data.status                              | String  | Company Activity Status                                                                             |
| data.statusOrigin                        | String  | Origin of Company Activity Inquiry                                                                  |
| data.statusDate                          | Date    | Date of company activity inquiry                                                                    |
| data.QSA                                 | Array   | List of partners                                                                                    |
| data.QSA\[x].name                        | String  | Name                                                                                                |
| data.QSA\[x].cpf                         | String  | cpf                                                                                                 |
| data.QSA\[x].function                    | String  | Activity/function                                                                                   |
| data.QSA\[x].functionCode                | String  | Activity/function code                                                                              |
| data.QSA\[x].isLegalRepresentative       | Boolean | Legal representative indication                                                                     |
| data.QSA\[x].personType                  | String  | Type of person in the company                                                                       |
| data.QSA\[x].cnpj                        | String  | CNPJ of the company                                                                                 |
| {% endtab %}                             |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Message",
    "registrationNumber": "XXXXX6450XXXXX",
    "fantasyName": "TRADING NAME",
    "status": "ATIVA",
    "statusDate": "2000-00-00T00:00:00.000Z",
    "openingDate": "00/00/2000",
    "mainActivity": "XXX00XX - Main Activity",
    "mainActivityCode": "XXX00XX",
    "mainActivityDescription": "Main Activity Description",
    "secondaryActivities": [
      {
        "code": "XX015XX",
        "description": "Secondary Activities Description"
      }
    ],
    "address": {
      "state": "UF",
      "city": "CITY",
      "zipCode": "XXX00XXX",
      "street": "STREET",
      "neighborhood": "NEIGHBORHOOD",
      "number": "X7X",
      "complement": "COMPLEMENT"
    },
    "phoneNumber": "00(0X) XXX00XXX",
    "companyEmail": "company@mail.com",
    "jointStock": "R$ 0X.X00,00",
    "officialName": "OFFICIAL NAME",
    "legalNature": "X00X - Legal Nature",
    "legalNatureCode": "X00X",
    "legalNatureDescription": "Legal Nature",
    "isMei": true,
    "companySize": "COMPANY SIZE",
    "qsa": [
      {
        "name": "JOHN DOE",
        "cpf": "**000000**",
        "function": "Function",
        "functionCode": "X0",
        "isLegalRepresentative": true
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| authentic\_cnpj\_number                           | Check that the CNPJ number is authentic.                                                                                                                                                                                                                                                                                                                                                                                         |
| active\_cnpj\_number                              | Check that the CNPJ is active with the Receita Federal.                                                                                                                                                                                                                                                                                                                                                                          |
| is\_not\_me\_company                              | Checks that the size of the company is not ME according to the Receita Federal.                                                                                                                                                                                                                                                                                                                                                  |
| qsa\_pj\_data\_not\_empty                         | Check the corporate structure published by Receita Federal.                                                                                                                                                                                                                                                                                                                                                                      |
| is\_company\_lifetime\_greater\_than\_six\_months | The rule will be invalid if the company's lifespan is less than 6 months.                                                                                                                                                                                                                                                                                                                                                        |
| has\_at\_least\_one\_cnae                         | The rule will be invalid if the company does not have any corresponding CNAEs as defined in the extra rule settings.                                                                                                                                                                                                                                                                                                             |
| minimum\_company\_lifetime                        | Checks that the company's lifespan is longer than the minimum required.                                                                                                                                                                                                                                                                                                                                                          |
| has\_at\_least\_one\_legal\_nature                | The rule will be invalid if the company does not have a corresponding Legal Nature as defined in the extra rule settings.                                                                                                                                                                                                                                                                                                        |
| qsa\_consistent                                   | The rule will be invalid if the QSA information provided in attributes differs from the QSA information provided in the Federal Revenue Service consultation. To use this rule, the [Create Transaction API](https://docs.caf.io/api/core-api/available-resources/transaction) attributes must include the field: `"qsa": [ {"name": "first partner", "cpf": "00000000000"}, {"name": "second partner", "cpf": "11111111111"} ]` |
| qsa\_with\_company\_partner                       | Check if the company has a Legal Person in its corporate structure.                                                                                                                                                                                                                                                                                                                                                              |
| {% endtab %}                                      |                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| {% endtabs %}                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                  |

## Simples Nacional Data (PJ40)

Query whether the company is included in Simples.\
**Important:** Company data is updated monthly, but the update process is gradual and may take a few days to complete. This means that the data will not be updated all at once, but rather gradually throughout the month.

**Section:** `pjSimples`

**Required parameter:** `cnpj`

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

| Attribute         | Type    | Description                                                                                         |
| ----------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode        | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data              | Object  | Return data                                                                                         |
| data.officialName | String  | Official name                                                                                       |
| data.cnpj         | String  | CNPJ of the company                                                                                 |
| data.taxRegime    | String  | Company's tax regime                                                                                |
| data.simples      | Boolean | Belongs to the simple (true/false)                                                                  |
| {% endtab %}      |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "X0",
  "data": {
    "officialName": "OFFICIAL NAME",
    "cnpj": "XXXXX000XXXX",
    "taxRegime": "TAX REGIME",
    "simples": true
  }
}
```

{% endtab %}
{% endtabs %}

## Sintegra Data (PJ61)

Consults information about a legal entity in the Centralized Taxpayer Register by CNPJ and UF, returning all the state inscriptions found.

**Section:** `pjSintegraData`

**Required parameters:** `cnpj, uf`

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

| Attribute                                                           | Type   | Description                                                                                         |
| ------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                                          | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                                                | Object | Return data                                                                                         |
| data.message                                                        | String | Description with query status                                                                       |
| data.cnpj                                                           | String | CNPJ of the company                                                                                 |
| data.uf                                                             | String | State of the company                                                                                |
| data.officialName                                                   | String | Official name                                                                                       |
| data.fantasyName                                                    | String | Trading name                                                                                        |
| data.stateRegistrationList                                          | Array  | List of State Registrations by CNPJ                                                                 |
| data.stateRegistrationList\[x].cnpjStatus                           | String | CNPJ status                                                                                         |
| data.stateRegistrationList\[x].stateRegistration                    | String | State Registration (IE)                                                                             |
| data.stateRegistrationList\[x].stateRegistrationStatus              | String | State Registration status                                                                           |
| data.stateRegistrationList\[x].stateRegistrationStatusDate          | String | Status date in UF                                                                                   |
| data.stateRegistrationList\[x].stateRegistrationType                | String | Type of State Registration                                                                          |
| data.stateRegistrationList\[x].stateRegistrationConsignee           | String | IE information as a Receiver                                                                        |
| data.stateRegistrationList\[x].initialDateActivity                  | String | Date of the beginning of activity                                                                   |
| data.stateRegistrationList\[x].finalDateActivity                    | String | Activity end date                                                                                   |
| data.stateRegistrationList\[x].taxRegime                            | String | Tax system                                                                                          |
| data.stateRegistrationList\[x].companySize                          | String | Company Size                                                                                        |
| data.stateRegistrationList\[x].mainActivityCnae                     | String | Main CNAE                                                                                           |
| data.stateRegistrationList\[x].historic                             | Array  | History                                                                                             |
| data.stateRegistrationList\[x].historic\[x].nsuNumber               | String | Unique Sequential Number (NSU) Movto.                                                               |
| data.stateRegistrationList\[x].historic\[x].uf                      | String | UF                                                                                                  |
| data.stateRegistrationList\[x].historic\[x].cnpj                    | String | CNPJ of the company                                                                                 |
| data.stateRegistrationList\[x].historic\[x].cnpjStatus              | String | CNPJ Situation                                                                                      |
| data.stateRegistrationList\[x].historic\[x].stateRegistration       | String | State Registration (IE)                                                                             |
| data.stateRegistrationList\[x].historic\[x].stateRegistrationStatus | String | State Registration status                                                                           |
| data.stateRegistrationList\[x].historic\[x].taxRegime               | String | Tax Regime                                                                                          |
| data.stateRegistrationList\[x].historic\[x].situationDate           | String | Situation date                                                                                      |
| data.stateRegistrationList\[x].historic\[x].updateDate              | String | Date of update                                                                                      |
| data.stateRegistrationList\[x].historic\[x].reason                  | String | Reason for update                                                                                   |
| data.stateRegistrationList\[x].address                              | Object | Address                                                                                             |
| data.stateRegistrationList\[x].address.street                       | String | Street                                                                                              |
| data.stateRegistrationList\[x].address.number                       | String | Number                                                                                              |
| data.stateRegistrationList\[x].address.complement                   | String | Complemento                                                                                         |
| data.stateRegistrationList\[x].address.neighborhood                 | String | Neighborhood                                                                                        |
| data.stateRegistrationList\[x].address.city                         | String | City                                                                                                |
| data.stateRegistrationList\[x].address.state                        | String | State                                                                                               |
| data.stateRegistrationList\[x].address.zipCode                      | String | ZIP CODE                                                                                            |
| {% endtab %}                                                        |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "X0",
  "data": {
    "message": "Message",
    "cnpj": "XXXXX00000XXXXX",
    "uf": "UF",
    "officialName": "OFFICIAL NAME",
    "fantasyName": "TRADING NAME",
    "stateRegistrationList": [
      {
        "cnpjStatus": "",
        "stateRegistration": "",
        "stateRegistrationStatus": "",
        "stateRegistrationStatusDate": "",
        "stateRegistrationType": "",
        "stateRegistrationConsignee": "",
        "initialDateActivity": "",
        "finalDateActivity": "",
        "taxRegime": "",
        "companySize": "",
        "mainActivityCnae": "",
        "historic": [
          {
            "nsuNumber": "00XX00",
            "uf": "UF",
            "cnpj": "XXXXX00000XXXX",
            "cnpjStatus": "",
            "stateRegistration": "",
            "stateRegistrationStatus": "",
            "taxRegime": "",
            "situationDate": "",
            "updateDate": "2000-00-00T00:00:00.000Z",
            "reason": ""
          }
        ],
        "address": {
          "street": "STREET",
          "number": "0X",
          "complement": "COMPLEMENT",
          "neighborhood": "NEIGHBORHOOD",
          "city": "CITY",
          "state": "UF",
          "zipCode": "000XX-X00"
        }
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                      | Description                                                         |
| ------------------------- | ------------------------------------------------------------------- |
| has\_no\_sintegra\_record | The rule will be invalid if the CNPJ is not registered in Sintegra. |
| {% endtab %}              |                                                                     |
| {% endtabs %}             |                                                                     |


# Risk

## KYC & Compliance (PJ44)

**Section:** `pjKycCompliance`

**Required parameter:** `cnpj`

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

| Attribute                                                        | Type    | Description                                                                                         |
| ---------------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                                                       | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                                             | Object  | Return data                                                                                         |
| data.message                                                     | String  | Description with query status                                                                       |
| data.pepHistory                                                  | Array   | Object list with the political exposure history                                                     |
| data.pepHistory\[x].level                                        | String  | Level of political exposure                                                                         |
| data.pepHistory\[x].jobTitle                                     | String  | Job                                                                                                 |
| data.pepHistory\[x].department                                   | String  | Department                                                                                          |
| data.pepHistory\[x].motive                                       | String  | Reason                                                                                              |
| data.pepHistory\[x].cpf                                          | String  | CPF of the politically exposed partner                                                              |
| data.pepHistory\[x].firstLevelPepCpf                             | String  | CPF of the politically exposed person related to the partner                                        |
| data.pepHistory\[x].source                                       | String  | Source                                                                                              |
| data.pepHistory\[x].startDate                                    | String  | Start Date                                                                                          |
| data.pepHistory\[x].endDate                                      | String  | End Date                                                                                            |
| data.pepHistory\[x].creationDate                                 | String  | Date Created                                                                                        |
| data.pepHistory\[x].lastUpdateDate                               | String  | Date last updated                                                                                   |
| data.sanctionsHistory                                            | Array   | Object list with sanction and restriction history                                                   |
| data.sanctionsHistory\[x].source                                 | String  | Sanction source                                                                                     |
| data.sanctionsHistory\[x].type                                   | String  | Sanction type                                                                                       |
| data.sanctionsHistory\[x].matchRate                              | String  | Name approximation rate                                                                             |
| data.sanctionsHistory\[x].details                                | Object  | Details                                                                                             |
| data.sanctionsHistory\[x].details.agreementNumber                | String  | Agreement number                                                                                    |
| data.sanctionsHistory\[x].details.grantingBody                   | String  | Granting authority                                                                                  |
| data.sanctionsHistory\[x].details.impedimentReason               | String  | Impediment reasons                                                                                  |
| data.sanctionsHistory\[x].details.nameInformedBySanctioningBody  | String  | Name entered                                                                                        |
| data.sanctionsHistory\[x].details.processNumber                  | String  | Case Number                                                                                         |
| data.sanctionsHistory\[x].details.sanctioningBody                | String  | Sanctioning body                                                                                    |
| data.sanctionsHistory\[x].details.sanctioningBodyState           | String  | Sanctioning body status                                                                             |
| data.sanctionsHistory\[x].details.informationOrigin              | String  | Origin of information                                                                               |
| data.sanctionsHistory\[x].details.informationOriginDate          | String  | Date.sanctionsHistory\[x] of information origin                                                     |
| data.sanctionsHistory\[x].details.publicationDate                | Date    | Date.sanctionsHistory\[x] of publication                                                            |
| data.sanctionsHistory\[x].details.publication                    | String  | Publication                                                                                         |
| data.sanctionsHistory\[x].details.legalSubstantiation            | String  | Legal Reasoning                                                                                     |
| data.sanctionsHistory\[x].details.legalSubstantiationDescription | String  | Description of the legal basis                                                                      |
| data.sanctionsHistory\[x].details.transitDueDate                 | Date    | Date.sanctionsHistory\[x] of expiration of transaction                                              |
| data.sanctionsHistory\[x].details.actionYear                     | String  | Year of action                                                                                      |
| data.sanctionsHistory\[x].details.employer                       | String  | Employer                                                                                            |
| data.sanctionsHistory\[x].details.establishment                  | String  | Establishment                                                                                       |
| data.sanctionsHistory\[x].details.state                          | String  | State                                                                                               |
| data.sanctionsHistory\[x].details.cnae                           | String  | CNAE                                                                                                |
| data.sanctionsHistory\[x].details.originalName                   | String  | Original Name                                                                                       |
| data.sanctionsHistory\[x].details.sanctionName                   | String  | Name of the sanction                                                                                |
| data.sanctionsHistory\[x].details.nationalities                  | String  | Nationality                                                                                         |
| data.sanctionsHistory\[x].details.fineAmount                     | String  | Amount of the fine                                                                                  |
| data.sanctionsHistory\[x].details.organComplement                | String  | Body Complement                                                                                     |
| data.sanctionsHistory\[x].details.scopeDefinedInJudicialDecision | String  | Scope defined in court decision                                                                     |
| data.sanctionsHistory\[x].details.resjusdicataDate               | String  | Termination date                                                                                    |
| data.sanctionsHistory\[x].details.amountOfWorkersInvolved        | String  | Number of workers involved                                                                          |
| data.sanctionsHistory\[x].details.nameInSanctionList             | String  | Name on sanction list                                                                               |
| data.sanctionsHistory\[x].details.designation                    | String  | Designation                                                                                         |
| data.sanctionsHistory\[x].details.nationality                    | String  | Nationality                                                                                         |
| data.sanctionsHistory\[x].details.title                          | String  | Title                                                                                               |
| data.sanctionsHistory\[x].details.nationalIdentificationNumber   | String  | National Identification Number                                                                      |
| data.sanctionsHistory\[x].details.permanentReferenceNumber       | String  | Permanent Reference Number                                                                          |
| data.sanctionsHistory\[x].details.otherInformation               | String  | Other information                                                                                   |
| data.sanctionsHistory\[x].details.tadNumber                      | String  | Tad number                                                                                          |
| data.sanctionsHistory\[x].details.selfInfringementNumber         | String  | Self infraction number                                                                              |
| data.sanctionsHistory\[x].details.deforestedAreaHa               | String  | Deforested area Hectare                                                                             |
| data.sanctionsHistory\[x].details.propertyLocation               | String  | Property location                                                                                   |
| data.sanctionsHistory\[x].details.propertyUF                     | String  | Property Federative Unit                                                                            |
| data.sanctionsHistory\[x].details.propertyCounty                 | String  | Property country                                                                                    |
| data.sanctionsHistory\[x].details.infraction                     | String  | Infraction                                                                                          |
| data.sanctionsHistory\[x].details.registrationDate               | String  | Date of Registration                                                                                |
| data.sanctionsHistory\[x].details.judgementDate                  | String  | Date of Sentence                                                                                    |
| data.sanctionsHistory\[x].details.penalty                        | String  | Penalty                                                                                             |
| data.sanctionsHistory\[x].details.penaltyTimeToBeServed          | String  | Penalty time to be served                                                                           |
| data.sanctionsHistory\[x].details.finalDeadline                  | String  | Term                                                                                                |
| data.sanctionsHistory\[x].details.irregularAction                | String  | Irregular Action                                                                                    |
| data.sanctionsHistory\[x].details.deliberationContent            | String  | Content of Deliberation                                                                             |
| data.sanctionsHistory\[x].details.referenceDate                  | String  | Reference Date                                                                                      |
| data.sanctionsHistory\[x].details.decisionType                   | String  | Type of Decision                                                                                    |
| data.sanctionsHistory\[x].details.timeToBeServed                 | String  | Time to be served                                                                                   |
| data.sanctionsHistory\[x].details.judgementDescription           | String  | Decision Description                                                                                |
| data.sanctionsHistory\[x].details.completeDecisionURL            | String  | Complete decision URL                                                                               |
| data.sanctionsHistory\[x].details.processInfoUrl                 | String  | URL of process information                                                                          |
| data.sanctionsHistory\[x].startDate                              | String  | Start date                                                                                          |
| data.sanctionsHistory\[x].standardizedSanctionType               | String  | Standardized sanction type                                                                          |
| data.sanctionsHistory\[x].nameUniquenessScore                    | String  | Name exclusivity score                                                                              |
| data.sanctionsHistory\[x].creationDate                           | String  | Creation date                                                                                       |
| data.sanctionsHistory\[x].lastUpdateDate                         | String  | Last updated date                                                                                   |
| data.sanctionsHistory\[x].isCurrentlyPresentOnSource             | String  | Is currently present at source                                                                      |
| data.sanctionsHistory\[x].endDate                                | String  | End Date                                                                                            |
| data.isCurrentlyPEP                                              | Boolean | Indicates whether the person is currently an EPP                                                    |
| data.isCurrentlySanctioned                                       | Boolean | Indicates whether the person is currently under any sanctions                                       |
| data.last30DaysSanctions                                         | Number  | Number of sanctions and restrictions encountered in the past 30 days                                |
| data.last90DaysSanctions                                         | Number  | Number of sanctions and restrictions encountered during the past 90 days                            |
| data.last180DaysSanctions                                        | Number  | Number of sanctions and restrictions encountered during the last 180 days                           |
| data.last365DaysSanctions                                        | Number  | Number of sanctions and restrictions encountered during the last 365 days                           |
| data.lastYearPEPOccurence                                        | Number  | Number of PEP registrations found in the last year                                                  |
| data.last3YearsPEPOccurence                                      | Number  | Number of PEP registers found in the last 3 years                                                   |
| data.last5YearsPEPOccurence                                      | Number  | Number of PEP registers found in the last 5 years                                                   |
| data.last5PlusYearsPEPOccurence                                  | Number  | Number of PEP records found in the last 5 or more years                                             |
| data.isCurrentlyElectoralDonor                                   | Boolean | Indicates if the person donates to political campaigns                                              |
| data.isHistoricalElectoralDonor                                  | Boolean | Indicates whether the person has donated to political campaigns                                     |
| data.totalElectoralDonationsLastTwoElections                     | Number  | Number of donations made in the last two election cycles                                            |
| data.totalElectoralDonations                                     | Number  | Total number of donations made                                                                      |
| data.totalElectoralDonationAmountLastTwoElections                | Number  | Sum of the amount donated in the last two election cycles                                           |
| data.totalElectoralDonationAmount                                | Number  | Total amount donated                                                                                |
| data.firstSanctionDate                                           | String  | Date of the first sanction                                                                          |
| data.lastSanctionDate                                            | String  | Date of last sanction                                                                               |
| {% endtab %}                                                     |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "",
  "data": {
    "message": "",
    "pepHistory": [
      {
        "level": "",
        "jobTitle": "",
        "department": "",
        "motive": "",
        "cpf": "",
        "firstLevelPepCpf": "",
        "source": "",
        "startDate": "",
        "endDate": "",
        "creationDate": "",
        "lastUpdateDate": ""
      }
    ],
    "sanctionsHistory": [
      {
        "source": "",
        "type": "",
        "matchRate": "",
        "details": {
          "agreementNumber": "",
          "grantingBody": "",
          "impedimentReason": "",
          "nameInformedBySanctioningBody": "",
          "processNumber": "",
          "sanctioningBody": "",
          "sanctioningBodyState": "",
          "informationOrigin": "",
          "informationOriginDate": "",
          "publicationDate": "2000-00-00T00:00:00",
          "publication": "",
          "legalSubstantiation": "",
          "legalSubstantiationDescription": "",
          "transitDueDate": "2000-00-00T00:00:00",
          "actionYear": "",
          "employer": "",
          "establishment": "",
          "state": "",
          "cnae": "",
          "originalName": "",
          "sanctionName": "",
          "nationalities": "",
          "fineAmount": "",
          "organComplement": "",
          "scopeDefinedInJudicialDecision": "",
          "resjusdicataDate": "",
          "amountOfWorkersInvolved": "",
          "nameInSanctionList": "",
          "designation": "",
          "nationality": "",
          "title": "",
          "nationalIdentificationNumber": "",
          "permanentReferenceNumber": "",
          "otherInformation": "",
          "tadNumber": "",
          "selfInfringementNumber": "",
          "deforestedAreaHa": "",
          "propertyLocation": "",
          "propertyUF": "",
          "propertyCounty": "",
          "infraction": "",
          "registrationDate": "",
          "judgementDate": "",
          "penalty": "",
          "penaltyTimeToBeServed": "",
          "finalDeadline": "",
          "irregularAction": "",
          "deliberationContent": "",
          "referenceDate": "",
          "decisionType": "",
          "timeToBeServed": "",
          "judgementDescription": "",
          "completeDecisionURL": "",
          "processInfoUrl": ""
        },
        "startDate": "",
        "standardizedSanctionType": "",
        "nameUniquenessScore": "",
        "creationDate": "",
        "lastUpdateDate": "",
        "isCurrentlyPresentOnSource": "",
        "endDate": ""
      }
    ],
    "isCurrentlyPEP": true,
    "isCurrentlySanctioned": true,
    "last30DaysSanctions": 00,
    "last90DaysSanctions": 00,
    "last180DaysSanctions": 00,
    "last365DaysSanctions": 00,
    "lastYearPEPOccurence": 00,
    "last3YearsPEPOccurence": 00,
    "last5YearsPEPOccurence": 00,
    "last5PlusYearsPEPOccurence": 00,
    "isCurrentlyElectoralDonor": true,
    "isHistoricalElectoralDonor": true,
    "totalElectoralDonationsLastTwoElections": 00,
    "totalElectoralDonations": 00,
    "totalElectoralDonationAmountLastTwoElections": 00,
    "totalElectoralDonationAmount": 00,
    "firstSanctionDate": "",
    "lastSanctionDate": ""
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule               | Description                                                   |
| ------------------ | ------------------------------------------------------------- |
| has\_no\_sanctions | Check that no sanctions have been found on restrictive lists. |
| has\_no\_pep       | Checks whether the CPF or CNPJ holder has political exposure. |
| {% endtab %}       |                                                               |
| {% endtabs %}      |                                                               |

## KYC & Membership Compliance (PJ59)

Returns a list with the partners of the queried company.

**Section:** `pjKycComplianceOwners`

**Required parameter:** `cnpj`

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

| Attribute                                      | Type         | Description                                                                                         |
| ---------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                     | String       | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                           | Array        | Return data                                                                                         |
| data\[x].cpf                                   | String       | Member's CPF                                                                                        |
| data\[x].pepHistory                            | Array        | List of objects with political exposure history                                                     |
| data\[x].pepHistory\[x].level                  | String       | PPE(Politically Exposed Person) level                                                               |
| data\[x].pepHistory\[x].jobTitle               | String       | Position                                                                                            |
| data\[x].pepHistory\[x].department             | String       | Department                                                                                          |
| data\[x].pepHistory\[x].motive                 | String       | Reason                                                                                              |
| data\[x].pepHistory\[x].source                 | String       | Source                                                                                              |
| data\[x].pepHistory\[x].startDate              | String       | Date person became a PEP                                                                            |
| data\[x].pepHistory\[x].endDate                | String       | Date person ceased to be an EPP                                                                     |
| data\[x].pepHistory\[x].creationDate           | String       | Date created                                                                                        |
| data\[x].pepHistory\[x].lastUpdateDate         | String       | Date last updated                                                                                   |
| data\[x].isCurrentlyPEP                        | Boolean      | Whether it is currently a SPP                                                                       |
| data\[x].sanctionsHistory                      | Array        | Object list with sanction and restriction history                                                   |
| data\[x].sanctionsHistory\[x].source           | String       | Sanction source                                                                                     |
| data\[x].sanctionsHistory\[x].type             | String       | Type of sanction                                                                                    |
| data\[x].sanctionsHistory\[x].matchRate        | String       | Indication of how closely the name resembles                                                        |
| data\[x].sanctionsHistory\[x].startDate        | String       | Start date                                                                                          |
| data\[x].sanctionsHistory\[x].endDate          | String       | End Date                                                                                            |
| data\[x].sanctionsHistory\[x].originalName     | String       | Original name associated with the individual                                                        |
| data\[x].sanctionsHistory\[x].sanctionName     | String       | Name registered on the international sanctions list                                                 |
| data\[x].sanctionsHistory\[x].nationalities    | String       | Nationalities associated with the individual                                                        |
| data\[x].sanctionsHistory\[x].image            | String       | Individual's photo                                                                                  |
| data\[x].sanctionsHistory\[x].height           | String       | Height of Individual                                                                                |
| data\[x].sanctionsHistory\[x].eyes             | String       | Eye Color                                                                                           |
| data\[x].sanctionsHistory\[x].distinguishMarks | String       | Characteristics                                                                                     |
| data\[x].sanctionsHistory\[x].description      | String       | General description of sanction                                                                     |
| data\[x].isCurrentlySanctioned                 | Boolean      | If you are currently being sanctioned                                                               |
| data\[x].last30DaysSanctions                   | Number       | Sanctions during last 30 days                                                                       |
| data\[x].last90DaysSanctions                   | Number       | Sanction in the last 90 days                                                                        |
| data\[x].last180DaysSanctions                  | Number       | Sanctions in the last 180 days                                                                      |
| data\[x].last365DaysSanctions                  | Number       | Sanctioning in the last 365 days                                                                    |
| data\[x].lastYearPEPOccurence                  | Number       | Occurrence of PEP in the last year                                                                  |
| data\[x].last3YearsPEPOccurence                | Number       | PEP occurrence within the last three years                                                          |
| data\[x].last5YearsPEPOccurence                | Number       | WBS Occurrence within the last five years                                                           |
| data\[x].last5PlusYearsPEPOccurence            | Number       | WBS Occurrence within the last five years or more                                                   |
| data\[x].firstSanctionDate                     | String       | Date of first sanction                                                                              |
| data\[x].lastSanctionDate                      | String       | Date of last sanction                                                                               |
| data.totalCurrentlyPEP                         | Number       | Total current PEPs                                                                                  |
| data.totalHistoricallyPEP                      | Number       | Total PEPs History                                                                                  |
| data.totalCurrentlySanctioned                  | Number       | Total current sanctions                                                                             |
| data.totalHistoricallySanctioned               | Number       | Total sanctions history                                                                             |
| data.averageSanctionsPerOwner                  | Number       | Average number of sanctions per company partner                                                     |
| data.pepPercentage                             | Number       | Percentage of WBS                                                                                   |
| data.ownerMaxSanctions                         | Number       | Highest number of sanctions of a single member                                                      |
| data.ownerMinSanctions                         | Number       | Lowest number of sanctions of a single member                                                       |
| data.last30DaysSanctions                       | Number       | Sanctions in the last 30 days                                                                       |
| data.last90DaysSanctions                       | Number       | Sanctions in the last 90 days                                                                       |
| data.last180DaysSanctions                      | Number       | Sanctions in the last 180 days                                                                      |
| data.last365DaysSanctions                      | Number       | Penalties within the last 365 days                                                                  |
| data.lastYearPEPOccurence                      | Number       | Occurrence of PEP in the last year                                                                  |
| data.last3YearsPEPOccurence                    | Number       | PEP occurrence within the last three years                                                          |
| data.last5YearsPEPOccurence                    | Number       | WBS Occurrence within the last five years                                                           |
| data.last5PlusYearsPEPOccurence                | Number       | WBS Occurrence within the last five years or more                                                   |
| data.firstSanctionDate                         | String       | Date of first sanction                                                                              |
| data.lastSanctionDate                          | String       | Date of last sanction                                                                               |
| data.activeOwners                              | String Array | CPF of active owners                                                                                |
| data.inactiveOwners                            | String Array | CPF of inactive owners                                                                              |
| {% endtab %}                                   |              |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "",
  "data": [
    {
      "cpf": "",
      "pepHistory": [
        {
          "level": "",
          "jobTitle": "",
          "department": "",
          "motive": "",
          "source": "",
          "startDate": "",
          "endDate": "",
          "creationDate": "",
          "lastUpdateDate": ""
        }
      ],
      "isCurrentlyPEP": true,
      "sanctionsHistory": [
        {
          "source": "",
          "type": "",
          "matchRate": "",
          "startDate": "",
          "endDate": "",
          "originalName": "",
          "sanctionName": "",
          "nationalities": "",
          "image": "",
          "height": "",
          "eyes": "",
          "distinguishMarks": "",
          "description": ""
        }
      ],
      "isCurrentlySanctioned": true,
      "last30DaysSanctions": 00,
      "last90DaysSanctions": 00,
      "last180DaysSanctions": 00,
      "last365DaysSanctions": 00,
      "lastYearPEPOccurence": 00,
      "last3YearsPEPOccurence": 00,
      "last5YearsPEPOccurence": 00,
      "last5PlusYearsPEPOccurence": 00,
      "firstSanctionDate": "",
      "lastSanctionDate": "",
      "totalCurrentlyPEP": 00,
      "totalHistoricallyPEP": 00,
      "totalCurrentlySanctioned": 00,
      "totalHistoricallySanctioned": 00,
      "erageSanctionsPerOwner": 00,
      "pepPercentage": 00,
      "ownerMaxSanctions": 00,
      "ownerMinSanctions": 00,
      "last30DaysSanctions": 00,
      "last90DaysSanctions": 00,
      "last180DaysSanctions": 00,
      "last365DaysSanctions": 00,
      "lastYearPEPOccurence": 00,
      "last3YearsPEPOccurence": 00,
      "last5YearsPEPOccurence": 00,
      "last5PlusYearsPEPOccurence": 00,
      "firstSanctionDate": "",
      "lsstSanctionDate": "",
      "activeOwners": ["", ""],
      "inactiveOwners": ["", ""]
    }
  ]
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                            | Description                                           |
| ----------------------------------------------- | ----------------------------------------------------- |
| has\_no\_pep\_or\_sanctions\_compliance\_owners | Checks for PEPs or sanctions on a company's partners. |
| {% endtab %}                                    |                                                       |
| {% endtabs %}                                   |                                                       |

## Corporate Structure (PJ63)

Returns the registration data and the corporate structure (partners and legal representatives) of the queried company. When the CNPJ belongs to a MEI, the holder's CPF is returned.

**Section:** `pjCorporateStructure`

**Required parameter:** `cnpj`

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

| Attribute                                | Type    | Description                                                                                         |
| ---------------------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                               | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| message                                  | String  | Message returned when there is no registered data                                                   |
| data                                     | Object  | Return data                                                                                         |
| data.registrationNumber                  | String  | Company CNPJ                                                                                        |
| data.officialName                        | String  | Company legal name                                                                                  |
| data.fantasyName                         | String  | Company trade name                                                                                  |
| data.companyEmail                        | String  | Company email                                                                                       |
| data.openingDate                         | String  | Opening date                                                                                        |
| data.jointStock                          | String  | Share capital                                                                                       |
| data.status                              | String  | Registration status                                                                                 |
| data.statusDate                          | String  | Registration status date                                                                            |
| data.specialStatus                       | String  | Special status (e.g. extrajudicial liquidation)                                                     |
| data.specialStatusDate                   | String  | Special status date                                                                                 |
| data.reasonSituation                     | String  | Registration status reason code                                                                     |
| data.legalNature                         | String  | Legal nature (code and description)                                                                 |
| data.legalNatureCode                     | String  | Legal nature code                                                                                   |
| data.legalNatureDescription              | String  | Legal nature description                                                                            |
| data.isMei                               | Boolean | Whether the company is a MEI                                                                        |
| data.isSimples                           | Boolean | Whether the company opts for Simples Nacional                                                       |
| data.companySize                         | String  | Company size                                                                                        |
| data.mainActivity                        | String  | Main activity (CNAE code and description)                                                           |
| data.mainActivityCode                    | String  | Main activity code (CNAE)                                                                           |
| data.mainActivityDescription             | String  | Main activity description                                                                           |
| data.secondaryActivities                 | Array   | List of secondary activities                                                                        |
| data.secondaryActivities\[x].code        | String  | Secondary activity code (CNAE)                                                                      |
| data.secondaryActivities\[x].description | String  | Secondary activity description                                                                      |
| data.address                             | Object  | Company address                                                                                     |
| data.address.street                      | String  | Street                                                                                              |
| data.address.number                      | String  | Number                                                                                              |
| data.address.complement                  | String  | Complement                                                                                          |
| data.address.neighborhood                | String  | Neighborhood                                                                                        |
| data.address.zipCode                     | String  | Zip code                                                                                            |
| data.address.city                        | String  | City                                                                                                |
| data.address.state                       | String  | State                                                                                               |
| data.phoneNumberDDD                      | String  | Phone area code                                                                                     |
| data.phoneNumber                         | String  | Phone number                                                                                        |
| data.items                               | Array   | List of partners and legal representatives                                                          |
| data.items\[x].isActiveOwner             | Boolean | Whether the partner is active                                                                       |
| data.items\[x].personType                | String  | Person type (Física/Jurídica)                                                                       |
| data.items\[x].name                      | String  | Partner name                                                                                        |
| data.items\[x].cpf                       | String  | Partner CPF (individuals; also the MEI holder)                                                      |
| data.items\[x].cnpj                      | String  | Partner CNPJ (legal entities)                                                                       |
| data.items\[x].function                  | String  | Role/qualification description                                                                      |
| data.items\[x].functionCode              | String  | Role/qualification code                                                                             |
| data.items\[x].entryDate                 | String  | Date the partner joined the company                                                                 |
| {% endtab %}                             |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "",
  "data": {
    "registrationNumber": "",
    "officialName": "",
    "fantasyName": "",
    "companyEmail": "",
    "openingDate": "",
    "jointStock": "",
    "status": "",
    "statusDate": "",
    "specialStatus": "",
    "specialStatusDate": "",
    "reasonSituation": "",
    "legalNature": "",
    "legalNatureCode": "",
    "legalNatureDescription": "",
    "isMei": true,
    "isSimples": true,
    "companySize": "",
    "mainActivity": "",
    "mainActivityCode": "",
    "mainActivityDescription": "",
    "secondaryActivities": [
      {
        "code": "",
        "description": ""
      }
    ],
    "address": {
      "street": "",
      "number": "",
      "complement": "",
      "neighborhood": "",
      "zipCode": "",
      "city": "",
      "state": ""
    },
    "phoneNumberDDD": "",
    "phoneNumber": "",
    "items": [
      {
        "isActiveOwner": true,
        "personType": "",
        "name": "",
        "cpf": "",
        "cnpj": "",
        "function": "",
        "functionCode": "",
        "entryDate": ""
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

## Lawsuits (PJ66)

Returns information about legal actions that the person has, of any type (criminal, civil, labor, ...).

**Section:** `pj_processes_alt`

**Required :** `cnpj`

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

| Attribute                                          | Type         | Description                                                                                         |
| -------------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                         | String       | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                               | Object       | Return data                                                                                         |
| data.message                                       | String       | Description with query status                                                                       |
| data.total                                         | Number       | Total number of processes                                                                           |
| data.results                                       | Array        | List of processes returned                                                                          |
| data.results\[x].id                                | String       | Query identifier                                                                                    |
| data.results\[x].criminalCategory                  | String       | Category of process                                                                                 |
| data.results\[x].lawsuitClass                      | String       | Class                                                                                               |
| data.results\[x].distributionDate                  | String       | Distribution date                                                                                   |
| data.results\[x].statusDate                        | String       | Status date                                                                                         |
| data.results\[x].lawsuitDegree                     | String       | Degree of lawsuit                                                                                   |
| data.results\[x].physicalLocation                  | String       | Physical location                                                                                   |
| data.results\[x].oldLawsuitNumber                  | String       | Old Case Number                                                                                     |
| data.results\[x].judgingBody                       | String       | Trial court                                                                                         |
| data.results\[x].lawsuitId                         | String       | Case number                                                                                         |
| data.results\[x].isDigitalLawsuit                  | Boolean      | If the case is digital                                                                              |
| data.results\[x].lawBranch                         | String       | Branch of Law                                                                                       |
| data.results\[x].segment                           | String       | Segment                                                                                             |
| data.results\[x].isJusticeSecret                   | Boolean      | If it is a legal secret                                                                             |
| data.results\[x].complementaryStatus               | String       | Complementary status                                                                                |
| data.results\[x].observationStatus                 | String       | Observation status                                                                                  |
| data.results\[x].court                             | String       | Court                                                                                               |
| data.results\[x].state                             | String       | STATE                                                                                               |
| data.results\[x].sourceUnit                        | String       | Unit of origin                                                                                      |
| data.results\[x].lawsuitUrl                        | String       | Process URL                                                                                         |
| data.results\[x].lawsuitValue                      | Object       | Process value return                                                                                |
| data.results\[x].lawsuitValue.currency             | String       | Currency (R$, U$, etc)                                                                              |
| data.results\[x].lawsuitValue.value                | Number       | Value                                                                                               |
| data.results\[x].subjects                          | String Array | Subjects list                                                                                       |
| data.results\[x].moves                             | Array        | Process' movement list                                                                              |
| data.results\[x].moves\[x].date                    | String       | Date of the movement                                                                                |
| data.results\[x].moves\[x].description             | String       | Description of the movement                                                                         |
| data.results\[x].actives                           | Array        | Assets list                                                                                         |
| data.results\[x].actives\[x].cnpj                  | String       | CNPJ                                                                                                |
| data.results\[x].actives\[x].cpf                   | String       | CPF                                                                                                 |
| data.results\[x].actives\[x].name                  | String       | Name                                                                                                |
| data.results\[x].actives\[x].type                  | String       | Type                                                                                                |
| data.results\[x].actives\[x].lawyers               | Array        | List of Lawyers                                                                                     |
| data.results\[x].actives\[x].lawyers\[x].oab       | String       | OAB Number                                                                                          |
| data.results\[x].actives\[x].lawyers\[x].name      | String       | Name                                                                                                |
| data.results\[x].actives\[x].lawyers\[x].cpf       | String       | CPF                                                                                                 |
| data.results\[x].passives                          | Array        | List of liabilities                                                                                 |
| data.results\[x].passives\[x].cnpj                 | String       | CNPJ                                                                                                |
| data.results\[x].passives\[x].cpf                  | String       | CPF                                                                                                 |
| data.results\[x].passives\[x].name                 | String       | Name                                                                                                |
| data.results\[x].passives\[x].type                 | String       | Type                                                                                                |
| data.results\[x].passives\[x].lawyers              | Array        | List of Lawyers                                                                                     |
| data.results\[x].passives\[x].lawyers\[x].oab      | String       | OAB Number                                                                                          |
| data.results\[x].passives\[x].lawyers\[x].name     | String       | Name                                                                                                |
| data.results\[x].passives\[x].lawyers\[x].cpf      | String       | CPF                                                                                                 |
| data.results\[x].otherParties                      | Array        | Other parties list                                                                                  |
| data.results\[x].otherParties\[x].cnpj             | String       | CNPJ                                                                                                |
| data.results\[x].otherParties\[x].cpf              | String       | CPF                                                                                                 |
| data.results\[x].otherParties\[x].name             | String       | Name                                                                                                |
| data.results\[x].otherParties\[x].type             | String       | Type                                                                                                |
| data.results\[x].otherParties\[x].lawyers          | Array        | List of Lawyers                                                                                     |
| data.results\[x].otherParties\[x].lawyers\[x].oab  | String       | OAB Number                                                                                          |
| data.results\[x].otherParties\[x].lawyers\[x].name | String       | Name                                                                                                |
| data.results\[x].otherParties\[x].lawyers\[x].cpf  | String       | CPF                                                                                                 |
| data.results\[x].authorType                        | String       | Author Type                                                                                         |
| data.results\[x].authorParty                       | String       | Author Party                                                                                        |
| {% endtab %}                                       |              |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "",
  "data": {
    "message": "",
    "total": 00,
    "results": [
      {
        "id": "",
        "criminalCategory": "",
        "lawsuitClass": "",
        "distributionDate": "",
        "statusDate": "",
        "lawsuitDegree": "",
        "physicalLocation": "",
        "oldLawsuitNumber": "",
        "judgingBody": "",
        "lawsuitId": "",
        "isDigitalLawsuit": true,
        "lawBranch": "",
        "segment": "",
        "isJusticeSecret": true,
        "complementaryStatus": "",
        "observationStatus": "",
        "court": "",
        "state": "",
        "sourceUnit": "",
        "lawsuitUrl": "",
        "lawsuitValue": {
          "currency": "",
          "value": 00
        },
        "subjects": ["", ""],
        "moves": [
          {
            "date": "",
            "description": ""
          }
        ],
        "actives": [
          {
            "cnpj": "",
            "cpf": "",
            "name": "",
            "type": "",
            "lawyers": [
              {
                "oab": "",
                "name": "",
                "cpf": ""
              }
            ]
          }
        ],
        "passives": [
          {
            "cnpj": "",
            "cpf": "",
            "name": "",
            "type": "",
            "lawyers": [
              {
                "oab": "",
                "name": "",
                "cpf": ""
              }
            ]
          }
        ],
        "otherParties": [
          {
            "cnpj": "",
            "cpf": "",
            "name": "",
            "type": "",
            "lawyers": [
              {
                "oab": "",
                "name": "",
                "cpf": ""
              }
            ]
          }
        ],
        "authorType": "",
        "authorParty": ""
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                             | Description                                                          |
| ------------------------------------------------ | -------------------------------------------------------------------- |
| has\_no\_processes                               | Checks if the CPF/CNPJ is linked to processes.                       |
| has\_no\_defendant\_processes                    | Checks if the CPF/CNPJ is linked to proceedings as a defendant.      |
| has\_no\_criminal\_processes                     | Checks if the CPF/CNPJ is linked to criminal proceedings.            |
| has\_author\_type\_null\_in\_criminal\_processes | Checks if there is an empty 'authorType' field in any criminal case. |
| {% endtab %}                                     |                                                                      |
| {% endtabs %}                                    |                                                                      |

## Lawsuits with keywords (PJ49)

Returns information about legal actions that the person has, of any type (criminal, civil, labor, ...).

**Section:** `pjProcessesWithKeywords`

**Required parameter:** `cnpj`

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

| Attribute                                          | Type         | Description                                                                                         |
| -------------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                         | String       | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                               | Object       | Return data                                                                                         |
| data.message                                       | String       | Description with query status                                                                       |
| data.total                                         | Number       | Total number of processes                                                                           |
| data.foundWords                                    | Array        | Keywords found                                                                                      |
| data.results                                       | Array        | List of processes returned                                                                          |
| data.results\[x].id                                | String       | Query identifier                                                                                    |
| data.results\[x].matchedWords                      | Array        | Keywords found in this lawsuit                                                                      |
| data.results\[x].criminalCategory                  | String       | Category of process                                                                                 |
| data.results\[x].lawsuitClass                      | String       | Class                                                                                               |
| data.results\[x].distributionDate                  | String       | Distribution date                                                                                   |
| data.results\[x].statusDate                        | String       | Status date                                                                                         |
| data.results\[x].lawsuitDegree                     | String       | Degree of lawsuit                                                                                   |
| data.results\[x].physicalLocation                  | String       | Physical location                                                                                   |
| data.results\[x].oldLawsuitNumber                  | String       | Old Case Number                                                                                     |
| data.results\[x].judgingBody                       | String       | Trial court                                                                                         |
| data.results\[x].lawsuitId                         | String       | Case number                                                                                         |
| data.results\[x].isDigitalLawsuit                  | Boolean      | If the case is digital                                                                              |
| data.results\[x].lawBranch                         | String       | Branch of Law                                                                                       |
| data.results\[x].segment                           | String       | Segment                                                                                             |
| data.results\[x].isJusticeSecret                   | Boolean      | If it is a legal secret                                                                             |
| data.results\[x].complementaryStatus               | String       | Complementary status                                                                                |
| data.results\[x].observationStatus                 | String       | Observation status                                                                                  |
| data.results\[x].court                             | String       | Court                                                                                               |
| data.results\[x].state                             | String       | STATE                                                                                               |
| data.results\[x].sourceUnit                        | String       | Unit of origin                                                                                      |
| data.results\[x].lawsuitUrl                        | String       | Case URL                                                                                            |
| data.results\[x].otherFields                       | Object       | Other Fields                                                                                        |
| data.results\[x].otherFields.juiz                  | Object       | Judge                                                                                               |
| data.results\[x].otherFields.juiz.nome             | String       | Judge name                                                                                          |
| data.results\[x].lawsuitValue                      | Object       | Process Value Return                                                                                |
| data.results\[x].lawsuitValue.currency             | String       | Currency (R$, U$, etc)                                                                              |
| data.results\[x].lawsuitValue.value                | Number       | Value                                                                                               |
| data.results\[x].subjects                          | String Array | List of Subjects                                                                                    |
| data.results\[x].moves                             | Array        | List of lawsuit movements                                                                           |
| data.results\[x].moves\[x].date                    | String       | Date of the movement                                                                                |
| data.results\[x].moves\[x].description             | String       | Description of the movement                                                                         |
| data.results\[x].actives                           | Array        | Assets list                                                                                         |
| data.results\[x].actives\[x].cnpj                  | String       | CNPJ                                                                                                |
| data.results\[x].actives\[x].cpf                   | String       | CPF                                                                                                 |
| data.results\[x].actives\[x].name                  | String       | Name                                                                                                |
| data.results\[x].actives\[x].type                  | String       | Type                                                                                                |
| data.results\[x].actives\[x].lawyers               | Array        | List of Lawyers                                                                                     |
| data.results\[x].actives\[x].lawyers\[x].oab       | String       | OAB Number                                                                                          |
| data.results\[x].actives\[x].lawyers\[x].name      | String       | Name                                                                                                |
| data.results\[x].actives\[x].lawyers\[x].cpf       | String       | CPF                                                                                                 |
| data.results\[x].passives                          | Array        | List of liabilities                                                                                 |
| data.results\[x].passives\[x].cnpj                 | String       | CNPJ                                                                                                |
| data.results\[x].passives\[x].cpf                  | String       | CPF                                                                                                 |
| data.results\[x].passives\[x].name                 | String       | Name                                                                                                |
| data.results\[x].passives\[x].type                 | String       | Type                                                                                                |
| data.results\[x].passives\[x].lawyers              | Array        | List of Lawyers                                                                                     |
| data.results\[x].passives\[x].lawyers\[x].oab      | String       | OAB Number                                                                                          |
| data.results\[x].passives\[x].lawyers\[x].name     | String       | Name                                                                                                |
| data.results\[x].passives\[x].lawyers\[x].cpf      | String       | CPF                                                                                                 |
| data.results\[x].otherParties                      | Array        | Other parties list                                                                                  |
| data.results\[x].otherParties\[x].cnpj             | String       | CNPJ                                                                                                |
| data.results\[x].otherParties\[x].cpf              | String       | CPF                                                                                                 |
| data.results\[x].otherParties\[x].name             | String       | Name                                                                                                |
| data.results\[x].otherParties\[x].type             | String       | Type                                                                                                |
| data.results\[x].otherParties\[x].lawyers          | Array        | List of Lawyers                                                                                     |
| data.results\[x].otherParties\[x].lawyers\[x].oab  | String       | OAB Number                                                                                          |
| data.results\[x].otherParties\[x].lawyers\[x].name | String       | Name                                                                                                |
| data.results\[x].otherParties\[x].lawyers\[x].cpf  | String       | CPF                                                                                                 |
| data.results\[x].authorType                        | String       | Author Type                                                                                         |
| data.results\[x].authorParty                       | String       | Author Party                                                                                        |
| {% endtab %}                                       |              |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "",
  "data": {
    "message": "",
    "total": 00,
    "foundWords": [
      ""
    ],
    "results": [
      {
        "id": "",
        "matchedWords": [
          ""
        ],
        "criminalCategory": "",
        "lawsuitClass": "",
        "distributionDate": "",
        "statusDate": "",
        "lawsuitDegree": "",
        "physicalLocation": "",
        "oldLawsuitNumber": "",
        "judgingBody": "",
        "lawsuitId": "",
        "isDigitalLawsuit": true,
        "lawBranch": "",
        "segment": "",
        "isJusticeSecret": true,
        "complementaryStatus": "",
        "observationStatus": "",
        "court": "",
        "state": "",
        "sourceUnit": "",
        "lawsuitUrl": "",
        "otherFields": {
          "juiz": {
            "nome": ""
          }
        },
        "lawsuitValue": {
          "currency": "",
          "value": ""
        },
        "subjects": ["", ""],
        "moves": [
          {
            "date": "",
            "description": ""
          }
        ],
        "actives": [
          {
            "cnpj": "",
            "cpf": "",
            "name": "",
            "type": "",
            "lawyers": [
              {
                "oab": "",
                "name": "",
                "cpf": ""
              }
            ]
          }
        ],
        "passives": [
          {
            "cnpj": "",
            "cpf": "",
            "name": "",
            "type": "",
            "lawyers": [
              {
                "oab": "",
                "name": "",
                "cpf": ""
              }
            ]
          }
        ],
        "otherParties": [
          {
            "cnpj": "",
            "cpf": "",
            "name": "",
            "type": "",
            "lawyers": [
              {
                "oab": "",
                "name": "",
                "cpf": ""
              }
            ]
          }
        ],
        "authorType": "",
        "authorParty": ""
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                     | Description                                                                                |
| ------------------------ | ------------------------------------------------------------------------------------------ |
| has\_processes\_keywords | The rule will become invalid if any of the configured keywords are found in the processes. |
| {% endtab %}             |                                                                                            |
| {% endtabs %}            |                                                                                            |

## Media Exposure + Related News (PJ67)

It returns global indicators that show the overall level of a company's media exposure, the nature of that exposure, detailed content identified, and the result of sentiment analysis.

**Section:** `pjMediaProfileAndExposure`

**Required parameter:** `cnpj`

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

| Attribute                                               | Type   | Description                                                                                         |
| ------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                              | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                                    | Object | Return data                                                                                         |
| data.message                                            | String | Descriptive with query status                                                                       |
| data.mediaExposureLevel                                 | String | Media exposure level                                                                                |
| data.celebrityLevel                                     | String | Celebrity level                                                                                     |
| data.unpopularityLevel                                  | String | Level of unpopularity                                                                               |
| data.newsItems                                          | Array  | List of news captured for the entity                                                                |
| data.newsItems\[x].title                                | String | Title of the news                                                                                   |
| data.newsItems\[x].sourceName                           | String | Name of the source responsible for the news                                                         |
| data.newsItems\[x].url                                  | String | URL of the news                                                                                     |
| data.newsItems\[x].sentimentAnalysis                    | Object | Sentiment analysis                                                                                  |
| data.newsItems\[x].sentimentAnalysis.label              | String | Label (positive, negative) attributed to the content in general                                     |
| data.newsItems\[x].sentimentAnalysis.peopleCount        | String | Number of people identified in the content                                                          |
| data.newsItems\[x].sentimentAnalysis.placesCount        | String | Number of places identified in the content                                                          |
| data.newsItems\[x].sentimentAnalysis.organizationsCount | String | Number of companies identified in the content                                                       |
| data.newsItems\[x].sentimentAnalysis.entities           | Object | Dictionary with entity names and labels of the content                                              |
| data.newsItems\[x].categories                           | Array  | List of categories of the news                                                                      |
| data.newsItems\[x].captureDate                          | String | Date in which the news was captured                                                                 |
| data.newsItems\[x].publicationDate                      | String | News publication date                                                                               |
| data.creationDate                                       | String | Creation date                                                                                       |
| data.lastUpdateDate                                     | String | Date of last update                                                                                 |
| {% endtab %}                                            |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "",
  "data": {
    "message": "",
    "mediaExposureLevel": "",
    "celebrityLevel": "",
    "unpopularityLevel": "",
    "newsItems": [
      {
        "title": "",
        "sourceName": "",
        "url": "",
        "sentimentAnalysis": {
          "label": "",
          "peopleCount": "",
          "placesCount": "",
          "organizationsCount": "",
          "entities": ""
        },
        "categories": "",
        "captureDate": "",
        "publicationDate": ""
      }
    ],
    "creationDate": "",
    "lastUpdateDate": ""
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                     | Description                                  |
| ------------------------ | -------------------------------------------- |
| has\_no\_media\_exposure | Checks if the CPF holder has media exposure. |
| {% endtab %}             |                                              |
| {% endtabs %}            |                                              |

## OFAC Sanctions List

Query the Specially Designated Nationals and Blocked Persons (SDN) List of the Office of Foreign Assets Control (OFAC). The query is by name and is international in scope.

**Section:** `pjOfacSanctionsList`

**Required paremter:** `name`

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

| Attribute                                             | Type   | Description                                                                                         |
| ----------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                            | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                                  | Object | Return data                                                                                         |
| data.message                                          | String | Description with query status                                                                       |
| data.sanctionsList                                    | Array  | List of protocols found for the queried cpf                                                         |
| data.sanctionsList\[x].type                           | String | Type                                                                                                |
| data.sanctionsList\[x].entityName                     | String | Company name                                                                                        |
| data.sanctionsList\[x].list                           | String | List to which the name belongs                                                                      |
| data.sanctionsList\[x].program                        | String | Program to which the name belongs                                                                   |
| data.sanctionsList\[x].remarks                        | String | Observations                                                                                        |
| data.sanctionsList\[x].identifications                | Array  | List of known identifications of the name entered                                                   |
| data.sanctionsList\[x].identifications\[x].type       | String | Type of identification                                                                              |
| data.sanctionsList\[x].identifications\[x].number     | String | Document number                                                                                     |
| data.sanctionsList\[x].identifications\[x].country    | String | Document's country of origin                                                                        |
| data.sanctionsList\[x].identifications\[x].issueDate  | String | Document Date of Issue                                                                              |
| data.sanctionsList\[x].identifications\[x].expireDate | String | Document's expiration date                                                                          |
| data.sanctionsList\[x].aliases                        | Array  | List of surnames by which the name entered can also be identified                                   |
| data.sanctionsList\[x].aliases\[x].type               | String | Type of surname                                                                                     |
| data.sanctionsList\[x].aliases\[x].category           | String | Category of surname                                                                                 |
| data.sanctionsList\[x].aliases\[x].name               | String | First or last name (can be false document)                                                          |
| data.sanctionsList\[x].addresses                      | Array  | List of known addresses of the entered name                                                         |
| data.sanctionsList\[x].addresses\[x].address          | String | Address                                                                                             |
| data.sanctionsList\[x].addresses\[x].city             | String | City                                                                                                |
| data.sanctionsList\[x].addresses\[x].stateOrProvince  | String | State or province                                                                                   |
| data.sanctionsList\[x].addresses\[x].postalCode       | String | Postal code (CEP)                                                                                   |
| data.sanctionsList\[x].addresses\[x].country          | String | Country                                                                                             |
| {% endtab %}                                          |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "",
  "data": {
    "message": "",
    "sanctionsList": [
      {
        "type": "",
        "entityName": "",
        "list": "",
        "program": "",
        "remarks": "",
        "identifications": [
          {
            "type": "",
            "number": "",
            "country": "",
            "issueDate": "",
            "expireDate": ""
          }
        ],
        "aliases": [
          {
            "type": "",
            "category": "",
            "name": ""
          }
        ],
        "addresses": [
          {
            "address": "",
            "city": "",
            "stateOrProvince": "",
            "postalCode": "",
            "country": ""
          }
        ]
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                          | Description                                                   |
| ----------------------------- | ------------------------------------------------------------- |
| is\_on\_ofac\_sanctions\_list | Checks if there are any records at OFAC for the name entered. |
| {% endtab %}                  |                                                               |
| {% endtabs %}                 |                                                               |

## Private Restrictions List (PJ78)

Query the presence in the private list of restrictions.

**Section:** `pjDenyListPrivate`

**Required parameter:** `cnpj`

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

| Attribute        | Type    | Description                                                                                         |
| ---------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode       | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data             | Object  | Return data                                                                                         |
| data.message     | String  | Descriptive with query status                                                                       |
| data.recordFound | Boolean | Indicative of presence in the private restriction list                                              |
| data.cnpj        | String  | CNPJ                                                                                                |
| data.name        | String  | Name                                                                                                |
| {% endtab %}     |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "",
  "data": {
    "message": "",
    "recordFound": true,
    "cnpj": "",
    "name": ""
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                | Description                                                             |
| ------------------- | ----------------------------------------------------------------------- |
| its\_on\_deny\_list | The rule will be invalid if the consulted CPF/CNPJ is on the Deny List. |
| {% endtab %}        |                                                                         |
| {% endtabs %}       |                                                                         |

## ANTT

Consult the ANTT site to identify if the carrier is qualified to perform activities.

**Section:** `antt`

**Required parameter:** `cnpj, plate`

**Plate formats:** *AAA9999* or *AAA9A999*

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

| Attribute           | Type    | Description                                                                                         |
| ------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode          | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                | Object  | Return data                                                                                         |
| data.hasRegister    | Boolean | Status informing whether it contains record                                                         |
| data.transporter    | String  | Carrier                                                                                             |
| data.rntrc          | String  | RNTRC number                                                                                        |
| data.rntrcSituation | String  | Status                                                                                              |
| data.memberSince    | String  | Date of first relationship                                                                          |
| data.expirationDate | String  | Expiry date                                                                                         |
| data.city           | String  | City                                                                                                |
| data.message        | String  | Message present at registration                                                                     |
| {% endtab %}        |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "",
  "data": {
    "hasRegister": true,
    "transporter": "",
    "rntrc": "",
    "rntrcSituation": "",
    "memberSince": "",
    "expirationDate": "",
    "city": "",
    "message": ""
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                       | Description                                                                                                    |
| -------------------------- | -------------------------------------------------------------------------------------------------------------- |
| has\_no\_participant\_antt | The rule will be invalid if the consulted vehicle and person/company are not authorized to perform activities. |
| {% endtab %}               |                                                                                                                |
| {% endtabs %}              |                                                                                                                |

## Lawsuits - NEW (PJ69)

It returns all available court cases through an expanded query, guaranteeing maximum information coverage.

**Section:** `pjLegalRecordsExtended`

**Required parameter:** `cnpj`

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

| Attribute                                                            | Type    | Description                   |
| -------------------------------------------------------------------- | ------- | ----------------------------- |
| statusCode                                                           | String  | Query status                  |
| data                                                                 | Object  | Return data                   |
| data.message                                                         | String  | Description with query status |
| data.lawsuits                                                        | Array   | Processes list returned       |
| data.lawsuits\[x].cnjCode                                            | String  | CNJ code                      |
| data.lawsuits\[x].secrecyLevel                                       | Number  | Secrecy level                 |
| data.lawsuits\[x].amount                                             | Number  | Lawsuit amount                |
| data.lawsuits\[x].area                                               | String  | Lawsuit area                  |
| data.lawsuits\[x].instance                                           | Number  | Lawsuit degree                |
| data.lawsuits\[x].phase                                              | String  | Lawsuit phase                 |
| data.lawsuits\[x].status                                             | String  | Lawsuit status                |
| data.lawsuits\[x].judge                                              | String  | Lawsuit judge                 |
| data.lawsuits\[x].name                                               | String  | Abbreviation of the parties   |
| data.lawsuits\[x].courtAcronym                                       | String  | Court acronym                 |
| data.lawsuits\[x].courtDistrict                                      | String  | Court district                |
| data.lawsuits\[x].state                                              | String  | Lawsuit state                 |
| data.lawsuits\[x].city                                               | String  | Lawsuit city                  |
| data.lawsuits\[x].distributionDate                                   | String  | Distribution date             |
| data.lawsuits\[x].justiceDescription                                 | String  | Justice description           |
| data.lawsuits\[x].isCriminal                                         | Boolean | Criminal lawsuit indication   |
| data.lawsuits\[x].mainPartySide                                      | String  | Side of the searched party    |
| data.lawsuits\[x].lastStep                                           | Object  | Lawsuit last step             |
| data.lawsuits\[x].lastStep.stepId                                    | String  | Last step identifier          |
| data.lawsuits\[x].lastStep.stepDate                                  | String  | Last step date                |
| data.lawsuits\[x].lastStep.content                                   | String  | Last step content             |
| data.lawsuits\[x].lastStep.stepType                                  | String  | Last step type                |
| data.lawsuits\[x].lastStep.stepsCount                                | Number  | Last step count               |
| data.lawsuits\[x].relatedLawsuits                                    | Array   | Related lawsuits              |
| data.lawsuits\[x].relatedLawsuits\[x].code                           | String  | Related lawsuits code         |
| data.lawsuits\[x].relatedLawsuits\[x].instance                       | String  | Related lawsuits instance     |
| data.lawsuits\[x].steps                                              | Array   | Steps                         |
| data.lawsuits\[x].steps\[x].stepDate                                 | String  | Step date                     |
| data.lawsuits\[x].steps\[x].stepType                                 | String  | Step type                     |
| data.lawsuits\[x].steps\[x].content                                  | String  | Step content                  |
| data.lawsuits\[x].steps\[x].private                                  | String  | Step private                  |
| data.lawsuits\[x].subjects                                           | Array   | Subjects                      |
| data.lawsuits\[x].subjects\[x].code                                  | String  | Subject code                  |
| data.lawsuits\[x].subjects\[x].subject                               | String  | Subject description           |
| data.lawsuits\[x].courts                                             | Array   | Courts                        |
| data.lawsuits\[x].courts\[x].code                                    | String  | Court code                    |
| data.lawsuits\[x].courts\[x].court                                   | String  | Court description             |
| data.lawsuits\[x].classifications                                    | Array   | Classifications               |
| data.lawsuits\[x].classifications\[x].code                           | String  | Classification code           |
| data.lawsuits\[x].classifications\[x].classification                 | String  | Classification description    |
| data.lawsuits\[x].parties                                            | Array   | Parties                       |
| data.lawsuits\[x].parties\[x].type                                   | String  | Party type                    |
| data.lawsuits\[x].parties\[x].side                                   | String  | Party side                    |
| data.lawsuits\[x].parties\[x].party                                  | String  | Party description             |
| data.lawsuits\[x].parties\[x].mainDocument                           | String  | Party main document           |
| data.lawsuits\[x].parties\[x].documents                              | Array   | Party Documents               |
| data.lawsuits\[x].parties\[x].documents\[x].documentType             | String  | Party document type           |
| data.lawsuits\[x].parties\[x].documents\[x].document                 | String  | Party document                |
| data.lawsuits\[x].parties\[x].lawyers                                | Array   | Party lawyers                 |
| data.lawsuits\[x].parties\[x].lawyers\[x].name                       | String  | Lawyer name                   |
| data.lawsuits\[x].parties\[x].lawyers\[x].mainDocument               | String  | Lawyers main document         |
| data.lawsuits\[x].parties\[x].lawyers\[x].documents                  | Array   | Lawyers documents             |
| data.lawsuits\[x].parties\[x].lawyers\[x].documents\[x].documentType | String  | Lawyers document type         |
| data.lawsuits\[x].parties\[x].lawyers\[x].documents\[x].document     | String  | Lawyers document              |
| {% endtab %}                                                         |         |                               |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "message": "Consulta realizada com sucesso",
  "data": {
    "lawsuits": [
      {
        "type": "lawsuit",
        "cnjCode": "099999-09.0990.9.99.9900",
        "secrecyLevel": 0,
        "amount": 1000,
        "area": "DIREITO PROCESSUAL CIVIL",
        "status": "Ativo",
        "phase": "Incial",
        "judge": "",
        "instance": 1,
        "name": "JONH DOE X JANE DOE",
        "courtAcronym": "TJSP",
        "courtDistrict": "VARA DA COMARCA DE SÃO PAULO",
        "state": "sp",
        "city": "SÃO PAULO",
        "distributionDate": "2024-03-12T09:57:51.000Z",
        "justiceDescription": "JUSTIÇA ESTADUAL",
        "isCriminal": false,
        "mainPartySide": "ATIVO",
        "steps": [],
        "subjects": [
          {
            "code": "10671",
            "subject": "Obrigação de Fazer / Não Fazer"
          }
        ],
        "courts": [
          {
            "code": "5117",
            "court": "VARA DA COMARCA DE SÃO PAULO"
          }
        ],
        "classifications": [
          {
            "code": "436",
            "classification": ""
          }
        ],
        "parties": [
          {
            "type": "Réu",
            "side": "Passive",
            "party": "JANE DOE",
            "mainDocument": "99999999999",
            "documents": [
              {
                "documentType": "cpf",
                "document": "99999999999"
              }
            ],
            "lawyers": [
              {
                "name": "JOSE DOE",
                "mainDocument": "",
                "documents": []
              }
            ]
          },
          {
            "type": "Autor",
            "side": "Active",
            "party": "JOHN DOE",
            "mainDocument": "88888888888",
            "documents": [
              {
                "documentType": "cpf",
                "document": "88888888888"
              }
            ],
            "lawyers": [
              {
                "name": "JOÃO DOE",
                "mainDocument": "",
                "documents": []
              }
            ]
          },
          {
            "type": "Advogado",
            "side": "Passive",
            "party": "JOSE DOE",
            "mainDocument": "",
            "documents": [],
            "lawyers": []
          },
          {
            "type": "Advogado",
            "side": "Active",
            "party": "JOÃO DOE",
            "mainDocument": "",
            "documents": [],
            "lawyers": []
          }
        ]
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                             | Description                                                          |
| ------------------------------------------------ | -------------------------------------------------------------------- |
| has\_no\_processes                               | Checks if the CPF/CNPJ is linked to processes.                       |
| has\_no\_processes\_active\_party                | Check if the CPF is linked to processes as an active party.          |
| has\_no\_processes\_passive\_party               | Check if the CPF is linked to processes as a passive party.          |
| has\_no\_processes\_other\_party                 | Check if the CPF is linked to processes as other parties.            |
| has\_no\_defendant\_processes                    | Checks if the CPF/CNPJ is linked to proceedings as a defendant.      |
| has\_no\_criminal\_processes                     | Checks if the CPF/CNPJ is linked to criminal proceedings.            |
| has\_author\_type\_null\_in\_criminal\_processes | Checks if there is an empty 'authorType' field in any criminal case. |
| {% endtab %}                                     |                                                                      |
| {% endtabs %}                                    |                                                                      |

## Lawsuits with Keywords - NEW (PJ70)

It returns all available court cases through an expanded query, guaranteeing maximum information coverage.

**Section:** `pjLegalRecordsExtendedKeywords`

**Required parameter:** `cnpj`

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

| Attribute                                                            | Type    | Description                    |
| -------------------------------------------------------------------- | ------- | ------------------------------ |
| statusCode                                                           | String  | Query status                   |
| data                                                                 | Object  | Return data                    |
| data.message                                                         | String  | Description with query status  |
| data.foundKeywords                                                   | Array   | Keywords found                 |
| data.lawsuits                                                        | Array   | Processes list returned        |
| data.lawsuits\[x].matchedWords                                       | Array   | Keywords found in this lawsuit |
| data.lawsuits\[x].cnjCode                                            | String  | CNJ code                       |
| data.lawsuits\[x].secrecyLevel                                       | Number  | Secrecy level                  |
| data.lawsuits\[x].amount                                             | Number  | Lawsuit amount                 |
| data.lawsuits\[x].area                                               | String  | Lawsuit area                   |
| data.lawsuits\[x].instance                                           | Number  | Lawsuit degree                 |
| data.lawsuits\[x].phase                                              | String  | Lawsuit phase                  |
| data.lawsuits\[x].status                                             | String  | Lawsuit status                 |
| data.lawsuits\[x].judge                                              | String  | Lawsuit judge                  |
| data.lawsuits\[x].name                                               | String  | Abbreviation of the parties    |
| data.lawsuits\[x].courtAcronym                                       | String  | Court acronym                  |
| data.lawsuits\[x].courtDistrict                                      | String  | Court district                 |
| data.lawsuits\[x].state                                              | String  | Lawsuit state                  |
| data.lawsuits\[x].city                                               | String  | Lawsuit city                   |
| data.lawsuits\[x].distributionDate                                   | String  | Distribution date              |
| data.lawsuits\[x].justiceDescription                                 | String  | Justice description            |
| data.lawsuits\[x].isCriminal                                         | Boolean | Criminal lawsuit indication    |
| data.lawsuits\[x].mainPartySide                                      | String  | Side of the searched party     |
| data.lawsuits\[x].lastStep                                           | Object  | Lawsuit last step              |
| data.lawsuits\[x].lastStep.stepId                                    | String  | Last step identifier           |
| data.lawsuits\[x].lastStep.stepDate                                  | String  | Last step date                 |
| data.lawsuits\[x].lastStep.content                                   | String  | Last step content              |
| data.lawsuits\[x].lastStep.stepType                                  | String  | Last step type                 |
| data.lawsuits\[x].lastStep.stepsCount                                | Number  | Last step count                |
| data.lawsuits\[x].relatedLawsuits                                    | Array   | Related lawsuits               |
| data.lawsuits\[x].relatedLawsuits\[x].code                           | String  | Related lawsuits code          |
| data.lawsuits\[x].relatedLawsuits\[x].instance                       | String  | Related lawsuits instance      |
| data.lawsuits\[x].steps                                              | Array   | Steps                          |
| data.lawsuits\[x].steps\[x].stepDate                                 | String  | Step date                      |
| data.lawsuits\[x].steps\[x].stepType                                 | String  | Step type                      |
| data.lawsuits\[x].steps\[x].content                                  | String  | Step content                   |
| data.lawsuits\[x].steps\[x].private                                  | String  | Step private                   |
| data.lawsuits\[x].subjects                                           | Array   | Subjects                       |
| data.lawsuits\[x].subjects\[x].code                                  | String  | Subject code                   |
| data.lawsuits\[x].subjects\[x].subject                               | String  | Subject description            |
| data.lawsuits\[x].courts                                             | Array   | Courts                         |
| data.lawsuits\[x].courts\[x].code                                    | String  | Court code                     |
| data.lawsuits\[x].courts\[x].court                                   | String  | Court description              |
| data.lawsuits\[x].classifications                                    | Array   | Classifications                |
| data.lawsuits\[x].classifications\[x].code                           | String  | Classification code            |
| data.lawsuits\[x].classifications\[x].classification                 | String  | Classification description     |
| data.lawsuits\[x].parties                                            | Array   | Parties                        |
| data.lawsuits\[x].parties\[x].type                                   | String  | Party type                     |
| data.lawsuits\[x].parties\[x].side                                   | String  | Party side                     |
| data.lawsuits\[x].parties\[x].party                                  | String  | Party description              |
| data.lawsuits\[x].parties\[x].mainDocument                           | String  | Party main document            |
| data.lawsuits\[x].parties\[x].documents                              | Array   | Party Documents                |
| data.lawsuits\[x].parties\[x].documents\[x].documentType             | String  | Party document type            |
| data.lawsuits\[x].parties\[x].documents\[x].document                 | String  | Party document                 |
| data.lawsuits\[x].parties\[x].lawyers                                | Array   | Party lawyers                  |
| data.lawsuits\[x].parties\[x].lawyers\[x].name                       | String  | Lawyer name                    |
| data.lawsuits\[x].parties\[x].lawyers\[x].mainDocument               | String  | Lawyers main document          |
| data.lawsuits\[x].parties\[x].lawyers\[x].documents                  | Array   | Lawyers documents              |
| data.lawsuits\[x].parties\[x].lawyers\[x].documents\[x].documentType | String  | Lawyers document type          |
| data.lawsuits\[x].parties\[x].lawyers\[x].documents\[x].document     | String  | Lawyers document               |
| {% endtab %}                                                         |         |                                |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "message": "Consulta realizada com sucesso",
  "data": {
    "foundKeywords": [
      "Indenização por dano moral"
    ],
    "lawsuits": [
      {
        "type": "lawsuit",
        "matchedWords": [
          "Indenização por dano moral"
        ],
        "cnjCode": "099999-09.0990.9.99.9900",
        "secrecyLevel": 0,
        "amount": 1000,
        "area": "DIREITO PROCESSUAL CIVIL",
        "phase": "Inicial",
        "status": "Ativo",
        "judge": "",
        "instance": 1,
        "name": "JONH DOE X JANE DOE",
        "courtAcronym": "TJSP",
        "courtDistrict": "VARA DA COMARCA DE SÃO PAULO",
        "state": "sp",
        "city": "SÃO PAULO",
        "distributionDate": "2024-03-12T09:57:51.000Z",
        "justiceDescription": "JUSTIÇA ESTADUAL",
        "isCriminal": false,
        "mainPartySide": "ATIVO",
        "steps": [],
        "subjects": [
          {
            "code": "10671",
            "subject": "Obrigação de Fazer / Não Fazer"
          },
          {
            "code": "10001",
            "subject": "Indenização por dano moral"
          }
        ],
        "courts": [
          {
            "code": "5117",
            "court": "VARA DA COMARCA DE SÃO PAULO"
          }
        ],
        "classifications": [
          {
            "code": "436",
            "classification": ""
          }
        ],
        "parties": [
          {
            "type": "Réu",
            "side": "Passive",
            "party": "JANE DOE",
            "mainDocument": "99999999999",
            "documents": [
              {
                "documentType": "cpf",
                "document": "99999999999"
              }
            ],
            "lawyers": [
              {
                "name": "JOSE DOE",
                "mainDocument": "",
                "documents": []
              }
            ]
          },
          {
            "type": "Autor",
            "side": "Active",
            "party": "JOHN DOE",
            "mainDocument": "88888888888",
            "documents": [
              {
                "documentType": "cpf",
                "document": "88888888888"
              }
            ],
            "lawyers": [
              {
                "name": "JOÃO DOE",
                "mainDocument": "",
                "documents": []
              }
            ]
          },
          {
            "type": "Advogado",
            "side": "Passive",
            "party": "JOSE DOE",
            "mainDocument": "",
            "documents": [],
            "lawyers": []
          },
          {
            "type": "Advogado",
            "side": "Active",
            "party": "JOÃO DOE",
            "mainDocument": "",
            "documents": [],
            "lawyers": []
          }
        ]
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                     | Description                                                                                |
| ------------------------ | ------------------------------------------------------------------------------------------ |
| has\_processes\_keywords | The rule will become invalid if any of the configured keywords are found in the processes. |
| {% endtab %}             |                                                                                            |
| {% endtabs %}            |                                                                                            |


# Documents

## VerifAI Docs - File manipulation detection - NEW (PJ99)

Returns information about digital manipulations in files, such as social contracts, invoices, and receipts, by analyzing their metadata. For greater accuracy, we recommend you send files in PDF format. Currently, this functionality is available in English and Portuguese, with Spanish as the next language to be added.

**Section**: `pjVerifaiDocs`

**Required files:** `Any file in .pdf, .jpg, or .jpeg format`

**Optional parameter:** `CNPJ`

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

| Attribute                            | Type             | Description                                                                                                                                                |
| ------------------------------------ | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| statusCode                           | String           | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code))                                                        |
| message                              | String           | Query result descriptive message                                                                                                                           |
| data                                 | Array            | A list with the analysis results for each submitted document                                                                                               |
| data\[x].status                      | String           | Status of the analysis                                                                                                                                     |
| data\[x].analysisTime                | String           | Timestamp of analysis                                                                                                                                      |
| data\[x].queryId                     | String           | Internal ID of the analysis                                                                                                                                |
| data\[x].sha256                      | String           | Sha256 of the input file                                                                                                                                   |
| data\[x].fileType                    | String           | Type of analyzed document                                                                                                                                  |
| data\[x].mimeType                    | String           | Mime type of the input document : `application/pdf`, `image/jpeg`                                                                                          |
| data\[x].score                       | String           | Fraud score produced by the document analysis: `NORMAL`, `TRUSTED`, `WARNING`, `HIGH_RISK`                                                                 |
| data\[x].decision                    | String           | Level of risk associated with the analyzed document: `LOW_RISK`, `MEDIUM_RISK`, `HIGH_RISK`                                                                |
| data\[x].numPages                    | String           | Number of pages in submitted document                                                                                                                      |
| data\[x].fileName                    | String           | File name                                                                                                                                                  |
| data\[x].submissionId                | String           | Document unique identifier                                                                                                                                 |
| data\[x].reason                      | Object           | Details object describing the reason for the decision                                                                                                      |
| data\[x].reason.value                | String           | Reason label                                                                                                                                               |
| data\[x].reason.label                | String           | Reason description                                                                                                                                         |
| data\[x].sampleMetadata              | Object           | Metadata of an analyzed document                                                                                                                           |
| data\[x].sampleMetadata.producer     | String           | Document produce                                                                                                                                           |
| data\[x].sampleMetadata.creator      | String           | Document creator                                                                                                                                           |
| data\[x].sampleMetadata.creationDate | String           | Document creation date                                                                                                                                     |
| data\[x].sampleMetadata.modDate      | String           | Document modification date                                                                                                                                 |
| data\[x].sampleMetadata.author       | String           | Document author                                                                                                                                            |
| data\[x].sampleMetadata.title        | String           | Document title                                                                                                                                             |
| data\[x].sampleMetadata.keywords     | String           | Document keywords                                                                                                                                          |
| data\[x].sampleMetadata.subject      | String           | Document subject                                                                                                                                           |
| data\[x].indicators                  | Array of objects | Detailed information about the specific results of the analysis. This field contains detailed observations that the system was able to make about the file |
| data\[x].indicators\[x].type         | String           | Type of a quality indicator: `RISK`, `TRUST`, `INFO`                                                                                                       |
| data\[x].indicators\[x].category     | String           | Category of indicator                                                                                                                                      |
| data\[x].indicators\[x].title        | String           | Indicator title                                                                                                                                            |
| data\[x].indicators\[x].description  | String           | Description of the indicator                                                                                                                               |
| data\[x].indicators\[x].origin       | String           | Indicator origin: `fraud`, `quality`                                                                                                                       |
| data\[x].documentClass               | Object           | The type of file submitted for analysis                                                                                                                    |
| data\[x].documentClass.id            | String           | Document type ID                                                                                                                                           |
| data\[x].documentClass.type          | String           | Document type                                                                                                                                              |
| data\[x].documentClass.detailedType  | String           | Document type detailed                                                                                                                                     |
| {% endtab %}                         |                  |                                                                                                                                                            |

{% tab title="Example" %}

```json
{
  "pjVerifaiDocs": {
    "statusCode": "01",
    "data": [
      {
        "status": "SUCCESS",
        "analysisTime": "2025-07-01T19:39:20.605088Z",
        "deploymentVersion": "4f59fea5",
        "queryId": "3512299f-8385-4152-93c2-eaa2dea85983-6864382d16941a000265d233-conta-internet-20-05",
        "fileType": "pdf",
        "mimeType": "application/pdf",
        "sha256": "63d5d349a6610d048c05a620aa3f7afbda3be2686c6791418ac8c7d2b099db71",
        "score": "HIGH_RISK",
        "sampleMetadata": {
          "producer": "Producer 1.91a ",
          "creator": "Dox PDF",
          "creationDate": "2024-12-20T09:41:35+01:00",
          "modDate": "2025-01-09T17:48:56+01:00",
          "author": "Document Designer Development Group",
          "title": "Vivo conta 20/05/2025",
          "keywords": "Ver 6.0",
          "subject": "Internet"
        },
        "indicators": [
          {
            "type": "RISK",
            "category": "document_structure",
            "title": "Known document with unexpected patterns",
            "description": "We’ve seen many documents like this from Telefonica Brasil S.A., and this one stands out - in the wrong way. Its structure, layout, and other elements don’t follow the expected pattern. These clues strongly suggest the document was modified, recreated, or produced using different software.",
            "origin": "fraud"
          },
          {
            "type": "RISK",
            "category": "modifications",
            "title": "Content was modified",
            "description": "This document was produced in several versions. This version of the document differs from the original.",
            "origin": "fraud"
          },
          {
            "type": "RISK",
            "category": "modifications",
            "title": "Edited using editor",
            "description": "This document contains tags used by PDF editors, which indicate modifications of the document.",
            "origin": "fraud"
          },
          {
            "type": "TRUST",
            "category": "visual_appearance",
            "title": "Telefonica Brasil S.A. logo",
            "description": "This document contains a logo commonly associated with Telefonica Brasil S.A., suggesting it was issued by that utility.",
            "origin": "fraud"
          },
          {
            "type": "RISK",
            "category": "metadata_modifications",
            "title": "Evidence of modification based on document metadata",
            "description": "Time of creation is 2024-12-20T08:41:35+00:00 but the time of modification is 2025-01-09T16:48:56+00:00. This may indicate that the document was updated or modified. The time span between creation and modification is 20 days, 8:07:21.",
            "origin": "fraud"
          },
          {
            "type": "RISK",
            "category": "modifications",
            "title": "Anomalous fonts",
            "description": "Some of the fonts in use here are not typically used by the issuer in this kind of document.",
            "origin": "fraud"
          },
          {
            "type": "RISK",
            "category": "anomalous_metadata",
            "title": "Document has anomalous metadata",
            "description": "The metadata (creator, producer, etc.) differs from the typical document from the same issuer. ",
            "origin": "fraud"
          }
        ],
        "documentClass": {
          "id": "utility_bill_vivo",
          "type": "utility_bill",
          "documentClassType": "UtilityBillDocumentClass",
          "detailedType": "internet_mobile_television"
        },
        "numPages": 3,
        "fileName": "conta-internet-20-05.pdf",
        "submissionId": "bdd50bc4-fa5c-46ba-a9d6-5c715af98daa",
        "decision": "HIGH_RISK",
        "reason": {
            "value": "DIGITAL_MODIFICATION_HIGH_CONFIDENCE",
            "label": "Document contains traces of digital modification, likely with fraudulent intent"
        }
      },
      {
          "status": "SUCCESS",
          "analysisTime": "2025-07-02T13:11:30.099104Z",
          "deploymentVersion": "4f59fea5",
          "queryId": "49dc9bda-fa86-41c0-9c9c-8a8cff5e6ecd-68652fdfdf165d00021c9f44-comprovante-pix",
          "fileType": "pdf",
          "mimeType": "application/pdf",
          "sha256": "55662b513518cf0bedf695febedbfd489924b1ec92de3aabfdc6dcf97e2822dc",
          "score": "NORMAL",
          "sampleMetadata": {
            "producer": "mPDF 7.1.9",
            "creator": null,
            "creationDate": "2019-11-29T06:33:40+03:00",
            "modDate": "2019-11-29T06:33:40+03:00",
            "author": null,
            "title": "Tiny",
            "keywords": null,
            "subject": null
          },
          "indicators": [
            {
              "indicatorId": "is_pdf_unmodified_per_metadata",
              "type": "TRUST",
              "category": "authenticity",
              "title": "No modification in document metadata",
              "description": "Timestamps in this document's metadata do not indicate that the file was incrementally updated or modified.",
              "origin": "fraud"
            },
            {
              "indicatorId": "has_mpdf_metadata",
              "type": "INFO",
              "category": "known_creator",
              "title": "Saved in mPDF",
              "description": "The document was processed and saved in mPDF - software library (PHP language) for generating PDF files from HTML documents.",
              "origin": "fraud"
            }
          ],
          "documentClass": {
            "id": "unknown",
            "type": "unknown",
            "documentClassType": "DocumentClass"
          },
          "numPages": 1,
          "fileName": "comprovante-pix.pdf",
          "submissionId": "a441c5d6-b2d2-4fef-8aaa-799ae7308f4b",
          "decision": "LOW_RISK",
          "reason": {
              "value": "NO_DIGITAL_MODIFICATION",
              "label": "Document shows no signs of digital modification"
          }
        }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                  | Description                                                                         |
| ------------------------------------- | ----------------------------------------------------------------------------------- |
| verifai\_docs\_available\_analysis    | Checks if analysis results are available for the submitted documents.               |
| verifai\_docs\_analysis\_medium\_risk | Checks whether the analysis result of any submitted document indicates medium risk. |
| verifai\_docs\_analysis\_high\_risk   | Checks whether the analysis result of any submitted document indicates high risk.   |
| {% endtab %}                          |                                                                                     |
| {% endtabs %}                         |                                                                                     |


# Credit Report

Specializing in business credit reports and housing data on over 365 million global businesses, we provide accurate and current information in a user-friendly format for businesses of all sizes. Endorsed by major credit insurers, our reports help verify the existence, activity, and trading status of a business, assessing potential financial and reputational risks. Our extensive coverage and depth of data make us an integral part of your Know Your Business (KYB) offering.

**Section**: `kybCreditReport`

**Required parameter:** `creditReportId`

Note: All fields returned by this API are optional and their presence cannot be guaranteed. Depending on the request or specific conditions, certain fields may not appear in the response.

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

| Attribute                                                                        | Type             | Description                                                                                                                                                                                                                                                                                                                |
| -------------------------------------------------------------------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                                                                               | string           | Internal company identification.                                                                                                                                                                                                                                                                                           |
| name                                                                             | string           | Registered company name/trading name of the business.                                                                                                                                                                                                                                                                      |
| number                                                                           | string           | Official registration number.                                                                                                                                                                                                                                                                                              |
| vatRegistrationNumber                                                            | string           | Local VAT Number.                                                                                                                                                                                                                                                                                                          |
| registrationDate                                                                 | date             | The date the company was registered.                                                                                                                                                                                                                                                                                       |
| legalForm                                                                        | string           | The legal type of the company                                                                                                                                                                                                                                                                                              |
| country                                                                          | string           | Country where the company is registered (Alpha‑2 Code).                                                                                                                                                                                                                                                                    |
| status                                                                           | object           |                                                                                                                                                                                                                                                                                                                            |
| status.status                                                                    | string           | High-level status. Values include "Active", "NonActive", "Pending" and "Other".                                                                                                                                                                                                                                            |
| status.description                                                               | string           | A more in-depth status value, based on local descriptions.                                                                                                                                                                                                                                                                 |
| activities                                                                       | array of objects |                                                                                                                                                                                                                                                                                                                            |
| activities.classification                                                        | string           | The type of activity classification.                                                                                                                                                                                                                                                                                       |
| activities.code                                                                  | string           | Industry code used in that country.                                                                                                                                                                                                                                                                                        |
| activities.description                                                           | string           | Description of company’s main activity.                                                                                                                                                                                                                                                                                    |
| activities.main                                                                  | boolean          | Indicate if the activity is the main activity of the company.                                                                                                                                                                                                                                                              |
| contact.phoneNumber                                                              | strings          | Telephone number of the company.                                                                                                                                                                                                                                                                                           |
| contact.emails                                                                   | array of strings | Email address for the company.                                                                                                                                                                                                                                                                                             |
| contact.websites                                                                 | array of strings | Website address of the company.                                                                                                                                                                                                                                                                                            |
| contact.addresses                                                                | array of objects |                                                                                                                                                                                                                                                                                                                            |
| contact.addresses.fullAddress                                                    | string           | Whole string address                                                                                                                                                                                                                                                                                                       |
| contact.addresses.state                                                          | string           |                                                                                                                                                                                                                                                                                                                            |
| contact.addresses.city                                                           | string           | City portion of the address.                                                                                                                                                                                                                                                                                               |
| contact.addresses.postalCode                                                     | string           | Postal code portion of the address.                                                                                                                                                                                                                                                                                        |
| contact.addresses.telephone                                                      | string           | Telephone number of the address.                                                                                                                                                                                                                                                                                           |
| contact.addresses.main                                                           | boolean          | Indicate if the address is the main address.                                                                                                                                                                                                                                                                               |
| creditRating                                                                     | object           |                                                                                                                                                                                                                                                                                                                            |
| creditRating.internationalScore                                                  | string           | Standardised credit score – will be A, B, C, D or E.                                                                                                                                                                                                                                                                       |
| creditRating.creditLimit                                                         | object           |                                                                                                                                                                                                                                                                                                                            |
| creditRating.creditLimit.currency                                                | string           | The Currency in which the financial value is displayed, as a three-character ISO code.                                                                                                                                                                                                                                     |
| creditRating.creditLimit.value                                                   | string           | Amount of credit advisable at any one time.                                                                                                                                                                                                                                                                                |
| directors                                                                        | array of objects |                                                                                                                                                                                                                                                                                                                            |
| directors.id                                                                     | string           | Internal director identification                                                                                                                                                                                                                                                                                           |
| directors.name                                                                   | string           | Full name of director                                                                                                                                                                                                                                                                                                      |
| directors.title                                                                  | String           | Title of director. Values include "Miss", "Mr", "Mrs", "Ms".                                                                                                                                                                                                                                                               |
| directors.nationality                                                            | string           | The director’s nationality or country of birth.                                                                                                                                                                                                                                                                            |
| directors.birthDate                                                              | string           | The director’s date of birth.                                                                                                                                                                                                                                                                                              |
| directors.gender                                                                 | string           | An standard description, as “Male”, “Female” or “Unknown”.                                                                                                                                                                                                                                                                 |
| directors.isCurrent                                                              | boolean          | Indicate if the director is a current director                                                                                                                                                                                                                                                                             |
| directors.address                                                                | object           |                                                                                                                                                                                                                                                                                                                            |
| directors.address.fullAddress                                                    | string           | Whole string address.                                                                                                                                                                                                                                                                                                      |
| directors.address.postalCode                                                     | string           | Postal code portion of the address.                                                                                                                                                                                                                                                                                        |
| directors.address.city                                                           | string           | City portion of the address                                                                                                                                                                                                                                                                                                |
| directors.address.state                                                          | string           |                                                                                                                                                                                                                                                                                                                            |
| directors.address.country                                                        | string           | The country where the directors details are registered.                                                                                                                                                                                                                                                                    |
| directors.additionalData                                                         | object           |                                                                                                                                                                                                                                                                                                                            |
| directors.additionalData.disqualified                                            | boolean          |                                                                                                                                                                                                                                                                                                                            |
| directors.additionalData.occupation                                              | string           |                                                                                                                                                                                                                                                                                                                            |
| directors.additionalData.presentAppointments                                     | number           |                                                                                                                                                                                                                                                                                                                            |
| directors.additionalData.dissolvedAppointments                                   | number           |                                                                                                                                                                                                                                                                                                                            |
| directors.additionalData.previousAppointments                                    | number           |                                                                                                                                                                                                                                                                                                                            |
| directors.additionalData.positions                                               | array of objects |                                                                                                                                                                                                                                                                                                                            |
| directors.additionalData.positions.name                                          | string           | The director’s role/position in a company.                                                                                                                                                                                                                                                                                 |
| directors.additionalData.positions.dateAppointed                                 | date             | The date the director was appointed.                                                                                                                                                                                                                                                                                       |
| groupStructure                                                                   | array of objects |                                                                                                                                                                                                                                                                                                                            |
| groupStructure.name                                                              | string           | Full company name                                                                                                                                                                                                                                                                                                          |
| groupStructure.level                                                             | number           | The hierarchical level of the company within the group structure.                                                                                                                                                                                                                                                          |
| groupStructure.country                                                           | string           | Country where the company is established.                                                                                                                                                                                                                                                                                  |
| groupStructure.number                                                            | string           | Official registration number.                                                                                                                                                                                                                                                                                              |
| groupStructure.safeNumber                                                        | string           | Internal company identification                                                                                                                                                                                                                                                                                            |
| groupStructure.status                                                            | string           | High-level status. Values include "Active", "NonActive", "Pending" and "Other".                                                                                                                                                                                                                                            |
| groupStructure.latestAnnualAccounts                                              | date             | The last filed financial statements Year End Date of the company.                                                                                                                                                                                                                                                          |
| groupStructure.address                                                           | object           |                                                                                                                                                                                                                                                                                                                            |
| groupStructure.address.fullAddress                                               | string           | Whole string address                                                                                                                                                                                                                                                                                                       |
| groupStructure.address.postalCode                                                | string           | Postal code portion of the address                                                                                                                                                                                                                                                                                         |
| groupStructure.address.city                                                      | string           | City portion of the address                                                                                                                                                                                                                                                                                                |
| groupStructure.address.state                                                     | string           |                                                                                                                                                                                                                                                                                                                            |
| groupStructure.address.country                                                   | string           | Country where the address is registered.                                                                                                                                                                                                                                                                                   |
| groupStructure.relationType                                                      | object           |                                                                                                                                                                                                                                                                                                                            |
| groupStructure.relationType.isUltimateParent                                     | boolean          | Indicate if the company is a ultimate parent.                                                                                                                                                                                                                                                                              |
| groupStructure.relationType.isImmediateParent                                    | boolean          | Indicate if the company is a immediate parent.                                                                                                                                                                                                                                                                             |
| groupStructure.relationType.isSubsidiaryCompany                                  | boolean          | Indicate if the company is a subsidiary company.                                                                                                                                                                                                                                                                           |
| groupStructure.relationType.isAffiliatedCompany                                  | boolean          | Indicate if the company is a affiliated company.                                                                                                                                                                                                                                                                           |
| otherInformation                                                                 | object           |                                                                                                                                                                                                                                                                                                                            |
| otherInformation.advisors                                                        | array of objects |                                                                                                                                                                                                                                                                                                                            |
| otherInformation.advisors.accountantName                                         | string           | Full name of the accountancy firm who responsible for preparing the accounts.                                                                                                                                                                                                                                              |
| otherInformation.advisors.solicitorName                                          | string           | Name of solicitors.                                                                                                                                                                                                                                                                                                        |
| otherInformation.advisors.auditorName                                            | string           | Full name of the company who is responsible for auditing.                                                                                                                                                                                                                                                                  |
| otherInformation.employeesInformation                                            | array of objects |                                                                                                                                                                                                                                                                                                                            |
| otherInformation.employeesInformation.year                                       | number           | Year that the figures were reordered.                                                                                                                                                                                                                                                                                      |
| otherInformation.employeesInformation.numberOfEmployees                          | string           | Number of staff that the company employ directly.                                                                                                                                                                                                                                                                          |
| localFinancialStatements                                                         | object           |                                                                                                                                                                                                                                                                                                                            |
| localFinancialStatements.type                                                    | string           | Type of the format representing how the accounts are presented.                                                                                                                                                                                                                                                            |
| localFinancialStatements.currency                                                | String           | Currency the figures are displayed in, as an ISO char(3) code. Examples GBP, EUR.                                                                                                                                                                                                                                          |
| localFinancialStatements.yearEndDate                                             | date             | Year End to which the annual accounts relate.                                                                                                                                                                                                                                                                              |
| localFinancialStatements.numberOfWeeks                                           | number           | The number of weeks covered by the accounts.                                                                                                                                                                                                                                                                               |
| localFinancialStatements.consolidatedAccounts                                    | boolean          | Are the accounts consolidated?                                                                                                                                                                                                                                                                                             |
| localFinancialStatements.profitAndLoss                                           | object           |                                                                                                                                                                                                                                                                                                                            |
| localFinancialStatements.profitAndLoss.turnover                                  | number           | Total amount of income generated by the sale of goods and services.                                                                                                                                                                                                                                                        |
| localFinancialStatements.profitAndLoss.preTaxProfit                              | number           | The results of the company before deducting any charge for taxation.                                                                                                                                                                                                                                                       |
| localFinancialStatements.balanceSheet                                            | object           |                                                                                                                                                                                                                                                                                                                            |
| localFinancialStatements.balanceSheet.totalShareholdersEquity                    | number           | The total capital and reserves of the company.                                                                                                                                                                                                                                                                             |
| localFinancialStatements.balanceSheet.tradeDebtors                               | number           | Invoices owed to the company by customers.                                                                                                                                                                                                                                                                                 |
| localFinancialStatements.balanceSheet.tradeCreditors                             | number           | Invoices owed by the company to suppliers and customers.                                                                                                                                                                                                                                                                   |
| localFinancialStatements.cashFlow                                                | object           |                                                                                                                                                                                                                                                                                                                            |
| localFinancialStatements.cashFlow\.operatingActivities                           | number           | Net cash inflow/outflow generated from operating activities.                                                                                                                                                                                                                                                               |
| localFinancialStatements.cashFlow\.investingActivities                           | number           | Net cash inflow/outflow generated from investing activities.                                                                                                                                                                                                                                                               |
| localFinancialStatements.cashFlow\.financingActivities                           | number           | Net cash inflow/outflow generated from financing activities.                                                                                                                                                                                                                                                               |
| localFinancialStatements.cashFlow\.netChangeInCash                               | number           | Measures how much the value of Cash and Cash Equivalents changed over the reporting period.                                                                                                                                                                                                                                |
| localFinancialStatements.cashFlow\.cashAtBeginningOfYear                         | number           | The amount of cash a company has at the start of the fiscal period.                                                                                                                                                                                                                                                        |
| localFinancialStatements.cashFlow\.exchangeRateEffect                            | number           | The impact on the prices paid for imported products.                                                                                                                                                                                                                                                                       |
| localFinancialStatements.cashFlow\.cashAndCashEquivalentsAtYearEnd               | number           | The amount of cash a company has at the end of the fiscal period (Balance Sheet “Cash” figure).                                                                                                                                                                                                                            |
| localFinancialStatements.cashFlow\.netCashFlowFromOperations                     | number           | Net cash inflow/outflow from operations.                                                                                                                                                                                                                                                                                   |
| localFinancialStatements.cashFlow\.netCashFlowBeforeFinancing                    | number           | Net cash inflow/outflow before financing.                                                                                                                                                                                                                                                                                  |
| localFinancialStatements.cashFlow\.netCashFlowFromFinancing                      | number           | Net cash inflow/outflow from financing.                                                                                                                                                                                                                                                                                    |
| localFinancialStatements.cashFlow\.increaseInCash                                | number           | Net increase/decrease in cash and cash equivalents for the year.                                                                                                                                                                                                                                                           |
| localFinancialStatements.cashFlow\.decreaseOrIncreaseInCash                      | number           | The total increase or decrease in cash and cash equivalents for the period.                                                                                                                                                                                                                                                |
| localFinancialStatements.cashFlow\.managementOfLiquidResources                   | number           | Management of Liquid Resources.                                                                                                                                                                                                                                                                                            |
| localFinancialStatements.cashFlow\.equityDividendsPaid                           | number           | The total amount of profits distributed to shareholders.                                                                                                                                                                                                                                                                   |
| localFinancialStatements.cashFlow\.acquisitionsAndDisposals                      | number           | The net cash/inflow/outflow arising from acquisitions/disposals.                                                                                                                                                                                                                                                           |
| localFinancialStatements.cashFlow\.capitalExpenditure                            | number           | Net cash inflow/outflow arising from capital expenditure activities.                                                                                                                                                                                                                                                       |
| localFinancialStatements.cashFlow\.taxation                                      | number           | Net cash inflow/outflow arising from taxation.                                                                                                                                                                                                                                                                             |
| localFinancialStatements.cashFlow\.returnOnInvestment                            | number           | Net cash inflow/outflow generated from investing activities.                                                                                                                                                                                                                                                               |
| financialStatements                                                              | object           |                                                                                                                                                                                                                                                                                                                            |
| financialStatements.type                                                         | string           | Type of the format representing how the accounts are presented.                                                                                                                                                                                                                                                            |
| financialStatements.currency                                                     | string           | The Currency in which the financial values are displayed, as a three-character ISO code.                                                                                                                                                                                                                                   |
| financialStatements.yearEndDate                                                  | date             | Financial Year End date for the annual accounts.                                                                                                                                                                                                                                                                           |
| financialStatements.numberOfWeeks                                                | number           | Number of weeks in the year.                                                                                                                                                                                                                                                                                               |
| financialStatements.consolidatedAccounts                                         | boolean          | Are the accounts consolidated?                                                                                                                                                                                                                                                                                             |
| financialStatements.profitAndLoss                                                | object           |                                                                                                                                                                                                                                                                                                                            |
| financialStatements.profitAndLoss.turnover                                       | number           |                                                                                                                                                                                                                                                                                                                            |
| financialStatements.profitAndLoss.preTaxProfit                                   | number           |                                                                                                                                                                                                                                                                                                                            |
| financialStatements.profitAndLoss.revenue                                        | number           | Income earned from normal business activities, including the sale of goods and services.                                                                                                                                                                                                                                   |
| financialStatements.profitAndLoss.operatingCosts                                 | number           | Costs incurred in the general running of the business.                                                                                                                                                                                                                                                                     |
| financialStatements.profitAndLoss.operatingProfit                                | number           | The results of the company after deducting Operating Costs from its Revenue.                                                                                                                                                                                                                                               |
| financialStatements.profitAndLoss.wagesAndSalaries                               | number           | Wages and salaries paid to employees of the company. Where possible this excludes Pensions.                                                                                                                                                                                                                                |
| financialStatements.profitAndLoss.pensionCosts                                   | number           | The cost of pension benefits for employees of the company.                                                                                                                                                                                                                                                                 |
| financialStatements.profitAndLoss.depreciation                                   | number           | The amount written off Tangible Fixed Assets during the year.                                                                                                                                                                                                                                                              |
| financialStatements.profitAndLoss.amortisation                                   | number           | The amount written off Intangible Fixed Assets during the year.                                                                                                                                                                                                                                                            |
| financialStatements.profitAndLoss.financialExpenses                              | number           | Interest expenses incurred during the year.                                                                                                                                                                                                                                                                                |
| financialStatements.profitAndLoss.financialIncome                                | number           | Interest income earned during the year.                                                                                                                                                                                                                                                                                    |
| financialStatements.profitAndLoss.extraordinaryIncome                            | number           | Income arising due to events of a non-recurring nature.                                                                                                                                                                                                                                                                    |
| financialStatements.profitAndLoss.extraordinaryCosts                             | number           | Costs incurred due to events of a non-recurring nature.                                                                                                                                                                                                                                                                    |
| financialStatements.profitAndLoss.tax                                            | number           | Taxation payable on the profits of the company.                                                                                                                                                                                                                                                                            |
| financialStatements.profitAndLoss.profitAfterTax                                 | number           | The results of the company after deducting any charge for taxation.                                                                                                                                                                                                                                                        |
| financialStatements.profitAndLoss.dividends                                      | number           | The total amount of profits distributed to shareholders.                                                                                                                                                                                                                                                                   |
| financialStatements.profitAndLoss.minorityInterests                              | number           | Profits attributable to shareholders holding a minority interest in the company.                                                                                                                                                                                                                                           |
| financialStatements.profitAndLoss.otherAppropriations                            | number           | Other miscellaneous items that are deducted / added to affect the Retained Profit / Loss of a company                                                                                                                                                                                                                      |
| financialStatements.profitAndLoss.retainedProfit                                 | number           | The results of the company after all income and expenses have been credited/debited.                                                                                                                                                                                                                                       |
| financialStatements.balanceSheet                                                 | object           |                                                                                                                                                                                                                                                                                                                            |
| financialStatements.balanceSheet.landAndBuildings                                | number           | Land and buildings owned by the company for long-term use.                                                                                                                                                                                                                                                                 |
| financialStatements.balanceSheet.plantAndMachinery                               | number           | Plant and machinery owned by the company for long-term use.                                                                                                                                                                                                                                                                |
| financialStatements.balanceSheet.otherTangibleAssets                             | number           | Tangible fixed assets other than Land & Buildings or Plant & Machinery.                                                                                                                                                                                                                                                    |
| financialStatements.balanceSheet.totalTangibleAssets                             | number           | Physical assets owned by the company for long-term use.                                                                                                                                                                                                                                                                    |
| financialStatements.balanceSheet.goodwill                                        | number           | The premium paid or accumulated on the purchase of an asset.                                                                                                                                                                                                                                                               |
| financialStatements.balanceSheet.otherIntangibleAssets                           | number           | <p>Intangible fixed assets other than goodwill such as Trademarks, Patents, Research &<br>Development etc.</p>                                                                                                                                                                                                             |
| financialStatements.balanceSheet.totalIntangibleAssets                           | number           | Assets that have a value but no physical existence.                                                                                                                                                                                                                                                                        |
| financialStatements.balanceSheet.investments                                     | number           | Long-term investments including shares and securities.                                                                                                                                                                                                                                                                     |
| financialStatements.balanceSheet.loansToGroup                                    | number           | Long-term loans made by the company to related businesses.                                                                                                                                                                                                                                                                 |
| financialStatements.balanceSheet.otherLoans                                      | number           | Other long-term loans made by the company.                                                                                                                                                                                                                                                                                 |
| financialStatements.balanceSheet.miscellaneousFixedAssets                        | number           | Long-term assets other than Tangible Assets, Intangible Assets, Investments or Loans.                                                                                                                                                                                                                                      |
| financialStatements.balanceSheet.totalOtherFixedAssets                           | number           | Total long-term assets other than Tangible Assets or Intangible Assets.                                                                                                                                                                                                                                                    |
| financialStatements.balanceSheet.totalFixedAssets                                | number           | The total of Tangible, Intangible and Other Fixed Assets.                                                                                                                                                                                                                                                                  |
| financialStatements.balanceSheet.rawMaterials                                    | number           | Materials held by the company that have not yet been processed.                                                                                                                                                                                                                                                            |
| financialStatements.balanceSheet.workInProgress                                  | number           | Goods or contracts that are in the process of manufacture or completion.                                                                                                                                                                                                                                                   |
| financialStatements.balanceSheet.finishedGoods                                   | number           | Goods held that are ready for sale or use.                                                                                                                                                                                                                                                                                 |
| financialStatements.balanceSheet.otherInventories                                | number           | Other amounts classed as Inventory but not included above.                                                                                                                                                                                                                                                                 |
| financialStatements.balanceSheet.totalInventories                                | number           | The total of stocks held by the company and work in progress.                                                                                                                                                                                                                                                              |
| financialStatements.balanceSheet.tradeReceivables                                | number           | Amounts due within one year from customers for goods and services supplied on credit.                                                                                                                                                                                                                                      |
| financialStatements.balanceSheet.groupReceivables                                | number           | Amounts due within one year from related businesses.                                                                                                                                                                                                                                                                       |
| financialStatements.balanceSheet.receivablesDueAfter1Year                        | number           | Amounts due after one year owing to the company (including trade and group receivables due after one year).                                                                                                                                                                                                                |
| financialStatements.balanceSheet.miscellaneousReceivables                        | number           | Amounts due within one year owing to the company other than trade and group receivables.                                                                                                                                                                                                                                   |
| financialStatements.balanceSheet.totalReceivables                                | number           | Total amounts receivable by the company.                                                                                                                                                                                                                                                                                   |
| financialStatements.balanceSheet.cash                                            | number           | Cash at bank, cash in hand and cash equivalents.                                                                                                                                                                                                                                                                           |
| financialStatements.balanceSheet.otherCurrentAssets                              | number           | Any short-term assets that have not already been included as Inventory, Receivables or Cash.                                                                                                                                                                                                                               |
| financialStatements.balanceSheet.totalCurrentAssets                              | number           | The total of Stocks, Debtors, Cash and other assets due within one year.                                                                                                                                                                                                                                                   |
| financialStatements.balanceSheet.totalAssets                                     | number           | The total of Current and Fixed Assets.                                                                                                                                                                                                                                                                                     |
| financialStatements.balanceSheet.tradePayables                                   | number           | Amount due within one year owing to suppliers for goods and services provided on credit.                                                                                                                                                                                                                                   |
| financialStatements.balanceSheet.bankLiabilities                                 | number           | Amount due within one year owing to banks for overdrafts and loans.                                                                                                                                                                                                                                                        |
| financialStatements.balanceSheet.otherLoansOrFinance                             | number           | Loans or finance due within one year owing to parties other than banks or related businesses.                                                                                                                                                                                                                              |
| financialStatements.balanceSheet.groupPayables                                   | number           | Amounts due within one year to related businesses.                                                                                                                                                                                                                                                                         |
| financialStatements.balanceSheet.miscellaneousLiabilities                        | number           | Other amounts due within one year owing by the company.                                                                                                                                                                                                                                                                    |
| financialStatements.balanceSheet.totalCurrentLiabilities                         | number           | Total short-term liabilities of the company.                                                                                                                                                                                                                                                                               |
| financialStatements.balanceSheet.tradePayablesDueAfter1Year                      | number           | Amount due after one year owing to suppliers for goods and services provided on credit.                                                                                                                                                                                                                                    |
| financialStatements.balanceSheet.bankLiabilitiesDueAfter1Year                    | number           | Amount due after one year owing to banks for overdrafts and loans.                                                                                                                                                                                                                                                         |
| financialStatements.balanceSheet.otherLoansOrFinanceDueAfter1Year                | number           | Loans or finance due after one year owing to parties other than banks or related businesses.                                                                                                                                                                                                                               |
| financialStatements.balanceSheet.groupPayablesDueAfter1Year                      | number           | Amounts due after one year to related businesses.                                                                                                                                                                                                                                                                          |
| financialStatements.balanceSheet.miscellaneousLiabilitiesDueAfter1Year           | number           | Other amounts due after one year owing by the company.                                                                                                                                                                                                                                                                     |
| financialStatements.balanceSheet.totalLongTermLiabilities                        | number           | Total long-term liabilities of the company.                                                                                                                                                                                                                                                                                |
| financialStatements.balanceSheet.totalLiabilities                                | number           | The total of Total Long-term Liabilities and Total Current Liabilities.                                                                                                                                                                                                                                                    |
| financialStatements.balanceSheet.calledUpShareCapital                            | number           | The issued and paid share capital from shareholders.                                                                                                                                                                                                                                                                       |
| financialStatements.balanceSheet.sharePremium                                    | number           | The excess of the amount received on the issue of shares over their value.                                                                                                                                                                                                                                                 |
| financialStatements.balanceSheet.revenueReserves                                 | number           | The accumulation of profits/losses from previous trading periods.                                                                                                                                                                                                                                                          |
| financialStatements.balanceSheet.otherReserves                                   | number           | Other capital and reserves that form part of shareholders equity.                                                                                                                                                                                                                                                          |
| financialStatements.balanceSheet.totalShareholdersEquity                         | number           | The total capital and reserves of the company.                                                                                                                                                                                                                                                                             |
| financialStatements.otherFinancials                                              | Object           |                                                                                                                                                                                                                                                                                                                            |
| financialStatements.otherFinancials.contingentLiabilities                        | number           | <p>Potential liabilities that are not recognised in the balance sheet, output as a string. Usually<br>contains integers, but can also be output as a string value (such as “YES” or “NO”).</p>                                                                                                                             |
| financialStatements.otherFinancials.workingCapital                               | number           | <p>Total Current Assets – Receivables Due after 1 year – Total Current Liabilities. This measures if the<br>company has sufficient short-term assets to cover its current debts.</p>                                                                                                                                       |
| financialStatements.otherFinancials.netWorth                                     | number           | <p>Often referred to as the 'book value' of the business this equals Total Shareholders’ Equity less<br>Total Intangible Assets.</p>                                                                                                                                                                                       |
| financialStatements.ratios                                                       | Object           |                                                                                                                                                                                                                                                                                                                            |
| financialStatements.ratios.preTaxProfitMargin                                    | number           | <p>Pre-tax profits / Turnover x 100. This shows the percentage of Profit in each pound of sales or the<br>equivalent of retailers 'mark-up'.</p>                                                                                                                                                                           |
| financialStatements.ratios.returnOnCaptialEmployed                               | number           | <p>Pre-Tax Profit / Capital Employed x 100. This ratio measures the profits a business yields in return<br>for the money (Capital) invested.</p>                                                                                                                                                                           |
| financialStatements.ratios.returnOnTotalAssetsEmployed                           | number           | <p>Pre-Tax Profits / Total Assets x 100. This shows the ‘return’ or 'profit' on each pound of Assets<br>used as a percentage.</p>                                                                                                                                                                                          |
| financialStatements.ratios.returnOnNetAssetsEmployed                             | number           | <p>Pre-Tax Profits / Net Assets x 100. This shows the ‘return’ in percent on the net assets of the<br>company. The higher the percentage the more profitable the company.</p>                                                                                                                                              |
| financialStatements.ratios.salesOrNetWorkingCapital                              | number           | <p>Turnover / (Total Current Assets - Receivables Due after 1 year - Total Current Liabilities). The<br>higher the ratio the higher the volume of Sales made per the companies working capital.</p>                                                                                                                        |
| financialStatements.ratios.stockTurnoverRatio                                    | number           | <p>Stocks / Turnover x 100. This shows the number of times the trading stock of a company is ‘turned<br>over’ in a trading period. If the ratio is low this indicates that relatively little money is tied up in<br>Stocks.</p>                                                                                            |
| financialStatements.ratios.debtorDays                                            | number           | <p>Trade Debtors / Turnover x 365 days. This is a calculation that predicts the average time taken for<br>the company to collect its invoices for goods and services provided to its customers.</p>                                                                                                                        |
| financialStatements.ratios.creditorDays                                          | number           | <p>Trade Creditors / Turnover x 365 days. This is a calculation that predicts the average time taken<br>for the company to settle its invoices for goods and services provided by its suppliers.</p>                                                                                                                       |
| financialStatements.ratios.currentRatio                                          | number           | <p>Total Current Assets - Receivables Due after 1 year / Total Current Liabilities. This is an indication<br>of a company's ability to meet short-term debt obligations; the higher the ratio, the more liquid the<br>company is.</p>                                                                                      |
| financialStatements.ratios.liquidityRatioOrAcidTest                              | number           | <p>Total Current Assets - Total Inventories - Receivables Due after 1 year / Total Current Liabilities.<br>This, like the current ratio, measures how quickly a company can meet its short-term debts.<br>However, this ratio excludes stock, as there is no guarantee the value of Stocks can be realised<br>quickly.</p> |
| financialStatements.ratios.currentDebtRatio                                      | number           | <p>Total Current Liabilities / Total Shareholders’ Equity. This measures the amount of short-term debt<br>in relation to the value of shareholders’ funds.</p>                                                                                                                                                             |
| financialStatements.ratios.gearing                                               | number           | <p>Bank Overdraft & Loans + Total Long-term Liabilities/Total Shareholders’ Equity x 100. This is the<br>relationship between the size of the company’s debt in proportion to Equity (Shareholders Funds).</p>                                                                                                             |
| financialStatements.ratios.equityInPercentage                                    | number           | <p>Total Shareholders’ Equity / (Total Current Assets + Tangible Fixed Assets – Total Intangible<br>Assets) x 100. This ratio shows the worth of the company (shareholders’ funds) as a percentage<br>of total current and tangible assets.</p>                                                                            |
| financialStatements.ratios.totalDebtRatio                                        | number           | <p>Total Current Liabilities + Total Long-term liabilities / Total Shareholders’ Equity x 100. This shows<br>the relative indebtedness of a company in relation to the worth of the company.</p>                                                                                                                           |
| negativeInformation                                                              | object           |                                                                                                                                                                                                                                                                                                                            |
| negativeInformation.summary                                                      | object           |                                                                                                                                                                                                                                                                                                                            |
| negativeInformation.summary.currency                                             | string           | The ISO currency of the corresponding financial values.                                                                                                                                                                                                                                                                    |
| negativeInformation.summary.numberOfExact                                        | number           | <p>The number of exact match Unregistered County Court Judgments (CJ's). These will<br>remain on the public record for 6 years from the issue date of the Judgment.</p>                                                                                                                                                    |
| negativeInformation.summary.valueOfExact                                         | number           | The value of exact match Registered CCJ's.                                                                                                                                                                                                                                                                                 |
| negativeInformation.summary.numberOfSatisfied                                    | number           | <p>The number of exact match Satisfied CCJ's. These will remain on the public record for 6<br>years from the issue date of the Judgment.</p>                                                                                                                                                                               |
| negativeInformation.summary.numberOfWrits                                        | number           | The count of High Court Writs.                                                                                                                                                                                                                                                                                             |
| negativeInformation.summary.possibleRegistered                                   | number           | <p>The number of possible match Registered County Court Judgments (CCJ's). These will<br>remain on the public record for 6 years (from the CCJ date).</p>                                                                                                                                                                  |
| negativeInformation.summary.exactRegistered                                      | number           | <p>The number of exact match Registered County Court Judgments (CCJ). These remain on<br>the public record for 6 years (from the CCJ date).</p>                                                                                                                                                                            |
| negativeInformation.summary.numberOfPossible                                     | number           | <p>The number of possible match Unregistered County Court Judgments (CJ's). These will<br>remain on the public record for 6 years (from the CCJ date).</p>                                                                                                                                                                 |
| negativeInformation.summary.valueOfSatisfied                                     | number           | The value of exact match Satisfied CCJ's.                                                                                                                                                                                                                                                                                  |
| negativeInformation.countyCourtJudgements                                        | object           |                                                                                                                                                                                                                                                                                                                            |
| negativeInformation.countyCourtJudgements.registered                             | object           |                                                                                                                                                                                                                                                                                                                            |
| negativeInformation.countyCourtJudgements.registered.exact                       | object           |                                                                                                                                                                                                                                                                                                                            |
| negativeInformation.countyCourtJudgements.registered.exact.caseNumber            | string           | The case number of the judgment.                                                                                                                                                                                                                                                                                           |
| negativeInformation.countyCourtJudgements.registered.exact.court                 | string           | The court in which the judgment was registered.                                                                                                                                                                                                                                                                            |
| negativeInformation.countyCourtJudgements.registered.exact.date                  | date             | The date that the judgment was registered in court.                                                                                                                                                                                                                                                                        |
| negativeInformation.countyCourtJudgements.registered.exact.status                | string           | The status of the judgment.                                                                                                                                                                                                                                                                                                |
| negativeInformation.countyCourtJudgements.registered.exact.paidDate              | date             | The date that the judgment was satisfied.                                                                                                                                                                                                                                                                                  |
| negativeInformation.countyCourtJudgements.registered.exact.amount                | number           | The financial value of the judgment.                                                                                                                                                                                                                                                                                       |
| negativeInformation.countyCourtJudgements.registered.exact.currency              | string           | The currency in which a County Court Judgment has been issued.                                                                                                                                                                                                                                                             |
| negativeInformation.countyCourtJudgements.registered.exact.incomingRecordDetails | string           | The name and address of the defendant as received by us.                                                                                                                                                                                                                                                                   |
| negativeInformation.highCourtWrits                                               | object           |                                                                                                                                                                                                                                                                                                                            |
| negativeInformation.highCourtWrits.date                                          | date             | The date when the High Court Writ was issued.                                                                                                                                                                                                                                                                              |
| negativeInformation.highCourtWrits.court                                         | string           | The High Court where the Writ was issued.                                                                                                                                                                                                                                                                                  |
| negativeInformation.highCourtWrits.plaintiff                                     | string           | The party responsible for bringing the claim (e.g. an escalated CCJ) to the High Court.                                                                                                                                                                                                                                    |
| shareCapitalStructure                                                            | object           |                                                                                                                                                                                                                                                                                                                            |
| shareCapitalStructure.issuedShareCapital                                         | object           |                                                                                                                                                                                                                                                                                                                            |
| shareCapitalStructure.issuedShareCapital.currency                                | string           | The Currency in which the share values are displayed, as a three-character ISO code.                                                                                                                                                                                                                                       |
| shareCapitalStructure.issuedShareCapital.value                                   | number           |                                                                                                                                                                                                                                                                                                                            |
| shareCapitalStructure.shareHolders                                               | array            |                                                                                                                                                                                                                                                                                                                            |
| shareCapitalStructure.shareHolders.name                                          | string           | Name of the Shareholder, or Company Name if a corporate shareholder exists.                                                                                                                                                                                                                                                |
| shareCapitalStructure.shareHolders.currency                                      | string           | The Currency in which the share values are displayed, as a three-character ISO code.                                                                                                                                                                                                                                       |
| shareCapitalStructure.shareHolders.totalNumberOfSharesOwned                      | number           | The total number of all shares owned.                                                                                                                                                                                                                                                                                      |
| shareCapitalStructure.shareHolders.shareType                                     | string           | The share class, for example "Ordinary".                                                                                                                                                                                                                                                                                   |
| shareCapitalStructure.shareHolders.shareClassesValuePerShare                     | array of numbers | The value per share, also known as the par value.                                                                                                                                                                                                                                                                          |
| shareCapitalStructure.shareHolders.percentSharesHeld                             | number           | The total percentage of all shares held. Expressed as an integer, or to two decimal places.                                                                                                                                                                                                                                |
| shareCapitalStructure.shareHolders.issuedShareCapital                            | object           |                                                                                                                                                                                                                                                                                                                            |
| shareCapitalStructure.shareHolders.issuedShareCapital.currency                   | string           | The Currency in which the share values are displayed.                                                                                                                                                                                                                                                                      |
| shareCapitalStructure.shareHolders.issuedShareCapital.value                      | number           | This is the value of issued and paid share capital from shareholders.                                                                                                                                                                                                                                                      |
| additionalInformation.mortgageDetails                                            | array            |                                                                                                                                                                                                                                                                                                                            |
| additionalInformation.mortgageDetails.mortgageType                               | string           | A description of the type of the mortgage charge.                                                                                                                                                                                                                                                                          |
| additionalInformation.mortgageDetails.dateChargeCreated                          | date             | The date that the mortgage charge was created.                                                                                                                                                                                                                                                                             |
| additionalInformation.mortgageDetails.dateChargeRegistered                       | date             | The date that the mortgage charge was registered.                                                                                                                                                                                                                                                                          |
| additionalInformation.mortgageDetails.status                                     | string           | The status of the mortgage charge (outstanding or satisfied).                                                                                                                                                                                                                                                              |
| additionalInformation.mortgageDetails.personsEntitled                            | string           | The name of the person or organisation entitled to the charge.                                                                                                                                                                                                                                                             |
| additionalInformation.mortgageDetails.amountSecured                              | string           | The amount secured by the mortgage or charge.                                                                                                                                                                                                                                                                              |
| additionalInformation.mortgageDetails.details                                    | string           | Further details of the particulars of the mortgage charge.                                                                                                                                                                                                                                                                 |
| additionalInformation.miscellaneous                                              | object           |                                                                                                                                                                                                                                                                                                                            |
| additionalInformation.miscellaneous.ftseIndex                                    | number           | A count of land and property registered to the company, as confirmed via the HM Land Registry.                                                                                                                                                                                                                             |
| additionalInformation.miscellaneous.filingDateOfAccounts                         | string           | The date accounts have been filed.                                                                                                                                                                                                                                                                                         |
| additionalInformation.miscellaneous.charityNumber                                | string           | The date when the latest accounts were filed at the official registry.                                                                                                                                                                                                                                                     |
| additionalInformation.landRegistry                                               | object           |                                                                                                                                                                                                                                                                                                                            |
| additionalInformation.landRegistry.registeredLandAndProperty                     | number           |                                                                                                                                                                                                                                                                                                                            |
| additionalInformation.personsWithSignificantControl                              | object           |                                                                                                                                                                                                                                                                                                                            |
| additionalInformation.personsWithSignificantControl.active                       | object           |                                                                                                                                                                                                                                                                                                                            |
| additionalInformation.personsWithSignificantControl.active.name                  | string           | The name of a person or entity with significant control.                                                                                                                                                                                                                                                                   |
| additionalInformation.personsWithSignificantControl.active.personType            | string           | High level person type Identifies. Include Person, Company or Other                                                                                                                                                                                                                                                        |
| additionalInformation.personsWithSignificantControl.active.country               | string           | The Country that a person with significant control of the company is based in.                                                                                                                                                                                                                                             |
| additionalInformation.personsWithSignificantControl.active.notifiedOn            | date             | Date when the PSC details or changes were filed at Companies House                                                                                                                                                                                                                                                         |
| additionalInformation.personsWithSignificantControl.active.kind                  | string           | Detailed person type identifies, include individual-person, corporate entity, legal-person or super-secure                                                                                                                                                                                                                 |
| additionalInformation.personsWithSignificantControl.active.natureOfControl       | string           | The nature of the person’s control of the company.                                                                                                                                                                                                                                                                         |
| additionalInformation.personsWithSignificantControl.active.governingLaw          | string           | Governing law/legal authority under which the entity is bound.                                                                                                                                                                                                                                                             |
| additionalInformation.personsWithSignificantControl.active.insertDate            | date             | The date when the PSC record was received from Companies House.                                                                                                                                                                                                                                                            |
| additionalInformation.personsWithSignificantControl.active.legalForm             | string           | The stated Legal Form of the PSC legal entity.                                                                                                                                                                                                                                                                             |
| additionalInformation.personsWithSignificantControl.active.placeRegistered       | string           | The place in which the company has been registered.                                                                                                                                                                                                                                                                        |
| additionalInformation.personsWithSignificantControl.active.registrationNumber    | string           | The company registration number                                                                                                                                                                                                                                                                                            |
| additionalInformation.personsWithSignificantControl.active.countryOfRegistration | string           | The country in which the company is registered                                                                                                                                                                                                                                                                             |
| additionalInformation.personsWithSignificantControl.ceased                       | object           |                                                                                                                                                                                                                                                                                                                            |
| additionalInformation.personsWithSignificantControl.ceased.name                  | string           | The name of a person or entity with significant control.                                                                                                                                                                                                                                                                   |
| additionalInformation.personsWithSignificantControl.ceased.personType            | string           | High level person type Identifies. Include Person, Company or Other                                                                                                                                                                                                                                                        |
| additionalInformation.personsWithSignificantControl.ceased.country               | string           | The Country that a person with significant control of the company is based in.                                                                                                                                                                                                                                             |
| additionalInformation.personsWithSignificantControl.ceased.notifiedOn            | date             | Date when the PSC details or changes were filed at Companies House                                                                                                                                                                                                                                                         |
| additionalInformation.personsWithSignificantControl.ceased.kind                  | string           | Detailed person type identifies, include individual-person, corporate entity, legal-person or super-secure                                                                                                                                                                                                                 |
| additionalInformation.personsWithSignificantControl.ceased.natureOfControl       | string           | The nature of the person’s control of the company.                                                                                                                                                                                                                                                                         |
| additionalInformation.personsWithSignificantControl.ceased.governingLaw          | string           | Governing law/legal authority under which the entity is bound.                                                                                                                                                                                                                                                             |
| additionalInformation.personsWithSignificantControl.ceased.insertDate            | date             | The date when the PSC record was received from Companies House.                                                                                                                                                                                                                                                            |
| additionalInformation.personsWithSignificantControl.ceased.legalForm             | string           | The stated Legal Form of the PSC legal entity.                                                                                                                                                                                                                                                                             |
| additionalInformation.personsWithSignificantControl.ceased.placeRegistered       | string           | The place in which the company has been registered.                                                                                                                                                                                                                                                                        |
| additionalInformation.personsWithSignificantControl.ceased.registrationNumber    | string           | The company registration number                                                                                                                                                                                                                                                                                            |
| additionalInformation.personsWithSignificantControl.ceased.countryOfRegistration | string           | The country in which the company is registered                                                                                                                                                                                                                                                                             |
| additionalInformation.commentaries                                               | string           | Score Commentary                                                                                                                                                                                                                                                                                                           |
| additionalInformation.commentaries.text                                          | string           | The commentary highlights various evolving trends within the business.                                                                                                                                                                                                                                                     |
| additionalInformation.commentaries.indicator                                     | string           | This shows an arrow indicating if the trend has improved or decreased. Possible values are "Positive", "Negative" or "Neutral".                                                                                                                                                                                            |
| {% endtab %}                                                                     |                  |                                                                                                                                                                                                                                                                                                                            |

{% tab title="Example" %}

```json
{
  "id": "Id",
  "name": "Company name",
  "registrationDate": "1970-01-01T00:00:00Z",
  "country": "GB",
  "number": "123",
  "vatRegistrationNumber": "456",
  "legalForm": "Public limited",
  "status": {
    "description": "Active - Accounts Filed",
    "code": "Active"
  },
  "additionalInformation": {
    "mortgageDetails": [
      {
        "dateChargeCreated": "1970-01-01T00:00:00Z",
        "mortgageType": "String",
        "personsEntitled": "String",
        "details": "String",
        "dateChargeRegistered": "1970-01-01T00:00:00Z",
        "amountSecured": "String",
        "status": "String"
      }
    ],
    "landRegistry": {
      "registeredLandAndProperty": 3
    },
    "miscellaneous": {
      "filingDateOfAccounts": "1970-01-01T00:00:00Z",
      "ftseIndex": "String"
    },
    "commentaries": [
      {
        "text": "String",
        "indicator": "Positive",
      }
    ]
  },
  "groupStructure": [
    {
      "id": "Id",
      "country": "GB",
      "name": "Name",
      "status": "Active",
      "level": 0,
      "address": {
        "fullAddress": "Address"
      },
      "latestAnnualAccounts": "1970-01-01T00:00:00Z",
      "relationType": {
        "isUltimateParent": true
      }
    }
  ],
  "directors": [
    {
      "id": "Id",
      "name": "Name",
      "gender": "Male",
      "title": "Mr",
      "birthDate": "1970-01-01T00:00:00Z",
      "address": {
        "fullAddress": "Full address"
      },
      "additionalData": {
        "positions": [
          {
            "name": "Director",
            "dateAppointed": "1970-01-01T00:00:00Z"
          }
        ],
        "disqualified": false,
        "occupation": "DIRECTOR",
        "disqualifiedException": false,
        "presentAppointments": 1
      },
      "isCurrent": true
    }
  ],
  "shareCapitalStructure": {
    "shareHolders": [
      {
        "name": "Name",
        "currency": "GBP",
        "shareClassesValuePerShare": [0.0],
        "percentSharesHeld": 0,
        "shareType": "ORDINARY",
        "totalNumberOfSharesOwned": 0
      }
    ],
    "issuedShareCapital": {
      "value": 0,
      "currency": "GBP"
    }
  },
  "otherInformation": {
    "advisors": [
      {
        "auditorName": "Auditor"
      }
    ],
    "employeesInformation": [
      {
        "year": 2023,
        "numberOfEmployees": "0"
      }
    ]
  },
  "activities": [
    {
      "description": "Description",
      "main": true,
      "code": "123",
      "classification": "SIC07"
    }
  ],
  "contact": {
    "websites": ["www.website.com"],
    "phoneNumber": "123456789",
    "addresses": [
      {
        "fullAddress": "Address",
        "phoneNumber": "123456789",
        "city": "City",
        "postalCode": "AAA BBB",
        "main": true
      }
    ]
  },
  "negativeInformation": {
    "summary": {
      "numberOfExact": 0,
      "valueOfExact": 0,
      "numberOfSatisfied": 0,
      "numberOfWrits": 0,
      "possibleRegistered": 0,
      "currency": "GBP",
      "exactRegistered": 0,
      "numberOfPossible": 0,
      "valueOfSatisfied": 0
    },
    "countyCourtJudgements": {
      "registered": {
        "exact": [
          {
            "date": "1970-01-01T00:00:00Z",
            "amount": 0,
            "incomingRecordDetails": "String",
            "caseNumber": "String",
            "currency": "GBP",
            "court": "String",
            "status": "Judgment"
          }
        ]
      }
    }
  },
  "financialStatements": [
    {
      "type": "GlobalFinancialsGGS",
      "profitAndLoss": {
        "amortisation": 0,
        "wagesAndSalaries": 0,
        "tax": -0,
        "retainedProfit": -0,
        "revenue": 0,
        "operatingCosts": 0,
        "profitAfterTax": 0,
        "financialExpenses": 0,
        "dividends": 0,
        "depreciation": 0,
        "minorityInterests": -0,
        "operatingProfit": 0,
        "pensionCosts": 0,
        "otherAppropriations": 0
      },
      "otherFinancials": {
        "workingCapital": 0,
        "contingentLiabilities": "NO",
        "netWorth": 0
      },
      "yearEndDate": "1970-01-01T00:00:00Z",
      "consolidatedAccounts": true,
      "currency": "GBP",
      "numberOfWeeks": 0,
      "balanceSheet": {
        "totalAssets": 0,
        "otherReserves": 0,
        "miscellaneousReceivables": 0,
        "miscellaneousLiabilities": 0,
        "miscellaneousLiabilitiesDueAfter1Year": 0,
        "totalCurrentLiabilities": 0,
        "otherCurrentAssets": 0,
        "revenueReserves": 0,
        "totalReceivables": 0,
        "totalTangibleAssets": 0,
        "cash": 0,
        "otherLoansOrFinance": 0,
        "totalShareholdersEquity": 0,
        "tradeReceivables": 0,
        "totalOtherFixedAssets": 0,
        "bankLiabilitiesDueAfter1Year": 0,
        "totalCurrentAssets": 0,
        "totalLiabilities": 0,
        "otherLoansOrFinanceDueAfter1Year": 0,
        "totalLongTermLiabilities": 0,
        "totalFixedAssets": 0,
        "calledUpShareCapital": 0,
        "totalInventories": 0,
        "totalIntangibleAssets": 0,
        "bankLiabilities": 0
      },

      "ratios": {
        "currentDebtRatio": 0,
        "equityInPercentage": 0,
        "debtorDays": 0,
        "returnOnNetAssetsEmployed": 0,
        "stockTurnoverRatio": 0,
        "returnOnTotalAssetsEmployed": 0,
        "creditorDays": 0,
        "liquidityRatioOrAcidTest": 0,
        "totalDebtRatio": 0,
        "preTaxProfitMargin": 0,
        "gearing": 0,
        "salesOrNetWorkingCapital": -0,
        "currentRatio": 0
      }
    }
  ],
  "localFinancialStatements": [
    {
      "type": "LocalFinancials",
      "yearEndDate": "1970-01-01T00:00:00Z",
      "cashFlow": {
        "increaseInCash": 0,
        "netCashFlowFromFinancing": 0,
        "netCashFlowBeforeFinancing": 0,
        "netCashFlowFromOperations": 0
      },
      "consolidatedAccounts": true,
      "currency": "GBP",
      "numberOfWeeks": 0,
      "balanceSheet": {
        "tradeDebtors": 0,
        "tradeCreditors": 0,
        "totalShareholdersEquity": 0
      }
    }
  ],
  "creditRating": {
    "creditLimit": {
      "value": "0",
      "currency": "GBP"
    },
    "internationalScore": "A"
  }
}
```

{% endtab %}
{% endtabs %}


# Business Identity

Our unique Business Identity dataset is the gold standard in KYB intelligence. Dive into 2.8 billion original records spanning 250+ global jurisdictions, even in challenging areas like Latin America, China, and Russia. Crafted meticulously by investigative experts, Business Identity not only consolidates fragmented data but ensures it's analysis-ready, maintaining a direct link to public records. Allowing you to navigate the intricate web of global corporate ownership effortlessly, always anchored to primary sources. Providing crystal clear insights and undeniable authenticity.

**Section**: `kybBusinessIdentity`

**Required parameter:** `businessIdentityId`

Note: All fields returned by this API are optional and their presence cannot be guaranteed. Depending on the request or specific conditions, certain fields may not appear in the response.

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

| Attribute                                            | Type             | Description                                                                          |
| ---------------------------------------------------- | ---------------- | ------------------------------------------------------------------------------------ |
| id                                                   | string           | Internal company identification.                                                     |
| name                                                 | string           | Registered company name.                                                             |
| number                                               | string           | Official registration number.                                                        |
| identifiers                                          | array of objects |                                                                                      |
| identifiers.label                                    | string           | Description of the identifier                                                        |
| identifiers.type                                     | string           | Type of the identifier                                                               |
| identifiers.value                                    | string           | Identifier                                                                           |
| status                                               | object           |                                                                                      |
| status.code                                          | string           | High-level status.                                                                   |
| status.description                                   | string           | A more in-depth status value.                                                        |
| businessPurpose                                      | string           | Text and/or a code that describes what a company is legally allowed to do or produce |
| registrationDate                                     | date             | The date the company was registered.                                                 |
| addresses                                            | array of strings | A physical location description                                                      |
| countries                                            | array of strings | All the countries related to the company.                                            |
| type                                                 | string           | A type of legal entity in a given jurisdiction.                                      |
| aliasNames                                           | array of strings | An alternative, former, or otherwise non-primary name.                               |
| sources                                              | array of objects |                                                                                      |
| sources.id                                           | string           | ID of the source                                                                     |
| sources.name                                         | string           | Name of the source                                                                   |
| sources.total                                        | number           | Count of data taken from this source                                                 |
| records                                              | object           |                                                                                      |
| records.count                                        | number           | Count of records                                                                     |
| records.data                                         | array of objects |                                                                                      |
| records.data.id                                      | string           | ID of the associated record.                                                         |
| records.data.type                                    | string           | Type of the record. Can be "about" or "mentions"                                     |
| records.data.label                                   | string           | Human readable label for the record.                                                 |
| records.data.sourceId                                | string           | ID of the associated source.                                                         |
| records.data.sourceUrl                               | string           | Url to the source associated with the record.                                        |
| records.data.acquisitionDate                         | string           | Date of record publication.                                                          |
| records.data.publicationDate                         | string           | The date we acquired the source document.                                            |
| records.data.referencesCount                         | number           | Count of entities referenced in source document.                                     |
| riskData                                             | array of objects |                                                                                      |
| riskData.name                                        | string           | Risk data type                                                                       |
| riskData.countries                                   | array of strings | Countries associated with the risk data                                              |
| riskData.value                                       | number, boolean  | Risk data value                                                                      |
| attributes                                           | array of objects |                                                                                      |
| attributes.name                                      | string           | Nome of the attribute                                                                |
| attributes.total                                     | number           | Total count of items within the attribute                                            |
| attributes.data                                      | array of objects |                                                                                      |
| attributes.data.properties                           | object           | Properties of the attribute                                                          |
| attributes.data.records                              | array of strings | Records reference                                                                    |
| relationships                                        | object           |                                                                                      |
| relationships.directors                              | array of objects |                                                                                      |
| relationships.directors.name                         | string           | The name of the company director.                                                    |
| relationships.directors.birthDate                    | date             | The birth date of the company director.                                              |
| relationships.directors.former                       | boolean          | Indicates if the director is a former director                                       |
| relationships.directors.pep                          | boolean          | Indicates if the director is a politically exposed person (PEP)                      |
| relationships.directors.sanctioned                   | boolean          | Indicates if the director is sanctioned                                              |
| relationships.directors.addresses                    | array of strings | Addresses associated with the director                                               |
| relationships.directors.identifiers                  | array of strings | Identifiers associated with the director                                             |
| relationships.directors.appointmentDate              | date             | The date when the director was appointed                                             |
| relationships.directors.riskData                     | object           |                                                                                      |
| relationships.directors.riskData.basel\_aml          | object           |                                                                                      |
| relationships.directors.riskData.basel\_aml.value    | number           | The value or score indicating the AML risk level                                     |
| relationships.directors.riskData.cpi\_score          | object           |                                                                                      |
| relationships.directors.riskData.cpi\_score.value    | number           | The actual numerical value of the CPI score                                          |
| relationships.officers                               | array of objects |                                                                                      |
| relationships.officers.name                          | string           | The name of the company officer.                                                     |
| relationships.officers.birthDate                     | date             | The birth date of the company officer.                                               |
| relationships.officers.former                        | boolean          | Indicates if the officer is a former officer                                         |
| relationships.officers.pep                           | boolean          | Indicates if the officer is a politically exposed person (PEP)                       |
| relationships.officers.sanctioned                    | boolean          | Indicates if the officer is sanctioned                                               |
| relationships.officers.addresses                     | array of strings | Addresses associated with the officer                                                |
| relationships.officers.identifiers                   | array of strings | Identifiers associated with the officer                                              |
| relationships.officers.appointmentDate               | date             | The date when the officer was appointed                                              |
| relationships.officers.riskData                      | object           |                                                                                      |
| relationships.officers.riskData.basel\_aml           | object           |                                                                                      |
| relationships.officers.riskData.basel\_aml.value     | number           | The value or score indicating the AML risk level                                     |
| relationships.officers.riskData.cpi\_score           | object           |                                                                                      |
| relationships.officers.riskData.cpi\_score.value     | number           | The actual numerical value of the CPI score                                          |
| relationships.shareHolders                           | array of objects |                                                                                      |
| relationships.shareHolders.name                      | string           | The name of the company shareholder.                                                 |
| relationships.shareHolders.birthDate                 | date             | The birth date of the company shareholder.                                           |
| relationships.shareHolders.former                    | boolean          | Indicates if the shareholder is a former shareholder                                 |
| relationships.shareHolders.pep                       | boolean          | Indicates if the shareholder is a politically exposed person (PEP)                   |
| relationships.shareHolders.sanctioned                | boolean          | Indicates if the shareholder is sanctioned                                           |
| relationships.shareHolders.addresses                 | array of strings | Addresses associated with the shareholder                                            |
| relationships.shareHolders.identifiers               | array of strings | Identifiers associated with the shareholder                                          |
| relationships.shareHolders.appointmentDate           | date             | The date when the shareholder was appointed                                          |
| relationships.shareHolders.riskData                  | object           |                                                                                      |
| relationships.shareHolders.riskData.basel\_aml       | object           |                                                                                      |
| relationships.shareHolders.riskData.basel\_aml.value | number           | The value or score indicating the AML risk level                                     |
| relationships.shareHolders.riskData.cpi\_score       | object           |                                                                                      |
| relationships.shareHolders.riskData.cpi\_score.value | number           | The actual numerical value of the CPI score                                          |
| contact                                              | object           |                                                                                      |
| contact.phoneNumbers                                 | array of strings | List of contact phone number                                                         |
| contact.emails                                       | array of strings | List of contact email                                                                |
| contact.websites                                     | array of strings | List of contact website                                                              |
| {% endtab %}                                         |                  |                                                                                      |

{% tab title="Example" %}

```json
{
  "id": "uniqueId",
  "name": "Company X",
  "businessPurpose": "Business Purpose",
  "number": "00445790",
  "status": {
    "description": "Active",
    "code": "registered"
  },
  "addresses": ["Address 1", "Address 2"],
  "sources": [
    {
      "id": "7b3f91a4c28e6d7f2a4e682b15638d2a",
      "name": "Source 1",
      "total": 7
    },
    {
      "id": "7b3f91a4c28e6d7f2a4e682b15638d2a",
      "name": "Source 2",
      "total": 22
    }
  ],
  "records": {
    "count": 1,
    "data": [
      {
        "id": "7b3f91a4c28e6d7f2a4e682b15638d2a/603039824/1688515200000",
        "type": "about",
        "label": "Company Record from UK",
        "sourceId": "7b3f91a4c28e6d7f2a4e682b15638d2a",
        "sourceUrl": "https://country.gov/",
        "acquisitionDate": "2023-07-05",
        "publicationDate": "2023-07-05",
        "referencesCount": 6
      },
    ]
  },
  "identifiers": [
    {
      "type": "type1",
      "value": "123",
      "label": "Identifier 1"
    },
    {
      "type": "type2",
      "value": "456",
      "label": "Identifier 2"
    }
  ],
  "countries": ["GB", "US"],
  "type": "Public Limited Company",
  "riskData": [
    {
      "name": "regulatory_action",
      "value": true
    },
    {
      "name": "basel_aml",
      "value": 3.99,
      "countries": ["GBR"]
    }
  ],
  "contact": {
    "phoneNumbers": [
      "123456789",
      "1234567898", 
      "(123) 123-1234",
      "1234342343434"
    ],
    "emails": [
      "email@example.com",
      "email@example.com"
    ],
    "websites": ["example.com"]
	}, 
  "relationships": {
    "shareHolders": [
      {
        "addresses": ["Address"],
        "sanctioned": false,
        "identifiers": ["1234"],
        "name": "Person One",
        "pep": false,
        "birthDate": "1970-01-01",
        "former": false,
        "riskData": {
          "basel_aml": {
            "value": 0
          },
          "cpi_score": {
            "value": 0
          }
        }
      }
    ],
    "directors": [
      {
        "addresses": ["Address"],
        "sanctioned": false,
        "identifiers": ["123"],
        "name": "Person Two",
        "pep": false,
        "birthDate": "1970-01-01",
        "appointmentDate": "1970-01-01",
        "former": false,
        "riskData": {
          "basel_aml": {
            "value": 0
          },
          "cpi_score": {
            "value": 0
          }
        }
      }
    ],
    "officers": [
      {
        "addresses": ["Address"],
        "sanctioned": false,
        "identifiers": ["123"],
        "name": "Person Three",
        "pep": false,
        "birthDate": "1970-01-01",
        "former": true,
        "riskData": {
          "basel_aml": {
            "value": 0
          },
          "cpi_score": {
            "value": 0
          }
        }
      }
    ]
  },
  "aliasNames": ["Alias Name 1", "Alias Name 2"],
  "attributes": [
    {
      "name": "status",
      "data": [
        {
          "properties": {
            "from_date": "1970-01-01",
            "value": "registered"
          }
        },
        {
          "properties": {
            "value": "active",
            "text": "Active"
          }
        },
        {
          "properties": {
            "date": "1970-01-01",
            "value": "incorporated"
          }
        }
      ],
      "total": 3
    }
  ]
}
```

{% endtab %}
{% endtabs %}


# Vehicle

{% content-ref url="/pages/2rj8E8PMsyXHctbH2urS" %}
[Register data](/caf-api/connect/transactions/background-check/vehicle/register-data)
{% endcontent-ref %}


# Register data

## DENATRAN Vehicle Data + Traffic Violations

Consultation of general data of the license plate and possible traffic violations of the vehicle with Denatran.

**Section:** `denatranVehicleViolations`

**Required parameters:** `plate`

**Plate formats:** *AAA9999* or *AAA9A999*

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

| Attribute                                                                                   | Type    | Description                                                                                         |
| ------------------------------------------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                                                                                  | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| data                                                                                        | Object  | Return data                                                                                         |
| data.message                                                                                | String  | Description of the query status                                                                     |
| data.vehicle                                                                                | Object  | Contains the vehicle information                                                                    |
| data.vehicle.hasVehicle                                                                     | Boolean | If you have a vehicle for the given license plate (T/F)                                             |
| data.vehicle.manufactureYear                                                                | Number  | Year of manufacture                                                                                 |
| data.vehicle.modelYear                                                                      | Number  | Model Year                                                                                          |
| data.vehicle.cmc                                                                            | Number  | CMC                                                                                                 |
| data.vehicle.cmt                                                                            | Number  | CMT                                                                                                 |
| data.vehicle.bodyworkTypeId                                                                 | String  | Body type code                                                                                      |
| data.vehicle.bodyworkTypeDescription                                                        | String  | Body type description                                                                               |
| data.vehicle.categoryId                                                                     | String  | Cetegory identifier                                                                                 |
| data.vehicle.categoryDescription                                                            | String  | Category Description                                                                                |
| data.vehicle.chassiSerial                                                                   | String  | Chassis serial number                                                                               |
| data.vehicle.chassisFull                                                                    | String  | Full vehicle chassis number                                                                         |
| data.vehicle.engineCapacity                                                                 | Number  | Engine capacity                                                                                     |
| data.vehicle.engineNumber                                                                   | String  | Engine number                                                                                       |
| data.vehicle.fuelId                                                                         | String  | Fuel Code                                                                                           |
| data.vehicle.fuelDescription                                                                | String  | Fuel type description                                                                               |
| data.vehicle.gearboxNumber                                                                  | String  | Transmission number                                                                                 |
| data.vehicle.colorId                                                                        | String  | Color code                                                                                          |
| data.vehicle.crlvExerciseYear                                                               | Number  | CRLV fiscal year                                                                                    |
| data.vehicle.crlvIssueDate                                                                  | String  | CRLV issuance date                                                                                  |
| data.vehicle.colorDescription                                                               | String  | Color Description                                                                                   |
| data.vehicle.customsRecord                                                                  | String  | Customs registration                                                                                |
| data.vehicle.speciesId                                                                      | String  | Species code                                                                                        |
| data.vehicle.speciesDescription                                                             | String  | Species description                                                                                 |
| data.vehicle.alarmIndication                                                                | Boolean | Alarm indicator                                                                                     |
| data.vehicle.burglaryTheftIndicator                                                         | Boolean | Theft or robbery indicator                                                                          |
| data.vehicle.vehicleCapacity                                                                | Number  | Passenger capacity                                                                                  |
| data.vehicle.modelBrandId                                                                   | String  | Make and model code                                                                                 |
| data.vehicle.modelBrandDescription                                                          | String  | Brand and Model Description                                                                         |
| data.vehicle.licensePlateMunicipalityId                                                     | String  | Code for the municipality of registration                                                           |
| data.vehicle.licensePlateMunicipalityDescription                                            | String  | Description of the municipality of registration                                                     |
| data.vehicle.quantityAxles                                                                  | Number  | Number of axles                                                                                     |
| data.vehicle.pbt                                                                            | Number  | PBT                                                                                                 |
| data.vehicle.plate                                                                          | String  | Plate                                                                                               |
| data.vehicle.power                                                                          | Number  | Power                                                                                               |
| data.vehicle.situation                                                                      | String  | Situation                                                                                           |
| data.vehicle.vehicleTypeType                                                                | String  | Vehicle type code                                                                                   |
| data.vehicle.vehicleTypeDescription                                                         | String  | Vehicle type description                                                                            |
| data.vehicle.stateJurisdiction                                                              | String  | UF of jurisdiction                                                                                  |
| data.vehicle.limitDate                                                                      | String  | Deadline                                                                                            |
| data.vehicle.salesCommunicationIndicator                                                    | Boolean | Sales communication indicator                                                                       |
| data.vehicle.publicSaleIndicator                                                            | Boolean | Auction Indicator                                                                                   |
| data.vehicle.trafficTicketRenainfIndicator                                                  | Boolean | Renainf fine indicator                                                                              |
| data.vehicle.pendingIssueIndicator                                                          | Boolean | Pending Issue Indicator                                                                             |
| data.vehicle.recallIndicator                                                                | Boolean | Recall indicator                                                                                    |
| data.vehicle.restriction1Id                                                                 | String  | Restriction code 1                                                                                  |
| data.vehicle.restriction1Description                                                        | String  | Description of Constraint 1                                                                         |
| data.vehicle.restriction2Id                                                                 | String  | Restriction code 2                                                                                  |
| data.vehicle.restriction2Description                                                        | String  | Description of Constraint 2                                                                         |
| data.vehicle.restriction3Id                                                                 | String  | Restriction code 3                                                                                  |
| data.vehicle.restriction3Description                                                        | String  | Description of Constraint 3                                                                         |
| data.vehicle.restriction4Id                                                                 | String  | Restriction code 4                                                                                  |
| data.vehicle.restriction4Description                                                        | String  | Description of Constraint 4                                                                         |
| data.vehicle.restrictionIndicatorRenajud                                                    | Boolean | Renajud restriction indicator                                                                       |
| data.vehicle.rfbRestrictionId                                                               | String  | RFB restriction code                                                                                |
| data.vehicle.rfbRestrictionDescription                                                      | String  | RFB Restriction Description                                                                         |
| data.vehicle.origin                                                                         | String  | Origin                                                                                              |
| data.vehicle.tenantTypeId                                                                   | String  | Tenant type code                                                                                    |
| data.vehicle.tenantTypeDescription                                                          | String  | Description of the tenant type                                                                      |
| data.vehicle.bodyworkNumber                                                                 | String  | Body number                                                                                         |
| data.vehicle.chassisMarkupId                                                                | String  | Chassis remarking code                                                                              |
| data.vehicle.chassisMarkupDescription                                                       | String  | Description of chassis remarking                                                                    |
| data.vehicle.dischargeDate                                                                  | String  | Retirement Date                                                                                     |
| data.vehicle.crvIssueDate                                                                   | String  | CRV issue date                                                                                      |
| data.vehicle.lastUpdateDate                                                                 | String  | Date of last update                                                                                 |
| data.vehicle.mreUpdateDate                                                                  | String  | MRE update date                                                                                     |
| data.vehicle.rfbPartId                                                                      | String  | RFB agency code                                                                                     |
| data.vehicle.rfbPartDescription                                                             | String  | RFB agency description                                                                              |
| data.vehicle.auxiliaryAxeNumber                                                             | String  | Auxiliary axis number                                                                               |
| data.vehicle.rearAxeNumber                                                                  | String  | Rear axle number                                                                                    |
| data.vehicle.billingIdentificationNumber                                                    | String  | Billing CPF/CNPJ                                                                                    |
| data.vehicle.billOrigin                                                                     | String  | Nature of invoice                                                                                   |
| data.vehicle.stateBilling                                                                   | String  | UF of invoice                                                                                       |
| data.vehicle.importDistDate                                                                 | String  | Import Dist Date                                                                                    |
| data.vehicle.importDeclarationNumber                                                        | String  | Import declaration number                                                                           |
| data.vehicle.importerOrigin                                                                 | String  | Nature of Importer                                                                                  |
| data.vehicle.importerIdentificationNumber                                                   | String  | Importer identification number                                                                      |
| data.vehicle.importType                                                                     | String  | Import process type                                                                                 |
| data.vehicle.importProcessNumber                                                            | String  | Import process number                                                                               |
| data.vehicle.indicatedOwnerDocumentNumber                                                   | String  | Indicated owner document number                                                                     |
| data.vehicle.documentImporterDescription                                                    | String  | Importer Description                                                                                |
| data.vehicle.transferCountryId                                                              | String  | Transfer country code                                                                               |
| data.vehicle.transferCountryDescription                                                     | String  | Description of the transfer country                                                                 |
| data.vehicle.ownerDocumentIndicatorId                                                       | String  | Document type of the owner indicated                                                                |
| data.vehicle.ownerDocumentIndicatorDescription                                              | String  | Description of the document of the specified owner                                                  |
| data.vehicle.ownerTypeId                                                                    | String  | Owner type code                                                                                     |
| data.vehicle.ownerName                                                                      | String  | Owner name                                                                                          |
| data.vehicle.ownerIdentificationNumber                                                      | String  | Owner CPF/CNPJ                                                                                      |
| data.vehicle.ownerTypeDescription                                                           | String  | Owner type description                                                                              |
| data.vehicle.ownerPossessorDocument                                                         | String  | Holder document number                                                                              |
| data.vehicle.ownerPossessorName                                                             | String  | Holder name                                                                                         |
| data.vehicle.ownerPossessorOrigin                                                           | String  | Holder origin                                                                                       |
| data.vehicle.pivIndicator                                                                   | Boolean | PIV indicator (Vehicle Identification Plate)                                                        |
| data.vehicle.pivInfo                                                                        | String  | PIV information (Vehicle Identification Plate)                                                      |
| data.vehicle.propertyOriginCode                                                             | String  | Property origin code                                                                                |
| data.vehicle.tenantName                                                                     | String  | Lessee name                                                                                         |
| data.vehicle.tenantIdentificationNumber                                                     | String  | Lessee identification number                                                                        |
| data.vehicle.renavamCode                                                                    | String  | RENAVAM code                                                                                        |
| data.vehicle.additionalRestrictions                                                         | Object  | Additional restrictions                                                                             |
| data.vehicle.additionalRestrictions.restrictionCount                                        | Number  | Total restrictions                                                                                  |
| data.vehicle.additionalRestrictions.restrictions                                            | Array   | Restrictions list                                                                                   |
| data.vehicle.additionalRestrictions.restrictions\[x].uniqueIdentifier                       | String  | Restriction Identifier                                                                              |
| data.vehicle.additionalRestrictions.restrictions\[x].renavamCode                            | String  | RENAVAM code                                                                                        |
| data.vehicle.additionalRestrictions.restrictions\[x].plate                                  | String  | Plate                                                                                               |
| data.vehicle.additionalRestrictions.restrictions\[x].chassis                                | String  | Chassis number                                                                                      |
| data.vehicle.additionalRestrictions.restrictions\[x].restrictionTypeId                      | String  | Restriction type identifier                                                                         |
| data.vehicle.additionalRestrictions.restrictions\[x].restrictionTypeDescription             | String  | Restriction type description                                                                        |
| data.vehicle.additionalRestrictions.restrictions\[x].restrictionSubTypeId                   | String  | Restriction subtype identifier                                                                      |
| data.vehicle.additionalRestrictions.restrictions\[x].restrictionSubTypeDescription          | String  | Restriction subtype description                                                                     |
| data.vehicle.additionalRestrictions.restrictions\[x].renavamRegistrationDateTime            | String  | RENAVAM registration date and time                                                                  |
| data.vehicle.additionalRestrictions.restrictions\[x].renavamRegistrationDateTimeDescription | String  | RENAVAM registration date and time description                                                      |
| data.vehicle.additionalRestrictions.restrictions\[x].indicatedDocumentType                  | String  | Indicated document type                                                                             |
| data.vehicle.additionalRestrictions.restrictions\[x].indicatedDocumentNumber                | String  | Indicated document number                                                                           |
| data.vehicle.additionalRestrictions.restrictions\[x].updateDateTime                         | String  | Last update date and time                                                                           |
| data.vehicle.additionalRestrictions.restrictions\[x].piv                                    | String  | PIV information (Vehicle Identification Plate)                                                      |
| data.violations                                                                             | Array   | List of traffic violations                                                                          |
| data.violations\[x].violationId                                                             | String  | Infraction Code                                                                                     |
| data.violations\[x].violationBreakdownId                                                    | String  | Infraction Deployment Code                                                                          |
| data.violations\[x].violationDescription                                                    | String  | Infraction Description                                                                              |
| data.violations\[x].renainfId                                                               | String  | Renainf Code                                                                                        |
| data.violations\[x].violationRegistrationDate                                               | String  | Date of Infraction Registration                                                                     |
| data.violations\[x].actuatorAgencyState                                                     | String  | UF of the Authorizing Body                                                                          |
| data.violations\[x].plate                                                                   | String  | Plate                                                                                               |
| data.violations\[x].renavamId                                                               | String  | Renavam                                                                                             |
| data.violations\[x].modelBrandId                                                            | String  | Vehicle make and model code                                                                         |
| data.violations\[x].modelBrandDescription                                                   | String  | Description of the vehicle make and model                                                           |
| data.violations\[x].vehicleTypeId                                                           | Number  | Vehicle type code                                                                                   |
| data.violations\[x].vehicleTypeDescription                                                  | String  | Vehicle type description                                                                            |
| data.violations\[x].vehicleColorId                                                          | Number  | Vehicle color code                                                                                  |
| data.violations\[x].vehicleColorDescription                                                 | String  | Vehicle Color Description                                                                           |
| data.violations\[x].vehicleKindId                                                           | Number  | Vehicle type code                                                                                   |
| data.violations\[x].vehicleKindDescription                                                  | String  | Description of the vehicle type                                                                     |
| data.violations\[x].vehicleBodyworkId                                                       | Number  | Vehicle body code                                                                                   |
| data.violations\[x].vehicleBodyworkDescription                                              | String  | Description of the vehicle body                                                                     |
| data.violations\[x].vehicleCategoryId                                                       | Number  | Vehicle category identifier                                                                         |
| data.violations\[x].vehicleCategoryDescription                                              | String  | Vehicle category description                                                                        |
| data.violations\[x].vehicleJurisdictionState                                                | String  | UF of the vehicle's jurisdiction                                                                    |
| data.violations\[x].informedRegistrationState                                               | String  | State where the vehicle was registered                                                              |
| data.violations\[x].registrationCityId                                                      | Number  | Code of the municipality where the vehicle is registered                                            |
| data.violations\[x].registrationCityDescription                                             | String  | Description of the municipality where the vehicle is registered                                     |
| data.violations\[x].vehicleCountryId                                                        | Number  | Vehicle country code                                                                                |
| data.violations\[x].vehicleCountryDescription                                               | String  | Country description of the vehicle                                                                  |
| data.violations\[x].restrictionId1                                                          | Number  | Restriction code 1                                                                                  |
| data.violations\[x].restrictionDescription1                                                 | String  | Description of Constraint 1                                                                         |
| data.violations\[x].restrictionId2                                                          | Number  | Restriction code 2                                                                                  |
| data.violations\[x].restrictionDescription2                                                 | String  | Description of Constraint 2                                                                         |
| data.violations\[x].restrictionId3                                                          | Number  | Restriction code 3                                                                                  |
| data.violations\[x].restrictionDescription3                                                 | String  | Description of Constraint 3                                                                         |
| data.violations\[x].restrictionId4                                                          | Number  | Restriction code 4                                                                                  |
| data.violations\[x].restrictionDescription4                                                 | String  | Description of Constraint 4                                                                         |
| data.violations\[x].restrictionIndicatorRenajud                                             | Boolean | Renajud restriction indicator                                                                       |
| data.violations\[x].restrictionIndicatorRenavam                                             | Boolean | Renavam restriction indicator                                                                       |
| data.violations\[x].burglaryTheftIndicatorRenavam                                           | Boolean | Theft or Renavam indicator                                                                          |
| data.violations\[x].actuatorAgencyId                                                        | String  | Code of the Notary Body                                                                             |
| data.violations\[x].actuatorAgencyDescription                                               | String  | Description of the Notifying Body                                                                   |
| data.violations\[x].autoInfractionNumber                                                    | String  | Infraction notice number                                                                            |
| data.violations\[x].autoSignatureId                                                         | Number  | Infringement notice signature indicator                                                             |
| data.violations\[x].autoSignatureDescription                                                | String  | Description of signature on the infraction notice                                                   |
| data.violations\[x].driverCnhModelId                                                        | Number  | Driver's CNH model code                                                                             |
| data.violations\[x].driverCnhModelDescription                                               | String  | Description of the driver's CNH model                                                               |
| data.violations\[x].driverCnhRegistrationNumber                                             | String  | Driver's CNH registration number code                                                               |
| data.violations\[x].driverCnhExpeditionState                                                | String  | State of issue of the driver's CNH                                                                  |
| data.violations\[x].violationDate                                                           | String  | Date of infraction                                                                                  |
| data.violations\[x].violationTime                                                           | String  | Time of the infraction                                                                              |
| data.violations\[x].violationOccurrencePlace                                                | String  | Place where the infraction occurred                                                                 |
| data.violations\[x].violationCityId                                                         | String  | City code of the infraction                                                                         |
| data.violations\[x].violationCityDescription                                                | String  | Description of the city of infringement                                                             |
| data.violations\[x].autoTypeId                                                              | Number  | Auto type code                                                                                      |
| data.violations\[x].autoTypeDescription                                                     | String  | Description of the auto type                                                                        |
| data.violations\[x].notLicensedDriverDocumentNumber                                         | String  | Document number of the unlicensed driver                                                            |
| data.violations\[x].notLicensedDriverDocumentTypeId                                         | Number  | Unlicensed driver document number code                                                              |
| data.violations\[x].notLicensedDriverDocumentTypeDescription                                | String  | Description of the document number of the unlicensed driver                                         |
| data.violations\[x].actualMeasurement                                                       | String  | Actual Measurement                                                                                  |
| data.violations\[x].allowedLimit                                                            | String  | Allowed Limit                                                                                       |
| data.violations\[x].measurementConsidered                                                   | String  | Measurement Considered                                                                              |
| data.violations\[x].measurementUnitId                                                       | Number  | Unit of measure code                                                                                |
| data.violations\[x].measurementUnitDescription                                              | String  | Description of the unit of measure                                                                  |
| data.violations\[x].violationFullValue                                                      | String  | Full value of the violation                                                                         |
| data.violations\[x].vehicleOwnerOriginId                                                    | Number  | Code of the origin of the possessor                                                                 |
| data.violations\[x].vehicleOwnerOriginDescription                                           | String  | Description of the origin of the possessor                                                          |
| data.violations\[x].ownerDocumentTypeId                                                     | Number  | Code of the document type of the possessor                                                          |
| data.violations\[x].ownerDocumentTypeDescription                                            | String  | Description of the possessor's document type                                                        |
| data.violations\[x].ownerIdentificationNumber                                               | String  | Owner identification number                                                                         |
| data.violations\[x].ownerName                                                               | String  | Owner's name                                                                                        |
| data.violations\[x].notificationNoticeIssueDate                                             | String  | Date of issuance of the notice of violation                                                         |
| data.violations\[x].defenseNoticeLimitDate                                                  | String  | Deadline for defense of the infraction                                                              |
| data.violations\[x].notificationNoticeIndicator                                             | Boolean | Notification of notice indicator                                                                    |
| data.violations\[x].numberNotificationPenalty                                               | String  | Number of the penalty notice                                                                        |
| data.violations\[x].penaltyNotificationIssueDate                                            | String  | Date of issuance of penalty notice                                                                  |
| data.violations\[x].penaltyNotificationExpirationDate                                       | String  | Due date of penalty notice                                                                          |
| data.violations\[x].penaltyType                                                             | Number  | Penalty Type                                                                                        |
| data.violations\[x].penaltyDescription                                                      | String  | Description of the penalty                                                                          |
| data.violations\[x].violatorActualName                                                      | String  | Name of the real offender                                                                           |
| data.violations\[x].violatorActualCnhModelId                                                | Number  | Model code of the real offender's CNH                                                               |
| data.violations\[x].violatorActualCnhModelDescription                                       | String  | Description of the model of the real offender's CNH                                                 |
| data.violations\[x].violatorActualCnhRegistrationNumber                                     | String  | CNH registration number of the real offender                                                        |
| data.violations\[x].driverActualCnhExpeditionState                                          | String  | UF of issue of the real driver's CNH                                                                |
| data.violations\[x].scoreAnalysisStatusId                                                   | String  | Score Analysis Status Indicator                                                                     |
| data.violations\[x].scoreAnalysisStatusDescription                                          | String  | Score Analysis Status Description                                                                   |
| data.violations\[x].scoredCnhModelId                                                        | Number  | Model code of the scored CNH                                                                        |
| data.violations\[x].scoredCnhModelDescription                                               | String  | Description of the model of the scored CNH                                                          |
| data.violations\[x].scoredCnhRegistrationNumber                                             | String  | Registration number of the scored CNH                                                               |
| data.violations\[x].scoredCnhExpeditionState                                                | String  | UF of expedition of the scored CNH                                                                  |
| data.violations\[x].enforceabilityId                                                        | Number  | Demandability Indicator                                                                             |
| data.violations\[x].enforceabilityDescription                                               | String  | Description of the enforceability indicator                                                         |
| data.violations\[x].paymentState                                                            | String  | Uf of payment                                                                                       |
| data.violations\[x].violationPaymentDate                                                    | String  | Date of payment of the infraction                                                                   |
| data.violations\[x].violationPaidValue                                                      | String  | Paid amount of the infraction                                                                       |
| data.violations\[x].paymentRegistrationDate                                                 | String  | Record date of payment of the infraction                                                            |
| data.violations\[x].paymentsAmount                                                          | Number  | Total payments                                                                                      |
| data.violations\[x].occurrenceTypeId                                                        | Number  | Occurrence type code                                                                                |
| data.violations\[x].occurrenceTypeDescription                                               | String  | Description of the type of occurrence                                                               |
| data.violations\[x].occurrenceOriginDescription                                             | String  | Description of the origin of the occurrence                                                         |
| data.violations\[x].proccessNumber                                                          | String  | Case number                                                                                         |
| {% endtab %}                                                                                |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "vehicle": {
      "hasVehicle": true,
      "manufactureYear": 2019,
      "modelYear": 2020,
      "cmc": 0,
      "cmt": 2.1,
      "bodyworkTypeId": "999",
      "bodyworkTypeDescription": "NAO APLICAVEL",
      "categoryId": "01",
      "categoryDescription": "PARTICULAR",
      "chassiSerial": "45821",
      "chassisFull": "9BG1234AB5CD45821",
      "engineCapacity": 1600,
      "engineNumber": "ABC123456",
      "fuelId": "16",
      "fuelDescription": "ALCOOL/GASOLINA",
      "gearboxNumber": "G12345678",
      "colorId": "09",
      "crlvExerciseYear": 2025,
      "crlvIssueDate": "2025-03-10T14:30:00",
      "colorDescription": "VERMELHA",
      "customsRecord": "",
      "speciesId": "01",
      "speciesDescription": "PASSAGEIRO",
      "alarmIndication": false,
      "burglaryTheftIndicator": false,
      "vehicleCapacity": 5,
      "modelBrandId": "123456",
      "modelBrandDescription": "FIAT/ARGO 1.0 DRIVE",
      "licensePlateMunicipalityId": "9999",
      "licensePlateMunicipalityDescription": "SAO PAULO",
      "quantityAxles": 2,
      "pbt": 1.5,
      "plate": "ABC1D23",
      "power": 75,
      "situation": "EM_CIRCULACAO",
      "vehicleTypeType": "06",
      "vehicleTypeDescription": "AUTOMOVEL",
      "stateJurisdiction": "SP",
      "limitDate": null,
      "salesCommunicationIndicator": false,
      "publicSaleIndicator": false,
      "trafficTicketRenainfIndicator": true,
      "pendingIssueIndicator": false,
      "recallIndicator": false,
      "restriction1Id": "00",
      "restriction1Description": "SEM RESTRICAO",
      "restriction2Id": "00",
      "restriction2Description": "SEM RESTRICAO",
      "restriction3Id": "00",
      "restriction3Description": "SEM RESTRICAO",
      "restriction4Id": "00",
      "restriction4Description": "SEM RESTRICAO",
      "restrictionIndicatorRenajud": false,
      "rfbRestrictionId": "0",
      "rfbRestrictionDescription": "INEXISTENTE",
      "origin": "NACIONAL",
      "tenantTypeId": "0",
      "tenantTypeDescription": "INEXISTENTE",
      "bodyworkNumber": "",
      "chassisMarkupId": "2",
      "chassisMarkupDescription": "NORMAL",
      "dischargeDate": null,
      "crvIssueDate": "2024-06-15",
      "lastUpdateDate": "2025-03-10",
      "mreUpdateDate": null,
      "rfbPartId": "0000000",
      "rfbPartDescription": "INEXISTENTE",
      "auxiliaryAxeNumber": "",
      "rearAxeNumber": "",
      "billingIdentificationNumber": "12345678000199",
      "billOrigin": "JURIDICA",
      "stateBilling": "SP",
      "importDistDate": null,
      "importDeclarationNumber": "",
      "importerOrigin": "",
      "importerIdentificationNumber": "",
      "importType": null,
      "importProcessNumber": "0",
      "indicatedOwnerDocumentNumber": "",
      "documentImporterDescription": "INEXISTENTE",
      "transferCountryId": "00000",
      "transferCountryDescription": "INEXISTENTE",
      "ownerDocumentIndicatorDescription": "INEXISTENTE",
      "ownerTypeId": "1",
      "ownerName": "MARIA SILVA SANTOS",
      "ownerIdentificationNumber": "12345678901",
      "ownerTypeDescription": "FISICA",
      "ownerPossessorDocument": "12345678901",
      "ownerPossessorName": "MARIA SILVA SANTOS",
      "ownerPossessorOrigin": "4",
      "pivIndicator": false,
      "pivInfo": "",
      "propertyOriginCode": "0",
      "tenantName": "",
      "tenantIdentificationNumber": "",
      "renavamCode": "00123456789",
      "additionalRestrictions": {
        "restrictionCount": 1,
        "restrictions": [
          {
            "uniqueIdentifier": "2108301234567AB1234",
            "renavamCode": "00123456789",
            "plate": "ABC1D23",
            "chassis": "9BG1234AB5CD45821",
            "restrictionTypeId": "B1",
            "restrictionTypeDescription": "CNPJ_DA INSTITUICAO_FINANCEIRA",
            "restrictionSubTypeId": "",
            "restrictionSubTypeDescription": "",
            "renavamRegistrationDateTime": "",
            "renavamRegistrationDateTimeDescription": "",
            "indicatedDocumentType": "",
            "indicatedDocumentNumber": "",
            "updateDateTime": "2025-03-10T10:15:30.5",
            "piv": ""
          }
        ]
      }
    },
    "violations": [
      {
        "violationId": "7455",
        "violationBreakdownId": "0",
        "violationDescription": "TRANSITAR EM VELOCIDADE SUPERIOR A MAXIMA PERMITIDA EM ATE 20%",
        "renainfId": "10123456789",
        "violationRegistrationDate": "2025-02-15",
        "actuatorAgencyState": "SP",
        "plate": "ABC1D23",
        "renavamId": "00123456789",
        "modelBrandId": "123456",
        "modelBrandDescription": "FIAT/ARGO 1.0 DRIVE",
        "vehicleTypeId": 6,
        "vehicleTypeDescription": "AUTOMOVEL",
        "vehicleColorId": 9,
        "vehicleColorDescription": "VERMELHA",
        "vehicleKindId": 1,
        "vehicleKindDescription": "PASSAGEIRO",
        "vehicleBodyworkId": 999,
        "vehicleBodyworkDescription": "NAO APLICAVEL",
        "vehicleCategoryId": 1,
        "vehicleCategoryDescription": "PARTICULAR",
        "vehicleJurisdictionState": "SP",
        "informedRegistrationState": "SP",
        "registrationCityId": 9999,
        "registrationCityDescription": "SAO PAULO",
        "vehicleCountryId": 0,
        "vehicleCountryDescription": "INEXISTENTE",
        "restrictionId1": 0,
        "restrictionDescription1": "SEM RESTRICAO",
        "restrictionId2": 0,
        "restrictionDescription2": "SEM RESTRICAO",
        "restrictionId3": 0,
        "restrictionDescription3": "SEM RESTRICAO",
        "restrictionId4": 0,
        "restrictionDescription4": "SEM RESTRICAO",
        "restrictionIndicatorRenajud": false,
        "restrictionIndicatorRenavam": false,
        "burglaryTheftIndicatorRenavam": false,
        "actuatorAgencyId": "263010",
        "actuatorAgencyDescription": "DER - SP",
        "autoInfractionNumber": "E012345678",
        "autoSignatureId": 2,
        "autoSignatureDescription": "NAO ASSINADO",
        "driverCnhModelId": 0,
        "driverCnhModelDescription": "INEXISTENTE",
        "driverCnhRegistrationNumber": "00000000000",
        "driverCnhExpeditionState": "",
        "violationDate": "2025-02-10",
        "violationTime": "08:45",
        "violationOccurrencePlace": "ROD. RAPOSO TAVARES km 25",
        "violationCityId": "9999",
        "violationCityDescription": "SAO PAULO",
        "autoTypeId": 3,
        "autoTypeDescription": "INEXISTENTE",
        "notLicensedDriverDocumentNumber": "",
        "notLicensedDriverDocumentTypeId": 0,
        "notLicensedDriverDocumentTypeDescription": "INEXISTENTE",
        "actualMeasurement": "72.00",
        "allowedLimit": "60.00",
        "measurementConsidered": "65.00",
        "measurementUnitId": 1,
        "measurementUnitDescription": "KM/H",
        "violationFullValue": "130.16",
        "vehicleOwnerOriginId": 1,
        "vehicleOwnerOriginDescription": "PROPRIETARIO DA BIN AMPLIADA",
        "ownerDocumentTypeId": 1,
        "ownerDocumentTypeDescription": "CPF",
        "ownerIdentificationNumber": "12345678901",
        "ownerName": "MARIA SILVA SANTOS",
        "notificationNoticeIssueDate": "2025-02-15",
        "defenseNoticeLimitDate": "2025-04-16",
        "notificationNoticeIndicator": false,
        "numberNotificationPenalty": "2512345678",
        "penaltyNotificationIssueDate": "2025-05-01",
        "penaltyNotificationExpirationDate": "2025-07-01",
        "penaltyType": 1,
        "penaltyDescription": "PENALIDADE DE MULTA",
        "violatorActualName": "",
        "violatorActualCnhModelId": 0,
        "violatorActualCnhModelDescription": "INEXISTENTE",
        "violatorActualCnhRegistrationNumber": "00000000000",
        "driverActualCnhExpeditionState": "",
        "scoreAnalysisStatusId": "R006",
        "scoreAnalysisStatusDescription": "PONTUACAO APLICADA",
        "scoredCnhModelId": 2,
        "scoredCnhModelDescription": "RENACH",
        "scoredCnhRegistrationNumber": "01234567890",
        "scoredCnhExpeditionState": "SP",
        "enforceabilityId": 0,
        "enforceabilityDescription": "NAO EXIGIVEL",
        "paymentState": "SP",
        "violationPaymentDate": "2025-06-20",
        "violationPaidValue": "104.12",
        "paymentRegistrationDate": "2025-06-21",
        "paymentsAmount": 1,
        "occurrenceTypeId": 0,
        "occurrenceTypeDescription": "INEXISTENTE",
        "occurrenceOriginDescription": "INEXISTENTE",
        "proccessNumber": ""
      }
    ]
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                              | Description                                                                   |
| --------------------------------- | ----------------------------------------------------------------------------- |
| vehicle\_has\_traffic\_violations | Checks if the vehicle has any infractions with Denatran in the last 365 days. |
| {% endtab %}                      |                                                                               |
| {% endtabs %}                     |                                                                               |

## Vehicle data

Returns information about the vehicle, such as composition, chassis, RENAVAM, restrictions (IPVA, DPVAT, fines, licensing, RENAJUD), infractions from PRF, as well as tax data from SEFAZ and DETRAN in various states.

SEFAZ information available for the following states: AL, AM, BA, CE, DF, MA, MG, MT, PA, PB, PI, RS, SP, SE, TO DETRAN information available for the following states: AC, AM, CE, MA, MG, PE, RO, RJ, RR, SC, SE

**Section:** `vehicleViolations`

**Required parameter:** `plate`

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

| Attribute                                                                               | Type   | Description                                                                                         |
| --------------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| statusCode                                                                              | String | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| message                                                                                 | String | Descriptive with query status                                                                       |
| data                                                                                    | Object | Return data                                                                                         |
| data.driverName                                                                         | String | Driver's name                                                                                       |
| data.plate                                                                              | String | Vehicle plate                                                                                       |
| data.chassis                                                                            | String | Vehicle chassis                                                                                     |
| data.chassisSituation                                                                   | String | Chassis situation                                                                                   |
| data.renavam                                                                            | String | RENAVAM                                                                                             |
| data.origin                                                                             | String | Vehicle origin                                                                                      |
| data.cmtVehicle                                                                         | String | Vehicle CMT                                                                                         |
| data.srfAgencyCode                                                                      | String | SRF agency code                                                                                     |
| data.engineCapacity                                                                     | String | Engine capacity                                                                                     |
| data.vehicleCategory                                                                    | String | Vehicle category                                                                                    |
| data.vehicleType                                                                        | String | Vehicle type                                                                                        |
| data.vehicleKind                                                                        | String | Vehicle kind                                                                                        |
| data.vehicleColor                                                                       | String | Vehicle color                                                                                       |
| data.vehicleFuel                                                                        | String | Vehicle fuel                                                                                        |
| data.vehiclePower                                                                       | String | Vehicle power                                                                                       |
| data.vehicleImportOperationType                                                         | String | Vehicle import operation type                                                                       |
| data.passengersQuantity                                                                 | String | Vehicle passengers quantity                                                                         |
| data.gearBox                                                                            | String | Vehicle gear box                                                                                    |
| data.modelBrand                                                                         | String | Model brand                                                                                         |
| data.modelYear                                                                          | String | Model year                                                                                          |
| data.manufactureYear                                                                    | String | Manufacture year                                                                                    |
| data.quantityAxles                                                                      | String | Axles quantity                                                                                      |
| data.auxiliaryAxeNumber                                                                 | String | Auxiliary axe number                                                                                |
| data.rearAxeNumber                                                                      | String | Rear axe number                                                                                     |
| data.engineNumber                                                                       | String | Engine number                                                                                       |
| data.loadCapacity                                                                       | String | Load capacity                                                                                       |
| data.bodyworkName                                                                       | String | Bodywork name                                                                                       |
| data.bodyworkNumber                                                                     | String | Bodywork number                                                                                     |
| data.bodyworkType                                                                       | String | Bodywork type                                                                                       |
| data.assemblyType                                                                       | String | Assembly type                                                                                       |
| data.redaNumber                                                                         | String | REDA number                                                                                         |
| data.pbtVehicle                                                                         | String | Vehicle PBT                                                                                         |
| data.city                                                                               | String | City                                                                                                |
| data.state                                                                              | String | State                                                                                               |
| data.registrationDate                                                                   | String | Registration date                                                                                   |
| data.situation                                                                          | String | Situation                                                                                           |
| data.taxRestrictionLimitDate                                                            | String | Tax restriction limit date                                                                          |
| data.ownerName                                                                          | String | Owner name                                                                                          |
| data.ownerDocumentType                                                                  | String | Owner document type                                                                                 |
| data.ownerIdentificationNumber                                                          | String | Owner identification number                                                                         |
| data.diNumber                                                                           | String | DI number                                                                                           |
| data.diRegistrationDate                                                                 | String | DI registration date                                                                                |
| data.identificationNumberBilling                                                        | String | Identification number billing                                                                       |
| data.importProcessNumber                                                                | String | Import process number                                                                               |
| data.importerIdentificationNumber                                                       | String | Importer identification number                                                                      |
| data.importerDocumentType                                                               | String | Importer document type                                                                              |
| data.billingDocumentType                                                                | String | Billing document type                                                                               |
| data.billingDestinationState                                                            | String | Billing destination state                                                                           |
| data.restrictionAgentName                                                               | String | Restriction agent name                                                                              |
| data.tenantRestriction                                                                  | String | Tenant restriction                                                                                  |
| data.inclusionDateRestriction                                                           | String | Inclusion date restriction                                                                          |
| data.tenantDocumentRestriction                                                          | String | Tenant document restriction                                                                         |
| data.updateDate                                                                         | String | Update date                                                                                         |
| data.additionalInformation                                                              | Array  | Additional information                                                                              |
| data.additionalInformation\[x].description                                              | String | Information type                                                                                    |
| data.additionalInformation\[x].value                                                    | String | Description message                                                                                 |
| data.restrictions                                                                       | Object | Details about restrictions                                                                          |
| data.restrictions.hasGeneralRestriction                                                 | String | Indicates if has any restrictions                                                                   |
| data.restrictions.hasFinancialRestriction                                               | String | Indicates if has financial restrictions                                                             |
| data.restrictions.hasRenajudRestriction                                                 | String | Indicates if has Renajud restrictions                                                               |
| data.restrictions.hasTheftRegister                                                      | String | Indicates if has theft register                                                                     |
| data.restrictions.decommissionedVehicle                                                 | String | Indicates if vehicle was decommissioned                                                             |
| data.restrictions.financing                                                             | Object | Financing restrictions information                                                                  |
| data.restrictions.financing.financialCgc                                                | String | financial CGC                                                                                       |
| data.restrictions.financing.agentCode                                                   | String | Agent code                                                                                          |
| data.restrictions.financing.inclusionDate                                               | String | Inclusion date                                                                                      |
| data.restrictions.financing.contractValidityDate                                        | String | Contract validity date                                                                              |
| data.restrictions.financing.financialAgentName                                          | String | Financial agent name                                                                                |
| data.restrictions.financing.financedName                                                | String | Financed name                                                                                       |
| data.restrictions.financing.financedCpfCnpj                                             | String | Financed CPF/CNPJ                                                                                   |
| data.restrictions.financing.contractNumber                                              | String | Contract number                                                                                     |
| data.restrictions.financing.financingRestrictionType                                    | String | Financing restriction type                                                                          |
| data.restrictions.financing.transactionType                                             | String | Transaction type                                                                                    |
| data.restrictions.renajud                                                               | Object | Renajud restrictions information (Judicial Restrictions on Motor Vehicles)                          |
| data.restrictions.renajud.date                                                          | String | Date                                                                                                |
| data.restrictions.renajud.type                                                          | String | Type                                                                                                |
| data.restrictions.renajud.court                                                         | String | Court                                                                                               |
| data.restrictions.renajud.judicialAgency                                                | String | Judicial agency                                                                                     |
| data.restrictions.renajud.process                                                       | String | Process number                                                                                      |
| data.restrictions.messages                                                              | Array  | Restrictions messages                                                                               |
| data.restrictions.messages\[x].message                                                  | string | Message                                                                                             |
| data.restrictions.ipva                                                                  | Object | Pending IPVA information                                                                            |
| data.restrictions.ipva.hasPending                                                       | String | Indicates if has pending IPVA                                                                       |
| data.restrictions.ipva.pendingValue                                                     | String | Pending DPVAT value                                                                                 |
| data.restrictions.dpvat                                                                 | Object | Pending DPVAT information                                                                           |
| data.restrictions.dpvat.hasPending                                                      | String | Indicates if has pending DPVAT                                                                      |
| data.restrictions.dpvat.pendingValue                                                    | String | Pending IPVA value                                                                                  |
| data.restrictions.fines                                                                 | Object | Pending fines information                                                                           |
| data.restrictions.fines.hasPending                                                      | String | Indicates if has pending fines                                                                      |
| data.restrictions.fines.pendingValue                                                    | String | Pending fines value                                                                                 |
| data.restrictions.licensing                                                             | Object | Pending licensing information                                                                       |
| data.restrictions.licensing.hasPending                                                  | String | Indicates if has pending licensing                                                                  |
| data.restrictions.licensing.pendingValue                                                | String | Pending licensing value                                                                             |
| data.prf                                                                                | Object | Informations about fines on PRF (Federal Highway Police)                                            |
| data.prfStatus                                                                          | String | Fines status                                                                                        |
| data.hasFines                                                                           | Number | Indicates if has fines                                                                              |
| data.hasStatus                                                                          | Number | Indicates if has status                                                                             |
| data.fines                                                                              | Array  | Fines details                                                                                       |
| data.fines\[x].documentNumber                                                           | String | Document number                                                                                     |
| data.fines\[x].valueWithoutCalculations                                                 | String | Fine value without calculations                                                                     |
| data.fines\[x].violation                                                                | String | Violation                                                                                           |
| data.fines\[x].violationDate                                                            | String | Violation date                                                                                      |
| data.fines\[x].plate                                                                    | String | Plate                                                                                               |
| data.fines\[x].state                                                                    | String | State                                                                                               |
| data.fines\[x].aiNumber                                                                 | String | AI number                                                                                           |
| data.sefaz                                                                              | Object | SEFAZ                                                                                               |
| data.sefaz.AL                                                                           | Object | Object with the information of the state of Alagoas                                                 |
| data.sefaz.AL.message                                                                   | String | Message about the vehicle                                                                           |
| data.sefaz.AL.owner                                                                     | String | Owner                                                                                               |
| data.sefaz.AL.exercise                                                                  | String | Exercise                                                                                            |
| data.sefaz.AL.renavam                                                                   | String | Renavam                                                                                             |
| data.sefaz.AL.plate                                                                     | String | Plate                                                                                               |
| data.sefaz.AL.modelBrand                                                                | String | Model Brand                                                                                         |
| data.sefaz.AL.manufactureYear                                                           | String | Manufacture Year                                                                                    |
| data.sefaz.AL.ipvaTotal                                                                 | String | Ipva Total                                                                                          |
| data.sefaz.AL.bonusNFC                                                                  | String | Bonus NFC                                                                                           |
| data.sefaz.AL.installments.message                                                      | String | Message                                                                                             |
| data.sefaz.AL.installments.details                                                      | Array  | Details                                                                                             |
| data.sefaz.AL.installments.details\[x].installment                                      | String | Installment                                                                                         |
| data.sefaz.AL.installments.details\[x].principalValue                                   | String | Principal Value                                                                                     |
| data.sefaz.AL.installments.details\[x].discount                                         | String | Discount                                                                                            |
| data.sefaz.AL.installments.details\[x].bonus                                            | String | Bonus                                                                                               |
| data.sefaz.AL.installments.details\[x].fine                                             | String | Fine                                                                                                |
| data.sefaz.AL.installments.details\[x].interest                                         | String | Interest                                                                                            |
| data.sefaz.AL.installments.details\[x].total                                            | String | Total                                                                                               |
| data.sefaz.AL.installments.details\[x].dueDate                                          | String | Due Date                                                                                            |
| data.sefaz.AL.payments.message                                                          | String | Message                                                                                             |
| data.sefaz.AL.payments.details                                                          | Array  | Details                                                                                             |
| data.sefaz.AL.payments.details\[x].installment                                          | String | Installment                                                                                         |
| data.sefaz.AL.payments.details\[x].paidValue                                            | String | Paid Value                                                                                          |
| data.sefaz.AL.payments.details\[x].paymentDate                                          | String | Payment Date                                                                                        |
| data.sefaz.AL.payments.details\[x].bankAgency                                           | String | Bank Agency                                                                                         |
| data.sefaz.AM                                                                           | Object | Object with the information of the state of Amazonas                                                |
| data.sefaz.AM.message                                                                   | String | Message about the vehicle                                                                           |
| data.sefaz.AM.exercises                                                                 | Array  | List of exercises                                                                                   |
| data.sefaz.AM.exercises\[x].year                                                        | String | Year                                                                                                |
| data.sefaz.AM.exercises\[x].calculationBase                                             | String | Calculation base                                                                                    |
| data.sefaz.AM.ipvas                                                                     | object | Object of ipvas                                                                                     |
| data.sefaz.AM.ipvas.message                                                             | String | Message                                                                                             |
| data.sefaz.AM.ipvas.ipvaDetails                                                         | Array  | List of ipvaDetails                                                                                 |
| data.sefaz.AM.ipvas.ipvaDetails\[x].exerciseYear                                        | String | Exercise year                                                                                       |
| data.sefaz.AM.ipvas.ipvaDetails\[x].quota                                               | String | Quota                                                                                               |
| data.sefaz.AM.ipvas.ipvaDetails\[x].dueDate                                             | String | Due date                                                                                            |
| data.sefaz.AM.ipvas.ipvaDetails\[x].value                                               | String | Value                                                                                               |
| data.sefaz.BA                                                                           | Object | Object with the information of the state of Bahia                                                   |
| data.sefaz.BA.message                                                                   | String | Message about the vehicle                                                                           |
| data.sefaz.BA.plate                                                                     | String | Plate                                                                                               |
| data.sefaz.BA.model                                                                     | String | Model                                                                                               |
| data.sefaz.BA.ipvaPending                                                               | Array  | List of objects                                                                                     |
| data.sefaz.BA.ipvaPending\[x].exercise                                                  | String | Exercise                                                                                            |
| data.sefaz.BA.ipvaPending\[x].realValue                                                 | String | Real Value                                                                                          |
| data.sefaz.CE                                                                           | Object | Object with the information of the state of Ceará                                                   |
| data.sefaz.CE.message                                                                   | String | Message about the vehicle                                                                           |
| data.sefaz.CE.vehicle                                                                   | Object | Vehicle information                                                                                 |
| data.sefaz.CE.vehicle.chassis                                                           | String | Chassis                                                                                             |
| data.sefaz.CE.vehicle.plate                                                             | String | Plate                                                                                               |
| data.sefaz.CE.vehicle.renavam                                                           | String | Renavam                                                                                             |
| data.sefaz.CE.vehicle.modelBrand                                                        | String | Model brand                                                                                         |
| data.sefaz.CE.vehicle.manufactureYear                                                   | String | Manufacture year                                                                                    |
| data.sefaz.CE.vehicle.modelYear                                                         | String | Model year                                                                                          |
| data.sefaz.CE.vehicle.city                                                              | String | City                                                                                                |
| data.sefaz.CE.vehicleDebts                                                              | Array  | Vehicle debts                                                                                       |
| data.sefaz.CE.vehicleDebts\[x].exercise                                                 | String | Exercise                                                                                            |
| data.sefaz.CE.vehicleDebts\[x].principalValue                                           | String | Principal value                                                                                     |
| data.sefaz.CE.vehicleDebts\[x].fineValue                                                | String | Fine value                                                                                          |
| data.sefaz.CE.vehicleDebts\[x].interestValue                                            | String | Interest value                                                                                      |
| data.sefaz.CE.vehicleDebts\[x].totalValue                                               | String | Total value                                                                                         |
| data.sefaz.CE.vehicleDebts\[x].totalDiscount                                            | String | Total discount                                                                                      |
| data.sefaz.CE.vehicleDebts\[x].situation                                                | String | Situation                                                                                           |
| data.sefaz.DF                                                                           | Object | Object with the information of Distrito Federal                                                     |
| data.sefaz.DF.message                                                                   | String | Message about the vehicle                                                                           |
| data.sefaz.DF.renavam                                                                   | String | Renavam                                                                                             |
| data.sefaz.DF.plateChassis                                                              | String | Plate/Chassis                                                                                       |
| data.sefaz.DF.nameSocialReason                                                          | String | Name/Social Reason                                                                                  |
| data.sefaz.DF.vehicleCategory                                                           | String | Vehicle Category                                                                                    |
| data.sefaz.DF.vehicleModel                                                              | String | Vehicle Model                                                                                       |
| data.sefaz.DF.vehicleType                                                               | String | Vehicle Type                                                                                        |
| data.sefaz.DF.ipvaDebts                                                                 | Array  | IPVA Debts                                                                                          |
| data.sefaz.DF.ipvaDebts\[x].exerciseYear                                                | String | Exercise Year                                                                                       |
| data.sefaz.DF.ipvaDebts\[x].darCotaReference                                            | String | DAR Cota Reference                                                                                  |
| data.sefaz.DF.ipvaDebts\[x].principalValue                                              | String | Principal Value                                                                                     |
| data.sefaz.DF.ipvaDebts\[x].fineValue                                                   | String | Fine Value                                                                                          |
| data.sefaz.DF.ipvaDebts\[x].moraValue                                                   | String | Mora Value                                                                                          |
| data.sefaz.DF.ipvaDebts\[x].otherValue                                                  | String | Other Value                                                                                         |
| data.sefaz.DF.ipvaDebts\[x].totalValue                                                  | String | Total Value                                                                                         |
| data.sefaz.MA                                                                           | Object | Object with the information of the state of Maranhão                                                |
| data.sefaz.MA.message                                                                   | String | Message about the vehicle                                                                           |
| data.sefaz.MA.owner                                                                     | Object | Owner                                                                                               |
| data.sefaz.MA.owner.name                                                                | String | Owner name                                                                                          |
| data.sefaz.MA.owner.cpfCnpj                                                             | String | Owner CPF or CNPJ                                                                                   |
| data.sefaz.MA.renavam                                                                   | String | Renavam                                                                                             |
| data.sefaz.MA.chassis                                                                   | String | Chassis                                                                                             |
| data.sefaz.MA.modelBrand                                                                | String | Model brand                                                                                         |
| data.sefaz.MA.plate                                                                     | String | Plate                                                                                               |
| data.sefaz.MA.color                                                                     | String | Color                                                                                               |
| data.sefaz.MA.city                                                                      | String | City                                                                                                |
| data.sefaz.MA.ipvaDebts                                                                 | Object | IPVA debts                                                                                          |
| data.sefaz.MA.ipvaDebts.message                                                         | String | Message                                                                                             |
| data.sefaz.MA.ipvaDebts.debts                                                           | Array  | Debts                                                                                               |
| data.sefaz.MA.ipvaDebts.debts\[x].year                                                  | String | Year                                                                                                |
| data.sefaz.MA.ipvaDebts.debts\[x].dueDate                                               | String | Due date                                                                                            |
| data.sefaz.MA.ipvaDebts.debts\[x].installmentDescription                                | String | Installment description                                                                             |
| data.sefaz.MA.ipvaDebts.debts\[x].installmentNumber                                     | String | Installment number                                                                                  |
| data.sefaz.MA.ipvaDebts.debts\[x].fineValue                                             | String | Fine value                                                                                          |
| data.sefaz.MA.ipvaDebts.debts\[x].interestValue                                         | String | Interest value                                                                                      |
| data.sefaz.MA.ipvaDebts.debts\[x].reductionValue                                        | String | Reduction value                                                                                     |
| data.sefaz.MA.ipvaDebts.debts\[x].installmentValue                                      | String | Installment value                                                                                   |
| data.sefaz.MA.ipvaDebts.debts\[x].originalValue                                         | String | Original value                                                                                      |
| data.sefaz.MA.ipvaDebts.debts\[x].debtBalance                                           | String | Debt balance                                                                                        |
| data.sefaz.MA.otherDebts                                                                | Object | Other debts                                                                                         |
| data.sefaz.MA.otherDebts.message                                                        | String | Message                                                                                             |
| data.sefaz.MA.otherDebts.debts                                                          | Array  | Debts                                                                                               |
| data.sefaz.MA.otherDebts.debts\[x].year                                                 | String | Year                                                                                                |
| data.sefaz.MA.otherDebts.debts\[x].documentNumber                                       | String | Document number                                                                                     |
| data.sefaz.MA.otherDebts.debts\[x].dueDate                                              | String | Due date                                                                                            |
| data.sefaz.MA.otherDebts.debts\[x].referencePeriod                                      | String | Reference period                                                                                    |
| data.sefaz.MA.otherDebts.debts\[x].fineValue                                            | String | Fine value                                                                                          |
| data.sefaz.MA.otherDebts.debts\[x].interestValue                                        | String | Interest value                                                                                      |
| data.sefaz.MA.otherDebts.debts\[x].installmentValue                                     | String | Installment value                                                                                   |
| data.sefaz.MA.otherDebts.debts\[x].debtBalance                                          | String | Debt balance                                                                                        |
| data.sefaz.MA.otherDebts.debts\[x].accountType                                          | String | Account type                                                                                        |
| data.sefaz.MA.otherDebts.debts\[x].certificateNumber                                    | String | Certificate number                                                                                  |
| data.sefaz.MG                                                                           | Object | Object with the information of the state of Minas Gerais                                            |
| data.sefaz.MG.hasAlert                                                                  | String | Indicates if has any alert                                                                          |
| data.sefaz.MG.hasVehicleData                                                            | String | Indicates if has vehicle data                                                                       |
| data.sefaz.MG.hasExercise                                                               | String | Indicates if has exercise                                                                           |
| data.sefaz.MG.alert                                                                     | Array  | Alert message                                                                                       |
| data.sefaz.MG.vehicleData                                                               | Object | Vehicle data                                                                                        |
| data.sefaz.MG.vehicleData.owner                                                         | String | Owner name                                                                                          |
| data.sefaz.MG.vehicleData.cpfCnpj                                                       | String | CPF or CNPJ                                                                                         |
| data.sefaz.MG.vehicleData.renavam                                                       | String | Renavam code                                                                                        |
| data.sefaz.MG.vehicleData.plate                                                         | String | Plate                                                                                               |
| data.sefaz.MG.vehicleData.chassis                                                       | String | Chassis                                                                                             |
| data.sefaz.MG.vehicleData.city                                                          | String | City                                                                                                |
| data.sefaz.MG.vehicleData.state                                                         | String | State                                                                                               |
| data.sefaz.MG.exercise                                                                  | Array  | exercise                                                                                            |
| data.sefaz.MG.exercise\[x].taxInstallment                                               | String | Tax installment                                                                                     |
| data.sefaz.MG.exercise\[x].revenue                                                      | String | Revenue                                                                                             |
| data.sefaz.MG.exercise\[x].fine                                                         | String | Fine                                                                                                |
| data.sefaz.MG.exercise\[x].interest                                                     | String | Interest                                                                                            |
| data.sefaz.MG.exercise\[x].totalValue                                                   | String | Total value                                                                                         |
| data.sefaz.MG.exercise\[x].dueDate                                                      | String | Due date                                                                                            |
| data.sefaz.MT                                                                           | Object | Object with the information of the state of Mato Grosso                                             |
| data.sefaz.MT.message                                                                   | String | Message about the vehicle                                                                           |
| data.sefaz.MT.model                                                                     | String | Model                                                                                               |
| data.sefaz.MT.manufactureYear                                                           | String | Manufacture Year                                                                                    |
| data.sefaz.MT.chassis                                                                   | String | Chassis                                                                                             |
| data.sefaz.MT.owner                                                                     | String | Owner                                                                                               |
| data.sefaz.MT.plate                                                                     | String | Plate                                                                                               |
| data.sefaz.MT.renavam                                                                   | String | Renavam                                                                                             |
| data.sefaz.MT.extracts                                                                  | Array  | Extracts                                                                                            |
| data.sefaz.MT.extracts\[x].referenceYear                                                | String | Reference Year                                                                                      |
| data.sefaz.MT.extracts\[x].venalValue                                                   | String | Venal Value                                                                                         |
| data.sefaz.MT.extracts\[x].aliquot                                                      | String | Aliquot                                                                                             |
| data.sefaz.MT.extracts\[x].category                                                     | String | Category                                                                                            |
| data.sefaz.MT.extracts\[x].launches                                                     | Array  | Launches                                                                                            |
| data.sefaz.MT.extracts\[x].launches\[x].description                                     | String | Description                                                                                         |
| data.sefaz.MT.extracts\[x].launches\[x].documentNumber                                  | String | Document Number                                                                                     |
| data.sefaz.MT.extracts\[x].launches\[x].paymentDueDate                                  | String | Payment Due Date                                                                                    |
| data.sefaz.MT.extracts\[x].launches\[x].value                                           | String | Value                                                                                               |
| data.sefaz.MT.extracts\[x].launches\[x].type                                            | String | Type                                                                                                |
| data.sefaz.PA                                                                           | Object | Object with the information of the state of Pará                                                    |
| data.sefaz.PA.message                                                                   | String | Message about the vehicle                                                                           |
| data.sefaz.PA.owner                                                                     | String | Owner                                                                                               |
| data.sefaz.PA.plate                                                                     | String | Plate                                                                                               |
| data.sefaz.PA.color                                                                     | String | Color                                                                                               |
| data.sefaz.PA.chassis                                                                   | String | Chassis                                                                                             |
| data.sefaz.PA.model                                                                     | String | Model                                                                                               |
| data.sefaz.PA.type                                                                      | String | Type                                                                                                |
| data.sefaz.PA.renavam                                                                   | String | Renavam                                                                                             |
| data.sefaz.PA.year                                                                      | String | Year                                                                                                |
| data.sefaz.PA.ipva                                                                      | Object | IPVA                                                                                                |
| data.sefaz.PA.ipva.ipvaExercise                                                         | Array  | IPVA Exercise                                                                                       |
| data.sefaz.PA.ipva.ipvaExercise\[x].exercise                                            | String | Exercise                                                                                            |
| data.sefaz.PA.ipva.ipvaExercise\[x].baseCalculation                                     | String | Base Calculation                                                                                    |
| data.sefaz.PA.ipva.ipvaExercise\[x].nominalValue                                        | String | Nominal Value                                                                                       |
| data.sefaz.PA.ipva.ipvaExercise\[x].aliquot                                             | String | Aliquot                                                                                             |
| data.sefaz.PA.ipva.ipvaExercise\[x].updatedValue                                        | String | Updated Value                                                                                       |
| data.sefaz.PA.ipva.total                                                                | String | Total                                                                                               |
| data.sefaz.PB                                                                           | Object | Object with the information of the state of Paraíba                                                 |
| data.sefaz.PB.message                                                                   | String | Message about the vehicle                                                                           |
| data.sefaz.PB.plate                                                                     | String | Plate                                                                                               |
| data.sefaz.PB.renavam                                                                   | String | Renavam                                                                                             |
| data.sefaz.PB.owner                                                                     | String | Owner                                                                                               |
| data.sefaz.PB.ipvaDebts                                                                 | Array  | Array of objects                                                                                    |
| data.sefaz.PB.ipvaDebts\[x].exerciseYear                                                | String | Exercise Year                                                                                       |
| data.sefaz.PB.ipvaDebts\[x].ourNumber                                                   | String | Our Number                                                                                          |
| data.sefaz.PB.ipvaDebts\[x].debtValue                                                   | String | Debt Value                                                                                          |
| data.sefaz.PI                                                                           | Object | Object with the information of the state of Piauí                                                   |
| data.sefaz.PI.message                                                                   | String | Message about the vehicle                                                                           |
| data.sefaz.PI.renavam                                                                   | Number | Renavam                                                                                             |
| data.sefaz.PI.plate                                                                     | String | Plate                                                                                               |
| data.sefaz.PI.situation                                                                 | String | Situation                                                                                           |
| data.sefaz.PI.originDate                                                                | String | Origin Date                                                                                         |
| data.sefaz.PI.owner                                                                     | Object | Owner data                                                                                          |
| data.sefaz.PI.owner.cpfCnpj                                                             | String | CPF or CNPJ                                                                                         |
| data.sefaz.PI.owner.nameSocialReason                                                    | String | Name or Social Reason                                                                               |
| data.sefaz.PI.owner.address                                                             | String | Address                                                                                             |
| data.sefaz.PI.owner.zipCode                                                             | String | Zip Code                                                                                            |
| data.sefaz.PI.owner.city                                                                | String | City                                                                                                |
| data.sefaz.PI.owner.state                                                               | String | State                                                                                               |
| data.sefaz.PI.ipva                                                                      | Object | IPVA data                                                                                           |
| data.sefaz.PI.ipva.message                                                              | String | Message                                                                                             |
| data.sefaz.PI.ipva.ipvaDescriptions                                                     | Array  | IPVA Descriptions                                                                                   |
| data.sefaz.PI.ipva.ipvaDescriptions\[x].documentNumber                                  | String | Document Number                                                                                     |
| data.sefaz.PI.ipva.ipvaDescriptions\[x].referencePeriod                                 | String | Reference Period                                                                                    |
| data.sefaz.PI.ipva.ipvaDescriptions\[x].dueDate                                         | String | Due Date                                                                                            |
| data.sefaz.PI.ipva.ipvaDescriptions\[x].installmentDescription                          | String | Installment Description                                                                             |
| data.sefaz.PI.ipva.ipvaDescriptions\[x].stateDescription                                | String | State Description                                                                                   |
| data.sefaz.PI.ipva.ipvaDescriptions\[x].principalValue                                  | String | Principal Value                                                                                     |
| data.sefaz.PI.ipva.ipvaDescriptions\[x].fineValue                                       | String | Fine Value                                                                                          |
| data.sefaz.PI.ipva.ipvaDescriptions\[x].interestValue                                   | String | Interest Value                                                                                      |
| data.sefaz.PI.ipva.ipvaDescriptions\[x].updateValue                                     | String | Update Value                                                                                        |
| data.sefaz.PI.ipva.ipvaDescriptions\[x].toPayValue                                      | String | To Pay Value                                                                                        |
| data.sefaz.RS                                                                           | Object | Object with the information of the state of Rio Grande do Sul                                       |
| data.sefaz.RS.message                                                                   | String | Message about the vehicle                                                                           |
| data.sefaz.RS.plate                                                                     | String | Plate                                                                                               |
| data.sefaz.RS.renavam                                                                   | Number | Renavam                                                                                             |
| data.sefaz.RS.modelBrandManufactureYear                                                 | String | Model, brand and manufacture year                                                                   |
| data.sefaz.RS.ipva                                                                      | Array  | IPVA                                                                                                |
| data.sefaz.RS.ipva\[x].value                                                            | String | Value                                                                                               |
| data.sefaz.RS.ipva\[x].debt                                                             | String | Debt                                                                                                |
| data.sefaz.RS.ipva\[x].payableUntil                                                     | String | Payable until                                                                                       |
| data.sefaz.RS.ipva\[x].exercise                                                         | Number | Exercise                                                                                            |
| data.sefaz.RS.ipva\[x].details                                                          | Array  | Details                                                                                             |
| data.sefaz.RS.ipvaActiveDebt                                                            | Array  | IPVA active debt                                                                                    |
| data.sefaz.RS.ipvaActiveDebt\[x].value                                                  | String | Value                                                                                               |
| data.sefaz.RS.ipvaActiveDebt\[x].debt                                                   | String | Debt                                                                                                |
| data.sefaz.RS.ipvaActiveDebt\[x].payableUntil                                           | String | Payable until                                                                                       |
| data.sefaz.RS.ipvaActiveDebt\[x].details                                                | Array  | Details                                                                                             |
| data.sefaz.RS.licensing                                                                 | object | Licensing                                                                                           |
| data.sefaz.RS.licensing.value                                                           | String | Value                                                                                               |
| data.sefaz.RS.licensing.debt                                                            | String | Debt                                                                                                |
| data.sefaz.RS.expiredFines                                                              | Array  | Expired fines                                                                                       |
| data.sefaz.RS.expiredFines\[x].value                                                    | String | Value                                                                                               |
| data.sefaz.RS.expiredFines\[x].debt                                                     | String | Debt                                                                                                |
| data.sefaz.RS.expiredFines\[x].payableUntil                                             | String | Payable until                                                                                       |
| data.sefaz.SP                                                                           | Object | Object with the information of the state of São Paulo                                               |
| data.sefaz.SP.totalDebts                                                                | String | Total amount of debts                                                                               |
| data.sefaz.SP.vehicle                                                                   | Object | Object with vehicle information                                                                     |
| data.sefaz.SP.vehicle.renavam                                                           | String | Renavam code                                                                                        |
| data.sefaz.SP.vehicle.kind                                                              | String | Vehicle type                                                                                        |
| data.sefaz.SP.vehicle.plate                                                             | String | Plate                                                                                               |
| data.sefaz.SP.vehicle.category                                                          | String | Vehicle category                                                                                    |
| data.sefaz.SP.vehicle.modelBrand                                                        | String | Model or brand                                                                                      |
| data.sefaz.SP.vehicle.type                                                              | String | Vehicle type                                                                                        |
| data.sefaz.SP.vehicle.ipvaRange                                                         | String | IPVA year                                                                                           |
| data.sefaz.SP.vehicle.passengers                                                        | String | Number of passengers                                                                                |
| data.sefaz.SP.vehicle.manufactureYear                                                   | String | Year of manufacture                                                                                 |
| data.sefaz.SP.vehicle.bodywork                                                          | String | Bodywork                                                                                            |
| data.sefaz.SP.vehicle.city                                                              | String | City                                                                                                |
| data.sefaz.SP.vehicle.lastLicensing                                                     | String | Last licensing year                                                                                 |
| data.sefaz.SP.vehicle.fuel                                                              | String | Fuel                                                                                                |
| data.sefaz.SP.vehicle.saleCommunication                                                 | String | Sale communication date                                                                             |
| data.sefaz.SP.vehicle.saleDate                                                          | String | Sale date                                                                                           |
| data.sefaz.SP.vehicle.communicationDate                                                 | String | Communication date                                                                                  |
| data.sefaz.SP.ipva                                                                      | Object | Object with IPVA information                                                                        |
| data.sefaz.SP.ipva.calculationBase                                                      | String | Calculation base                                                                                    |
| data.sefaz.SP.ipva.aliquot                                                              | String | Aliquot                                                                                             |
| data.sefaz.SP.ipva.calculatedIpva                                                       | String | Calculated IPVA                                                                                     |
| data.sefaz.SP.ipva.paulistaFiscalNoteCredit                                             | String | Paulista fiscal note credit                                                                         |
| data.sefaz.SP.ipva.dueIpva                                                              | String | Due IPVA                                                                                            |
| data.sefaz.SP.ipva.paymentMade                                                          | String | Payment made                                                                                        |
| data.sefaz.SP.ipva.discountsOtherDeductions                                             | String | Discounts and other deductions                                                                      |
| data.sefaz.SP.ipva.balance                                                              | String | Balance                                                                                             |
| data.sefaz.SP.ipva.legalAdditions                                                       | String | Legal additions                                                                                     |
| data.sefaz.SP.ipva.toPayValue                                                           | String | To pay value                                                                                        |
| data.sefaz.SP.ipva.debtsPayment                                                         | Array  | List with debts payment information                                                                 |
| data.sefaz.SP.ipva.debtsPayment\[x].availableModalities                                 | String | Available modalities                                                                                |
| data.sefaz.SP.ipva.debtsPayment\[x].dueDate                                             | String | Due date                                                                                            |
| data.sefaz.SP.ipva.debtsPayment\[x].value                                               | String | Value                                                                                               |
| data.sefaz.SP.ipva.debtsNotRegistered                                                   | Array  | List with debts not registered information                                                          |
| data.sefaz.SP.ipva.debtsNotRegistered\[x].exercise                                      | String | Exercise                                                                                            |
| data.sefaz.SP.ipva.debtsNotRegistered\[x].value                                         | String | Value                                                                                               |
| data.sefaz.SP.ipva.registeredDebts                                                      | Object | Object with registered debts information                                                            |
| data.sefaz.SP.ipva.registeredDebts.exercise                                             | String | Exercise                                                                                            |
| data.sefaz.SP.dpvat                                                                     | Array  | List with DPVAT information                                                                         |
| data.sefaz.SP.dpvat\[x].exercise                                                        | String | Exercise                                                                                            |
| data.sefaz.SP.dpvat\[x].value                                                           | String | Value                                                                                               |
| data.sefaz.SP.taxes                                                                     | Array  | List with taxes information                                                                         |
| data.sefaz.SP.taxes\[x].description                                                     | String | Description                                                                                         |
| data.sefaz.SP.taxes\[x].value                                                           | String | Value                                                                                               |
| data.sefaz.SP.fines                                                                     | Object | Object with fines information                                                                       |
| data.sefaz.SP.fines.totalQuantity                                                       | String | Total quantity of fines                                                                             |
| data.sefaz.SP.fines.totalValue                                                          | String | Total value of fines                                                                                |
| data.sefaz.SP.fines.fines                                                               | Array  | List with fines information                                                                         |
| data.sefaz.SP.fines.fines\[x].agency                                                    | String | Agency                                                                                              |
| data.sefaz.SP.fines.fines\[x].quantity                                                  | String | Quantity                                                                                            |
| data.sefaz.SP.fines.fines\[x].value                                                     | String | Value                                                                                               |
| data.sefaz.SP.fines.detailFines                                                         | Array  | List with detail fines information                                                                  |
| data.sefaz.SP.fines.detailFines\[x].violation                                           | String | Violation                                                                                           |
| data.sefaz.SP.fines.detailFines\[x].city                                                | String | City                                                                                                |
| data.sefaz.SP.fines.detailFines\[x].location                                            | String | Location                                                                                            |
| data.sefaz.SP.fines.detailFines\[x].date                                                | String | Date                                                                                                |
| data.sefaz.SP.fines.detailFines\[x].nuAIT                                               | String | NuAIT                                                                                               |
| data.sefaz.SP.fines.detailFines\[x].guideNumber                                         | String | Guide number                                                                                        |
| data.sefaz.SP.fines.detailFines\[x].revenue                                             | String | Revenue                                                                                             |
| data.sefaz.SP.fines.detailFines\[x].dueDate                                             | String | Due date                                                                                            |
| data.sefaz.SP.fines.detailFines\[x].value                                               | String | Value                                                                                               |
| data.sefaz.SE                                                                           | Object | Object with the information of the state of Sergipe                                                 |
| data.sefaz.SE.message                                                                   | String | Message about the vehicle                                                                           |
| data.sefaz.SE.renavam                                                                   | String | Renavam                                                                                             |
| data.sefaz.SE.plate                                                                     | String | Plate                                                                                               |
| data.sefaz.SE.cpfCnpj                                                                   | String | CPF or CNPJ                                                                                         |
| data.sefaz.SE.ownerName                                                                 | String | Owner name                                                                                          |
| data.sefaz.SE.validityDate                                                              | String | Validity date                                                                                       |
| data.sefaz.SE.debt                                                                      | Object | Debt                                                                                                |
| data.sefaz.SE.debt.debts                                                                | Array  | debt.Debts                                                                                          |
| data.sefaz.SE.debt.debts\[x].exerciseYear                                               | String | Exercise year                                                                                       |
| data.sefaz.SE.debt.debts\[x].ipvaValue                                                  | String | IPVA value                                                                                          |
| data.sefaz.SE.debt.debts\[x].discountValue                                              | String | Discount value                                                                                      |
| data.sefaz.SE.debt.debts\[x].monetaryUpdateValue                                        | String | Monetary update value                                                                               |
| data.sefaz.SE.debt.debts\[x].fineValue                                                  | String | Fine value                                                                                          |
| data.sefaz.SE.debt.debts\[x].interestValue                                              | String | Interest value                                                                                      |
| data.sefaz.SE.debt.debts\[x].toPayValue                                                 | String | To pay value                                                                                        |
| data.sefaz.SE.debt.totalValue                                                           | String | Total value                                                                                         |
| data.sefaz.TO                                                                           | Object | Object with the information of the state of Tocantins                                               |
| data.sefaz.TO.message                                                                   | String | Message                                                                                             |
| data.sefaz.TO.data                                                                      | String | Owner data                                                                                          |
| data.sefaz.TO.data.owner                                                                | String | Owner                                                                                               |
| data.sefaz.TO.data.address                                                              | String | Address                                                                                             |
| data.sefaz.TO.data.neighborhood                                                         | String | Neighborhood                                                                                        |
| data.sefaz.TO.data.city                                                                 | String | City                                                                                                |
| data.sefaz.TO.data.modelBrand                                                           | String | Model Brand                                                                                         |
| data.sefaz.TO.data.manufacture                                                          | String | Manufacture                                                                                         |
| data.sefaz.TO.data.power                                                                | String | Power                                                                                               |
| data.sefaz.TO.previousIpva                                                              | Object | Previous IPVA                                                                                       |
| data.sefaz.TO.previousIpva.yearsDescription                                             | String | Years Description                                                                                   |
| data.sefaz.TO.previousIpva.previousIpvas                                                | Array  | Previous IPVA                                                                                       |
| data.sefaz.TO.previousIpva.previousIpvas\[x].description                                | String | Description                                                                                         |
| data.sefaz.TO.ipva                                                                      | Object | IPVA                                                                                                |
| data.sefaz.TO.ipva.message                                                              | String | Message                                                                                             |
| data.sefaz.TO.ipva.ipvaDetails                                                          | Array  | IPVA Details                                                                                        |
| data.sefaz.TO.ipva.ipvaDetails\[x].ourNumber                                            | String | Our Number                                                                                          |
| data.sefaz.TO.ipva.ipvaDetails\[x].installment                                          | String | Installment                                                                                         |
| data.sefaz.TO.ipva.ipvaDetails\[x].dueDate                                              | String | Due Date                                                                                            |
| data.sefaz.TO.ipva.ipvaDetails\[x].value                                                | String | Value                                                                                               |
| data.sefaz.TO.ipva.ipvaDetails\[x].situation                                            | String | Situation                                                                                           |
| data.detran                                                                             | Object | DETRAN                                                                                              |
| data.detran.AC                                                                          | Object | Object with the information of the state of Acre                                                    |
| data.detran.AC.message                                                                  | String | Message                                                                                             |
| data.detran.AC.plate                                                                    | String | Plate                                                                                               |
| data.detran.AC.renavam                                                                  | String | Renavam                                                                                             |
| data.detran.AC.chassis                                                                  | String | Chassis                                                                                             |
| data.detran.AC.brandModel                                                               | String | Brand Model                                                                                         |
| data.detran.AC.color                                                                    | String | Color                                                                                               |
| data.detran.AC.manufactureModelYear                                                     | String | Manufacture Model Year                                                                              |
| data.detran.AC.type                                                                     | String | Type                                                                                                |
| data.detran.AC.fuel                                                                     | String | Fuel                                                                                                |
| data.detran.AC.powerCapacity                                                            | String | Power capacity                                                                                      |
| data.detran.AC.category                                                                 | String | Category                                                                                            |
| data.detran.AC.passengerCapacity                                                        | String | Passenger capacity                                                                                  |
| data.detran.AC.species                                                                  | String | Species                                                                                             |
| data.detran.AC.nationality                                                              | String | Nationality                                                                                         |
| data.detran.AC.city                                                                     | String | City                                                                                                |
| data.detran.AC.hasTheft                                                                 | String | Has theft indicator                                                                                 |
| data.detran.AC.vehicleSituation                                                         | String | Vehicle situation                                                                                   |
| data.detran.AC.lastLicensingYear                                                        | String | Last licensing year                                                                                 |
| data.detran.AC.restriction1                                                             | String | Restriction 1                                                                                       |
| data.detran.AC.restriction2                                                             | String | Restriction 2                                                                                       |
| data.detran.AC.restriction3                                                             | String | Restriction 3                                                                                       |
| data.detran.AC.restriction4                                                             | String | Restriction 4                                                                                       |
| data.detran.AC.licensingFee                                                             | Object | Detran message                                                                                      |
| data.detran.AC.licensingFee.detranMessage                                               | String | Detran message                                                                                      |
| data.detran.AC.licensingFee.licensingDetails                                            | Array  | Licensing details                                                                                   |
| data.detran.AC.licensingFee.licensingDetails\[x].year                                   | String | Year                                                                                                |
| data.detran.AC.licensingFee.licensingDetails\[x].dueDate                                | String | Due date                                                                                            |
| data.detran.AC.licensingFee.licensingDetails\[x].value                                  | String | Value                                                                                               |
| data.detran.AC.licensingFee.licensingDetails\[x].paidValue                              | String | Paid value                                                                                          |
| data.detran.AC.licensingFee.licensingDetails\[x].differenceValue                        | String | Difference value                                                                                    |
| data.detran.AC.licensingFee.totalLicensing                                              | String | Total licensing                                                                                     |
| data.detran.AC.ipvas                                                                    | Object | Detran message                                                                                      |
| data.detran.AC.ipvas.detranMessage                                                      | String | Detran message                                                                                      |
| data.detran.AC.ipvas.ipvaDetails                                                        | Array  | Ipva details                                                                                        |
| data.detran.AC.ipvas.ipvaDetails\[x].year                                               | String | Year                                                                                                |
| data.detran.AC.ipvas.ipvaDetails\[x].dueDate                                            | String | Due date                                                                                            |
| data.detran.AC.ipvas.ipvaDetails\[x].value                                              | String | Value                                                                                               |
| data.detran.AC.ipvas.totalIpva                                                          | String | Total Ipva                                                                                          |
| data.detran.AC.mandatoryInsurance                                                       | Object | Mandatory insurance                                                                                 |
| data.detran.AC.mandatoryInsurance.detranMessage                                         | String | Detran message                                                                                      |
| data.detran.AC.infraction                                                               | Object | Infraction                                                                                          |
| data.detran.AC.infraction.detranMessage                                                 | String | Detran message                                                                                      |
| data.detran.AC.infraction.infractionDetails                                             | Array  | Infraction details                                                                                  |
| data.detran.AC.infraction.infractionDetails\[x].situation                               | String | Situation                                                                                           |
| data.detran.AC.infraction.infractionDetails\[x].quantity                                | String | Quantity                                                                                            |
| data.detran.AC.infraction.infractionDetails\[x].value                                   | String | Value                                                                                               |
| data.detran.AC.infraction.infractionDetails\[x].valueWithDiscount                       | String | Value with discount                                                                                 |
| data.detran.AM                                                                          | Object | Object with the information of the state of Amazonas                                                |
| data.detran.AM.message                                                                  | String | Message about the vehicle                                                                           |
| data.detran.AM.ownerData                                                                | Object | Owner data                                                                                          |
| data.detran.AM.ownerData.ownerName                                                      | String | Owner name                                                                                          |
| data.detran.AM.ownerData.ownerCpf                                                       | String | Owner CPF                                                                                           |
| data.detran.AM.vehicleData                                                              | Object | Vehicle data                                                                                        |
| data.detran.AM.vehicleData.vehicleTypeDescription                                       | String | Vehicle type description                                                                            |
| data.detran.AM.vehicleData.vehicleModelYear                                             | Number | Vehicle model year                                                                                  |
| data.detran.AM.vehicleData.plate                                                        | String | Plate                                                                                               |
| data.detran.AM.vehicleData.vehicleManufactureYear                                       | Number | Vehicle manufacture year                                                                            |
| data.detran.AM.vehicleData.renavam                                                      | String | Renavam                                                                                             |
| data.detran.AM.vehicleData.vehicleBrandDescription                                      | String | Vehicle brand description                                                                           |
| data.detran.AM.vehicleData.vehicleColorDescription                                      | String | Vehicle color description                                                                           |
| data.detran.AM.vehicleSituation                                                         | Object | Vehicle situation                                                                                   |
| data.detran.AM.vehicleSituation.licensingDueDate                                        | String | Licensing due date                                                                                  |
| data.detran.AM.vehicleSituation.exercise                                                | Number | Exercise                                                                                            |
| data.detran.AM.vehicleSituation.chassis                                                 | String | Chassis                                                                                             |
| data.detran.AM.vehicleSituation.vehicleCategoryDescription                              | String | Vehicle category description                                                                        |
| data.detran.AM.vehicleSituation.restriction1                                            | String | Restriction                                                                                         |
| data.detran.AM.vehicleSituation.restriction2                                            | String | Restriction                                                                                         |
| data.detran.AM.vehicleSituation.restriction3                                            | String | Restriction                                                                                         |
| data.detran.AM.vehicleSituation.restriction4                                            | String | Restriction                                                                                         |
| data.detran.AM.vehicleSituation.SNGRestriction                                          | String | SNG restriction                                                                                     |
| data.detran.AM.debts                                                                    | Object | Debts                                                                                               |
| data.detran.AM.debts.feeValue                                                           | String | Fee value                                                                                           |
| data.detran.AM.debts.municipalFinesValue                                                | String | Municipal fines value                                                                               |
| data.detran.AM.debts.dpvatInsuranceValue                                                | String | DPVAT insurance value                                                                               |
| data.detran.AM.debts.totalFinesAndFeesValue                                             | String | Total fines and fees value                                                                          |
| data.detran.AM.fineConsultation                                                         | Object | Fine consultation                                                                                   |
| data.detran.AM.fineConsultation.message                                                 | String | Message                                                                                             |
| data.detran.AM.fineConsultation.fines                                                   | Array  | Fines                                                                                               |
| data.detran.AM.fineConsultation.fines\[x].completeFineDescription                       | String | Complete fine description                                                                           |
| data.detran.AM.fineConsultation.fines\[x].issuingAgencyCode                             | Number | Issuing agency code                                                                                 |
| data.detran.AM.fineConsultation.fines\[x].infractionAuto                                | String | Infraction auto                                                                                     |
| data.detran.AM.fineConsultation.fines\[x].fineCode                                      | Number | Fine code                                                                                           |
| data.detran.AM.fineConsultation.fines\[x].typificationCode                              | Number | Typification code                                                                                   |
| data.detran.AM.fineConsultation.fines\[x].situation                                     | String | Situation                                                                                           |
| data.detran.AM.fineConsultation.fines\[x].situationDate                                 | String | Situation date                                                                                      |
| data.detran.AM.fineConsultation.fines\[x].offender                                      | String | Offender                                                                                            |
| data.detran.AM.fineConsultation.fines\[x].renainfCode                                   | String | Renainf code                                                                                        |
| data.detran.AM.fineConsultation.fines\[x].infractionDate                                | String | Infraction date                                                                                     |
| data.detran.AM.fineConsultation.fines\[x].infractionHour                                | String | Infraction hour                                                                                     |
| data.detran.AM.fineConsultation.fines\[x].value                                         | String | Value                                                                                               |
| data.detran.AM.fineConsultation.fines\[x].paidValue                                     | String | Paid value                                                                                          |
| data.detran.AM.fineConsultation.fines\[x].infractionLocation                            | String | Infraction location                                                                                 |
| data.detran.AM.fineConsultation.fines\[x].onEmissionDate                                | String | On emission date                                                                                    |
| data.detran.AM.fineConsultation.fines\[x].onDefenseDate                                 | String | On defense date                                                                                     |
| data.detran.AM.fineConsultation.fines\[x].onDriverPresentationDate                      | String | On driver presentation date                                                                         |
| data.detran.AM.fineConsultation.fines\[x].nipEmissionDate                               | String | NIP emission date                                                                                   |
| data.detran.AM.fineConsultation.fines\[x].nipAppealDate                                 | String | NIP appeal date                                                                                     |
| data.detran.AM.fineConsultation.fines\[x].nipDueDate                                    | String | NIP due date                                                                                        |
| data.detran.AM.fineConsultation.fines\[x].issuingAgencyUF                               | String | Issuing agency UF                                                                                   |
| data.detran.AM.fineConsultation.fines\[x].infractionMunicipalityDescription             | String | Infraction municipality description                                                                 |
| data.detran.CE                                                                          | Object | Object with the information of the state of Ceará                                                   |
| data.detran.CE.message                                                                  | String | Message about the vehicle                                                                           |
| data.detran.CE.plateMessage                                                             | String | Message about the vehicle plate                                                                     |
| data.detran.CE.fine                                                                     | Object | Fine                                                                                                |
| data.detran.CE.fine.message                                                             | String | Message                                                                                             |
| data.detran.CE.fine.details                                                             | Array  | Fine details                                                                                        |
| data.detran.CE.fine.details\[x].ait                                                     | String | AIT                                                                                                 |
| data.detran.CE.fine.details\[x].originalAIT                                             | String | Original AIT                                                                                        |
| data.detran.CE.fine.details\[x].reason                                                  | String | Reason                                                                                              |
| data.detran.CE.fine.details\[x].infractionDate                                          | String | Infraction date                                                                                     |
| data.detran.CE.fine.details\[x].dueDate                                                 | String | Due date                                                                                            |
| data.detran.CE.fine.details\[x].value                                                   | String | Value                                                                                               |
| data.detran.CE.fine.details\[x].valueToPay                                              | String | Value to pay                                                                                        |
| data.detran.CE.licensing                                                                | Object | Licensing                                                                                           |
| data.detran.CE.licensing.message                                                        | String | Message                                                                                             |
| data.detran.CE.licensing.details                                                        | Array  | Licensing details                                                                                   |
| data.detran.CE.licensing.details\[x].date                                               | String | Date                                                                                                |
| data.detran.CE.licensing.details\[x].agency                                             | String | Agency                                                                                              |
| data.detran.CE.licensing.details\[x].description                                        | String | Description                                                                                         |
| data.detran.CE.licensing.details\[x].value                                              | String | Value                                                                                               |
| data.detran.CE.licensing.details\[x].totalValue                                         | String | Total value                                                                                         |
| data.detran.CE.totalLicensing                                                           | Object | Total licensing                                                                                     |
| data.detran.CE.totalLicensing.totalValue                                                | String | Total licensing value                                                                               |
| data.detran.MA                                                                          | Object | Object with the information of the state of Maranhão                                                |
| data.detran.MA.message                                                                  | String | Message about the vehicle                                                                           |
| data.detran.MA.plate                                                                    | String | Plate                                                                                               |
| data.detran.MA.renavam                                                                  | String | Renavam                                                                                             |
| data.detran.MA.previousPlate                                                            | String | Previous plate                                                                                      |
| data.detran.MA.type                                                                     | String | Type                                                                                                |
| data.detran.MA.bodywork                                                                 | String | Bodywork                                                                                            |
| data.detran.MA.species                                                                  | String | Species                                                                                             |
| data.detran.MA.ownerName                                                                | String | Owner name                                                                                          |
| data.detran.MA.brandModel                                                               | String | Brand model                                                                                         |
| data.detran.MA.color                                                                    | String | Color                                                                                               |
| data.detran.MA.category                                                                 | String | Category                                                                                            |
| data.detran.MA.places                                                                   | String | Places                                                                                              |
| data.detran.MA.power                                                                    | String | Power                                                                                               |
| data.detran.MA.fuel                                                                     | String | Fuel                                                                                                |
| data.detran.MA.licensedUntil                                                            | String | Licensed until                                                                                      |
| data.detran.MA.acquiredIn                                                               | String | Acquired in                                                                                         |
| data.detran.MA.SNGInformation                                                           | String | SNG information                                                                                     |
| data.detran.MA.impediments                                                              | String | Impediments                                                                                         |
| data.detran.MA.additionalInformation                                                    | String | Additional information                                                                              |
| data.detran.MA.debts.message                                                            | String | Message about the debts                                                                             |
| data.detran.MA.debts.debtsDetails                                                       | Array  | Debts details                                                                                       |
| data.detran.MA.debts.debtsDetails\[x].description                                       | String | Description                                                                                         |
| data.detran.MA.debts.debtsDetails\[x].dueDate                                           | String | Due date                                                                                            |
| data.detran.MA.debts.debtsDetails\[x].nominal                                           | String | Nominal                                                                                             |
| data.detran.MA.debts.debtsDetails\[x].corrected                                         | String | Corrected                                                                                           |
| data.detran.MA.debts.debtsDetails\[x].discount                                          | String | Discount                                                                                            |
| data.detran.MA.debts.debtsDetails\[x].interest                                          | String | Interest                                                                                            |
| data.detran.MA.debts.debtsDetails\[x].fine                                              | String | Fine                                                                                                |
| data.detran.MA.debts.debtsDetails\[x].current                                           | String | Current                                                                                             |
| data.detran.MA.autuations.message                                                       | String | Message about the autuations                                                                        |
| data.detran.MA.autuations.autuationsDetails                                             | Array  | Autuations details                                                                                  |
| data.detran.MA.autuations.autuationsDetails\[x].autoNumber                              | String | Auto number                                                                                         |
| data.detran.MA.autuations.autuationsDetails\[x].description                             | String | Description                                                                                         |
| data.detran.MA.autuations.autuationsDetails\[x].localComplement                         | String | Local complement                                                                                    |
| data.detran.MA.autuations.autuationsDetails\[x].value                                   | String | Value                                                                                               |
| data.detran.MA.fines.message                                                            | String | Message                                                                                             |
| data.detran.MA.fines.finesDetails                                                       | Array  | Fines details                                                                                       |
| data.detran.MA.fines.finesDetails\[x].autoNumber                                        | String | Auto number                                                                                         |
| data.detran.MA.fines.finesDetails\[x].description                                       | String | Description                                                                                         |
| data.detran.MA.fines.finesDetails\[x].localComplement                                   | String | Local complement                                                                                    |
| data.detran.MA.fines.finesDetails\[x].value                                             | String | Value                                                                                               |
| data.detran.MA.infractionAppeals.message                                                | String | Message about the infraction appeals                                                                |
| data.detran.MA.infractionAppeals.appealsDetails                                         | Array  | Appeals details                                                                                     |
| data.detran.MA.infractionAppeals.appealsDetails\[x].process                             | String | Process                                                                                             |
| data.detran.MA.infractionAppeals.appealsDetails\[x].renainfNumber                       | String | Renainf number                                                                                      |
| data.detran.MA.infractionAppeals.appealsDetails\[x].autoNumber                          | String | Auto number                                                                                         |
| data.detran.MA.infractionAppeals.appealsDetails\[x].infractionDetail                    | String | Infraction detail                                                                                   |
| data.detran.MA.infractionAppeals.appealsDetails\[x].processSituation                    | String | Process situation                                                                                   |
| data.detran.MG                                                                          | Object | Object with the information of the state of Minas Gerais                                            |
| data.detran.MG.hasAlert                                                                 | Number | Indicates if has any alert                                                                          |
| data.detran.MG.hasVehicleData                                                           | Number | Indicates if has vehicle data                                                                       |
| data.detran.MG.hasAutuation                                                             | Number | Indicates if has autuation                                                                          |
| data.detran.MG.hasFines                                                                 | Number | Indicates if has fines                                                                              |
| data.detran.MG.alert                                                                    | Array  | List of alerts                                                                                      |
| data.detran.MG.vehicleData                                                              | Object | Vehicle data                                                                                        |
| data.detran.MG.vehicleData.ipvaPaid                                                     | String | IPVA paid                                                                                           |
| data.detran.MG.vehicleData.installment                                                  | String | Installment                                                                                         |
| data.detran.MG.vehicleData.insurancePaid                                                | String | Insurance paid                                                                                      |
| data.detran.MG.vehicleData.insurancePaidInstallment                                     | String | Insurance paid installment                                                                          |
| data.detran.MG.vehicleData.previousInsurancePaid                                        | String | Previous insurance paid                                                                             |
| data.detran.MG.vehicleData.previousInsurancePaidInstallment                             | String | Previous insurance paid installment                                                                 |
| data.detran.MG.vehicleData.previousPlate                                                | String | Previous plate                                                                                      |
| data.detran.MG.vehicleData.city                                                         | String | City                                                                                                |
| data.detran.MG.vehicleData.previousCity                                                 | String | Previous city                                                                                       |
| data.detran.MG.vehicleData.manufactureYear                                              | String | Manufacture year                                                                                    |
| data.detran.MG.vehicleData.modelYear                                                    | String | Model year                                                                                          |
| data.detran.MG.vehicleData.brand                                                        | String | Brand                                                                                               |
| data.detran.MG.vehicleData.licensingFeePaid                                             | String | Licensing fee paid                                                                                  |
| data.detran.MG.vehicleData.licensingDate                                                | String | Licensing date                                                                                      |
| data.detran.MG.vehicleData.licensingSituation                                           | String | Licensing situation                                                                                 |
| data.detran.MG.autuation                                                                | Array  | Autuation                                                                                           |
| data.detran.MG.autuation\[x].agency                                                     | String | Agency                                                                                              |
| data.detran.MG.autuation\[x].quantity                                                   | Number | Quantity                                                                                            |
| data.detran.MG.fines                                                                    | Array  | Fines                                                                                               |
| data.detran.MG.fines\[x].agency                                                         | String | Agency                                                                                              |
| data.detran.MG.fines\[x].quantity                                                       | Number | Quantity                                                                                            |
| data.detran.MG.fines\[x].value                                                          | String | Value                                                                                               |
| data.detran.PE                                                                          | Object | Object with the information of the state of Pernambuco                                              |
| data.detran.PE.message                                                                  | String | Message about the vehicle                                                                           |
| data.detran.PE.plate                                                                    | String | Plate                                                                                               |
| data.detran.PE.type                                                                     | String | Type                                                                                                |
| data.detran.PE.model                                                                    | String | Model                                                                                               |
| data.detran.PE.powerCapacityCylinder                                                    | String | Power Capacity Cylinder                                                                             |
| data.detran.PE.color                                                                    | String | Color                                                                                               |
| data.detran.PE.chassis                                                                  | String | Chassis                                                                                             |
| data.detran.PE.fuel                                                                     | String | Fuel                                                                                                |
| data.detran.PE.manufactureModelYear                                                     | String | Manufacture Model Year                                                                              |
| data.detran.PE.category                                                                 | String | Category                                                                                            |
| data.detran.PE.installment                                                              | String | Installment                                                                                         |
| data.detran.PE.detranFees                                                               | String | Detran Fees                                                                                         |
| data.detran.PE.finesWithSuspensiveAppeal                                                | String | Fines With Suspensive Appeal                                                                        |
| data.detran.PE.infractionsSuspendedByCourtOrder                                         | String | Infractions Suspended By Court Order                                                                |
| data.detran.PE.debtsSuspendedByCourtOrder                                               | String | Debts Suspended By Court Order                                                                      |
| data.detran.PE.mandatoryInsurance                                                       | String | Mandatory Insurance                                                                                 |
| data.detran.PE.restrictions                                                             | Array  | Restrictions messages                                                                               |
| data.detran.PE.restrictionsDetails                                                      | Object | Restrictions details                                                                                |
| data.detran.PE.restrictionsDetails\[x].message                                          | String | Message                                                                                             |
| data.detran.PE.restrictionsDetails\[x].restrictions                                     | Array  | Restrictions                                                                                        |
| data.detran.PE.finesDetails                                                             | Object | Fines details                                                                                       |
| data.detran.PE.finesDetails.message                                                     | String | Message                                                                                             |
| data.detran.PE.finesDetails.details                                                     | Array  | Fines details                                                                                       |
| data.detran.PE.finesDetails.details\[x].hasFine                                         | String | Has Fine                                                                                            |
| data.detran.PE.finesDetails.details\[x].issuingAgencyName                               | String | Issuing Agency Name                                                                                 |
| data.detran.PE.finesDetails.details\[x].installment                                     | String | Installment                                                                                         |
| data.detran.PE.finesDetails.details\[x].dueDate                                         | String | Due Date                                                                                            |
| data.detran.PE.finesDetails.details\[x].realValue                                       | String | Real Value                                                                                          |
| data.detran.PE.finesDetails.details\[x].description                                     | String | Description                                                                                         |
| data.detran.PE.autuationsDetails                                                        | Object | Autuations details                                                                                  |
| data.detran.PE.autuationsDetails.message                                                | String | Message                                                                                             |
| data.detran.PE.autuationsDetails.details                                                | Array  | Autuations details                                                                                  |
| data.detran.PE.autuationsDetails.details\[x].hasAutuation                               | String | Has Autuation                                                                                       |
| data.detran.PE.autuationsDetails.details\[x].issuingAgencyName                          | String | Issuing Agency Name                                                                                 |
| data.detran.PE.autuationsDetails.details\[x].installment                                | String | Installment                                                                                         |
| data.detran.PE.autuationsDetails.details\[x].defenseIdentificationLimit                 | String | Defense Identification Limit                                                                        |
| data.detran.PE.autuationsDetails.details\[x].realValue                                  | String | Real Value                                                                                          |
| data.detran.PE.autuationsDetails.details\[x].description                                | String | Description                                                                                         |
| data.detran.PE.licensings                                                               | Object | Licensings details                                                                                  |
| data.detran.PE.licensings.message                                                       | String | Message                                                                                             |
| data.detran.PE.licensings.details                                                       | Array  | Licensings details                                                                                  |
| data.detran.PE.licensings.details\[x].hasLicensing                                      | String | Has Licensing                                                                                       |
| data.detran.PE.licensings.details\[x].debit                                             | String | Debit                                                                                               |
| data.detran.PE.licensings.details\[x].exercise                                          | String | Exercise                                                                                            |
| data.detran.PE.licensings.details\[x].installment                                       | String | Installment                                                                                         |
| data.detran.PE.licensings.details\[x].dueDate                                           | String | Due Date                                                                                            |
| data.detran.PE.licensings.details\[x].realValue                                         | String | Real Value                                                                                          |
| data.detran.PE.totalDebtsWithExceptionOfFinesSuspensiveAndAutuations                    | Object | Total Debts With Exception Of Fines Suspensive And Autuations                                       |
| data.detran.PE.totalDebtsWithExceptionOfFinesSuspensiveAndAutuations.totalInSingleQuota | String | Total In Single Quota                                                                               |
| data.detran.PE.totalDebtsWithExceptionOfFinesSuspensiveAndAutuations.totalInstallment   | String | Total Installment                                                                                   |
| data.detran.RO                                                                          | Object | Object with the information of the state of Rondônia                                                |
| data.detran.RO.message                                                                  | String | Message about the vehicle                                                                           |
| data.detran.RO.publicConsultation                                                       | Object | Public consultation data                                                                            |
| data.detran.RO.publicConsultation.plate                                                 | String | Plate                                                                                               |
| data.detran.RO.publicConsultation.brandModel                                            | String | Brand and model                                                                                     |
| data.detran.RO.publicConsultation.chassis                                               | String | Chassis                                                                                             |
| data.detran.RO.publicConsultation.color                                                 | String | Color                                                                                               |
| data.detran.RO.publicConsultation.manufactureYear                                       | String | Manufacture year                                                                                    |
| data.detran.RO.publicConsultation.cityUF                                                | String | City and State                                                                                      |
| data.detran.RO.publicConsultation.situation                                             | String | Situation                                                                                           |
| data.detran.RO.publicConsultation.detranMessage                                         | String | Detran message                                                                                      |
| data.detran.RO.additionalVehicleDebtsInformation                                        | Object | Additional vehicle debts information                                                                |
| data.detran.RO.additionalVehicleDebtsInformation.licensingYear                          | String | Licensing year                                                                                      |
| data.detran.RO.additionalVehicleDebtsInformation.information                            | String | Information                                                                                         |
| data.detran.RO.additionalVehicleDebtsInformation.pendingInformation                     | Array  | Pending information                                                                                 |
| data.detran.RO.additionalVehicleDebtsInformation.debts                                  | Array  | Debts                                                                                               |
| data.detran.RO.additionalVehicleDebtsInformation.debts\[x].description                  | String | Description                                                                                         |
| data.detran.RO.additionalVehicleDebtsInformation.debts\[x].dueDate                      | String | Due date                                                                                            |
| data.detran.RO.additionalVehicleDebtsInformation.debts\[x].value                        | String | Value                                                                                               |
| data.detran.RO.additionalVehicleDebtsInformation.debts\[x].corrected                    | String | Corrected                                                                                           |
| data.detran.RO.additionalVehicleDebtsInformation.debts\[x].discount                     | String | Discount                                                                                            |
| data.detran.RO.additionalVehicleDebtsInformation.debts\[x].interest                     | String | Interest                                                                                            |
| data.detran.RO.additionalVehicleDebtsInformation.debts\[x].fine                         | String | Fine                                                                                                |
| data.detran.RO.additionalVehicleDebtsInformation.debts\[x].currentValue                 | String | Current value                                                                                       |
| data.detran.RO.additionalVehicleDebtsInformation.restrictions                           | Array  | Restrictions                                                                                        |
| data.detran.RO.additionalVehicleDebtsInformation.restrictions\[x].message               | String | Message                                                                                             |
| data.detran.RO.additionalVehicleDebtsInformation.restrictions\[x].restrictionSituation  | String | Restriction situation                                                                               |
| data.detran.RO.additionalVehicleDebtsInformation.restrictions\[x].impacts               | Array  | Impacts                                                                                             |
| data.detran.RJ                                                                          | Object | Object with the information of the state of Rio de Janeiro                                          |
| data.detran.RJ.message                                                                  | String | Message about the vehicle                                                                           |
| data.detran.RJ.fines                                                                    | Array  | Array of fines                                                                                      |
| data.detran.RJ.fines\[x].type                                                           | String | Type of fine                                                                                        |
| data.detran.RJ.fines\[x].infractionAuto                                                 | String | Infraction auto                                                                                     |
| data.detran.RJ.fines\[x].autoRenainf                                                    | String | Auto Renainf                                                                                        |
| data.detran.RJ.fines\[x].paymentDateWithDiscount                                        | String | Payment date with discount                                                                          |
| data.detran.RJ.fines\[x].infractionEnrollment                                           | String | Infraction enrollment                                                                               |
| data.detran.RJ.fines\[x].infractionDate                                                 | String | Infraction date                                                                                     |
| data.detran.RJ.fines\[x].hour                                                           | String | Hour                                                                                                |
| data.detran.RJ.fines\[x].description                                                    | String | Description                                                                                         |
| data.detran.RJ.fines\[x].relatedPlate                                                   | String | Related plate                                                                                       |
| data.detran.RJ.fines\[x].infractionLocation                                             | String | Infraction location                                                                                 |
| data.detran.RJ.fines\[x].originalValue                                                  | String | Original value                                                                                      |
| data.detran.RJ.fines\[x].valueToBePaid                                                  | String | Value to be paid                                                                                    |
| data.detran.RJ.fines\[x].paymentStatus                                                  | String | Payment status                                                                                      |
| data.detran.RJ.fines\[x].issuingAgency                                                  | String | Issuing agency                                                                                      |
| data.detran.RJ.fines\[x].issuingAgent                                                   | String | Issuing agent                                                                                       |
| data.detran.RR                                                                          | Object | Object with the information of the state of Roraima                                                 |
| data.detran.RR.brandModel                                                               | String | Brand and model of the vehicle                                                                      |
| data.detran.RR.category                                                                 | String | Category of the vehicle                                                                             |
| data.detran.RR.chassis                                                                  | String | Chassis of the vehicle                                                                              |
| data.detran.RR.city                                                                     | String | City of the vehicle                                                                                 |
| data.detran.RR.color                                                                    | String | Color of the vehicle                                                                                |
| data.detran.RR.debts                                                                    | Object | Debts                                                                                               |
| data.detran.RR.debts.message                                                            | String | Message about the debts                                                                             |
| data.detran.RR.debts.totalDebts                                                         | Array  | Array with the debts details                                                                        |
| data.detran.RR.debts.totalDebts\[x].debtsDetails                                        | Array  | Array with the debts details                                                                        |
| data.detran.RR.debts.totalDebts\[x].debtsDetails\[x].debt                               | String | Debt                                                                                                |
| data.detran.RR.debts.totalDebts\[x].debtsDetails\[x].dueDate                            | String | Due date of the debt                                                                                |
| data.detran.RR.debts.totalDebts\[x].debtsDetails\[x].value                              | String | Value of the debt                                                                                   |
| data.detran.RR.debts.totalDebts\[x].description                                         | String | Description of the debt                                                                             |
| data.detran.RR.debts.totalDebts\[x].totalDescription                                    | String | Total description of the debt                                                                       |
| data.detran.RR.debts.totalDebts\[x].totalValue                                          | String | Total value of the debt                                                                             |
| data.detran.RR.fuel                                                                     | String | Fuel of the vehicle                                                                                 |
| data.detran.RR.hasTheft                                                                 | String | If the vehicle has theft register                                                                   |
| data.detran.RR.infractions                                                              | Object | Infractions                                                                                         |
| data.detran.RR.infractions.infractionsDetails                                           | Array  | Array with the infractions details                                                                  |
| data.detran.RR.infractions.infractionsDetails\[x].quantity                              | String | Quantity of infractions                                                                             |
| data.detran.RR.infractions.infractionsDetails\[x].situation                             | String | Situation of the infraction                                                                         |
| data.detran.RR.infractions.infractionsDetails\[x].value                                 | String | Value of the infraction                                                                             |
| data.detran.RR.infractions.infractionsDetails\[x].valueWithDiscount                     | String | Value of the infraction with discount                                                               |
| data.detran.RR.infractions.message                                                      | String | Message about the infractions                                                                       |
| data.detran.RR.infractions.totalDescription                                             | String | Total description of the infractions                                                                |
| data.detran.RR.infractions.totalQuantity                                                | String | Total quantity of the infractions                                                                   |
| data.detran.RR.infractions.totalValue                                                   | String | Total value of the infractions                                                                      |
| data.detran.RR.lastLicensing                                                            | String | Last licensing of the vehicle                                                                       |
| data.detran.RR.manufactureYear                                                          | String | Manufacture year of the vehicle                                                                     |
| data.detran.RR.message                                                                  | String | Message about the vehicle                                                                           |
| data.detran.RR.nationality                                                              | String | Nationality                                                                                         |
| data.detran.RR.passengerCapacity                                                        | String | Passenger capacity                                                                                  |
| data.detran.RR.plate                                                                    | String | Plate                                                                                               |
| data.detran.RR.powerCapacity                                                            | String | Power capacity                                                                                      |
| data.detran.RR.renavam                                                                  | String | Renavam                                                                                             |
| data.detran.RR.restrictions                                                             | Array  | Restrictions                                                                                        |
| data.detran.RR.services                                                                 | Object | Services                                                                                            |
| data.detran.RR.services.message                                                         | String | Message about the services                                                                          |
| data.detran.RR.services.servicesDetails                                                 | Array  | Array with the services details                                                                     |
| data.detran.RR.services.servicesDetails\[x].date                                        | String | Date of the service                                                                                 |
| data.detran.RR.services.servicesDetails\[x].dueValue                                    | String | Due value of the service                                                                            |
| data.detran.RR.services.servicesDetails\[x].paidValue                                   | String | Paid value of the service                                                                           |
| data.detran.RR.services.servicesDetails\[x].service                                     | String | Service                                                                                             |
| data.detran.RR.services.servicesDetails\[x].serviceValue                                | String | Value of the service                                                                                |
| data.detran.RR.services.totalDescription                                                | String | Total description of the services                                                                   |
| data.detran.RR.services.totalDueValue                                                   | String | Total due value of the services                                                                     |
| data.detran.RR.services.totalPaidValue                                                  | String | Total paid value of the services                                                                    |
| data.detran.RR.services.totalServiceValue                                               | String | Total value of the services                                                                         |
| data.detran.RR.species                                                                  | String | Species of the vehicle                                                                              |
| data.detran.RR.type                                                                     | String | Type of the vehicle                                                                                 |
| data.detran.RR.vehicleSituation                                                         | String | Vehicle situation                                                                                   |
| data.detran.SC                                                                          | Object | Object with the information of the state of Santa Catarina                                          |
| data.detran.SC.stampAuthorization.message                                               | Object | Stamp authorization                                                                                 |
| data.detran.SC.stampAuthorization.message                                               | String | Message                                                                                             |
| data.detran.SC.stampAuthorization.lastStampAuthorization                                | String | Last stamp authorization                                                                            |
| data.detran.SC.debtsList.message                                                        | Object | Debts list                                                                                          |
| data.detran.SC.debtsList.message                                                        | String | Message                                                                                             |
| data.detran.SC.debtsList.finesList                                                      | Array  | Fines list                                                                                          |
| data.detran.SC.debtsList.finesList\[x].class                                            | String | Class                                                                                               |
| data.detran.SC.debtsList.finesList\[x].detranNetNumber                                  | String | Detran net number                                                                                   |
| data.detran.SC.debtsList.finesList\[x].dueDate                                          | String | Due date                                                                                            |
| data.detran.SC.debtsList.finesList\[x].nominalValue                                     | String | Nominal value                                                                                       |
| data.detran.SC.debtsList.finesList\[x].fine                                             | String | Fine                                                                                                |
| data.detran.SC.debtsList.finesList\[x].interest                                         | String | Interest                                                                                            |
| data.detran.SC.debtsList.finesList\[x].currentValue                                     | String | Current value                                                                                       |
| data.detran.SC.debtsList.totalDebts                                                     | String | Total debts                                                                                         |
| data.detran.SC.debtsList.detranFee                                                      | String | Detran fee                                                                                          |
| data.detran.SC.debtsList.dpvatInsurance                                                 | String | Dpvat insurance                                                                                     |
| data.detran.SC.debtsList.ipva                                                           | String | Ipva                                                                                                |
| data.detran.SC.debtsList.fines                                                          | String | Fines                                                                                               |
| data.detran.SC.notifiedInfractionHistory                                                | Object | Notified infraction history                                                                         |
| data.detran.SC.notifiedInfractionHistory.message                                        | String | Message                                                                                             |
| data.detran.SC.notifiedInfractionHistory.notifiedInfractions                            | Array  | Notified infractions                                                                                |
| data.detran.SC.notifiedInfractionHistory.notifiedInfractions\[x].autoNumber             | String | Auto number                                                                                         |
| data.detran.SC.notifiedInfractionHistory.notifiedInfractions\[x].description            | String | Description                                                                                         |
| data.detran.SC.notifiedInfractionHistory.notifiedInfractions\[x].localComplement        | String | Local complement                                                                                    |
| data.detran.SC.autuationInfractions                                                     | Object | Autuation infractions                                                                               |
| data.detran.SC.autuationInfractions.message                                             | String | Message                                                                                             |
| data.detran.SC.autuationInfractions.infractions                                         | Array  | Infractions                                                                                         |
| data.detran.SC.autuationInfractions.infractions\[x].autoNumber                          | String | Auto number                                                                                         |
| data.detran.SC.autuationInfractions.infractions\[x].description                         | String | Description                                                                                         |
| data.detran.SC.autuationInfractions.infractions\[x].localComplement                     | String | Local complement                                                                                    |
| data.detran.SC.finesList                                                                | Object | Fines list                                                                                          |
| data.detran.SC.finesList.message                                                        | String | Message                                                                                             |
| data.detran.SC.finesList.fines                                                          | Array  | Fines                                                                                               |
| data.detran.SC.finesList.fines\[x].autoNumber                                           | String | Auto number                                                                                         |
| data.detran.SC.finesList.fines\[x].description                                          | String | Description                                                                                         |
| data.detran.SC.finesList.fines\[x].localComplement                                      | String | Local complement                                                                                    |
| data.detran.SC.lastProcess                                                              | Object | Last process                                                                                        |
| data.detran.SC.lastProcess.process                                                      | String | Process                                                                                             |
| data.detran.SC.lastProcess.interested                                                   | String | Interested                                                                                          |
| data.detran.SC.lastProcess.startIn                                                      | String | Start in                                                                                            |
| data.detran.SC.lastProcess.situation                                                    | String | Situation                                                                                           |
| data.detran.SC.lastProcess.endIn                                                        | String | End in                                                                                              |
| data.detran.SC.lastProcess.history                                                      | Array  | History                                                                                             |
| data.detran.SC.lastProcess.history\[x].service                                          | String | Service                                                                                             |
| data.detran.SC.lastProcess.history\[x].executionIn                                      | String | Execution in                                                                                        |
| data.detran.SC.lastProcess.invoiceIssuer                                                | String | Invoice issuer                                                                                      |
| data.detran.SC.lastProcess.issuerDocumentUF                                             | String | Issuer document UF                                                                                  |
| data.detran.SC.lastProcess.emissionDate                                                 | String | Emission date                                                                                       |
| data.detran.SC.lastProcess.invoiceValue                                                 | String | Invoice value                                                                                       |
| data.detran.SC.infractionAppeals                                                        | Object | Infraction appeals                                                                                  |
| data.detran.SC.infractionAppeals.message                                                | String | Message                                                                                             |
| data.detran.SC.infractionAppeals.appeals                                                | Array  | Appeals                                                                                             |
| data.detran.SC.infractionAppeals.appeals\[x].process                                    | String | Process                                                                                             |
| data.detran.SC.infractionAppeals.appeals\[x].autoNumber                                 | String | Auto number                                                                                         |
| data.detran.SC.infractionAppeals.appeals\[x].infractionDetail                           | String | Infraction detail                                                                                   |
| data.detran.SC.infractionAppeals.appeals\[x].processResult                              | String | Process result                                                                                      |
| data.detran.SC.CEDONotificationEdicts                                                   | Object | CEDO notification edicts                                                                            |
| data.detran.SC.CEDONotificationEdicts.message                                           | String | Message                                                                                             |
| data.detran.SC.CEDONotificationEdicts.notifications                                     | Array  | Notifications                                                                                       |
| data.detran.SC.CEDONotificationEdicts.notifications\[x].edict                           | String | Edict                                                                                               |
| data.detran.SC.CEDONotificationEdicts.notifications\[x].infractionAuto                  | String | Infraction auto                                                                                     |
| data.detran.SC.CEDONotificationEdicts.notifications\[x].notificationType                | String | Notification type                                                                                   |
| data.detran.SC.CEDONotificationEdicts.notifications\[x].publicationDate                 | String | Publication date                                                                                    |
| data.detran.SE                                                                          | Object | Object with the information of the state of Sergipe                                                 |
| data.detran.SE.message                                                                  | String | Message about the vehicle                                                                           |
| data.detran.SE.identification                                                           | Object | Identification                                                                                      |
| data.detran.SE.identification.renavam                                                   | String | Renavam                                                                                             |
| data.detran.SE.identification.plate                                                     | String | Plate                                                                                               |
| data.detran.SE.identification.owner                                                     | String | Owner                                                                                               |
| data.detran.SE.personalData                                                             | Object | Personal Data                                                                                       |
| data.detran.SE.personalData.cpfCnpj                                                     | String | CPF/CNPJ                                                                                            |
| data.detran.SE.personalData.owner                                                       | String | Owner                                                                                               |
| data.detran.SE.personalData.previousOwner                                               | String | Previous Owner                                                                                      |
| data.detran.SE.vehicleData                                                              | Object | Vehicle Data                                                                                        |
| data.detran.SE.vehicleData.currentPlate                                                 | String | Current Plate                                                                                       |
| data.detran.SE.vehicleData.previousPlate                                                | String | Previous Plate                                                                                      |
| data.detran.SE.vehicleData.city                                                         | String | City                                                                                                |
| data.detran.SE.vehicleData.species                                                      | String | Species                                                                                             |
| data.detran.SE.vehicleData.type                                                         | String | Type                                                                                                |
| data.detran.SE.vehicleData.fuel                                                         | String | Fuel                                                                                                |
| data.detran.SE.vehicleData.acquisitionDate                                              | String | Acquisition Date                                                                                    |
| data.detran.SE.vehicleData.brandModel                                                   | String | Brand Model                                                                                         |
| data.detran.SE.vehicleData.manufactureYear                                              | String | Manufacture Year                                                                                    |
| data.detran.SE.vehicleData.modelYear                                                    | String | Model Year                                                                                          |
| data.detran.SE.vehicleData.capacity                                                     | String | Capacity                                                                                            |
| data.detran.SE.vehicleData.power                                                        | String | Power                                                                                               |
| data.detran.SE.vehicleData.category                                                     | String | Category                                                                                            |
| data.detran.SE.vehicleData.predominantColor                                             | String | Predominant Color                                                                                   |
| data.detran.SE.vehicleData.sealNumber                                                   | String | Seal Number                                                                                         |
| data.detran.SE.vehicleData.csvNumber                                                    | String | CSV Number                                                                                          |
| data.detran.SE.vehicleSituation                                                         | Object | Vehicle Situation                                                                                   |
| data.detran.SE.vehicleSituation.lastPaidExercise                                        | String | Last Paid Exercise                                                                                  |
| data.detran.SE.vehicleSituation.lastEmissionDate                                        | String | Last Emission Date                                                                                  |
| data.detran.SE.vehicleSituation.theftTheftRestriction                                   | String | Theft Theft Restriction                                                                             |
| data.detran.SE.vehicleSituation.CRLVeObservations                                       | String | CRLVe Observations                                                                                  |
| data.detran.SE.vehicleSituation.restrictions                                            | Array  | Restrictions                                                                                        |
| data.detran.SE.vehicleDriver                                                            | Object | Vehicle Driver                                                                                      |
| data.detran.SE.vehicleDriver.message                                                    | String | Message                                                                                             |
| data.detran.SE.vehicleDriver.name                                                       | String | Name                                                                                                |
| data.detran.SE.vehicleDriver.cpf                                                        | String | CPF                                                                                                 |
| data.detran.SE.vehicleDriver.category                                                   | String | Category                                                                                            |
| data.detran.SE.vehicleDriver.activationDate                                             | String | Activation Date                                                                                     |
| data.detran.SE.debts                                                                    | Object | Debts                                                                                               |
| data.detran.SE.debts.message                                                            | String | Message                                                                                             |
| data.detran.SE.debts.debtsDescription                                                   | Array  | Debts Description                                                                                   |
| data.detran.SE.debts.debtsDescription\[x].fee                                           | String | Fee                                                                                                 |
| data.detran.SE.debts.debtsDescription\[x].singleQuota                                   | String | Single Quota                                                                                        |
| data.detran.SE.debts.totalValue                                                         | String | Total Value                                                                                         |
| data.detran.SE.debts.pending                                                            | Array  | Pending                                                                                             |
| data.detran.SE.fines                                                                    | Object | Fines                                                                                               |
| data.detran.SE.fines.finesDescription                                                   | Array  | Fines Description                                                                                   |
| data.detran.SE.fines.finesDescription\[x].auto                                          | String | Auto                                                                                                |
| data.detran.SE.fines.finesDescription\[x].infractionDate                                | String | Infraction Date                                                                                     |
| data.detran.SE.fines.finesDescription\[x].issuingAgency                                 | String | Issuing Agency                                                                                      |
| data.detran.SE.fines.finesDescription\[x].competence                                    | String | Competence                                                                                          |
| data.detran.SE.fines.finesDescription\[x].situation                                     | String | Situation                                                                                           |
| data.detran.SE.fines.finesDescription\[x].value                                         | String | Value                                                                                               |
| data.detran.SE.fines.totalValue                                                         | String | Total Value                                                                                         |
| data.detran.SE.processes                                                                | Array  | Processes                                                                                           |
| data.detran.SE.processes\[x].protocol                                                   | String | Protocol                                                                                            |
| data.detran.SE.processes\[x].service                                                    | String | Service                                                                                             |
| data.detran.SE.processes\[x].creationDate                                               | String | Creation Date                                                                                       |
| data.detran.SE.processes\[x].situation                                                  | String | Situation                                                                                           |
| {% endtab %}                                                                            |        |                                                                                                     |

{% tab title="Example" %}

```json
{
  "statusCode": "01",
  "message": "Consulta realizada com sucesso.",
  "data": {
    "plate": "XYZ9876",
    "chassis": "9BWZZZ377VT004252",
    "chassisSituation": "Normal",
    "renavam": "987654321",
    "origin": "Nacional",
    "cmtVehicle": "Caminhão",
    "srfAgencyCode": "456",
    "engineCapacity": "2500",
    "vehicleCategory": "Passeio",
    "vehicleType": "Automóvel",
    "vehicleKind": "SUV",
    "vehicleColor": "Branco",
    "vehicleFuel": "Diesel",
    "vehiclePower": "200",
    "vehicleImportOperationType": "Importado",
    "passengersQuantity": "7",
    "gearBox": "Automático",
    "modelBrand": "Toyota",
    "modelYear": "2021",
    "manufactureYear": "2020",
    "quantityAxles": "2",
    "auxiliaryAxeNumber": "0",
    "rearAxeNumber": "1",
    "engineNumber": "987654321",
    "loadCapacity": "700",
    "bodyworkName": "Fechada",
    "bodyworkNumber": "1",
    "bodyworkType": "Monobloco",
    "assemblyType": "Nacional",
    "redaNumber": "654321",
    "pbtVehicle": "4000",
    "city": "Rio de Janeiro",
    "state": "RJ",
    "registrationDate": "2021-01-01",
    "situation": "Regular",
    "taxRestrictionLimitDate": "2022-12-31",
    "ownerName": "Maria Oliveira",
    "ownerDocumentType": "CPF",
    "ownerIdentificationNumber": "987.654.321-00",
    "diNumber": "987654321",
    "diRegistrationDate": "2021-01-01",
    "identificationNumberBilling": "987654321",
    "importProcessNumber": "987654321",
    "importerIdentificationNumber": "987.654.321-00",
    "importerDocumentType": "CNPJ",
    "billingDocumentType": "Nota Fiscal",
    "billingDestinationState": "RJ",
    "restrictionAgentName": "Banco ABC",
    "tenantRestriction": "Leasing",
    "inclusionDateRestriction": "2021-01-01",
    "tenantDocumentRestriction": "987.654.321-00",
    "updateDate": "2022-01-01",
    "additionalInformation": [
      {
        "description": "Observação",
        "value": "Veículo em perfeito estado"
      },
      {
        "description": "Seguro",
        "value": "Pago até 2022"
      },
      {
        "description": "Revisão",
        "value": "Última revisão em 2022"
      },
      {
        "description": "Multas",
        "value": "Sem multas pendentes"
      },
      {
        "description": "Licenciamento",
        "value": "Licenciado até 2022"
      }
    ],
    "restrictions": {
      "hasFinancialRestriction": "true",
      "hasGeneralRestriction": "true",
      "hasRenajudRestriction": "false",
      "hasTheftRegister": "false",
      "decommissionedVehicle": "false",
      "financing": {
        "financing.financialCgc": "12345678000123",
        "financing.agentCode": "001",
        "financing.inclusionDate": "2020-01-01",
        "financing.contractValidityDate": "2025-01-01",
        "financing.financialAgentName": "Banco XYZ",
        "financing.financedName": "João da Silva",
        "financing.financedCpfCnpj": "123.456.789-00",
        "financing.contractNumber": "123456789",
        "financing.financingRestrictionType": "Leasing",
        "financing.transactionType": "Financiamento"
      },
      "renajud": {
        "renajud.date": "2020-01-01",
        "renajud.type": "Judicial",
        "renajud.court": "Tribunal de Justiça",
        "renajud.judicialAgency": "TJSP",
        "renajud.process": "123456789"
      },
      "messages": [
        {
          "message": "Existem restrições financeiras e gerais pendentes"
        }
      ],
      "ipva": {
        "hasPending": "true",
        "pendingValue": "500.00"
      },
      "dpvat": {
        "hasPending": "true",
        "pendingValue": "100.00"
      },
      "fines": {
        "hasPending": "true",
        "pendingValue": "200.00"
      },
      "licensing": {
        "hasPending": "true",
        "pendingValue": "150.00"
      }
    },
    "prf": {
      "prfStatus": ["Regular"],
      "fines": [
        {
          "documentNumber": "654321",
          "valueWithoutCalculations": "200.00",
          "violation": "Excesso de velocidade",
          "plate": "XYZ9876",
          "state": "RJ",
          "violationDate": "2021-06-01",
          "aiNumber": "654321"
        }
      ],
      "hasFines": 1,
      "hasStatus": 1
    },
    "sefaz": {
      "SP": {
        "totalDebts": "300.00",
        "vehicle": {
          "renavam": "987654321",
          "kind": "SUV",
          "plate": "XYZ9876",
          "category": "Passeio",
          "modelBrand": "Toyota",
          "type": "Automóvel",
          "ipvaRange": "2022",
          "passengers": "7",
          "manufactureYear": "2020",
          "bodywork": "Fechada",
          "city": "Rio de Janeiro",
          "lastLicensing": "2022",
          "fuel": "Diesel",
          "saleCommunication": "2021-01-01",
          "saleDate": "2021-01-01",
          "communicationDate": "2021-01-01"
        },
        "ipva": {
          "calculationBase": "20000.00",
          "aliquot": "4%",
          "calculatedIpva": "800.00",
          "paulistaFiscalNoteCredit": "50.00",
          "dueIpva": "750.00",
          "paymentMade": "450.00",
          "discountsOtherDeductions": "50.00",
          "balance": "250.00",
          "legalAdditions": "0.00",
          "toPayValue": "250.00",
          "debtsPayment": [
            {
              "availableModalities": "Parcelado",
              "dueDate": "2022-12-31",
              "value": "250.00"
            }
          ],
          "debtsNotRegistered": [
            {
              "exercise": "2022",
              "value": "250.00"
            }
          ],
          "registeredDebts": {
            "exercise": "2022"
          }
        },
        "dpvat": [
          {
            "exercise": "2022",
            "value": "100.00"
          }
        ],
        "taxes": [
          {
            "description": "Taxa de Licenciamento",
            "value": "150.00"
          }
        ],
        "fines": {
          "totalQuantity": "2",
          "totalValue": "350.00",
          "fines": [
            {
              "agency": "PRF",
              "quantity": "1",
              "value": "200.00"
            },
            {
              "agency": "DNIT",
              "quantity": "1",
              "value": "150.00"
            }
          ],
          "detailFines": [
            {
              "violation": "Excesso de velocidade",
              "city": "Rio de Janeiro",
              "location": "Rodovia BR-101",
              "date": "2021-06-01",
              "nuAIT": "654321",
              "guideNumber": "654321",
              "revenue": "Multa",
              "dueDate": "2021-07-01",
              "value": "200.00"
            },
            {
              "violation": "Estacionamento irregular",
              "city": "Rio de Janeiro",
              "location": "Avenida Atlântica",
              "date": "2021-07-01",
              "nuAIT": "123456",
              "guideNumber": "123456",
              "revenue": "Multa",
              "dueDate": "2021-08-01",
              "value": "150.00"
            }
          ]
        }
      }
    },
    "detran": {
      "RJ": {
        "message": "Nenhuma multa pendente",
        "fines": [
          {
            "type": "Grave",
            "infractionAuto": "123456",
            "autoRenainf": "654321",
            "paymentDateWithDiscount": "2023-01-01",
            "infractionEnrollment": "789012",
            "infractionDate": "2022-12-01",
            "hour": "14:00",
            "description": "Excesso de velocidade",
            "relatedPlate": "XYZ9876",
            "infractionLocation": "Rodovia BR-116",
            "originalValue": "200.00",
            "valueToBePaid": "150.00",
            "paymentStatus": "Pago",
            "issuingAgency": "DETRAN-RJ",
            "issuingAgent": "Agente 001"
          }
        ]
      }
    }
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                                       | Description                                           |
| ------------------------------------------ | ----------------------------------------------------- |
| vehicle\_has\_pending\_traffic\_violations | Checks if the vehicle has pending traffic violations. |
| {% endtab %}                               |                                                       |
| {% endtabs %}                              |                                                       |

## VIO - Document Verification via QR Code - NEW

A validation service that cross-references data decoded from the Vio QR Code with information extracted via OCR from the CRLV, identifying potential discrepancies between the sources. A digital or high-resolution scanned copy of the Vehicle Registration and Licensing Certificate (CRLV) is required. The file must contain a legible Vio QR Code and clear text for OCR processing. Although image formats may be supported, PDF is the preferred format to ensure optimal data extraction accuracy and document integrity.

**Section:** `vioQrcodeDecoder`

**Required parameters:** `CRLV Document`

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

| Attribute                               | Type    | Description                                                                                         |
| --------------------------------------- | ------- | --------------------------------------------------------------------------------------------------- |
| statusCode                              | String  | Query status ([details](/caf-api/connect/transactions/background-check/data-structure#status-code)) |
| message                                 | String  | Description of the query status                                                                     |
| data                                    | Object  | Return data                                                                                         |
| data.vioDecodedData                     | Object  | Information extracted directly from the Vio QR Code                                                 |
| data.vioDecodedData.crlvNumber          | String  | CRLV (Vehicle Registration) number                                                                  |
| data.vioDecodedData.crvNumber           | String  | CRV number                                                                                          |
| data.vioDecodedData.issueState          | String  | State (UF) where the document was issued                                                            |
| data.vioDecodedData.renavam             | String  | Vehicle's National Registry Number (RENAVAM)                                                        |
| data.vioDecodedData.assignmentYear      | String  | Licensing/Assignment year                                                                           |
| data.vioDecodedData.name                | String  | Owner's full name                                                                                   |
| data.vioDecodedData.cpfCnpj             | String  | Owner's tax ID (CPF or CNPJ)                                                                        |
| data.vioDecodedData.plate               | String  | Vehicle license plate                                                                               |
| data.vioDecodedData.chassis             | String  | Vehicle chassis number                                                                              |
| data.vioDecodedData.vehicleCategory     | String  | Vehicle category                                                                                    |
| data.vioDecodedData.vehicleType         | String  | Vehicle type                                                                                        |
| data.vioDecodedData.body                | String  | Vehicle body type                                                                                   |
| data.vioDecodedData.fuel                | String  | Type of fuel used by the vehicle                                                                    |
| data.vioDecodedData.manufactureYear     | String  | Year of manufacture                                                                                 |
| data.vioDecodedData.modelYear           | String  | Vehicle model year                                                                                  |
| data.vioDecodedData.brandAndModel       | String  | Brand and model description                                                                         |
| data.vioDecodedData.capacityInPeople    | String  | Total seating capacity                                                                              |
| data.vioDecodedData.horsepower          | String  | Engine power in HP                                                                                  |
| data.vioDecodedData.displacement        | String  | Engine displacement (cc)                                                                            |
| data.vioDecodedData.category            | String  | Usage category                                                                                      |
| data.vioDecodedData.predominantColor    | String  | Predominant vehicle color                                                                           |
| data.vioDecodedData.motor               | String  | Engine serial number                                                                                |
| data.vioDecodedData.capacityInWeight    | String  | Maximum weight capacity                                                                             |
| data.vioDecodedData.weight              | String  | Gross vehicle weight                                                                                |
| data.vioDecodedData.cmt                 | String  | Maximum Traction Capacity (CMT)                                                                     |
| data.vioDecodedData.axles               | String  | Number of vehicle axles                                                                             |
| data.vioDecodedData.issuePlace          | String  | City where the document was issued                                                                  |
| data.vioDecodedData.issueDate           | String  | Date of issuance (DD/MM/YYYY)                                                                       |
| data.vioDecodedData.rntrc               | String  | National Registry of Road Freight Haulers (if applicable)                                           |
| data.vioDecodedData.vehicleObservations | String  | Additional remarks or observations                                                                  |
| data.vioValidation                      | Object  | Results of the cross-check between OCR and QR Code data                                             |
| data.vioValidation.crlvNumber           | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.crvNumber            | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.issueState           | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.renavam              | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.assignmentYear       | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.name                 | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.cpfCnpj              | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.plate                | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.chassis              | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.vehicleCategory      | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.vehicleType          | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.body                 | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.fuel                 | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.manufactureYear      | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.modelYear            | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.brandAndModel        | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.capacityInPeople     | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.horsepower           | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.displacement         | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.category             | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.predominantColor     | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.motor                | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.capacityInWeight     | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.weight               | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.cmt                  | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.axles                | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.issuePlace           | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.issueDate            | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.rntrc                | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| data.vioValidation.vehicleObservations  | Boolean | Returns true if the OCR data matches the Vio QR Code data, and false if a discrepancy is found      |
| {% endtab %}                            |         |                                                                                                     |

{% tab title="Example" %}

```json
{
  "vioQrcodeDecoder": {
    "statusCode": "01",
    "message": "Validação de dados realizada com sucesso.",
    "data": {
      "vioDecodedData": {
        "crlvNumber": "00000000000",
        "crvNumber": "000000000000",
        "issueState": "SP",
        "renavam": "01234567890",
        "assignmentYear": "2026",
        "name": "JOHN DOE / JOSÉ DA SILVA",
        "cpfCnpj": "000.000.000-00",
        "plate": "ABC1D23",
        "chassis": "9BWZZZ000ZZ000000",
        "vehicleCategory": "PASSAGEIRO",
        "vehicleType": "AUTOMOVEL",
        "body": "NÃO APLICAVEL",
        "fuel": "GASOLINA/ALCOOL",
        "manufactureYear": "2024",
        "modelYear": "2025",
        "brandAndModel": "VOLKSWAGEN/GOL 1.0",
        "capacityInPeople": "5",
        "horsepower": "82",
        "displacement": "1000",
        "category": "PARTICULAR",
        "predominantColor": "BRANCA",
        "motor": "ABC0123456",
        "capacityInWeight": "0.0",
        "weight": "1.2",
        "cmt": "2.0",
        "axles": "4",
        "issuePlace": "SAO PAULO",
        "issueDate": "21/01/2026",
        "rntrc": "",
        "vehicleObservations": "SEM OBSERVACOES"
      },
      "vioValidation": {
        "crlvNumber": true,
        "crvNumber": true,
        "issueState": true,
        "renavam": true,
        "assignmentYear": true,
        "name": true,
        "cpfCnpj": true,
        "plate": true,
        "chassis": true,
        "vehicleCategory": true,
        "vehicleType": true,
        "body": true,
        "fuel": true,
        "manufactureYear": true,
        "modelYear": true,
        "brandAndModel": true,
        "capacityInPeople": true,
        "horsepower": true,
        "displacement": true,
        "category": true,
        "predominantColor": true,
        "motor": true,
        "capacityInWeight": true,
        "weight": true,
        "cmt": true,
        "axles": true,
        "issuePlace": true,
        "issueDate": true,
        "rntrc": true,
        "vehicleObservations": true
      }
    }
  }
}
```

{% endtab %}

{% tab title="Validations Rules" %}

| Rule                              | Description                                                                                                |
| --------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| vio\_qrcode\_decoder\_validations | Flags discrepancies between OCR results and encrypted QR data to detect tampering or transcription errors. |
| vio\_expiration\_date\_validation | Verifies licensing status by cross-referencing the exercise year with state-specific calendars.            |
| {% endtab %}                      |                                                                                                            |
| {% endtabs %}                     |                                                                                                            |


# Authentication

Certta's authentication system allows applications to securely integrate with the `APIs`, using the `OAuth2` standard to obtain access tokens. Each registered application receives a **Client ID** and **Client Secret**, and can be assigned specific permissions to access different resources.

## Topics

* [Applications](/caf-api/connect/authentication/applications)
* [Certificates](/caf-api/connect/authentication/certificates)
* [Using mTLS](/caf-api/connect/authentication/using-mtls)
* [Authenticating](/caf-api/connect/authentication/authenticating)

Refer to each section for details on the registration process, authentication, and permission management for applications.


# Applications

Applications allow you to integrate your services with Certta `APIs`, enabling secure communication and controlled access to various functionalities. Each application generates a unique Client ID and Client Secret and allows you to define specific permissions for `API` access.

## Topics

* [Creating an Application](/caf-api/connect/authentication/applications/creating-application)
* [Managing Applications](/caf-api/connect/authentication/applications/managing-applications)
* [Available Permissions](/caf-api/connect/authentication/applications/available-permissions)


# Creating an Application

To create an application, follow these steps:

1. **Log in to the Trust portal**:
   * Navigate to the Trust portal and authenticate with your credentials.
2. **Navigate to API Configurations**:
   * From the dashboard, locate the navigation menu.
   * Click on **Settings** (gear icon) in the menu.
   * Select **API Configurations** from the menu.

![API Configurations](https://3218940882-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVxCOSyBojfSIE5fcpfH%2Fuploads%2Fgit-blob-354fa561c66f21faecc8c4cee0a67721ceb0292d%2FAPI_Configurations.png?alt=media)

3. **Access Applications Section**:
   * Once on the **API configurations** page, ensure the **Applications** tab is selected. This page will display any existing applications or show "No applications found" if you haven't created any yet.

![Applications Tab](https://3218940882-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVxCOSyBojfSIE5fcpfH%2Fuploads%2Fgit-blob-ada28c66f75ef9f5a5e0aae38e948f320360dfe4%2FApplications_Tab.png?alt=media)

4. **Create New Application**:
   * Click on the **+ New application** button located in the page header.
   * In the **New application** dialog, provide the following information:
     * **Name**: A descriptive name for your application.
     * **Permissions**: Select the permissions your application requires from the available options.

{% hint style="warning" %}
The image below showing the available permissions is for illustrative purposes only. The actual permissions list may differ, as some permissions can be added or removed over time.
{% endhint %}

![Create Application Dialog](https://3218940882-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVxCOSyBojfSIE5fcpfH%2Fuploads%2Fgit-blob-6b9fd73fc57ffe4b196e69bdea4598db03452f52%2FCreate_Application_Dialog.png?alt=media)

5. **Confirm creation**:
   * After naming your application and selecting the appropriate permissions, click the **Create application** button.
   * Upon successful creation, a confirmation message **Application created!** will be displayed, providing your unique Client ID and Client Secret. **It is crucial to keep your Client Secret in a safe place.**

![Application Created Confirmation](https://3218940882-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVxCOSyBojfSIE5fcpfH%2Fuploads%2Fgit-blob-ca929124646cc5685f8abfae2fca9a4306abb363%2FApplication_Created_Confirmation.png?alt=media)

***

## Next steps: managing applications

After creating your application, you can edit its details, update permissions, or delete it as needed. Learn more in the next section:

{% content-ref url="/pages/oJnbCNlfhDXk6fTLvP5W" %}
[Managing Applications](/caf-api/connect/authentication/applications/managing-applications)
{% endcontent-ref %}


# Managing Applications

{% hint style="info" %}
Access [Creating an Application](/caf-api/connect/authentication/applications/creating-application) to learn how to set up applications first. This guide explains how to manage your applications in the Trust portal.
{% endhint %}

After creating an application, you can edit its details, update permissions, or delete it if no longer needed.

## Viewing your applications

To access your applications:

1. **Log in to the Trust portal**:
   * Navigate to the Trust portal and authenticate with your credentials.
2. **Navigate to API Configurations**:
   * From the dashboard, locate the navigation menu.
   * Click on **Settings** (gear icon) in the menu.
   * Select **API Configurations** from the menu.

![API Configurations](https://3218940882-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVxCOSyBojfSIE5fcpfH%2Fuploads%2Fgit-blob-354fa561c66f21faecc8c4cee0a67721ceb0292d%2FAPI_Configurations.png?alt=media)

3. **Access Applications Section**:
   * Click on the **Applications** tab.

![Applications Tab](https://3218940882-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVxCOSyBojfSIE5fcpfH%2Fuploads%2Fgit-blob-ada28c66f75ef9f5a5e0aae38e948f320360dfe4%2FApplications_Tab.png?alt=media)

If you have existing applications, they will be listed in the **Applications** tab.

![Applications Tab with Applications](https://3218940882-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVxCOSyBojfSIE5fcpfH%2Fuploads%2Fgit-blob-a8ac4939ed7fe99fcdec492ffb2c428005aff72d%2FApplications_Tab_Not_Empty.png?alt=media)

## Editing an application

To edit an application:

1. Click the **three-dot menu** (⋮) next to the application you want to manage.
2. Select **Edit** from the dropdown.

![Application Dropdown](https://3218940882-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVxCOSyBojfSIE5fcpfH%2Fuploads%2Fgit-blob-2d742a0fc542dd779d20161c31e50798da790e20%2FApplications_Application_Dropdown.png?alt=media)

3. In the dialog, you can update the application's name and permissions.

![Edit Application Dialog](https://3218940882-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVxCOSyBojfSIE5fcpfH%2Fuploads%2Fgit-blob-7ae69d69d37966f658621b12808c326e45ffdb78%2FApplications_Edit_Dialog.png?alt=media)

* Change the name in the **Name** field.
* Select or deselect permissions as needed.
* Click **Save Changes** to apply changes.

## Deleting an application

To delete an application:

1. Click the **three-dot menu** (⋮) next to the application.
2. Select **Delete**.
3. Confirm the deletion in the dialog that appears.

![Delete Application Dialog](https://3218940882-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVxCOSyBojfSIE5fcpfH%2Fuploads%2Fgit-blob-d0b3bf106d04842bc087be9d45b488286d64a90a%2FApplications_Delete_Dialog.png?alt=media)

> **Warning:** Deleting an application is irreversible. All credentials and access for this application will be lost.

***

Continue exploring the documentation for more details on authentication and permissions.


# Available Permissions

## Permissions

### Transactions

* **Create Transaction**: Allows the application to create transactions.
* **Read Transaction**: Allows the application to read transaction details.
* **Update Transaction**: Allows the application to update existing transactions.

### Transaction Files

* **Create**: Allows uploading a file via the API when creating a transaction.

### Services

* **Create**: Allows access to create services.

### Doc-less

* **Create**: Allows access to create doc-less.

### Face Authentication - Attempts

* **Read**: Allows access to read face attempts.

### Face Authentication - Create

* **Create**: Allows access to create faces.

### Company Profiles

* **Read**: Allows access to read company profiles.

### People Profiles

* **Read**: Allows access to read people profiles.

### Onboardings

* **Create**: Allows access to create an onboarding link.


# Certificates

Certta's Certificates platform allows you to manage digital certificates for mutual TLS (`mTLS`) authentication, ensuring secure, two-way communication between your applications and Certta `APIs`. Through this platform, you can issue, renew, and revoke certificates, supporting compliance and security best practices for your integrations.

## Topics

* [Creating a Certificate](/caf-api/connect/authentication/certificates/creating-certificate)
* [Managing Certificates](/caf-api/connect/authentication/certificates/managing-certificate)
* [Using mTLS](/caf-api/connect/authentication/using-mtls)

Refer to each section for details on how to request, manage, and use certificates for `mTLS` authentication with Certta `APIs`.




---

[Next Page](https://docs.caf.io/llms-full.txt/1)