> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-api/connect/transactions/background-check/kyb/financial.md).

# 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.md#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.md#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.md#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.md#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.md#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.md#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.md#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 %}            |                                                                                 |


---

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

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.caf.io/caf-api/connect/transactions/background-check/kyb/financial.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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

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