> 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/api-core/transaction-details/background-check/kyb/risk.md). # Risco ## KYC e Conformidade (PJ44) **Seção:** `pjKycCompliance` **Parâmetro obrigatório:** `cnpj` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/api-core/transaction-details/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 parceiro exposto politicamente | | data.pepHistory\[x].firstLevelPepCpf | String | CPF da pessoa exposta politicamente relacionada ao parceiro | | 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 similaridade 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 | Situação do órgão sancionador | | data.sanctionsHistory\[x].details.informationOrigin | String | Origem da informação | | data.sanctionsHistory\[x].details.informationOriginDate | String | Data de origem da informação | | data.sanctionsHistory\[x].details.publicationDate | Data | Data da 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 | Data | Data de vencimento da tramitaçã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 encerramento | | 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 | Hectares de área desmatada | | data.sanctionsHistory\[x].details.propertyLocation | String | Localização do imóvel | | data.sanctionsHistory\[x].details.propertyUF | String | UF do imóvel | | data.sanctionsHistory\[x].details.propertyCounty | String | País 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 de 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 cumprir | | 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 | Booleano | Indica se a pessoa é atualmente uma PEP | | data.isCurrentlySanctioned | Booleano | Indica se a pessoa está atualmente sob alguma sanção | | data.last30DaysSanctions | Número | Número de sanções e restrições encontradas nos últimos 30 dias | | data.last90DaysSanctions | Número | Número de sanções e restrições encontradas nos últimos 90 dias | | data.last180DaysSanctions | Número | Número de sanções e restrições encontradas nos últimos 180 dias | | data.last365DaysSanctions | Número | Número de sanções e restrições encontradas nos últimos 365 dias | | data.lastYearPEPOccurence | Número | Número de registros de PEP encontrados no último ano | | data.last3YearsPEPOccurence | Número | Número de registros de PEP encontrados nos últimos 3 anos | | data.last5YearsPEPOccurence | Número | Número de registros de PEP encontrados nos últimos 5 anos | | data.last5PlusYearsPEPOccurence | Número | Número de registros de PEP encontrados nos últimos 5 anos ou mais | | data.isCurrentlyElectoralDonor | Booleano | Indica se a pessoa faz doações para campanhas políticas | | data.isHistoricalElectoralDonor | Booleano | Indica se a pessoa já fez doações para campanhas políticas | | data.totalElectoralDonationsLastTwoElections | Número | Número de doações feitas nos últimos dois ciclos eleitorais | | data.totalElectoralDonations | Número | Número total de doações feitas | | data.totalElectoralDonationAmountLastTwoElections | Número | Soma do valor doado nos últimos dois ciclos eleitorais | | data.totalElectoralDonationAmount | Número | 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 | | ----------------- | ----------------------------------------------------------------- | | nao\_tem\_sancoes | Verifique se nenhuma sanção foi encontrada em listas restritivas. | | nao\_tem\_pep | Verifica se o titular do CPF ou CNPJ possui exposição política. | | {% endtab %} | | | {% endtabs %} | | ## KYC e Conformidade 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 | | ---------------------------------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/api-core/transaction-details/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 PEP (Pessoa Exposta Politicamente) | | 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 uma PEP | | data\[x].pepHistory\[x].endDate | String | Data em que a pessoa deixou de ser uma 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 | Booleano | 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 próximo o nome se assemelha | | 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 ao indivíduo | | data\[x].sanctionsHistory\[x].sanctionName | String | Nome registrado na lista internacional de sanções | | data\[x].sanctionsHistory\[x].nationalities | String | Nacionalidades associadas ao indivíduo | | data\[x].sanctionsHistory\[x].image | String | Foto do indivíduo | | data\[x].sanctionsHistory\[x].height | String | Altura do indivíduo | | 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 | Booleano | Se você estiver atualmente sancionado | | data\[x].last30DaysSanctions | Número | Sanções nos últimos 30 dias | | data\[x].last90DaysSanctions | Número | Sanção nos últimos 90 dias | | data\[x].last180DaysSanctions | Número | Sanções nos últimos 180 dias | | data\[x].last365DaysSanctions | Número | Sanção nos últimos 365 dias | | data\[x].lastYearPEPOccurence | Número | Ocorrência de PEP no último ano | | data\[x].last3YearsPEPOccurence | Número | Ocorrência de PEP nos últimos três anos | | data\[x].last5YearsPEPOccurence | Número | Ocorrência de WBS nos últimos cinco anos | | data\[x].last5PlusYearsPEPOccurence | Número | Ocorrência de WBS em cinco anos ou mais | | data\[x].firstSanctionDate | String | Data da primeira sanção | | data\[x].lastSanctionDate | String | Data da última sanção | | data.totalCurrentlyPEP | Número | Total atual de PEPs | | data.totalHistoricallyPEP | Número | Total histórico de PEPs | | data.totalCurrentlySanctioned | Número | Total atual de sanções | | data.totalHistoricallySanctioned | Número | Total histórico de sanções | | data.averageSanctionsPerOwner | Número | Número médio de sanções por sócio da empresa | | data.pepPercentage | Número | Percentual de WBS | | data.ownerMaxSanctions | Número | Maior número de sanções de um único membro | | data.ownerMinSanctions | Número | Menor número de sanções de um único membro | | data.last30DaysSanctions | Número | Sanções nos últimos 30 dias | | data.last90DaysSanctions | Número | Sanções nos últimos 90 dias | | data.last180DaysSanctions | Número | Sanções nos últimos 180 dias | | data.last365DaysSanctions | Número | Penalidades nos últimos 365 dias | | data.lastYearPEPOccurence | Número | Ocorrência de PEP no último ano | | data.last3YearsPEPOccurence | Número | Ocorrência de PEP nos últimos três anos | | data.last5YearsPEPOccurence | Número | Ocorrência de WBS nos últimos cinco anos | | data.last5PlusYearsPEPOccurence | Número | Ocorrência de WBS em 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 sócios 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 | | --------------------------------- | ------------------------------------------------------------------------ | | nao\_tem\_pep\_ou\_sancoes\_socio | Verifica a existência de PEPs ou sanções sobre os sócios de uma empresa. | | {% endtab %} | | | {% endtabs %} | | ## Estrutura societária (PJ63) Retorna os dados cadastrais e a estrutura societária (sócios e representantes legais) da empresa consultada. Quando o CNPJ pertencer a um MEI, o CPF do titular é retornado. **Seção:** `pjCorporateStructure` **Parâmetro obrigatório:** `cnpj` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/api-core/transaction-details/background-check/data-structure.md#status-code)) | | message | String | Mensagem retornada quando não houver dados cadastrados | | dados | Objeto | Dados de retorno | | data.registrationNumber | String | CNPJ da empresa | | data.officialName | String | Razão social da empresa | | data.fantasyName | String | Nome fantasia da empresa | | data.companyEmail | String | E-mail da empresa | | data.openingDate | String | Data de abertura | | data.jointStock | String | Capital social | | data.status | String | Situação cadastral | | data.statusDate | String | Data da situação cadastral | | data.specialStatus | String | Situação especial (ex.: liquidação extrajudicial) | | data.specialStatusDate | String | Data da situação especial | | data.reasonSituation | String | Código do motivo da situação cadastral | | data.legalNature | String | Natureza jurídica (código e descrição) | | data.legalNatureCode | String | Código da natureza jurídica | | data.legalNatureDescription | String | Descrição da natureza jurídica | | data.isMei | Booleano | Se a empresa é MEI | | data.isSimples | Booleano | Se a empresa opta pelo Simples Nacional | | data.companySize | String | Porte da empresa | | data.mainActivity | String | Atividade principal (código e descrição CNAE) | | data.mainActivityCode | String | Código da atividade principal (CNAE) | | data.mainActivityDescription | String | Descrição da atividade principal | | data.secondaryActivities | Array | Lista de atividades secundárias | | data.secondaryActivities\[x].code | String | Código da atividade secundária (CNAE) | | data.secondaryActivities\[x].description | String | Descrição da atividade secundária | | data.address | Objeto | Endereço da empresa | | data.address.street | String | Rua | | data.address.number | String | Número | | data.address.complement | String | Complemento | | data.address.neighborhood | String | Bairro | | data.address.zipCode | String | CEP | | data.address.city | String | Cidade | | data.address.state | String | Estado | | data.phoneNumberDDD | String | DDD do telefone | | data.phoneNumber | String | Número de telefone | | data.items | Array | Lista de sócios e representantes legais | | data.items\[x].isActiveOwner | Booleano | Se o sócio está ativo | | data.items\[x].personType | String | Tipo de pessoa (Física/Jurídica) | | data.items\[x].name | String | Nome do sócio | | data.items\[x].cpf | String | CPF do sócio (pessoas físicas; também o titular do MEI) | | data.items\[x].cnpj | String | CNPJ do sócio (pessoas jurídicas) | | data.items\[x].function | String | Descrição do cargo/qualificação | | data.items\[x].functionCode | String | Código do cargo/qualificação | | data.items\[x].entryDate | String | Data de entrada do sócio na empresa | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "", "data": { "registrationNumber": "", "officialName": "", "fantasyName": "", "companyEmail": "", "openingDate": "", "jointStock": "", "status": "", "statusDate": "", "specialStatus": "", "specialStatusDate": "", "reasonSituation": "", "legalNature": "", "legalNatureCode": "", "legalNatureDescription": "", "isMei": true, "isSimples": true, "porteDaEmpresa": "", "mainActivity": "", "mainActivityCode": "", "mainActivityDescription": "", "secondaryActivities": [ { "code": "", "description": "" } ], "address": { "street": "", "number": "", "complement": "", "neighborhood": "", "zipCode": "", "city": "", "state": "" }, "phoneNumberDDD": "", "phoneNumber": "", "items": [ { "isActiveOwner": true, "personType": "", "name": "", "cpf": "", "cnpj": "", "function": "", "functionCode": "", "entryDate": "" } ] } } ``` {% endtab %} {% endtabs %} ## 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 | | -------------------------------------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/api-core/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.total | Número | 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 da situação | | 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 | Vara de julgamento | | data.results\[x].lawsuitId | String | Número do processo | | data.results\[x].isDigitalLawsuit | Booleano | Se o processo for digital | | data.results\[x].lawBranch | String | Área do Direito | | data.results\[x].segment | String | Segmento | | data.results\[x].isJusticeSecret | Booleano | Se for segredo de justiça | | data.results\[x].complementaryStatus | String | Situação complementar | | data.results\[x].observationStatus | String | Situação de 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 | Número | 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 bens | | 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 | | ------------------------------------------------- | ------------------------------------------------------------------------- | | nao\_tem\_processos | Verifica se o CPF/CNPJ está vinculado a processos. | | nao\_tem\_processos\_reus | Verifica se o CPF/CNPJ está vinculado a processos como réu. | | nao\_tem\_processos\_criminais | Verifica se o CPF/CNPJ está vinculado a processos criminais. | | tem\_author\_type\_nulo\_em\_processos\_criminais | Verifica se há um campo 'authorType' vazio em qualquer processo criminal. | | {% endtab %} | | | {% endtabs %} | | ## Processos 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 | | -------------------------------------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/api-core/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.total | Número | 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 da situação | | 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 | Vara de julgamento | | data.results\[x].lawsuitId | String | Número do processo | | data.results\[x].isDigitalLawsuit | Booleano | Se o processo for digital | | data.results\[x].lawBranch | String | Área do Direito | | data.results\[x].segment | String | Segmento | | data.results\[x].isJusticeSecret | Booleano | Se for segredo de justiça | | data.results\[x].complementaryStatus | String | Situação complementar | | data.results\[x].observationStatus | String | Situação de 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 | Valor retornado do processo | | data.results\[x].lawsuitValue.currency | String | Moeda (R$, U$, etc) | | data.results\[x].lawsuitValue.value | Número | 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 bens | | 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 | | ----------------------------------- | ----------------------------------------------------------------------------------------------------- | | tem\_palavras\_chave\_em\_processos | A regra ficará inválida se qualquer uma 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 | | ------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/api-core/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descritivo com status da consulta | | data.mediaExposureLevel | String | Nível de exposição na mídia | | data.celebrityLevel | String | Nível de notoriedade | | 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 lugares 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 | | ------------------------------ | ---------------------------------------------------- | | nao\_tem\_exposicao\_na\_midia | Verifica se o titular do CPF tem exposição na mídia. | | {% endtab %} | | | {% endtabs %} | | ## Lista de sanções da OFAC Consulta a lista de Nacionais Especialmente Designados e Pessoas Bloqueadas (SDN) do Escritório de Controle de Ativos Estrangeiros (OFAC). A consulta é feita por nome e tem abrangência internacional. **Seção:** `pjOfacSanctionsList` **Parâmetro obrigatório:** `nome` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ----------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/api-core/transaction-details/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 validade 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 | Primeiro 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 | | ---------------------------------- | ------------------------------------------------------------ | | esta\_na\_lista\_de\_sancoes\_ofac | Verifica se há algum registro na OFAC para o nome informado. | | {% endtab %} | | | {% endtabs %} | | ## Lista privada de restrições (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 | | ---------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/api-core/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descritivo com status da consulta | | data.recordFound | Booleano | Indica presença na lista privada de restrições | | 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 | | ---------------------------- | ---------------------------------------------------------------------------- | | esta\_na\_lista\_de\_negados | A regra será inválida se o CPF/CNPJ consultado estiver na Lista de Bloqueio. | | {% endtab %} | | | {% endtabs %} | | ## ANTT Consulte o site da ANTT para identificar se o transportador está habilitado a exercer atividades. **Seção:** `antt` **Parâmetro obrigatório:** `cnpj, placa` **Formatos da placa:** *AAA9999* ou *AAA9A999* {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/api-core/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.hasRegister | Booleano | 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 vínculo | | data.expirationDate | String | Data de validade | | data.city | String | Cidade | | data.message | String | Mensagem presente no cadastro | | {% 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 | | ---------------------------- | ----------------------------------------------------------------------------------------------------------------- | | nao\_tem\_participante\_antt | A regra será inválida se o veículo e a pessoa/empresa consultados não estiverem autorizados a exercer atividades. | | {% endtab %} | | | {% endtabs %} | | ## Processos - NOVO (PJ69) Retorna todos os processos judiciais disponíveis por meio de uma consulta ampliada, garantindo a máxima cobertura de informações. **Seção:** `pjLegalRecordsExtended` **Parâmetro obrigatório:** `cnpj` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | -------------------------------------------------------------------- | -------- | ------------------------------------ | | statusCode | String | Status da consulta | | 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 | Número | Nível de sigilo | | data.lawsuits\[x].amount | Número | Valor do processo | | data.lawsuits\[x].area | String | Área do processo | | data.lawsuits\[x].instance | Número | 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 | Booleano | Indicação de processo criminal | | data.lawsuits\[x].mainPartySide | String | Lado da parte pesquisada | | data.lawsuits\[x].lastStep | Objeto | Última movimentação do processo | | data.lawsuits\[x].lastStep.stepId | String | Identificador da última movimentação | | data.lawsuits\[x].lastStep.stepDate | String | Data da última movimentação | | data.lawsuits\[x].lastStep.content | String | Conteúdo da última movimentação | | data.lawsuits\[x].lastStep.stepType | String | Tipo da última movimentação | | data.lawsuits\[x].lastStep.stepsCount | Número | Contagem da última movimentação | | 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 | Movimentações | | data.lawsuits\[x].steps\[x].stepDate | String | Data da movimentação | | data.lawsuits\[x].steps\[x].stepType | String | Tipo da movimentação | | data.lawsuits\[x].steps\[x].content | String | Conteúdo da movimentação | | data.lawsuits\[x].steps\[x].private | String | Movimentação sigilosa | | 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 do 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 do 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": "lawsuit", "cnjCode": "099999-09.0990.9.99.9900", "secrecyLevel": 0, "amount": 1000, "area": "DIREITO PROCESSUAL CIVIL", "status": "Ativo", "phase": "Incial", "judge": "", "instance": 1, "name": "JONH DOE X JANE DOE", "courtAcronym": "TJSP", "courtDistrict": "VARA DA COMARCA DE SÃO PAULO", "state": "sp", "city": "SÃO PAULO", "distributionDate": "2024-03-12T09:57:51.000Z", "justiceDescription": "JUSTIÇA ESTADUAL", "isCriminal": false, "mainPartySide": "ATIVO", "steps": [], "subjects": [ { "code": "10671", "subject": "Obrigação de Fazer / Não Fazer" } ], "courts": [ { "code": "5117", "court": "VARA DA COMARCA DE SÃO PAULO" } ], "classifications": [ { "code": "436", "classification": "" } ], "parties": [ { "type": "Réu", "side": "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 | | ------------------------------------------------- | ------------------------------------------------------------------------- | | nao\_tem\_processos | Verifica se o CPF/CNPJ está vinculado a processos. | | nao\_tem\_processos\_parte\_ativa | Verifique se o CPF está vinculado a processos como parte ativa. | | nao\_tem\_processos\_parte\_passiva | Verifique se o CPF está vinculado a processos como parte passiva. | | nao\_tem\_processos\_parte\_outra | Verifique se o CPF está vinculado a processos como outras partes. | | nao\_tem\_processos\_reus | Verifica se o CPF/CNPJ está vinculado a processos como réu. | | nao\_tem\_processos\_criminais | Verifica se o CPF/CNPJ está vinculado a processos criminais. | | tem\_author\_type\_nulo\_em\_processos\_criminais | Verifica se há um campo 'authorType' vazio em qualquer processo criminal. | | {% endtab %} | | | {% endtabs %} | | ## Processos com palavras-chave - NOVO (PJ70) Retorna todos os processos judiciais disponíveis por meio de uma consulta ampliada, garantindo a máxima cobertura de informações. **Seção:** `pjLegalRecordsExtendedKeywords` **Parâmetro obrigatório:** `cnpj` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | -------------------------------------------------------------------- | -------- | ----------------------------------------- | | statusCode | String | Status da consulta | | 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 | Número | Nível de sigilo | | data.lawsuits\[x].amount | Número | Valor do processo | | data.lawsuits\[x].area | String | Área do processo | | data.lawsuits\[x].instance | Número | 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 | Booleano | Indicação de processo criminal | | data.lawsuits\[x].mainPartySide | String | Lado da parte pesquisada | | data.lawsuits\[x].lastStep | Objeto | Última movimentação do processo | | data.lawsuits\[x].lastStep.stepId | String | Identificador da última movimentação | | data.lawsuits\[x].lastStep.stepDate | String | Data da última movimentação | | data.lawsuits\[x].lastStep.content | String | Conteúdo da última movimentação | | data.lawsuits\[x].lastStep.stepType | String | Tipo da última movimentação | | data.lawsuits\[x].lastStep.stepsCount | Número | Contagem da última movimentação | | 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 | Movimentações | | data.lawsuits\[x].steps\[x].stepDate | String | Data da movimentação | | data.lawsuits\[x].steps\[x].stepType | String | Tipo da movimentação | | data.lawsuits\[x].steps\[x].content | String | Conteúdo da movimentação | | data.lawsuits\[x].steps\[x].private | String | Movimentação sigilosa | | 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 do 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 do 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": "lawsuit", "matchedWords": [ "Indenização por dano moral" ], "cnjCode": "099999-09.0990.9.99.9900", "secrecyLevel": 0, "amount": 1000, "area": "DIREITO PROCESSUAL CIVIL", "phase": "Inicial", "status": "Ativo", "judge": "", "instance": 1, "name": "JONH DOE X JANE DOE", "courtAcronym": "TJSP", "courtDistrict": "VARA DA COMARCA DE SÃO PAULO", "state": "sp", "city": "SÃO PAULO", "distributionDate": "2024-03-12T09:57:51.000Z", "justiceDescription": "JUSTIÇA ESTADUAL", "isCriminal": false, "mainPartySide": "ATIVO", "steps": [], "subjects": [ { "code": "10671", "subject": "Obrigação de Fazer / Não Fazer" }, { "code": "10001", "subject": "Indenização por dano moral" } ], "courts": [ { "code": "5117", "court": "VARA DA COMARCA DE SÃO PAULO" } ], "classifications": [ { "code": "436", "classification": "" } ], "parties": [ { "type": "Réu", "side": "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 | | ----------------------------------- | ----------------------------------------------------------------------------------------------------- | | tem\_palavras\_chave\_em\_processos | A regra ficará inválida se qualquer uma 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.caf.io/caf-api/caf-api-pt-br/api-core/transaction-details/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 what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.