For the complete documentation index, see llms.txt. This page is also available as Markdown.

Risco

KYC e Conformidade (PJ44)

Seção: pjKycCompliance

Parâmetro obrigatório: cnpj

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

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 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

Status do órgão sancionador

data.sanctionsHistory[x].details.informationOrigin

String

Origem da informação

data.sanctionsHistory[x].details.informationOriginDate

String

Data.sanctionsHistory[x] da origem da informação

data.sanctionsHistory[x].details.publicationDate

Data

Data.sanctionsHistory[x] da publicação

data.sanctionsHistory[x].details.publication

String

Publicação

data.sanctionsHistory[x].details.legalSubstantiation

String

Fundamentação legal

data.sanctionsHistory[x].details.legalSubstantiationDescription

String

Descrição da base legal

data.sanctionsHistory[x].details.transitDueDate

Data

Data.sanctionsHistory[x] de vencimento 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 do TAD

data.sanctionsHistory[x].details.selfInfringementNumber

String

Número de infração própria

data.sanctionsHistory[x].details.deforestedAreaHa

String

Hectare de área desmatada

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

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 penalidade a ser cumprido

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

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 doa para campanhas eleitorais

data.isHistoricalElectoralDonor

Booleano

Indica se a pessoa já doou para campanhas eleitorais

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

Regra
Descrição

has_no_sanctions

Verifica se nenhuma sanção foi encontrada em listas restritivas.

has_no_pep

Verifica se o CPF ou CNPJ possui exposição política.

KYC e Conformidade de Membros (PJ59)

Retorna uma lista com os sócios da empresa consultada.

Seção: pjKycComplianceOwners

Parâmetro obrigatório: cnpj

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Array

Dados de retorno

data[x].cpf

String

CPF do membro

data[x].pepHistory

Array

Lista de objetos com o 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

Booleano

Se atualmente é uma SPP

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 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ê está 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ções 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 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

Número

Total atual de PEPs

data.totalHistoricallyPEP

Número

Total de PEPs no histórico

data.totalCurrentlySanctioned

Número

Total atual de sanções

data.totalHistoricallySanctioned

Número

Histórico total de sanções

data.averageSanctionsPerOwner

Número

Média 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 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 sócios inativos

Regra
Descrição

has_no_pep_or_sanctions_compliance_owners

Verifica a existência de PEPs ou sanções nos sócios de uma empresa.

Estrutura Societária (PJ63)

Retorna os dados cadastrais e a estrutura societária (sócios e representantes legais) da empresa consultada. Quando o CNPJ pertence a um MEI, é retornado o CPF do titular.

Seção: pjCorporateStructure

Parâmetro obrigatório: cnpj

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

message

String

Mensagem retornada quando não há dados cadastrados

data

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

Status especial (ex.: liquidação extrajudicial)

data.specialStatusDate

String

Data do status 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

Logradouro

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 da função/qualificação

data.items[x].functionCode

String

Código da função/qualificação

data.items[x].entryDate

String

Data de entrada do sócio na empresa

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

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

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 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

Órgão julgador

data.results[x].lawsuitId

String

Número do processo

data.results[x].isDigitalLawsuit

Booleano

Se o processo é digital

data.results[x].lawBranch

String

Ramo do Direito

data.results[x].segment

String

Segmento

data.results[x].isJusticeSecret

Booleano

Se for segredo de justiça

data.results[x].complementaryStatus

String

Status complementar

data.results[x].observationStatus

String

Status 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

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 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 de autor

data.results[x].authorParty

String

Parte autora

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.

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

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

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 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

Órgão julgador

data.results[x].lawsuitId

String

Número do processo

data.results[x].isDigitalLawsuit

Booleano

Se o processo é digital

data.results[x].lawBranch

String

Ramo do Direito

data.results[x].segment

String

Segmento

data.results[x].isJusticeSecret

Booleano

Se for segredo de justiça

data.results[x].complementaryStatus

String

Status complementar

data.results[x].observationStatus

String

Status 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 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 de autor

data.results[x].authorParty

String

Parte autora

Regra
Descrição

has_processes_keywords

A regra se tornará inválida se alguma das palavras-chave configuradas for encontrada nos processos.

Exposição na mídia + notícias relacionadas (PJ67)

Ele 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

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.message

String

Descritivo com o 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

Quantidade de pessoas identificadas no conteúdo

data.newsItems[x].sentimentAnalysis.placesCount

String

Quantidade de lugares identificados no conteúdo

data.newsItems[x].sentimentAnalysis.organizationsCount

String

Quantidade de empresas identificadas no conteúdo

data.newsItems[x].sentimentAnalysis.entities

Objeto

Dicionário com os nomes das 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

Regra
Descrição

has_no_media_exposure

Verifica se o titular do CPF tem exposição na mídia.

Lista de Sanções OFAC

Consulta a lista de Specially Designated Nationals and Blocked Persons (SDN) do Office of Foreign Assets Control (OFAC). A consulta é feita por nome e tem abrangência internacional.

Seção: pjOfacSanctionsList

Parâmetro obrigatório: nome

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.message

String

Descrição do status da consulta

data.sanctionsList

Array

Lista de registros 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 nomes 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

Regra
Descrição

is_on_ofac_sanctions_list

Verifica se há algum registro no OFAC para o nome informado.

Lista Privada de Restrições (PJ78)

Consulta a presença na lista privada de restrições.

Seção: pjDenyListPrivate

Parâmetro obrigatório: cnpj

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.message

String

Descritivo com o status da consulta

data.recordFound

Booleano

Indicativo de presença na lista privada de restrições

data.cnpj

String

CNPJ

data.name

String

Nome

Regra
Descrição

its_on_deny_list

A regra será inválida se o CPF/CNPJ consultado estiver na Deny List.

ANTT

Consulte o site da ANTT para identificar se a transportadora está habilitada para exercer atividades.

Seção: antt

Parâmetro obrigatório: cnpj, placa

Formatos de placa: AAA9999 ou AAA9A999

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.hasRegister

Booleano

Status informando se contém registro

data.transporter

String

Transportadora

data.rntrc

String

Número do RNTRC

data.rntrcSituation

String

Situação

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

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 exercer atividades.

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

Atributo
Tipo
Descrição

statusCode

String

Status da consulta

data

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

Quantidade de etapas

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 privada

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

Regra
Descrição

has_no_processes

Verifica se o CPF/CNPJ está vinculado a processos.

has_no_processes_active_party

Verifique se o CPF está vinculado a processos como parte ativa.

has_no_processes_passive_party

Verifique se o CPF está vinculado a processos como parte passiva.

has_no_processes_other_party

Verifique 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.

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

Atributo
Tipo
Descrição

statusCode

String

Status da consulta

data

Objeto

Dados de retorno

data.message

String

Descrição do status da consulta

data.palavrasChaveEncontradas

Array

Palavras-chave encontradas

data.lawsuits

Array

Lista de processos retornada

data.processos[x].palavrasCorrespondentes

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

Quantidade de etapas

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 privada

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

Regra
Descrição

has_processes_keywords

A regra se tornará inválida se alguma das palavras-chave configuradas for encontrada nos processos.

Atualizado