> 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/caf-api-pt-br/core-api/transaction-details/background-check/kyc/financial.md). # Financeiro ## Lista de devedores da PGFN (PF94) Retorna se o CPF consultado está inscrito em dívidas ativas na PGFN. **Seção:** `pfPgfnDebtors` **Parâmetro obrigatório:** `cpf` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Mensagem descritiva do resultado da consulta | | data.hasDebts | Boolean | Status da dívida (verdadeiro/falso) | | data.debtValue | String | Valor devido à PGFN | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "message": "Consulta realizada com sucesso.", "hasDebts": false, "debtValue": "0" } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | -------------------- | --------------------------------------------------- | | has\_debts\_on\_pgfn | A regra será inválida se houver dívidas com a PGFN. | | {% endtab %} | | | {% endtabs %} | | ## Estimativa de Patrimônio e Renda (PF24) Retorna uma estimativa da renda e do patrimônio da pessoa calculada por diferentes variáveis a partir de consultas públicas disponíveis. **Seção:** `pfFinantialData` **Parâmetro obrigatório:** `cpf` **Parâmetro opcional:** `birthDate` *Esta informação é exigida em algumas fontes para concluir a execução de menores* {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.totalAssets | String | Patrimônio total estimado do indivíduo | | data.taxReturns | Array | Lista de objetos com o histórico de restituições do imposto de renda | | data.taxReturns\[x].year | String | Ano da declaração de imposto de renda | | data.taxReturns\[x].status | String | Status da declaração de imposto de renda | | data.taxReturns\[x].bank | String | Banco usado para a declaração de imposto de renda | | data.taxReturns\[x].captureDate | String | Data de captura | | data.taxReturns\[x].lastUpdateDate | String | Data da última atualização | | data.incomeEstimates | Objeto | Renda estimada | | data.incomeEstimates.mte | String | Renda estimada conforme o MTE | | data.incomeEstimates.ibge | String | Renda estimada conforme o IBGE | | data.incomeEstimates.companyOwnership | String | Renda estimada mesmo sem histórico de trabalho formal | | data.lastUpdateDate | String | Data da última atualização | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "totalAssets": "ABAIXO DE 100K", "taxReturns": [ { "year": "2021", "status": "SUA DECLARAÇÃO NÃO CONSTA NA BASE DE DADOS DA RECEITA FEDERAL", "bank": "", "branch": "0000", "batch": "", "isVipBranch": "false", "captureDate": "2021-11-28T00:00:00Z", "creationDate": "2021-11-28T00:00:00Z", "lastUpdateDate": "2021-11-28T00:00:00Z" } ], "incomeEstimates": { "mte": "SEM INFORMAÇÃO", "ibge": "SEM INFORMAÇÃO", "companyOwnership": "SEM INFORMAÇÃO" }, "lastUpdateDate": "2022-10-22T00:00:00Z" } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------------------- | --------------------------------------------------------------------------------- | | is\_less\_than\_two\_salaries | Verifica se a renda estimada é inferior a dois (02) salários mínimos. | | is\_between\_two\_and\_four\_salaries | Verifica se a renda estimada está entre dois (02) e quatro (04) salários mínimos. | | is\_more\_than\_four\_salaries | Verifica se a renda estimada está acima de quatro (04) salários mínimos | | has\_salary\_information | Verifica se foram encontradas informações sobre renda estimada | | {% endtab %} | | | {% endtabs %} | | ## Quadro Geral de Inabilitados - Banco Central do Brasil (PF44) Retorna, se incluído no Quadro Geral de Inabilitados do Banco Central do Brasil, informações sobre a inabilitação. **Seção:** `pfBacenQgi` **Parâmetros obrigatórios:** `cpf` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.disabledList | Array | Lista de objetos com os dados da inabilitação | | data.disabledList\[x].pas | String | PAS (Processo Administrativo Sancionador) | | data.disabledList\[x].name | String | Nome | | data.disabledList\[x].cpf | String | CPF | | data.disabledList\[x].penalty | String | Penalidade | | data.disabledList\[x].publicationDate | String | Data de publicação | | data.disabledList\[x].penaltyDeadline | String | Prazo da penalidade | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "message": "O CPF não consta no quadro geral de inabilitados junto ao BACEN." } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------- | -------------------------------------------------------------------- | | disabled\_on\_bacen | Verifica se o CPF consultado não está autorizado pelo Banco Central. | | {% endtab %} | | | {% endtabs %} | | ## Associado à CVM (PF47) Retorna informações do CPF relacionadas a instituições financeiras **Seção:** `pfAssociatedCvm` **Parâmetro obrigatório:** `cpf` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | --------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.associates | Array | Descreve os dados dos tipos de cadastro na Comissão de Valores Mobiliários | | data.associates\[x].name | String | Nome da pessoa | | data.associates\[x].type | String | Tipo de registro | | data.associates\[x].recordDate | String | Data de registro | | data.associates\[x].situation | String | Situação do cadastro | | data.associates\[x].directors | Array | Lista de objetos que contêm dados sobre diretores | | data.associates\[x].directors\[x].name | String | Nome da empresa na qual o CPF atua como diretor | | data.associates\[x].directors\[x].startDate | String | Data de início do cargo de diretor | | data.associates\[x].directors\[x].instruction | String | Cargo do diretor na empresa | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "message": "Não foram encontrados participantes para esta consulta." } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------- | ----------------------------------------------------------------------------- | | has\_no\_participant\_cvm | A regra será inválida se o CPF/CNPJ consultado não estiver registrado na CVM. | | {% endtab %} | | | {% endtabs %} | | ## Renda Ibope (PF50) Retorna informações sobre a renda domiciliar / renda Ibope de uma pessoa **Seção:** `pfIbopeIncome` **Parâmetro obrigatório:** `cpf` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descritivo com a situação da consulta | | data.ibopeIncome | Número decimal | valor da renda Ibope | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "message": "Consulta realizada com sucesso", "ibopeIncome": 0 } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ---------------------- | --------------------------------- | | has\_no\_ibope\_income | Verifica a renda Ibope de um CPF. | | {% endtab %} | | | {% endtabs %} | | ## Renda Estimada (PF51) Retorna informações sobre a renda estimada de uma pessoa **Seção:** `pfEstimatedIncome` **Parâmetro obrigatório:** `cpf` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | -------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.estimatedIncome | Número decimal | Valor estimado da renda | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "message": "Consulta realizada com sucesso", "estimatedIncome": 0000 } } ``` {% endtab %} {% endtabs %} ## Sistema de Informações de Crédito (PF96) Retorna as informações de crédito de uma pessoa. **Seção:** `pfCreditOperationScr` **Parâmetros obrigatórios:** `cpf, PF` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------------------------------------------------------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.clientCode | String | CPF | | data.registrationDate | Date | Data de registro | | data.baseDate | Date | Data-base da consulta | | data.assumedCoobligation | Number | Coobrigação assumida na cessão de crédito pelo cliente | | data.receivedCoobligation | Number | Coobrigação recebida na cessão de crédito | | data.processedDocumentsPercentage | Number | Percentual dos documentos 3040 esperados para a data-base e que já foram incorporados à base do SCR no Banco Central, desconsiderando as instituições financeiras dispensadas | | data.processedVolumePercentage | Number | Percentual do volume previsto para a data-base e que já foi incorporado à base do SCR no Banco Central, desconsiderando as instituições financeiras isentas | | data.totalOfInstituions | String | Número de instituições financeiras (IFs) nas quais o cliente possui operações | | data.totalOfTransactions | String | Número de operações do cliente no SFN | | data.totalDisagreementTransactions | String | Número de operações marcadas com manifestação de discordância | | data.totalSubJudiceTransactions | String | Número de operações marcadas como sub judice | | data.fullLiabilityDisagreement | String | Responsabilidade total das operações marcadas com manifestação de discordância | | data.fullLiabilitySubJudice | String | Responsabilidade total das operações sob julgamento | | data.indirectVendorRisk | String | Risco indireto assumido pelo cliente em operações de vendor | | data.operationSumaryList | Array | Lista contendo o resumo das operações | | data.operationSumaryList\[x].modalityCategoryCode | String | Código da modalidade da operação | | data.operationSumaryList\[x].modalityCategoryDescription | String | Descrição do código da modalidade da operação | | data.operationSumaryList\[x].modalitySubCategoryCode | String | Código da subcategoria | | data.operationSumaryList\[x].modalitySubCategoryDescription | String | Descrição do indicador de subcategoria | | data.operationSumaryList\[x].listOfDebts | Array | Lista de vencimentos | | data.operationSumaryList\[x].listOfDebts\[x].expirationCode | String | Indicador de vencimento | | data.operationSumaryList\[x].listOfDebts\[x].expirationDescription | String | Descrição do indicador de vencimento | | data.operationSumaryList\[x].listOfDebts\[x].value | String | Valor do vencimento | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "message": "Consulta realizada com sucesso", "clientCode": "0XX52XX90XX", "registrationDate": "2020-05-08", "baseDate": "2022-10", "assumedCoobligation": 0, "receivedCoobligation": 0, "processedVolumePercentage": 99.98, "totalOfTransactions": "3", "totalDisagreementTransactions": "0", "totalSubJudiceTransactions": "0", "fullLiabilityDisagreement": "0", "fullLiabilitySubJudice": "0", "indirectVendorRisk": "0.00", "operationSumaryList": [ { "modalityCategoryCode": "13", "modalityCategoryDescription": "Outros créditos", "modalitySubCategoryCode": "XXXX", "modalitySubCategoryDescription": "cartão de crédito - compra à vista e parcelado lojista ", "listOfDebts": [ { "expirationCode": "140", "expirationDescription": "Créditos a vencer de 91 a 180 dias", "value": "XX.94" }, { "expirationCode": "150", "expirationDescription": "Créditos a vencer de 181 a 360 dias ", "value": "XX.37" }, { "expirationCode": "110", "expirationDescription": "Créditos a vencer até 30 dias", "value": "XX.92" }, { "expirationCode": "120", "expirationDescription": "Créditos a vencer de 31 a 60 dias", "value": "XX.54" }, { "expirationCode": "130", "expirationDescription": "Créditos a vencer de 61 a 90 dias", "value": "XX.93" } ] } ] } } ``` {% endtab %} {% endtabs %} ## Penalidades Temporárias na CVM (PF93) Consulta a lista de Penalidades Temporárias da CVM para verificar se o participante está temporariamente impedido de atuar no mercado de capitais devido a uma decisão em um Processo Administrativo Sancionador **Seção:** `pfPenaltiesOnCvm` **Parâmetros obrigatórios:** `name` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.result | Objeto | Detalhes dos participantes sancionados | | data.result.processNumber | String | Número do processo | | data.result.name | String | Participante | | data.result.decisionType | String | Tipo de decisão | | data.result.judgementDate | String | Data da decisão da CVM | | data.result.effectiveDate | String | Data de vigência da penalidade | | data.result.timeOfWithdrawal | String | Tempo de afastamento | | data.result.decisionLink | String | Link da decisão | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "message": "Consulta realizada com sucesso.", "result": { "processNumber": "01/2005", "name": "MASSA FALIDA DO BANCO SANTOS S.A.", "decisionType": "Inabilitação", "judgementDate": "26/11/2008", "effectiveDate": "25/07/2014", "timeOfDeparture": "20 anos", "decisionLink": "http://conteudo.cvm.gov.br/sancionadores/sancionador/2008/20081126_0105.html" } } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ----------------------- | -------------------------------------------------------------------------------- | | has\_penalties\_on\_cvm | A regra será inválida se o CPF estiver temporariamente impedido de atuar na CVM. | | {% endtab %} | | | {% endtabs %} | | ## Score de Crédito - NOVO (PF87) Retorna o score de crédito de um consumidor com base em seu comportamento; o score estimará a probabilidade de inadimplência e o quão arriscado é o perfil em relação ao crédito **Seção:** `pfCreditScore` **Parâmetro obrigatório:** `cpf` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ----------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | mensagem | String | Descrição do status da consulta | | dados | Objeto | Dados de retorno | | data.score | Integer | Classificação do Consumer Score | | data.scoreMessage | String | Contexto da recomendação para tomada de decisão | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "message": "Consulta realizada com sucesso.", "data": { "score": 777, "scoreMessage": "É provável que 96% das pessoas com esse mesmo comportamento paguem suas contas nos próximos 6 meses.", } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------ | ------------------------------------------------------------------------------------- | | credit\_score\_available | A regra se tornará inválida se o score de crédito não estiver disponível. | | credit\_score\_below | A regra se tornará inválida se o score de crédito estiver abaixo do valor definido. | | credit\_score\_over | A regra se tornará inválida se o score de crédito estiver acima do valor definido. | | credit\_score\_between | A regra se tornará inválida se o score de crédito estiver entre os valores definidos. | | {% endtab %} | | | {% endtabs %} | | ## Perfil de Crédito - NOVO (PF88) Retorna uma avaliação abrangente da saúde financeira de uma pessoa, devolvendo seu score de crédito e oferecendo um perfil financeiro detalhado. Com base em uma ampla variedade de dados, incluindo dívidas registradas, histórico de consultas, protestos, devoluções e histórico bancário, além de dados complementares como vínculos com empresas e registros de falência, entrega uma análise preditiva da capacidade de pagamento atual e futura. Esta solução permite acesso a uma visão financeira confiável e completa, sendo ideal para decisões de crédito e análise de risco, oferecendo percepções claras para mitigar riscos e maximizar oportunidades financeiras. Os blocos de dados só serão retornados se houver informações disponíveis. **Seção:** `pfCreditProfileDetails` **Parâmetro obrigatório:** `cpf` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------------------------------------------------------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | mensagem | String | Descrição do status da consulta | | dados | Objeto | Dados de retorno | | data.civilActionsSummary | Objeto | Um bloco que fornece uma visão consolidada dos registros de ações cíveis | | data.civilActionsSummary.quantity | String | Quantidade total de ações cíveis | | data.civilActionsSummary.initialPeriod | String | Período inicial das ações cíveis | | data.civilActionsSummary.finalPeriod | String | Período final das ações cíveis | | data.civilActionsList | Array | Uma lista contendo informações detalhadas sobre cada ação cível registrada | | data.civilActionsList\[x].court | String | Tribunal | | data.civilActionsList\[x].lawsuitNumber | String | Número da ação cível | | data.civilActionsList\[x].civilAction | String | Título da ação cível | | data.civilActionsList\[x].distributionDate | String | Data de distribuição da ação cível | | data.civilActionsList\[x].plaintiff | String | Autor da ação cível | | data.civilActionsList\[x].amount | String | Valor | | data.civilActionsList\[x].location | String | Local | | data.civilActionsList\[x].state | String | Estado | | data.civilActionsList\[x].municipalityCode | String | Código da cidade | | data.debtOccurrencesSummary | Objeto | Um bloco que fornece uma visão consolidada dos registros de dívida | | data.debtOccurrencesSummary.totalDebtor | String | Total de dívidas como devedor | | data.debtOccurrencesSummary.totalGuarantor | String | Total de dívidas como garantidor | | data.debtOccurrencesSummary.accumulatedAmount | String | Valor acumulado das dívidas | | data.debtOccurrencesSummary.firstDebtDate | String | Data da primeira dívida | | data.debtOccurrencesSummary.firstDebtAmount | String | Valor da primeira dívida | | data.debtOccurrencesSummary.largestDebtDate | String | Data da maior dívida | | data.debtOccurrencesSummary.largestDebtAmount | String | Valor da maior dívida | | data.debts | Array | Uma lista contendo informações detalhadas sobre cada dívida. | | data.debts\[x].occurrenceType | String | Tipo de ocorrência | | data.debts\[x].contract | String | Número do contrato da dívida | | data.debts\[x].occurrenceDate | String | Data de ocorrência da dívida | | data.debts\[x].availabilityDate | String | Data de disponibilidade da dívida | | data.debts\[x].currency | String | Tipo de moeda | | data.debts\[x].amount | String | Valor | | data.debts\[x].status | String | Status da dívida | | data.debts\[x].informer | String | Informante da dívida | | data.debts\[x].informedByConsultee | String | A dívida foi informada pelo consultado | | data.debts\[x].city | String | Cidade | | data.debts\[x].state | String | Estado | | data.debts\[x].condition | String | Condição da dívida | | data.debts\[x].municipalityCondition | String | Código da condição da cidade | | data.previous90DaysInquiriesSummary | Objeto | Um bloco que fornece uma visão consolidada dos registros dos 90 dias anteriores | | data.previous90DaysInquiriesSummary.total | String | Total | | data.previous90DaysInquiriesSummary.year | String | Ano | | data.previous90DaysInquiriesSummary.month | String | mês | | data.previousInquiries | Array | Uma lista contendo informações detalhadas sobre cada consulta anterior | | data.previousInquiries\[x].occurrenceType | String | Tipo de ocorrência | | data.previousInquiries\[x].date | String | Data da consulta | | data.previousInquiries\[x].amount | String | Valor | | data.previousInquiries\[x].currency | String | Tipo de moeda | | data.previousInquiries\[x].informer | String | Informante da consulta | | data.previousInquiries\[x].product | String | Produto da consulta | | data.additionalAnfo | Array | Uma lista contendo informações adicionais | | data.additionalAnfo\[x].text | String | Texto de informação adicional | | data.additionalAnfo\[x].originState | String | Estado de origem | | data.additionalAnfo\[x].origin | String | Origem da informação adicional | | data.additionalAnfo\[x].type | String | Tipo | | data.protestedBillsSummary | Objeto | Um bloco que fornece uma visão consolidada dos registros de títulos protestados | | data.protestedBillsSummary.total | String | Quantidade total de títulos protestados | | data.protestedBillsSummary.initialPeriod | String | Período inicial dos títulos protestados | | data.protestedBillsSummary.finalPeriod | String | Período final dos títulos protestados | | data.protestedBillsSummary.currency | String | Tipo de moeda | | data.protestedBillsSummary.accumulatedValue | String | Valor acumulado dos títulos protestados | | data.protestedBills | Array | Uma lista contendo informações detalhadas sobre cada título protestado | | data.protestedBills\[x].occurrenceType | String | Tipo de ocorrência | | data.protestedBills\[x].notaryOffice | String | Cartório | | data.protestedBills\[x].occurrenceDate | String | Data de ocorrência do título protestado | | data.protestedBills\[x].currency | String | Tipo de moeda | | data.protestedBills\[x].amount | String | Valor | | data.protestedBills\[x].city | String | Cidade | | data.protestedBills\[x].state | String | Estado | | data.cancelledCheckBook | Array | Uma lista contendo informações detalhadas sobre cada talão de cheques bancário cancelado | | data.cancelledCheckBook\[x].occurrenceType | String | Tipo de ocorrência | | data.cancelledCheckBook\[x].documentType | String | Tipo de documento | | data.cancelledCheckBook\[x].documentNumber | String | Número do documento | | data.cancelledCheckBook\[x].bank | String | Banco | | data.cancelledCheckBook\[x].agency | String | Agência | | data.cancelledCheckBook\[x].currentAccount | String | Número da conta corrente | | data.cancelledCheckBook\[x].check | String | Número do cheque bancário | | data.cancelledCheckBook\[x].reasonCode | String | Alínea | | data.cancelledCheckBook\[x].occurrenceDate | String | Data de ocorrência do cancelamento | | data.cancelledCheckBook\[x].availabilityDate | String | Data de disponibilidade | | data.cancelledCheckBook\[x].informer | String | Informante | | data.cancelledCheckBook\[x].indicator | String | Indicador | | data.ccfReportedReturnsSummary | Objeto | Um bloco que fornece uma visão consolidada das devoluções registradas pelo CCF | | data.ccfReportedReturnsSummary.documentType | String | Tipo de documento | | data.ccfReportedReturnsSummary.documentNumber | String | Número do documento | | data.ccfReportedReturnsSummary.name | String | Nome | | data.ccfReportedReturnsSummary.totalNames | String | Total de nomes | | data.ccfReportedReturnsSummary.totalReturns | String | Total de devoluções | | data.ccfReportedReturnsSummary.reason12 | String | Motivo 12 - Cheque bancário sem fundos - 2ª apresentação | | data.ccfReportedReturnsSummary.reason13 | String | Motivo 13 - Conta encerrada | | data.ccfReportedReturnsSummary.reason14 | String | Motivo 14 - Prática espúria | | data.ccfReportedReturnsSummary.reason99 | String | Motivo 99 - Instituição financeira não está mais em atividade | | data.ccfReportedReturnsList | Array | Uma lista contendo informações detalhadas sobre cada devolução reportada pelo CCF | | data.ccfReportedReturnsList\[x].documentType | String | Tipo de documento | | data.ccfReportedReturnsList\[x].documentNumber | String | Número do documento | | data.ccfReportedReturnsList\[x].name | String | Nome | | data.ccfReportedReturnsList\[x].bank | String | Banco | | data.ccfReportedReturnsList\[x].agency | String | Agência | | data.ccfReportedReturnsList\[x].reason12 | String | Motivo 12 - Cheque bancário sem fundos - 2ª apresentação | | data.ccfReportedReturnsList\[x].lastOccurrenceDate12 | String | Data da última ocorrência - motivo 12 | | data.ccfReportedReturnsList\[x].reason13 | String | Motivo 13 - Conta encerrada | | data.ccfReportedReturnsList\[x].lastOccurrenceDate13 | String | Data da última ocorrência - motivo 13 | | data.ccfReportedReturnsList\[x].reason14 | String | Motivo 14 - Prática espúria | | data.ccfReportedReturnsList\[x].lastOccurrenceDate14 | String | Data da última ocorrência - motivo 14 | | data.ccfReportedReturnsList\[x].reason99 | String | Motivo 99 - Instituição financeira não está mais em atividade | | data.ccfReportedReturnsList\[x].lastOccurrenceDate99 | String | Data da última ocorrência - motivo 99 | | data.ccfReportedReturnsList\[x].bankName | String | Nome do banco | | data.previousCheckInquiriesSummary | Objeto | Um bloco que fornece uma visão consolidada dos registros de consultas anteriores de cheques bancários | | data.previousCheckInquiriesSummary.documentType | String | Tipo de documento | | data.previousCheckInquiriesSummary.documentNumber | String | Número do documento | | data.previousCheckInquiriesSummary.total | String | Quantidade total de consultas anteriores de cheques bancários | | data.previousCheckInquiriesSummary.amount | String | Valor | | data.previousCheckInquiriesSummary.day | String | Dia | | data.previousCheckInquiriesSummary.dailyValue | String | Valor diário | | data.previousCheckInquiriesSummary.postdated | String | Pós-datado | | data.previousCheckInquiriesSummary.postdatedValue | String | Valor pós-datado | | data.previousCheckInquiries | Array | Uma lista contendo informações detalhadas sobre cada consulta anterior de cheque bancário | | data.previousCheckInquiries\[x].documentType | String | Tipo de documento | | data.previousCheckInquiries\[x].documentNumber | String | Número do documento | | data.previousCheckInquiries\[x].type | String | Tipo | | data.previousCheckInquiries\[x].creditDate | String | Data do crédito | | data.previousCheckInquiries\[x].creditTime | String | Hora do crédito | | data.previousCheckInquiries\[x].currency | String | Tipo de moeda | | data.previousCheckInquiries\[x].amount | String | Valor | | data.previousCheckInquiries\[x].informer | String | Informante | | data.phoneConfirmation | Array | Uma lista contendo informações detalhadas sobre cada confirmação telefônica | | data.phoneConfirmation\[x].areaCode | String | Código de área | | data.phoneConfirmation\[x].phoneNumber | String | Telefone | | data.phoneConfirmation\[x].documentType | String | Tipo de documento | | data.phoneConfirmation\[x].documentNumber | String | Número do documento | | data.phoneConfirmation\[x].name | String | Nome | | data.phoneConfirmation\[x].neighborhood | String | Bairro | | data.phoneConfirmation\[x].postalCode | String | CEP | | data.phoneConfirmation\[x].city | String | Cidade | | data.phoneConfirmation\[x].state | String | Estado | | data.bankBranchContactDetails | Array | Uma lista contendo informações detalhadas sobre cada contato de agência bancária | | data.bankBranchContactDetails\[x].bank | String | Banco | | data.bankBranchContactDetails\[x].bankName | String | Nome do banco | | data.bankBranchContactDetails\[x].agency | String | Agência | | data.bankBranchContactDetails\[x].branchName | String | Nome da agência | | data.bankBranchContactDetails\[x].address | String | Endereço | | data.bankBranchContactDetails\[x].neighborhood | String | Bairro | | data.bankBranchContactDetails\[x].postalCode | String | CEP | | data.bankBranchContactDetails\[x].city | String | Cidade | | data.bankBranchContactDetails\[x].state | String | Estado | | data.bankBranchContactDetails\[x].location | String | Local | | data.bankBranchContactDetails\[x].areaCode | String | Código de área | | data.bankBranchContactDetails\[x].phoneNumber1 | String | Número de telefone 1 | | data.bankBranchContactDetails\[x].phoneNumber2 | String | Número de telefone 2 | | data.bankBranchContactDetails\[x].reserved | String | Reservado | | data.postalCodeConfirmation | Objeto | Um bloco que fornece uma visão consolidada da confirmação de CEP | | data.postalCodeConfirmation.postalCode | String | CEP | | data.postalCodeConfirmation.address | String | Endereço | | data.postalCodeConfirmation.neighborhood | String | Bairro | | data.postalCodeConfirmation.city | String | Cidade | | data.postalCodeConfirmation.state | String | Estado | | data.documentName | Array | Uma lista contendo informações detalhadas sobre cada documento | | data.documentName\[x].name | String | Nome | | data.documentName\[x].birthDate | String | Data de nascimento | | data.documentName\[x].document | String | documento | | data.documentName\[x].documentType | String | Tipo de documento | | data.documentName\[x].documentNumber | String | Número do documento | | data.checkAdditionalInformation | Array | Uma lista contendo informações adicionais detalhadas sobre cheques bancários | | data.checkAdditionalInformation\[x].documentType | String | Tipo de documento | | data.checkAdditionalInformation\[x].documentNumber | String | Número do documento | | data.checkAdditionalInformation\[x].text | String | Texto de informação adicional | | data.userReportedReturnsSummary | Objeto | Devoluções informadas pelo usuário | | data.userReportedReturnsSummary.documentType | String | Tipo de documento | | data.userReportedReturnsSummary.documentNumber | String | Número do documento | | data.userReportedReturnsSummary.total | String | Total | | data.userReportedReturnsSummary.firstReturnDate | String | Data da primeira devolução | | data.userReportedReturnsSummary.lastReturnDate | String | Data da última devolução | | data.userReportedReturns | Array | Uma lista contendo informações detalhadas sobre cada devolução informada pelo usuário | | data.userReportedReturns\[x].documentType | String | Tipo de documento | | data.userReportedReturns\[x].document | String | Número do documento | | data.userReportedReturns\[x].bank | String | Banco | | data.userReportedReturns\[x].agency | String | Agência | | data.userReportedReturns\[x].currentAccount | String | Número da conta corrente | | data.userReportedReturns\[x].initialCheck | String | Cheque bancário inicial | | data.userReportedReturns\[x].finalCheck | String | Cheque bancário final | | data.userReportedReturns\[x].reason | String | Motivo | | data.userReportedReturns\[x].reasonCode | String | Código do motivo | | data.userReportedReturns\[x].occurrenceDate | String | Data da ocorrência | | data.userReportedReturns\[x].registrationDate | String | Data de registro | | data.userReportedReturns\[x].currency | String | Tipo de moeda | | data.userReportedReturns\[x].amount | String | Valor | | data.userReportedReturns\[x].reporterCode | String | Código do informante | | data.userReportedReturns\[x].informer | String | Informante | | data.userReportedReturns\[x].city | String | Cidade | | data.userReportedReturns\[x].state | String | Estado | | data.checksCancelledReason21 | Array | Uma lista contendo informações detalhadas sobre cada cheque bancário cancelado por motivo 21 - cancelado ou revogado | | data.checksCancelledReason21\[x].documentType | String | Tipo de documento | | data.checksCancelledReason21\[x].documentNumber | String | Número do documento | | data.checksCancelledReason21\[x].bank | String | Banco | | data.checksCancelledReason21\[x].agency | String | Agência | | data.checksCancelledReason21\[x].currentAccount | String | Número da conta corrente | | data.checksCancelledReason21\[x].initialCheck | String | Cheque bancário inicial | | data.checksCancelledReason21\[x].finalCheck | String | Cheque bancário final | | data.checksCancelledReason21\[x].reasonCode | String | Código do motivo | | data.checksCancelledReason21\[x].occurrenceDate | String | Data da ocorrência | | data.checksCancelledReason21\[x].availabilityDate | String | Data de disponibilidade | | data.checksCancelledReason21\[x].currency | String | Tipo de moeda | | data.checksCancelledReason21\[x].amount | String | Valor | | data.checksCancelledReason21\[x].informer | String | Informante | | data.reportedCheckHistory | Array | Uma lista contendo informações detalhadas sobre cada cheque reportado | | data.reportedCheckHistory\[x].documentType | String | Tipo de documento | | data.reportedCheckHistory\[x].documentNumber | String | Número do documento | | data.reportedCheckHistory\[x].bank | String | Banco | | data.reportedCheckHistory\[x].agency | String | Agência | | data.reportedCheckHistory\[x].currentAccount | String | Número da conta corrente | | data.reportedCheckHistory\[x].check | String | Número do cheque bancário | | data.reportedCheckHistory\[x].inquiryDate | String | Data da consulta | | data.reportedCheckHistory\[x].inquiryTime | String | Hora da consulta | | data.reportedCheckHistory\[x].network | String | Rede | | data.reportedCurrentAccountHistory | Array | Uma lista contendo informações detalhadas sobre cada conta corrente reportada | | data.reportedCurrentAccountHistory\[x].bank | String | Banco | | data.reportedCurrentAccountHistory\[x].agency | String | Agência | | data.reportedCurrentAccountHistory\[x].currentAccount | String | Número da conta corrente | | data.reportedCurrentAccountHistory\[x].documentType | String | Tipo de documento | | data.reportedCurrentAccountHistory\[x].documentNumber | String | Número do documento | | data.reportedCurrentAccountHistory\[x].inquiryDate | String | Data da consulta | | data.reportedCurrentAccountHistory\[x].inquiryTime | String | Hora da consulta | | data.participationsOfConsultedDocument | Array | Uma lista contendo informações detalhadas sobre cada participação do documento consultado | | data.participationsOfConsultedDocument\[x].documentTypeA | String | Tipo de documento | | data.participationsOfConsultedDocument\[x].documentNumberA | String | Número do documento | | data.participationsOfConsultedDocument\[x].companyName | String | Nome da empresa | | data.participationsOfConsultedDocument\[x].currencyType | String | Tipo de moeda | | data.participationsOfConsultedDocument\[x].amount | String | Valor | | data.participationsOfConsultedDocument\[x].observation | String | Observação | | data.participationsOfConsultedDocument\[x].percentageValue | String | Valor percentual | | data.participationsOfConsultedDocument\[x].entryDate | String | Data de entrada | | data.participationsOfConsultedDocument\[x].role | String | Função | | data.participationsOfConsultedDocument\[x].documentTypeB | String | Tipo de documento | | data.participationsOfConsultedDocument\[x].documentNumberB | String | Número do documento | | data.participationsOfConsultedDocument\[x].partnerType | String | Tipo de parceiro | | data.bankruptcyJudicialRecoveryRelationship | Array | Uma lista contendo informações detalhadas sobre cada relação de falência e recuperação judicial | | data.bankruptcyJudicialRecoveryRelationship\[x].documentType | String | Tipo de documento | | data.bankruptcyJudicialRecoveryRelationship\[x].documentNumber | String | Número do documento | | data.bankruptcyJudicialRecoveryRelationship\[x].companyName | String | Nome da empresa | | data.bankruptcyJudicialRecoveryRelationship\[x].occurrenceType | String | Tipo de ocorrência | | data.bankruptcyJudicialRecoveryRelationship\[x].notaryOffice | String | Cartório | | data.bankruptcyJudicialRecoveryRelationship\[x].occurrenceDate | String | Data da ocorrência | | data.bankruptcyJudicialRecoveryRelationship\[x].location | String | Local | | data.bankruptcyJudicialRecoveryRelationship\[x].state | String | Estado | | data.bankruptcyJudicialRecoveryRelationship\[x].municipalityCode | String | Código da cidade | | data.identification | Objeto | data. Informações de identificação | | data.identification.document | String | Documento | | data.identification.name | String | Nome | | data.identification.motherName | String | Nome da mãe | | data.identification.dataOfBirth | String | Data de nascimento | | data.identification.rgNumber | String | Número do RG | | data.identification.issuingAgency | String | Órgão emissor | | data.identification.rgFederativeUnit | String | UF de origem do RG | | data.identification.rgIssueDate | String | Data de emissão do RG | | data.identification.gender | String | Sexo | | data.identification.nacionalidade | String | Nacionalidade | | data.identification.maritalStatus | String | Estado civil | | data.identification.numberOfDependents | String | Número de dependentes | | data.identification.educationLevel | String | Nível de escolaridade | | data.identification.revenueStatus | String | Status do CPF | | data.identification.updateDate | String | Data da última atualização | | data.identification.cpfRegion | String | Região de origem do CPF | | data.identification.voterRegistration | String | Título de eleitor | | data.identification.message | String | Mensagem de observação de identificação | | data.location | Objeto | data. Informações de localização | | data.location.streetType | String | Tipo de logradouro | | data.location.streetName | String | Nome do logradouro | | data.location.streetNumber | String | Número do endereço | | data.location.addressComplement | String | Complemento do endereço | | data.location.neighborhood | String | Bairro | | data.location.city | String | Cidade | | data.location.state | String | Estado | | data.location.postalCode | String | CEP | | data.location.areaCode | String | Código de área | | data.location.phoneNumber | String | Telefone | | data.scores | Array | Classificação de scores dos dados do consumidor | | data.scores\[x].score | Integer | Classificação da pontuação | | data.scores\[x].scoreDescription | String | Score de crédito ou score de renda | | data.scores\[x].probability | String | Probabilidade | | data.scores\[x].numericalClassification | String | Classificação numérica | | data.scores\[x].alphabeticalClassification | String | Classificação alfabética | | data.scores\[x].scoreMessage | String | Contexto da recomendação para tomada de decisão | | data.scores\[x].presumedIncomeRange | String | Faixa de renda presumida. Presente apenas no score de renda | | data.positiveControlPanel | Objeto | Painel de indicadores de scores. Uma escala de classificação de 'A' a 'E', em que 'A' é a classificação mais alta e 'E' é a mais baixa | | data.positiveControlPanel.positivePaymentBehaviorIndicators | Objeto | Indicadores de comportamento de pagamento positivo | | data.positiveControlPanel.positivePaymentBehaviorIndicators.lateInvoiceBehaviorScore | Objeto | Score de comportamento de fatura em atraso | | data.positiveControlPanel.positivePaymentBehaviorIndicators.lateInvoiceBehaviorScore.score | String | Abrange informações sobre o status de pagamento de cartões de crédito, empréstimos e financiamentos nos últimos seis meses | | data.positiveControlPanel.positiveConsumptionBehaviorIndicators | Objeto | Indicadores de comportamento de pagamento positivo | | data.positiveControlPanel.positiveConsumptionBehaviorIndicators.recentContractBehaviorScore | Objeto | Score de comportamento de fatura em atraso | | data.positiveControlPanel.positiveConsumptionBehaviorIndicators.recentContractBehaviorScore.score | String | Aborda informações contratuais recentes sobre pagamentos de cartões de crédito, empréstimos e financiamentos nos últimos seis meses | | dados.statusDoConsumidor | Objeto | Status do consumidor | | dados.statusDoConsumidor.mensagem | String | Mensagem do status do consumidor | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "código": "01", "message": "Consulta realizada com sucesso.", "data": { "civilActionsSummary": { "quantidade": "1", "initialPeriod": "20/01/2018", "finalPeriod": "06/10/2019" }, "civilActionsList": [ { "court": "2", "lawsuitNumber": "1234567891011", "civilAction": "Ação executiva Fazenda Federal", "distributionDate": "06/10/2018", "plaintiff": "Banco Itaú", "amount": "30.000,00", "location": "São Paulo", "estado": "SP", "municipalityCode": "3550308" } ], "debtOccurrencesSummary": { "totalDebtor": "1", "totalGuarantor": "0", "accumulatedAmount": "9.301,00", "firstDebtDate": "12/03/2023", "firstDebtAmount": "9.301,00", "largestDebtDate": "12/03/2023", "largestDebtAmount": "9.301,00" }, "debts": [ { "occurrenceType": "Crédito Direto", "contract": "12345678910", "occurrenceDate": "12/03/2023", "availabilityDate": "12/03/2023", "currency": "R$", "amount": "9.301,00", "status": "C", "informer": "Banco Itaú", "informedByConsultee": "S", "city": "SCPC São Paulo", "estado": "SP", "condition": "A", "municipalityCondition": "3550308" } ], "previous90DaysInquiriesSummary": { "total": "00011", "year1": "2024", "month1": "10", "total1": "0003", "year2": "2024", "month2": "09", "total2": "0005", "year3": "2024", "month3": "08", "total3": "0003", "year4": "2024", "month4": "07", "total4": "0000" }, "additionalAnfo": [ { "text": "CARTEIRA PROFIS PERDA / EXTRAVIO 01/08/2019 12/08/2019 09:57:57", "originState": "SP", "origin": "SSP", "type": "01" } ], "previousInquiries": [ { "occurrenceType": "Crédito Pessoal", "date": "03/10/2024", "amount": "0,00", "currency": "R$", "informer": "CAF", "product": "S" }, { "occurrenceType": "Cartão de Crédito", "date": "16/09/2024", "amount": "0,00", "currency": "R$", "informer": "BoaVista", "product": "S" } ], "protestedBillsSummary": { "total": "1", "initialPeriod": "17/02/2022", "finalPeriod": "17/02/2022", "currency": "R$", "accumulatedValue": "2.789,45" }, "protestedBills": [ { "occurrenceType": "Crédito Pessoal", "notaryOffice": "3", "occurrenceDate": "17/02/2022", "currency": "R$", "amount": "2.789,45", "cidade": "São Paulo", "state": "SP" } ], "phoneConfirmation": [ { "areaCode": "011", "phoneNumber": "1137833742", "tipoDeDocumento": "CPF", "documentNumber": "74146649889", "nome": "Guilherme Joaquim Mateus Cardoso", "neighborhood": "União de Vila Nova", "postalCode": "08071105", "cidade": "São Paulo", "state": "SP" } ], "bankBranchContactDetails": [ { "bank": "Banco Itaú", "bankName": "Itaú", "agency": "0177", "branchName": "Itaú - Ag. 0177 - SP AV Liberdade", "address": "Avenia Liberdade, 87", "neighborhood": "Liberdade", "postalCode": "01503-000", "cidade": "São Paulo", "estado": "SP", "areaCode": "011", "phoneNumber1": "40044828", "phoneNumber2": "08009704828" } ], "postalCodeConfirmation": { "postalCode": "08071105", "address": "Rua das Flores", "neighborhood": "União de Vila Nova", "cidade": "São Paulo", "state": "SP" }, "documentName": [ { "nome": "Guilherme Joaquim Mateus Cardoso", "birthDate": "06/04/1986", "tipoDeDocumento": "CPF", "documentNumber": "74146649889" }, { "nome": "Guilherme Joaquim Mateus Cardoso", "birthDate": "06/04/1986", "documentType": "RG", "documentNumber": "183004164" }, { "nome": "Guilherme Joaquim Mateus Cardoso", "birthDate": "06/04/1986", "documentType": "CNH", "documentNumber": "86671530071" } ], "reportedCurrentAccountHistory": [ { "bank": "Itaú", "agency": "0177", "currentAccount": "29414-1", "documentType": "RG", "documentNumber": "183004164", "inquiryDate": "10/11/2024", "inquiryTime": "14:00:00" } ], "participationsOfConsultedDocument": [ { "documentTypeA": "CPF", "documentNumberA": "74146649889", "companyName": "Joaquim Buffet Ltda", "currencyType": "R$", "amount": "100,00", "observation": "N", "percentageValue": "50,00", "entryDate": "19/04/2019", "role": "SOCIO ADMINISTRADOR", "documentTypeB": "CNPJ", "documentNumberB": "13628777000147", "partnerType": "S" }, { "documentTypeA": "CPF", "documentNumberA": "74146649889", "companyName": "Bruno e Samuel Telecom Ltda", "currencyType": "R$", "amount": "80,00", "observation": "N", "percentageValue": "33,00", "entryDate": "19/10/2022", "role": "SOCIO ADMINISTRADOR", "documentTypeB": "CNPJ", "documentNumberB": "14293465000192", "partnerType": "S" } ], "bankruptcyJudicialRecoveryRelationship": [ { "tipoDeDocumento": "CNPJ", "documentNumber": "54036433000126", "companyName": "Joca Locações de Automóveis ME", "occurrenceType": "Outros", "notaryOffice": "0001", "occurrenceDate": "10/09/2019", "location": "Guarulhos", "estado": "SP", "municipalityCode": "3518800" } ], "identification": { "document": "74146649889", "nome": "Guilherme Joaquim Mateus Cardoso", "motherName": "Raquel Amanda Cardoso", "dataOfBirth": "06/04/1986", "rgNumber": "183004164", "issuingAgency": "SSP", "rgFederativeUnit": "SP", "rgIssueDate": "02/03/1999", "gender": "Masculino", "nacionalidade": "Brasileiro", "maritalStatus": "Casado", "numberOfDependents": "2", "educationLevel": "Mestrado Completo", "revenueStatus": "Regular", "updateDate": "31/10/2024", "cpfRegion": "SP", "voterRegistration": "776102840124" }, "location": { "streetType": "R", "streetName": "Rua das Flores", "streetNumber": "707", "addressComplement": "504", "neighborhood": "União de Vila Nova", "cidade": "São Paulo", "estado": "SP", "postalCode": "08071105", "areaCode1": "0011", "phoneNumber1": "1137833742", "areaCode2": "0011", "phoneNumber2": "11992681016" }, "scores": [ { "score": "802", "probability": "01300", "numericalClassification": "11", "alphabeticalClassification": "B", "scoreMessage": "É provável que 92% das pessoas com esse mesmo comportamento, paguem suas contas nos próximos 6 meses." }, { "score": "10", "probability": "00000", "numericalClassification": "00", "alphabeticalClassification": "F", "scoreMessage": "Renda estimada a partir de informações comportamentais e cadastrais do consumidor.", "presumedIncomeRange": "De R$ 9.001 até R$ 12.000" } ], "positiveControlPanel": { "positivePaymentBehaviorIndicators": { "lateInvoiceBehaviorScore": { "score": "A" } }, "positiveConsumptionBehaviorIndicators": { "recentContractBehaviorScore": { "score": "B" } } }, "statusDoConsumidor": { "mensagem": "CONSUMIDOR PARTICIPANTE DO CADASTRO POSITIVO COM INFORMAÇÃO" } } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------ | ------------------------------------------------------------------------------------- | | credit\_score\_available | A regra se tornará inválida se o score de crédito não estiver disponível. | | credit\_score\_below | A regra se tornará inválida se o score de crédito estiver abaixo do valor definido. | | credit\_score\_over | A regra se tornará inválida se o score de crédito estiver acima do valor definido. | | credit\_score\_between | A regra se tornará inválida se o score de crédito estiver entre os valores definidos. | | {% 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/caf-api-pt-br/core-api/transaction-details/background-check/kyc/financial.md?ask=&goal= ``` `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.