> 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/connect/transactions/background-check/kyb/risk.md). # Risco ## KYC e Compliance (PJ44) **Seção:** `pjKycCompliance` **Parâmetro obrigatório:** `cnpj` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/connect/transactions/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.pepHistory | Array | Lista de objetos com o histórico de exposição política | | data.pepHistory\[x].level | String | Nível de exposição política | | data.pepHistory\[x].jobTitle | String | Cargo | | data.pepHistory\[x].department | String | Departamento | | data.pepHistory\[x].motive | String | Motivo | | data.pepHistory\[x].cpf | String | CPF do sócio politicamente exposto | | data.pepHistory\[x].firstLevelPepCpf | String | CPF da pessoa politicamente exposta relacionada ao sócio | | data.pepHistory\[x].source | String | Fonte | | data.pepHistory\[x].startDate | String | Data de início | | data.pepHistory\[x].endDate | String | Data de término | | data.pepHistory\[x].creationDate | String | Data de criação | | data.pepHistory\[x].lastUpdateDate | String | Data da última atualização | | data.sanctionsHistory | Array | Lista de objetos com histórico de sanções e restrições | | data.sanctionsHistory\[x].source | String | Fonte da sanção | | data.sanctionsHistory\[x].type | String | Tipo de sanção | | data.sanctionsHistory\[x].matchRate | String | Taxa de correspondência do nome | | data.sanctionsHistory\[x].details | Objeto | Detalhes | | data.sanctionsHistory\[x].details.agreementNumber | String | Número do acordo | | data.sanctionsHistory\[x].details.grantingBody | String | Autoridade concedente | | data.sanctionsHistory\[x].details.impedimentReason | String | Motivos do impedimento | | data.sanctionsHistory\[x].details.nameInformedBySanctioningBody | String | Nome informado | | data.sanctionsHistory\[x].details.processNumber | String | Número do processo | | data.sanctionsHistory\[x].details.sanctioningBody | String | Órgão sancionador | | data.sanctionsHistory\[x].details.sanctioningBodyState | String | Status do órgão sancionador | | data.sanctionsHistory\[x].details.informationOrigin | String | Origem da informação | | data.sanctionsHistory\[x].details.informationOriginDate | String | Data.sanctionsHistory\[x] de origem da informação | | data.sanctionsHistory\[x].details.publicationDate | Date | Data.sanctionsHistory\[x] de publicação | | data.sanctionsHistory\[x].details.publication | String | Publicação | | data.sanctionsHistory\[x].details.legalSubstantiation | String | Fundamentação jurídica | | data.sanctionsHistory\[x].details.legalSubstantiationDescription | String | Descrição da base legal | | data.sanctionsHistory\[x].details.transitDueDate | Date | Data.sanctionsHistory\[x] de expiração da transação | | data.sanctionsHistory\[x].details.actionYear | String | Ano da ação | | data.sanctionsHistory\[x].details.employer | String | Empregador | | data.sanctionsHistory\[x].details.establishment | String | Estabelecimento | | data.sanctionsHistory\[x].details.state | String | Estado | | data.sanctionsHistory\[x].details.cnae | String | CNAE | | data.sanctionsHistory\[x].details.originalName | String | Nome original | | data.sanctionsHistory\[x].details.sanctionName | String | Nome da sanção | | data.sanctionsHistory\[x].details.nationalities | String | Nacionalidade | | data.sanctionsHistory\[x].details.fineAmount | String | Valor da multa | | data.sanctionsHistory\[x].details.organComplement | String | Complemento do órgão | | data.sanctionsHistory\[x].details.scopeDefinedInJudicialDecision | String | Escopo definido na decisão judicial | | data.sanctionsHistory\[x].details.resjusdicataDate | String | Data de término | | data.sanctionsHistory\[x].details.amountOfWorkersInvolved | String | Número de trabalhadores envolvidos | | data.sanctionsHistory\[x].details.nameInSanctionList | String | Nome na lista de sanções | | data.sanctionsHistory\[x].details.designation | String | Designação | | data.sanctionsHistory\[x].details.nationality | String | Nacionalidade | | data.sanctionsHistory\[x].details.title | String | Título | | data.sanctionsHistory\[x].details.nationalIdentificationNumber | String | Número de identificação nacional | | data.sanctionsHistory\[x].details.permanentReferenceNumber | String | Número de referência permanente | | data.sanctionsHistory\[x].details.otherInformation | String | Outras informações | | data.sanctionsHistory\[x].details.tadNumber | String | Número TAD | | data.sanctionsHistory\[x].details.selfInfringementNumber | String | Número da infração própria | | data.sanctionsHistory\[x].details.deforestedAreaHa | String | Área desmatada em hectares | | data.sanctionsHistory\[x].details.propertyLocation | String | Localização da propriedade | | data.sanctionsHistory\[x].details.propertyUF | String | Unidade Federativa da propriedade | | data.sanctionsHistory\[x].details.propertyCounty | String | Município da propriedade | | data.sanctionsHistory\[x].details.infraction | String | Infração | | data.sanctionsHistory\[x].details.registrationDate | String | Data de registro | | data.sanctionsHistory\[x].details.judgementDate | String | Data da sentença | | data.sanctionsHistory\[x].details.penalty | String | Penalidade | | data.sanctionsHistory\[x].details.penaltyTimeToBeServed | String | Tempo da pena a cumprir | | data.sanctionsHistory\[x].details.finalDeadline | String | Prazo | | data.sanctionsHistory\[x].details.irregularAction | String | Ação irregular | | data.sanctionsHistory\[x].details.deliberationContent | String | Conteúdo da deliberação | | data.sanctionsHistory\[x].details.referenceDate | String | Data de referência | | data.sanctionsHistory\[x].details.decisionType | String | Tipo de decisão | | data.sanctionsHistory\[x].details.timeToBeServed | String | Tempo a ser cumprido | | data.sanctionsHistory\[x].details.judgementDescription | String | Descrição da decisão | | data.sanctionsHistory\[x].details.completeDecisionURL | String | URL da decisão completa | | data.sanctionsHistory\[x].details.processInfoUrl | String | URL das informações do processo | | data.sanctionsHistory\[x].startDate | String | Data de início | | data.sanctionsHistory\[x].standardizedSanctionType | String | Tipo de sanção padronizado | | data.sanctionsHistory\[x].nameUniquenessScore | String | Pontuação de exclusividade do nome | | data.sanctionsHistory\[x].creationDate | String | Data de criação | | data.sanctionsHistory\[x].lastUpdateDate | String | Data da última atualização | | data.sanctionsHistory\[x].isCurrentlyPresentOnSource | String | Está atualmente presente na fonte | | data.sanctionsHistory\[x].endDate | String | Data de término | | data.isCurrentlyPEP | Boolean | Indica se a pessoa atualmente é uma PEP | | data.isCurrentlySanctioned | Boolean | Indica se a pessoa atualmente está sob alguma sanção | | data.last30DaysSanctions | Number | Número de sanções e restrições encontradas nos últimos 30 dias | | data.last90DaysSanctions | Number | Número de sanções e restrições encontradas nos últimos 90 dias | | data.last180DaysSanctions | Number | Número de sanções e restrições encontradas nos últimos 180 dias | | data.last365DaysSanctions | Number | Número de sanções e restrições encontradas nos últimos 365 dias | | data.lastYearPEPOccurence | Number | Número de registros de PEP encontrados no último ano | | data.last3YearsPEPOccurence | Number | Número de registros de PEP encontrados nos últimos 3 anos | | data.last5YearsPEPOccurence | Number | Número de registros de PEP encontrados nos últimos 5 anos | | data.last5PlusYearsPEPOccurence | Number | Número de registros de PEP encontrados nos últimos 5 anos ou mais | | data.isCurrentlyElectoralDonor | Boolean | Indica se a pessoa faz doações para campanhas políticas | | data.isHistoricalElectoralDonor | Boolean | Indica se a pessoa já fez doações para campanhas políticas | | data.totalElectoralDonationsLastTwoElections | Number | Número de doações feitas nos últimos dois ciclos eleitorais | | data.totalElectoralDonations | Number | Número total de doações realizadas | | data.totalElectoralDonationAmountLastTwoElections | Number | Soma do valor doado nos últimos dois ciclos eleitorais | | data.totalElectoralDonationAmount | Number | Valor total doado | | data.firstSanctionDate | String | Data da primeira sanção | | data.lastSanctionDate | String | Data da última sanção | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "", "data": { "message": "", "pepHistory": [ { "level": "", "jobTitle": "", "department": "", "motive": "", "cpf": "", "firstLevelPepCpf": "", "source": "", "startDate": "", "endDate": "", "creationDate": "", "lastUpdateDate": "" } ], "sanctionsHistory": [ { "source": "", "type": "", "matchRate": "", "details": { "agreementNumber": "", "grantingBody": "", "impedimentReason": "", "nameInformedBySanctioningBody": "", "processNumber": "", "sanctioningBody": "", "sanctioningBodyState": "", "informationOrigin": "", "informationOriginDate": "", "publicationDate": "2000-00-00T00:00:00", "publication": "", "legalSubstantiation": "", "legalSubstantiationDescription": "", "transitDueDate": "2000-00-00T00:00:00", "actionYear": "", "employer": "", "establishment": "", "state": "", "cnae": "", "originalName": "", "sanctionName": "", "nationalities": "", "fineAmount": "", "organComplement": "", "scopeDefinedInJudicialDecision": "", "resjusdicataDate": "", "amountOfWorkersInvolved": "", "nameInSanctionList": "", "designation": "", "nationality": "", "title": "", "nationalIdentificationNumber": "", "permanentReferenceNumber": "", "otherInformation": "", "tadNumber": "", "selfInfringementNumber": "", "deforestedAreaHa": "", "propertyLocation": "", "propertyUF": "", "propertyCounty": "", "infraction": "", "registrationDate": "", "judgementDate": "", "penalty": "", "penaltyTimeToBeServed": "", "finalDeadline": "", "irregularAction": "", "deliberationContent": "", "referenceDate": "", "decisionType": "", "timeToBeServed": "", "judgementDescription": "", "completeDecisionURL": "", "processInfoUrl": "" }, "startDate": "", "standardizedSanctionType": "", "nameUniquenessScore": "", "creationDate": "", "lastUpdateDate": "", "isCurrentlyPresentOnSource": "", "endDate": "" } ], "isCurrentlyPEP": true, "isCurrentlySanctioned": true, "last30DaysSanctions": 00, "last90DaysSanctions": 00, "last180DaysSanctions": 00, "last365DaysSanctions": 00, "lastYearPEPOccurence": 00, "last3YearsPEPOccurence": 00, "last5YearsPEPOccurence": 00, "last5PlusYearsPEPOccurence": 00, "isCurrentlyElectoralDonor": true, "isHistoricalElectoralDonor": true, "totalElectoralDonationsLastTwoElections": 00, "totalElectoralDonations": 00, "totalElectoralDonationAmountLastTwoElections": 00, "totalElectoralDonationAmount": 00, "firstSanctionDate": "", "lastSanctionDate": "" } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------ | ----------------------------------------------------------------- | | has\_no\_sanctions | Verifique se não foram encontradas sanções em listas restritivas. | | has\_no\_pep | Verifica se o titular do CPF ou CNPJ possui exposição política. | | {% endtab %} | | | {% endtabs %} | | ## KYC e Compliance de Sócios (PJ59) Retorna uma lista com os sócios da empresa consultada. **Seção:** `pjKycComplianceOwners` **Parâmetro obrigatório:** `cnpj` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------------------------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/connect/transactions/background-check/data-structure.md#status-code)) | | dados | Array | Dados de retorno | | data\[x].cpf | String | CPF do sócio | | data\[x].pepHistory | Array | Lista de objetos com histórico de exposição política | | data\[x].pepHistory\[x].level | String | Nível de PPE (Pessoa Politicamente Exposta) | | data\[x].pepHistory\[x].jobTitle | String | Cargo | | data\[x].pepHistory\[x].department | String | Departamento | | data\[x].pepHistory\[x].motive | String | Motivo | | data\[x].pepHistory\[x].source | String | Fonte | | data\[x].pepHistory\[x].startDate | String | Data em que a pessoa se tornou PEP | | data\[x].pepHistory\[x].endDate | String | Data em que a pessoa deixou de ser PEP | | data\[x].pepHistory\[x].creationDate | String | Data de criação | | data\[x].pepHistory\[x].lastUpdateDate | String | Data da última atualização | | data\[x].isCurrentlyPEP | Boolean | Se atualmente é uma PEP | | data\[x].sanctionsHistory | Array | Lista de objetos com histórico de sanções e restrições | | data\[x].sanctionsHistory\[x].source | String | Fonte da sanção | | data\[x].sanctionsHistory\[x].type | String | Tipo de sanção | | data\[x].sanctionsHistory\[x].matchRate | String | Indicação de quão semelhante é o nome | | data\[x].sanctionsHistory\[x].startDate | String | Data de início | | data\[x].sanctionsHistory\[x].endDate | String | Data de término | | data\[x].sanctionsHistory\[x].originalName | String | Nome original associado à pessoa | | data\[x].sanctionsHistory\[x].sanctionName | String | Nome registrado na lista internacional de sanções | | data\[x].sanctionsHistory\[x].nationalities | String | Nacionalidades associadas à pessoa | | data\[x].sanctionsHistory\[x].image | String | Foto da pessoa | | data\[x].sanctionsHistory\[x].height | String | Altura da pessoa | | data\[x].sanctionsHistory\[x].eyes | String | Cor dos olhos | | data\[x].sanctionsHistory\[x].distinguishMarks | String | Características | | data\[x].sanctionsHistory\[x].description | String | Descrição geral da sanção | | data\[x].isCurrentlySanctioned | Boolean | Se você está sendo sancionado atualmente | | data\[x].last30DaysSanctions | Number | Sanções nos últimos 30 dias | | data\[x].last90DaysSanctions | Number | Sanção nos últimos 90 dias | | data\[x].last180DaysSanctions | Number | Sanções nos últimos 180 dias | | data\[x].last365DaysSanctions | Number | Sanções nos últimos 365 dias | | data\[x].lastYearPEPOccurence | Number | Ocorrência de PEP no último ano | | data\[x].last3YearsPEPOccurence | Number | Ocorrência de PEP nos últimos três anos | | data\[x].last5YearsPEPOccurence | Number | Ocorrência de PEP nos últimos cinco anos | | data\[x].last5PlusYearsPEPOccurence | Number | Ocorrência de PEP nos últimos cinco anos ou mais | | data\[x].firstSanctionDate | String | Data da primeira sanção | | data\[x].lastSanctionDate | String | Data da última sanção | | data.totalCurrentlyPEP | Number | Total atual de PEPs | | data.totalHistoricallyPEP | Number | Histórico total de PEPs | | data.totalCurrentlySanctioned | Number | Total atual de sanções | | data.totalHistoricallySanctioned | Number | Histórico total de sanções | | data.averageSanctionsPerOwner | Number | Número médio de sanções por sócio da empresa | | data.pepPercentage | Number | Percentual de PEPs | | data.ownerMaxSanctions | Number | Maior número de sanções de um único sócio | | data.ownerMinSanctions | Number | Menor número de sanções de um único sócio | | data.last30DaysSanctions | Number | Sanções nos últimos 30 dias | | data.last90DaysSanctions | Number | Sanções nos últimos 90 dias | | data.last180DaysSanctions | Number | Sanções nos últimos 180 dias | | data.last365DaysSanctions | Number | Penalidades nos últimos 365 dias | | data.lastYearPEPOccurence | Number | Ocorrência de PEP no último ano | | data.last3YearsPEPOccurence | Number | Ocorrência de PEP nos últimos três anos | | data.last5YearsPEPOccurence | Number | Ocorrência de PEP nos últimos cinco anos | | data.last5PlusYearsPEPOccurence | Number | Ocorrência de PEP nos últimos cinco anos ou mais | | data.firstSanctionDate | String | Data da primeira sanção | | data.lastSanctionDate | String | Data da última sanção | | data.activeOwners | Array de strings | CPF dos sócios ativos | | data.inactiveOwners | Array de strings | CPF dos proprietários inativos | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "", "data": [ { "cpf": "", "pepHistory": [ { "level": "", "jobTitle": "", "department": "", "motive": "", "source": "", "startDate": "", "endDate": "", "creationDate": "", "lastUpdateDate": "" } ], "isCurrentlyPEP": true, "sanctionsHistory": [ { "source": "", "type": "", "matchRate": "", "startDate": "", "endDate": "", "originalName": "", "sanctionName": "", "nationalities": "", "image": "", "height": "", "eyes": "", "distinguishMarks": "", "description": "" } ], "isCurrentlySanctioned": true, "last30DaysSanctions": 00, "last90DaysSanctions": 00, "last180DaysSanctions": 00, "last365DaysSanctions": 00, "lastYearPEPOccurence": 00, "last3YearsPEPOccurence": 00, "last5YearsPEPOccurence": 00, "last5PlusYearsPEPOccurence": 00, "firstSanctionDate": "", "lastSanctionDate": "", "totalCurrentlyPEP": 00, "totalHistoricallyPEP": 00, "totalCurrentlySanctioned": 00, "totalHistoricallySanctioned": 00, "erageSanctionsPerOwner": 00, "pepPercentage": 00, "ownerMaxSanctions": 00, "ownerMinSanctions": 00, "last30DaysSanctions": 00, "last90DaysSanctions": 00, "last180DaysSanctions": 00, "last365DaysSanctions": 00, "lastYearPEPOccurence": 00, "last3YearsPEPOccurence": 00, "last5YearsPEPOccurence": 00, "last5PlusYearsPEPOccurence": 00, "firstSanctionDate": "", "lsstSanctionDate": "", "activeOwners": ["", ""], "inactiveOwners": ["", ""] } ] } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ----------------------------------------------- | --------------------------------------------------------- | | has\_no\_pep\_or\_sanctions\_compliance\_owners | Verifica se há PEPs ou sanções nos sócios de uma empresa. | | {% endtab %} | | | {% endtabs %} | | ## Processos judiciais (PJ66) Retorna informações sobre as ações judiciais que a pessoa possui, de qualquer tipo (criminal, cível, trabalhista, ...). **Seção:** `pj_processes_alt` **Obrigatório:** `cnpj` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | -------------------------------------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/connect/transactions/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.total | Number | Número total de processos | | data.results | Array | Lista de processos retornados | | data.results\[x].id | String | Identificador da consulta | | data.results\[x].criminalCategory | String | Categoria do processo | | data.results\[x].lawsuitClass | String | Classe | | data.results\[x].distributionDate | String | Data de distribuição | | data.results\[x].statusDate | String | Data do status | | data.results\[x].lawsuitDegree | String | Grau do processo | | data.results\[x].physicalLocation | String | Localização física | | data.results\[x].oldLawsuitNumber | String | Número antigo do processo | | data.results\[x].judgingBody | String | Juízo de origem | | data.results\[x].lawsuitId | String | Número do processo | | data.results\[x].isDigitalLawsuit | Boolean | Se o processo é digital | | data.results\[x].lawBranch | String | Área do Direito | | data.results\[x].segment | String | Segmento | | data.results\[x].isJusticeSecret | Boolean | Se é segredo de justiça | | data.results\[x].complementaryStatus | String | Status complementar | | data.results\[x].observationStatus | String | Status da observação | | data.results\[x].court | String | Tribunal | | data.results\[x].state | String | ESTADO | | data.results\[x].sourceUnit | String | Unidade de origem | | data.results\[x].lawsuitUrl | String | URL do processo | | data.results\[x].lawsuitValue | Objeto | Valor do processo retornado | | data.results\[x].lawsuitValue.currency | String | Moeda (R$, U$, etc) | | data.results\[x].lawsuitValue.value | Number | Valor | | data.results\[x].subjects | Array de strings | Lista de assuntos | | data.results\[x].moves | Array | Lista de movimentações do processo | | data.results\[x].moves\[x].date | String | Data da movimentação | | data.results\[x].moves\[x].description | String | Descrição da movimentação | | data.results\[x].actives | Array | Lista de ativos | | data.results\[x].actives\[x].cnpj | String | CNPJ | | data.results\[x].actives\[x].cpf | String | CPF | | data.results\[x].actives\[x].name | String | Nome | | data.results\[x].actives\[x].type | String | Tipo | | data.results\[x].actives\[x].lawyers | Array | Lista de advogados | | data.results\[x].actives\[x].lawyers\[x].oab | String | Número da OAB | | data.results\[x].actives\[x].lawyers\[x].name | String | Nome | | data.results\[x].actives\[x].lawyers\[x].cpf | String | CPF | | data.results\[x].passives | Array | Lista de passivos | | data.results\[x].passives\[x].cnpj | String | CNPJ | | data.results\[x].passives\[x].cpf | String | CPF | | data.results\[x].passives\[x].name | String | Nome | | data.results\[x].passives\[x].type | String | Tipo | | data.results\[x].passives\[x].lawyers | Array | Lista de advogados | | data.results\[x].passives\[x].lawyers\[x].oab | String | Número da OAB | | data.results\[x].passives\[x].lawyers\[x].name | String | Nome | | data.results\[x].passives\[x].lawyers\[x].cpf | String | CPF | | data.results\[x].otherParties | Array | Lista de outras partes | | data.results\[x].otherParties\[x].cnpj | String | CNPJ | | data.results\[x].otherParties\[x].cpf | String | CPF | | data.results\[x].otherParties\[x].name | String | Nome | | data.results\[x].otherParties\[x].type | String | Tipo | | data.results\[x].otherParties\[x].lawyers | Array | Lista de advogados | | data.results\[x].otherParties\[x].lawyers\[x].oab | String | Número da OAB | | data.results\[x].otherParties\[x].lawyers\[x].name | String | Nome | | data.results\[x].otherParties\[x].lawyers\[x].cpf | String | CPF | | data.results\[x].authorType | String | Tipo do autor | | data.results\[x].authorParty | String | Parte autora | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "", "data": { "message": "", "total": 00, "results": [ { "id": "", "criminalCategory": "", "lawsuitClass": "", "distributionDate": "", "statusDate": "", "lawsuitDegree": "", "physicalLocation": "", "oldLawsuitNumber": "", "judgingBody": "", "lawsuitId": "", "isDigitalLawsuit": true, "lawBranch": "", "segment": "", "isJusticeSecret": true, "complementaryStatus": "", "observationStatus": "", "court": "", "state": "", "sourceUnit": "", "lawsuitUrl": "", "lawsuitValue": { "currency": "", "value": 00 }, "subjects": ["", ""], "moves": [ { "date": "", "description": "" } ], "actives": [ { "cnpj": "", "cpf": "", "name": "", "type": "", "lawyers": [ { "oab": "", "name": "", "cpf": "" } ] } ], "passives": [ { "cnpj": "", "cpf": "", "name": "", "type": "", "lawyers": [ { "oab": "", "name": "", "cpf": "" } ] } ], "otherParties": [ { "cnpj": "", "cpf": "", "name": "", "type": "", "lawyers": [ { "oab": "", "name": "", "cpf": "" } ] } ], "authorType": "", "authorParty": "" } ] } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------------------------------ | ---------------------------------------------------------------------- | | has\_no\_processes | Verifica se o CPF/CNPJ está vinculado a processos. | | has\_no\_defendant\_processes | Verifica se o CPF/CNPJ está vinculado a processos como réu. | | has\_no\_criminal\_processes | Verifica se o CPF/CNPJ está vinculado a processos criminais. | | has\_author\_type\_null\_in\_criminal\_processes | Verifica se há um campo 'authorType' vazio em algum processo criminal. | | {% endtab %} | | | {% endtabs %} | | ## Processos judiciais com palavras-chave (PJ49) Retorna informações sobre as ações judiciais que a pessoa possui, de qualquer tipo (criminal, cível, trabalhista, ...). **Seção:** `pjProcessesWithKeywords` **Parâmetro obrigatório:** `cnpj` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | -------------------------------------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/connect/transactions/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.total | Number | Número total de processos | | data.foundWords | Array | Palavras-chave encontradas | | data.results | Array | Lista de processos retornados | | data.results\[x].id | String | Identificador da consulta | | data.results\[x].matchedWords | Array | Palavras-chave encontradas neste processo | | data.results\[x].criminalCategory | String | Categoria do processo | | data.results\[x].lawsuitClass | String | Classe | | data.results\[x].distributionDate | String | Data de distribuição | | data.results\[x].statusDate | String | Data do status | | data.results\[x].lawsuitDegree | String | Grau do processo | | data.results\[x].physicalLocation | String | Localização física | | data.results\[x].oldLawsuitNumber | String | Número antigo do processo | | data.results\[x].judgingBody | String | Juízo de origem | | data.results\[x].lawsuitId | String | Número do processo | | data.results\[x].isDigitalLawsuit | Boolean | Se o processo é digital | | data.results\[x].lawBranch | String | Área do Direito | | data.results\[x].segment | String | Segmento | | data.results\[x].isJusticeSecret | Boolean | Se é segredo de justiça | | data.results\[x].complementaryStatus | String | Status complementar | | data.results\[x].observationStatus | String | Status da observação | | data.results\[x].court | String | Tribunal | | data.results\[x].state | String | ESTADO | | data.results\[x].sourceUnit | String | Unidade de origem | | data.results\[x].lawsuitUrl | String | URL do processo | | data.results\[x].otherFields | Objeto | Outros campos | | data.results\[x].otherFields.juiz | Objeto | Juiz | | data.results\[x].otherFields.juiz.nome | String | Nome do juiz | | data.results\[x].lawsuitValue | Objeto | Retorno do valor do processo | | data.results\[x].lawsuitValue.currency | String | Moeda (R$, U$, etc) | | data.results\[x].lawsuitValue.value | Number | Valor | | data.results\[x].subjects | Array de strings | Lista de assuntos | | data.results\[x].moves | Array | Lista de movimentações processuais | | data.results\[x].moves\[x].date | String | Data da movimentação | | data.results\[x].moves\[x].description | String | Descrição da movimentação | | data.results\[x].actives | Array | Lista de ativos | | data.results\[x].actives\[x].cnpj | String | CNPJ | | data.results\[x].actives\[x].cpf | String | CPF | | data.results\[x].actives\[x].name | String | Nome | | data.results\[x].actives\[x].type | String | Tipo | | data.results\[x].actives\[x].lawyers | Array | Lista de advogados | | data.results\[x].actives\[x].lawyers\[x].oab | String | Número da OAB | | data.results\[x].actives\[x].lawyers\[x].name | String | Nome | | data.results\[x].actives\[x].lawyers\[x].cpf | String | CPF | | data.results\[x].passives | Array | Lista de passivos | | data.results\[x].passives\[x].cnpj | String | CNPJ | | data.results\[x].passives\[x].cpf | String | CPF | | data.results\[x].passives\[x].name | String | Nome | | data.results\[x].passives\[x].type | String | Tipo | | data.results\[x].passives\[x].lawyers | Array | Lista de advogados | | data.results\[x].passives\[x].lawyers\[x].oab | String | Número da OAB | | data.results\[x].passives\[x].lawyers\[x].name | String | Nome | | data.results\[x].passives\[x].lawyers\[x].cpf | String | CPF | | data.results\[x].otherParties | Array | Lista de outras partes | | data.results\[x].otherParties\[x].cnpj | String | CNPJ | | data.results\[x].otherParties\[x].cpf | String | CPF | | data.results\[x].otherParties\[x].name | String | Nome | | data.results\[x].otherParties\[x].type | String | Tipo | | data.results\[x].otherParties\[x].lawyers | Array | Lista de advogados | | data.results\[x].otherParties\[x].lawyers\[x].oab | String | Número da OAB | | data.results\[x].otherParties\[x].lawyers\[x].name | String | Nome | | data.results\[x].otherParties\[x].lawyers\[x].cpf | String | CPF | | data.results\[x].authorType | String | Tipo do autor | | data.results\[x].authorParty | String | Parte autora | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "", "data": { "message": "", "total": 00, "foundWords": [ "" ], "results": [ { "id": "", "matchedWords": [ "" ], "criminalCategory": "", "lawsuitClass": "", "distributionDate": "", "statusDate": "", "lawsuitDegree": "", "physicalLocation": "", "oldLawsuitNumber": "", "judgingBody": "", "lawsuitId": "", "isDigitalLawsuit": true, "lawBranch": "", "segment": "", "isJusticeSecret": true, "complementaryStatus": "", "observationStatus": "", "court": "", "state": "", "sourceUnit": "", "lawsuitUrl": "", "otherFields": { "juiz": { "nome": "" } }, "lawsuitValue": { "currency": "", "value": "" }, "subjects": ["", ""], "moves": [ { "date": "", "description": "" } ], "actives": [ { "cnpj": "", "cpf": "", "name": "", "type": "", "lawyers": [ { "oab": "", "name": "", "cpf": "" } ] } ], "passives": [ { "cnpj": "", "cpf": "", "name": "", "type": "", "lawyers": [ { "oab": "", "name": "", "cpf": "" } ] } ], "otherParties": [ { "cnpj": "", "cpf": "", "name": "", "type": "", "lawyers": [ { "oab": "", "name": "", "cpf": "" } ] } ], "authorType": "", "authorParty": "" } ] } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------ | ----------------------------------------------------------------------------------------------- | | has\_processes\_keywords | A regra ficará inválida se alguma das palavras-chave configuradas for encontrada nos processos. | | {% endtab %} | | | {% endtabs %} | | ## Exposição na mídia + notícias relacionadas (PJ67) Retorna indicadores globais que mostram o nível geral de exposição de uma empresa na mídia, a natureza dessa exposição, o conteúdo detalhado identificado e o resultado da análise de sentimento. **Seção:** `pjMediaProfileAndExposure` **Parâmetro obrigatório:** `cnpj` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/connect/transactions/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.mediaExposureLevel | String | Nível de exposição na mídia | | data.celebrityLevel | String | Nível de celebridade | | data.unpopularityLevel | String | Nível de impopularidade | | data.newsItems | Array | Lista de notícias capturadas para a entidade | | data.newsItems\[x].title | String | Título da notícia | | data.newsItems\[x].sourceName | String | Nome da fonte responsável pela notícia | | data.newsItems\[x].url | String | URL da notícia | | data.newsItems\[x].sentimentAnalysis | Objeto | Análise de sentimento | | data.newsItems\[x].sentimentAnalysis.label | String | Rótulo (positivo, negativo) atribuído ao conteúdo em geral | | data.newsItems\[x].sentimentAnalysis.peopleCount | String | Número de pessoas identificadas no conteúdo | | data.newsItems\[x].sentimentAnalysis.placesCount | String | Número de locais identificados no conteúdo | | data.newsItems\[x].sentimentAnalysis.organizationsCount | String | Número de empresas identificadas no conteúdo | | data.newsItems\[x].sentimentAnalysis.entities | Objeto | Dicionário com nomes de entidades e rótulos do conteúdo | | data.newsItems\[x].categories | Array | Lista de categorias da notícia | | data.newsItems\[x].captureDate | String | Data em que a notícia foi capturada | | data.newsItems\[x].publicationDate | String | Data de publicação da notícia | | data.creationDate | String | Data de criação | | data.lastUpdateDate | String | Data da última atualização | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "", "data": { "message": "", "mediaExposureLevel": "", "celebrityLevel": "", "unpopularityLevel": "", "newsItems": [ { "title": "", "sourceName": "", "url": "", "sentimentAnalysis": { "label": "", "peopleCount": "", "placesCount": "", "organizationsCount": "", "entities": "" }, "categories": "", "captureDate": "", "publicationDate": "" } ], "creationDate": "", "lastUpdateDate": "" } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------ | ---------------------------------------------------- | | has\_no\_media\_exposure | Verifica se o titular do CPF tem exposição na mídia. | | {% endtab %} | | | {% endtabs %} | | ## Lista de sanções do OFAC Consulta a Lista de Nacionais Especialmente Designados e Pessoas Bloqueadas (SDN) do Office of Foreign Assets Control (OFAC). A consulta é por nome e tem escopo internacional. **Seção:** `pjOfacSanctionsList` **Parâmetro obrigatório:** `name` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ----------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/connect/transactions/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.sanctionsList | Array | Lista de protocolos encontrados para o cpf consultado | | data.sanctionsList\[x].type | String | Tipo | | data.sanctionsList\[x].entityName | String | Nome da empresa | | data.sanctionsList\[x].list | String | Lista à qual o nome pertence | | data.sanctionsList\[x].program | String | Programa ao qual o nome pertence | | data.sanctionsList\[x].remarks | String | Observações | | data.sanctionsList\[x].identifications | Array | Lista de identificações conhecidas do nome informado | | data.sanctionsList\[x].identifications\[x].type | String | Tipo de identificação | | data.sanctionsList\[x].identifications\[x].number | String | Número do documento | | data.sanctionsList\[x].identifications\[x].country | String | País de origem do documento | | data.sanctionsList\[x].identifications\[x].issueDate | String | Data de emissão do documento | | data.sanctionsList\[x].identifications\[x].expireDate | String | Data de expiração do documento | | data.sanctionsList\[x].aliases | Array | Lista de sobrenomes pelos quais o nome informado também pode ser identificado | | data.sanctionsList\[x].aliases\[x].type | String | Tipo de sobrenome | | data.sanctionsList\[x].aliases\[x].category | String | Categoria do sobrenome | | data.sanctionsList\[x].aliases\[x].name | String | Nome ou sobrenome (pode ser documento falso) | | data.sanctionsList\[x].addresses | Array | Lista de endereços conhecidos do nome informado | | data.sanctionsList\[x].addresses\[x].address | String | Endereço | | data.sanctionsList\[x].addresses\[x].city | String | Cidade | | data.sanctionsList\[x].addresses\[x].stateOrProvince | String | Estado ou província | | data.sanctionsList\[x].addresses\[x].postalCode | String | Código postal (CEP) | | data.sanctionsList\[x].addresses\[x].country | String | País | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "", "data": { "message": "", "sanctionsList": [ { "type": "", "entityName": "", "list": "", "program": "", "remarks": "", "identifications": [ { "type": "", "number": "", "country": "", "issueDate": "", "expireDate": "" } ], "aliases": [ { "type": "", "category": "", "name": "" } ], "addresses": [ { "address": "", "city": "", "stateOrProvince": "", "postalCode": "", "country": "" } ] } ] } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ----------------------------- | ------------------------------------------------------------ | | is\_on\_ofac\_sanctions\_list | Verifica se há algum registro no OFAC para o nome informado. | | {% endtab %} | | | {% endtabs %} | | ## Lista de restrições privadas (PJ78) Consulta a presença na lista privada de restrições. **Seção:** `pjDenyListPrivate` **Parâmetro obrigatório:** `cnpj` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/connect/transactions/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.recordFound | Boolean | Indicativo de presença na lista de restrições privadas | | data.cnpj | String | CNPJ | | data.name | String | Nome | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "", "data": { "message": "", "recordFound": true, "cnpj": "", "name": "" } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------- | -------------------------------------------------------------------- | | its\_on\_deny\_list | A regra será inválida se o CPF/CNPJ consultado estiver na Deny List. | | {% endtab %} | | | {% endtabs %} | | ## ANTT Consulte o site da ANTT para identificar se o transportador está habilitado a realizar atividades. **Seção:** `antt` **Parâmetro obrigatório:** `cnpj, placa` **Formatos de placa:** *AAA9999* ou *AAA9A999* {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/connect/transactions/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.hasRegister | Boolean | Status informando se contém registro | | data.transporter | String | Transportador | | data.rntrc | String | Número do RNTRC | | data.rntrcSituation | String | Status | | data.memberSince | String | Data do primeiro relacionamento | | data.expirationDate | String | Data de validade | | data.city | String | Cidade | | data.message | String | Mensagem presente no registro | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "", "data": { "hasRegister": true, "transporter": "", "rntrc": "", "rntrcSituation": "", "memberSince": "", "expirationDate": "", "city": "", "message": "" } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | -------------------------- | ----------------------------------------------------------------------------------------------------------------- | | has\_no\_participant\_antt | A regra será inválida se o veículo consultado e a pessoa/empresa não estiverem autorizados a realizar atividades. | | {% endtab %} | | | {% endtabs %} | | ## Processos judiciais - NOVO (PJ69) Retorna todos os processos judiciais disponíveis por meio de uma consulta expandida, garantindo a cobertura máxima de informações. **Seção:** `pjLegalRecordsExtended` **Parâmetro obrigatório:** `cnpj` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | -------------------------------------------------------------------- | ------- | ------------------------------------ | | código de status | String | Consultar status | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.lawsuits | Array | Lista de processos retornada | | data.lawsuits\[x].cnjCode | String | Código CNJ | | data.lawsuits\[x].secrecyLevel | Number | Nível de sigilo | | data.lawsuits\[x].amount | Number | Valor do processo | | data.lawsuits\[x].area | String | Área do processo | | data.lawsuits\[x].instance | Number | Grau do processo | | data.lawsuits\[x].phase | String | Fase do processo | | data.lawsuits\[x].status | String | Status do processo | | data.lawsuits\[x].judge | String | Juiz do processo | | data.lawsuits\[x].name | String | Abreviação das partes | | data.lawsuits\[x].courtAcronym | String | Sigla do tribunal | | data.lawsuits\[x].courtDistrict | String | Comarca | | data.lawsuits\[x].state | String | Estado do processo | | data.lawsuits\[x].city | String | Cidade do processo | | data.lawsuits\[x].distributionDate | String | Data de distribuição | | data.lawsuits\[x].justiceDescription | String | Descrição da justiça | | data.lawsuits\[x].isCriminal | Boolean | Indicação de processo criminal | | data.lawsuits\[x].mainPartySide | String | Lado da parte pesquisada | | data.lawsuits\[x].lastStep | Objeto | Último andamento do processo | | data.lawsuits\[x].lastStep.stepId | String | Identificador do último andamento | | data.lawsuits\[x].lastStep.stepDate | String | Data do último andamento | | data.lawsuits\[x].lastStep.content | String | Conteúdo do último andamento | | data.lawsuits\[x].lastStep.stepType | String | Tipo do último andamento | | data.lawsuits\[x].lastStep.stepsCount | Number | Quantidade de últimos andamentos | | data.lawsuits\[x].relatedLawsuits | Array | Processos relacionados | | data.lawsuits\[x].relatedLawsuits\[x].code | String | Código dos processos relacionados | | data.lawsuits\[x].relatedLawsuits\[x].instance | String | Instância dos processos relacionados | | data.lawsuits\[x].steps | Array | Andamentos | | data.lawsuits\[x].steps\[x].stepDate | String | Data do andamento | | data.lawsuits\[x].steps\[x].stepType | String | Tipo do andamento | | data.lawsuits\[x].steps\[x].content | String | Conteúdo do andamento | | data.lawsuits\[x].steps\[x].private | String | Andamento sigiloso | | data.lawsuits\[x].subjects | Array | Assuntos | | data.lawsuits\[x].subjects\[x].code | String | Código do assunto | | data.lawsuits\[x].subjects\[x].subject | String | Descrição do assunto | | data.lawsuits\[x].courts | Array | Tribunais | | data.lawsuits\[x].courts\[x].code | String | Código do tribunal | | data.lawsuits\[x].courts\[x].court | String | Descrição do tribunal | | data.lawsuits\[x].classifications | Array | Classificações | | data.lawsuits\[x].classifications\[x].code | String | Código da classificação | | data.lawsuits\[x].classifications\[x].classification | String | Descrição da classificação | | data.lawsuits\[x].parties | Array | Partes | | data.lawsuits\[x].parties\[x].type | String | Tipo da parte | | data.lawsuits\[x].parties\[x].side | String | Lado da parte | | data.lawsuits\[x].parties\[x].party | String | Descrição da parte | | data.lawsuits\[x].parties\[x].mainDocument | String | Documento principal da parte | | data.lawsuits\[x].parties\[x].documents | Array | Documentos da parte | | data.lawsuits\[x].parties\[x].documents\[x].documentType | String | Tipo de documento da parte | | data.lawsuits\[x].parties\[x].documents\[x].document | String | Documento da parte | | data.lawsuits\[x].parties\[x].lawyers | Array | Advogados da parte | | data.lawsuits\[x].parties\[x].lawyers\[x].name | String | Nome do advogado | | data.lawsuits\[x].parties\[x].lawyers\[x].mainDocument | String | Documento principal dos advogados | | data.lawsuits\[x].parties\[x].lawyers\[x].documents | Array | Documentos dos advogados | | data.lawsuits\[x].parties\[x].lawyers\[x].documents\[x].documentType | String | Tipo de documento dos advogados | | data.lawsuits\[x].parties\[x].lawyers\[x].documents\[x].document | String | Documento dos advogados | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "message": "Consulta realizada com sucesso", "data": { "lawsuits": [ { "type": "processo", "cnjCode": "099999-09.0990.9.99.9900", "secrecyLevel": 0, "amount": 1000, "area": "DIREITO PROCESSUAL CIVIL", "status": "Ativo", "phase": "Inicial", "judge": "", "instance": 1, "name": "JONH DOE X JANE DOE", "courtAcronym": "TJSP", "courtDistrict": "VARA DA COMARCA DE SÃO PAULO", "state": "sp", "city": "SÃO PAULO", "distributionDate": "2024-03-12T09:57:51.000Z", "justiceDescription": "JUSTIÇA ESTADUAL", "isCriminal": false, "mainPartySide": "ATIVO", "steps": [], "subjects": [ { "code": "10671", "subject": "Obrigação de Fazer / Não Fazer" } ], "courts": [ { "code": "5117", "court": "VARA DA COMARCA DE SÃO PAULO" } ], "classifications": [ { "code": "436", "classification": "" } ], "parties": [ { "type": "Réu", "side": "Passivo", "party": "JANE DOE", "mainDocument": "99999999999", "documents": [ { "documentType": "cpf", "document": "99999999999" } ], "lawyers": [ { "name": "JOSE DOE", "mainDocument": "", "documents": [] } ] }, { "type": "Autor", "side": "Ativo", "party": "JOHN DOE", "mainDocument": "88888888888", "documents": [ { "documentType": "cpf", "document": "88888888888" } ], "lawyers": [ { "name": "JOÃO DOE", "mainDocument": "", "documents": [] } ] }, { "type": "Advogado", "side": "Passivo", "party": "JOSE DOE", "mainDocument": "", "documents": [], "lawyers": [] }, { "type": "Advogado", "side": "Ativo", "party": "JOÃO DOE", "mainDocument": "", "documents": [], "lawyers": [] } ] } ] } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------------------------------ | ---------------------------------------------------------------------- | | has\_no\_processes | Verifica se o CPF/CNPJ está vinculado a processos. | | has\_no\_processes\_active\_party | Verifica se o CPF está vinculado a processos como parte ativa. | | has\_no\_processes\_passive\_party | Verifica se o CPF está vinculado a processos como parte passiva. | | has\_no\_processes\_other\_party | Verifica se o CPF está vinculado a processos como outras partes. | | has\_no\_defendant\_processes | Verifica se o CPF/CNPJ está vinculado a processos como réu. | | has\_no\_criminal\_processes | Verifica se o CPF/CNPJ está vinculado a processos criminais. | | has\_author\_type\_null\_in\_criminal\_processes | Verifica se há um campo 'authorType' vazio em algum processo criminal. | | {% endtab %} | | | {% endtabs %} | | ## Processos judiciais com palavras-chave - NOVO (PJ70) Retorna todos os processos judiciais disponíveis por meio de uma consulta expandida, garantindo a cobertura máxima de informações. **Seção:** `pjLegalRecordsExtendedKeywords` **Parâmetro obrigatório:** `cnpj` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | -------------------------------------------------------------------- | ------- | ----------------------------------------- | | código de status | String | Consultar status | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.foundKeywords | Array | Palavras-chave encontradas | | data.lawsuits | Array | Lista de processos retornada | | data.lawsuits\[x].matchedWords | Array | Palavras-chave encontradas neste processo | | data.lawsuits\[x].cnjCode | String | Código CNJ | | data.lawsuits\[x].secrecyLevel | Number | Nível de sigilo | | data.lawsuits\[x].amount | Number | Valor do processo | | data.lawsuits\[x].area | String | Área do processo | | data.lawsuits\[x].instance | Number | Grau do processo | | data.lawsuits\[x].phase | String | Fase do processo | | data.lawsuits\[x].status | String | Status do processo | | data.lawsuits\[x].judge | String | Juiz do processo | | data.lawsuits\[x].name | String | Abreviação das partes | | data.lawsuits\[x].courtAcronym | String | Sigla do tribunal | | data.lawsuits\[x].courtDistrict | String | Comarca | | data.lawsuits\[x].state | String | Estado do processo | | data.lawsuits\[x].city | String | Cidade do processo | | data.lawsuits\[x].distributionDate | String | Data de distribuição | | data.lawsuits\[x].justiceDescription | String | Descrição da justiça | | data.lawsuits\[x].isCriminal | Boolean | Indicação de processo criminal | | data.lawsuits\[x].mainPartySide | String | Lado da parte pesquisada | | data.lawsuits\[x].lastStep | Objeto | Último andamento do processo | | data.lawsuits\[x].lastStep.stepId | String | Identificador do último andamento | | data.lawsuits\[x].lastStep.stepDate | String | Data do último andamento | | data.lawsuits\[x].lastStep.content | String | Conteúdo do último andamento | | data.lawsuits\[x].lastStep.stepType | String | Tipo do último andamento | | data.lawsuits\[x].lastStep.stepsCount | Number | Quantidade de últimos andamentos | | data.lawsuits\[x].relatedLawsuits | Array | Processos relacionados | | data.lawsuits\[x].relatedLawsuits\[x].code | String | Código dos processos relacionados | | data.lawsuits\[x].relatedLawsuits\[x].instance | String | Instância dos processos relacionados | | data.lawsuits\[x].steps | Array | Andamentos | | data.lawsuits\[x].steps\[x].stepDate | String | Data do andamento | | data.lawsuits\[x].steps\[x].stepType | String | Tipo do andamento | | data.lawsuits\[x].steps\[x].content | String | Conteúdo do andamento | | data.lawsuits\[x].steps\[x].private | String | Andamento sigiloso | | data.lawsuits\[x].subjects | Array | Assuntos | | data.lawsuits\[x].subjects\[x].code | String | Código do assunto | | data.lawsuits\[x].subjects\[x].subject | String | Descrição do assunto | | data.lawsuits\[x].courts | Array | Tribunais | | data.lawsuits\[x].courts\[x].code | String | Código do tribunal | | data.lawsuits\[x].courts\[x].court | String | Descrição do tribunal | | data.lawsuits\[x].classifications | Array | Classificações | | data.lawsuits\[x].classifications\[x].code | String | Código da classificação | | data.lawsuits\[x].classifications\[x].classification | String | Descrição da classificação | | data.lawsuits\[x].parties | Array | Partes | | data.lawsuits\[x].parties\[x].type | String | Tipo da parte | | data.lawsuits\[x].parties\[x].side | String | Lado da parte | | data.lawsuits\[x].parties\[x].party | String | Descrição da parte | | data.lawsuits\[x].parties\[x].mainDocument | String | Documento principal da parte | | data.lawsuits\[x].parties\[x].documents | Array | Documentos da parte | | data.lawsuits\[x].parties\[x].documents\[x].documentType | String | Tipo de documento da parte | | data.lawsuits\[x].parties\[x].documents\[x].document | String | Documento da parte | | data.lawsuits\[x].parties\[x].lawyers | Array | Advogados da parte | | data.lawsuits\[x].parties\[x].lawyers\[x].name | String | Nome do advogado | | data.lawsuits\[x].parties\[x].lawyers\[x].mainDocument | String | Documento principal dos advogados | | data.lawsuits\[x].parties\[x].lawyers\[x].documents | Array | Documentos dos advogados | | data.lawsuits\[x].parties\[x].lawyers\[x].documents\[x].documentType | String | Tipo de documento dos advogados | | data.lawsuits\[x].parties\[x].lawyers\[x].documents\[x].document | String | Documento dos advogados | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "message": "Consulta realizada com sucesso", "data": { "foundKeywords": [ "Indenização por dano moral" ], "lawsuits": [ { "type": "processo", "matchedWords": [ "Indenização por dano moral" ], "cnjCode": "099999-09.0990.9.99.9900", "secrecyLevel": 0, "amount": 1000, "area": "DIREITO PROCESSUAL CIVIL", "phase": "Inicial", "status": "Ativo", "judge": "", "instance": 1, "name": "JONH DOE X JANE DOE", "courtAcronym": "TJSP", "courtDistrict": "VARA DA COMARCA DE SÃO PAULO", "state": "sp", "city": "SÃO PAULO", "distributionDate": "2024-03-12T09:57:51.000Z", "justiceDescription": "JUSTIÇA ESTADUAL", "isCriminal": false, "mainPartySide": "ATIVO", "steps": [], "subjects": [ { "code": "10671", "subject": "Obrigação de Fazer / Não Fazer" }, { "code": "10001", "subject": "Indenização por dano moral" } ], "courts": [ { "code": "5117", "court": "VARA DA COMARCA DE SÃO PAULO" } ], "classifications": [ { "code": "436", "classification": "" } ], "parties": [ { "type": "Réu", "side": "Passivo", "party": "JANE DOE", "mainDocument": "99999999999", "documents": [ { "documentType": "cpf", "document": "99999999999" } ], "lawyers": [ { "name": "JOSE DOE", "mainDocument": "", "documents": [] } ] }, { "type": "Autor", "side": "Ativo", "party": "JOHN DOE", "mainDocument": "88888888888", "documents": [ { "documentType": "cpf", "document": "88888888888" } ], "lawyers": [ { "name": "JOÃO DOE", "mainDocument": "", "documents": [] } ] }, { "type": "Advogado", "side": "Passivo", "party": "JOSE DOE", "mainDocument": "", "documents": [], "lawyers": [] }, { "type": "Advogado", "side": "Ativo", "party": "JOÃO DOE", "mainDocument": "", "documents": [], "lawyers": [] } ] } ] } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------ | ----------------------------------------------------------------------------------------------- | | has\_processes\_keywords | A regra ficará inválida se alguma das palavras-chave configuradas for encontrada nos processos. | | {% 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/connect/transactions/background-check/kyb/risk.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.