Background Checking PJ
O background check é um complemento de dados e permite a geração completa de um dossiê com informações relevantes tanto para PF (Pessoa Física) quanto PJ (Pessoa Jurídica).
Código de status
As fontes de dados retornam um código responsável por detalhar a situação da consulta. Este código é identificado como statusCode
e auxilia na interpretação dos resultados.
Valor | Descrição |
---|---|
01 | Consulta realizada com sucesso |
02 | Dados inválidos ou insuficientes |
05 | Aguardando processamento |
50 ou 70 | Não foi possível realizar a consulta |
55 | Indisponível |
Query
As fontes de dados retornam um objeto responsável por informar alguns parâmetros utilizados na consulta. Estes parâmetros ficam dentro do objeto query
e auxiliam na interpretação dos resultados.
Valor | Tipo | Descrição |
---|---|---|
firstStartAt | Date | Data e hora do início da primeira execução da fonte |
startAt | Date | Data e hora do início da última execução da fonte |
endDate | Date | Data e hora do término da execução da fonte |
data | Object | Objeto que contém parâmetros utilizados na consulta |
Dados cadastrais
Dados básicos (PJ1)
Informações contidas no Cartão CNPJ da empresa junto a Receita Federal.
Seção: pjData
Parâmetro obrigatório: cnpj
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.registrationNumber | String | N° do registro |
data.openingDate | String | Data de abertura |
data.officialName | String | Nome oficial |
data.fantasyName | String | Nome fantasia |
data.companySize | String | Tamanho da empresa |
data.mainActivity | String | Atividade econômica principal |
data.secondaryActivities | Array | Lista de atividades secundárias |
data.secondaryActivities[x].code | String | Código da atividade |
data.secondaryActivities[x].description | String | Descrição da atividade |
data.legalNature | String | Natureza |
data.isMei | Boolean | Indicativo se o CNPJ é MEI |
data.address | Object | Endereço |
data.address.street | String | Rua |
data.address.number | String | Número |
data.address.complement | String | Complemento |
data.address.zipCode | String | CEP |
data.address.neighborhood | String | Bairro |
data.address.city | String | Cidade |
data.address.state | String | Estado |
data.companyEmail | String | |
data.phoneNumber | String | Telefone |
data.jointStock | String | Capital social |
data.status | String | Status de atividade da empresa |
data.statusOrigin | String | Origem da consulta de atividade da empresa |
data.statusDate | Date | Data da consulta de atividade da empresa |
data.QSA | Array | Lista de sócios |
data.QSA[x].name | String | Nome |
data.QSA[x].cpf | String | cpf |
data.QSA[x].function | String | Atividade/função |
data.QSA[x].functionCode | String | Cód. da atividade/função |
data.QSA[x].isLegalRepresentative | Boolean | Indicativo de representante legal |
Dados do Simples (PJ40)
Consulta dados se a empresa está enquadrada no Simples.
Seção: pjSimples
Parâmetro obrigatório: cnpj
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.officialName | String | Nome oficial |
data.cnpj | String | CNPJ da empresa |
data.taxRegime | String | Regime Tributário da empresa |
data.simples | Boolean | Pertence ao simples (true/false) |
Risco
KYC & Compliance (PJ44)
Seção: pjKycCompliance
Parâmetro obrigatório: cnpj
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
query | Object | Parâmetros utilizados na consulta (detalhes) |
query.data.cnpj | String | CNPJ utilizado na consulta |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.pepHistory | Array | Lista de Objects com o histórico de exposição política |
data.pepHistory[x].level | String | Nivel de exposição política |
data.pepHistory[x].jobTitle | String | Trabalho |
data.pepHistory[x].department | String | Departamento |
data.pepHistory[x].motive | String | Motivo |
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 Objects com o histórico de sanções e restrições |
data.sanctionsHistory[x].source | String | Fonte de sanção |
data.sanctionsHistory[x].type | String | Tipo de sanção |
data.sanctionsHistory[x].matchRate | String | Rate de aproximação do nome |
data.sanctionsHistory[x].details | Object | Detalhes |
data.sanctionsHistory[x].details.agreementNumber | String | Número do acordo |
data.sanctionsHistory[x].details.grantingBody | String | Entidade concessora |
data.sanctionsHistory[x].details.impedimentReason | String | Motivos de 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 | Entidade sancionadora |
data.sanctionsHistory[x].details.sanctioningBodyState | String | Estado da entidade sancionadora |
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 | Date | Data.sanctionsHistory[x] de 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 fundamentação legal |
data.sanctionsHistory[x].details.transitDueDate | Date | Data.sanctionsHistory[x] de vencimento da transitaçã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 de órgão |
data.sanctionsHistory[x].details.scopeDefinedInJudicialDecision | String | Escopo definido em decisão judicial |
data.sanctionsHistory[x].details.resjusdicataDate | String | Data rescisória |
data.sanctionsHistory[x].details.amountOfWorkersInvolved | String | Quantidade 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 | Outra informação |
data.sanctionsHistory[x].details.tadNumber | String | Número tad |
data.sanctionsHistory[x].details.selfInfringementNumber | String | Número de auto-infração |
data.sanctionsHistory[x].details.deforestedAreaHa | String | Área desmatada Hectare |
data.sanctionsHistory[x].details.propertyLocation | String | Localização da propriedade |
data.sanctionsHistory[x].details.propertyUF | String | Propriedade Unidade Federativa |
data.sanctionsHistory[x].details.propertyCounty | String | Propriedade país |
data.sanctionsHistory[x].details.infraction | String | Infração |
data.sanctionsHistory[x].details.registrationDate | String | Data de registro |
data.sanctionsHistory[x].details.judgementDate | String | Data do Julgamento |
data.sanctionsHistory[x].details.penalty | String | Pena |
data.sanctionsHistory[x].details.penaltyTimeToBeServed | String | Tempo de penalidade para ser servido |
data.sanctionsHistory[x].details.finalDeadline | String | Prazo final |
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 referencia |
data.sanctionsHistory[x].details.decisionType | String | Tipo de Decisão |
data.sanctionsHistory[x].details.timeToBeServed | String | Hora de ser atendido |
data.sanctionsHistory[x].details.judgementDescription | String | Julgamento Descrição |
data.sanctionsHistory[x].details.completeDecisionURL | String | URL de decisão completo |
data.sanctionsHistory[x].details.processInfoUrl | String | URL de informações do processo |
data.sanctionsHistory[x].startDate | String | Data inicial |
data.sanctionsHistory[x].standardizedSanctionType | String | Tipo de sanção padronizado |
data.sanctionsHistory[x].nameUniquenessScore | String | Pontuação de exclusividade de nome |
data.sanctionsHistory[x].creationDate | String | Data de criação |
data.sanctionsHistory[x].lastUpdateDate | String | Última data de atualização |
data.sanctionsHistory[x].isCurrentlyPresentOnSource | String | Está atualmente presente na fonte |
data.sanctionsHistory[x].endDate | String | Data Final |
data.isCurrentlyPEP | Boolean | Indica se a pessoa é atualmente uma PPE |
data.isCurrentlySanctioned | Boolean | Indica se a pessoa está atualmente sob alguma sanção |
data.last30DaysSanctions | Number | Quantidade de sanções e restrições encontradas nos últimos 30 dias |
data.last90DaysSanctions | Number | Quantidade de sanções e restrições encontradas nos últimos 90 dias |
data.last180DaysSanctions | Number | Quantidade de sanções e restrições encontradas nos últimos 180 dias |
data.last365DaysSanctions | Number | Quantidade de sanções e restrições encontradas nos últimos 365 dias |
data.lastYearPEPOccurence | Number | Quantidade de registros de PEP encontradas no último ano |
data.last3YearsPEPOccurence | Number | Quantidade de registros de PEP encontradas nos últimos 3 anos |
data.last5YearsPEPOccurence | Number | Quantidade de registros de PEP encontradas nos últimos 5 anos |
data.last5PlusYearsPEPOccurence | Number | Quantidade de registros de PEP encontradas nos últimos 5 ou mais anos |
data.isCurrentlyElectoralDonor | Boolean | Indica se a pessoa realiza doações para campanhas políticas |
data.isHistoricalElectoralDonor | Boolean | Indica se a pessoa já doou para campanhas políticas |
data.totalElectoralDonationsLastTwoElections | Number | Quantidade de doações realizadas nos últimos dois ciclos eleitorais |
data.totalElectoralDonations | Number | Quantidade total de doações realizadas |
data.totalElectoralDonationAmountLastTwoElections | Number | Somatório do valor doado nos últimos dois ciclos eleitorais |
data.totalElectoralDonationAmount | Number | Somatório total do valor doado |
data.firstSanctionDate | String | Data da primeira sanção |
data.lastSanctionDate | String | Data da última sanção |
KYC & Compliance de Sócios (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 | Situação da consulta (detalhes) |
data | Array | Dados de retorno |
data[x].cpf | String | CPF do sócio |
data[x].pepHistory | Array | Lista de objetos com histórico de exposição política |
data[x].pepHistory[x].level | String | Nível de PPE(Pessoa Politicamente Exposta) |
data[x].pepHistory[x].jobTitle | String | Cargo |
data[x].pepHistory[x].department | String | Departamento |
data[x].pepHistory[x].motive | String | Motivo |
data[x].pepHistory[x].source | String | Fonte |
data[x].pepHistory[x].startDate | String | Data em que a pessoa tornou-se uma PPE |
data[x].pepHistory[x].endDate | String | Data em que a pessoa deixou de ser uma PPE |
data[x].pepHistory[x].creationDate | String | Data de criação |
data[x].pepHistory[x].lastUpdateDate | String | Data da última atualização |
data[x].isCurrentlyPEP | Boolean | Se é PEP atualmente |
data[x].sanctionsHistory | Array | Lista de objetos com o 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 do 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 com o indivíduo |
data[x].sanctionsHistory[x].sanctionName | String | Nome registrado na lista de sanções internacionais |
data[x].sanctionsHistory[x].nationalities | String | Nacionalidades associadas com o 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 | Boolean | Se está sob sanção atualmente |
data[x].last30DaysSanctions | Number | Sanções nos ultimos 30 dias |
data[x].last90DaysSanctions | Number | Sanções nos ultimos 90 dias |
data[x].last180DaysSanctions | Number | Sanções nos ultimos 180 dias |
data[x].last365DaysSanctions | Number | Sanções nos ultimos 365 dias |
data[x].lastYearPEPOccurence | Number | Ocorrência de PEP no último ano |
data[x].last3YearsPEPOccurence | Number | Ocorrência de PEP nos últimos três anos |
data[x].last5YearsPEPOccurence | Number | Ocorrência de PEP nos últimos cinco anos |
data[x].last5PlusYearsPEPOccurence | Number | Ocorrência de PEP nos últimos cinco ou mais anos |
data[x].firstSanctionDate | String | Data da primeira sanção |
data[x].lastSanctionDate | String | Data da última sanção |
data.totalCurrentlyPEP | Number | Total de PEPs atuais |
data.totalHistoricallyPEP | Number | Histórico total de PEPs |
data.totalCurrentlySanctioned | Number | Total de sanções atuais |
data.totalHistoricallySanctioned | Number | Histórico total de sanções |
data.averageSanctionsPerOwner | Number | Média de sanções por sócio da empresa |
data.pepPercentage | Number | Porcentagem de PEP |
data.ownerMaxSanctions | Number | Maior número de sanções de um único sócio |
data.ownerMinSanctions | Number | Menor número de sanções de um único sócio |
data.last30DaysSanctions | Number | Sanções nos ultimos 30 dias |
data.last90DaysSanctions | Number | Sanções nos ultimos 90 dias |
data.last180DaysSanctions | Number | Sanções nos ultimos 180 dias |
data.last365DaysSanctions | Number | Sanções nos ultimos 365 dias |
data.lastYearPEPOccurence | Number | Ocorrência de PEP no último ano |
data.last3YearsPEPOccurence | Number | Ocorrência de PEP nos últimos três anos |
data.last5YearsPEPOccurence | Number | Ocorrência de PEP nos últimos cinco anos |
data.last5PlusYearsPEPOccurence | Number | Ocorrência de PEP nos últimos cinco ou mais anos |
data.firstSanctionDate | String | Data da primeira sanção |
data.lastSanctionDate | String | Data da última sanção |
data.activeOwners | String Array | CPF dos donos ativos |
data.inactiveOwners | String Array | CPF dos donos inativos |
Processos Judiciais e Administrativos (PJ54)
Retorna informações sobre ações judiciais que a pessoa tenha seja de qualquer tipo (criminal, civil, trabalhista, ...).
Seção: pjProcesses
Parâmetro obrigatório: cnpj
Atributo | Tipo | Descrição |
---|---|---|
data.statusCode | String | Situação da consulta (detalhes) |
data.data | Object | Dados de retorno |
data.lawsuits | Array | Lista de objetos com processos judiciais e administrativos |
data.lawsuits[x].number | String | Número do processo |
data.lawsuits[x].type | String | Tipo de processo |
data.lawsuits[x].mainSubject | String | Assunto principal do processo |
data.lawsuits[x].courtName | String | Nome do tribunal |
data.lawsuits[x].courtLevel | String | Nível do tribunal (instância) |
data.lawsuits[x].courtType | String | Tipo do tribunal |
data.lawsuits[x].judgingBody | String | Tipo do tribunal |
data.lawsuits[x].state | String | Estado |
data.lawsuits[x].status | String | Status |
data.lawsuits[x].publicationDate | Date | Data de publicação |
data.lawsuits[x].lastUpdate | Date | Data da última atualização |
data.lawsuits[x].parties | Array | Lista de partes envolvidas no processo |
data.lawsuits[x].parties[x].doc | String | Número do documento (CPF ou CNPJ) |
data.lawsuits[x].parties[x].name | String | Nome da parte descrito no processo |
data.lawsuits[x].parties[x].polarity | String | Polaridade (ativo, passivo, neutro) da parte no processo |
data.lawsuits[x].parties[x].type | String | Tipo da parte |
data.lawsuits[x].parties[x].partyDetails | Object | Detalhes adicionais das partes do processo |
data.lawsuits[x].parties[x].partyDetails.OAB | String | Número de registro na OAB |
data.lawsuits[x].parties[x].partyDetails.State | String | Estado |
data.lawsuits[x].parties[x].partyDetails.SpecificType | String | Tipo |
data.totalLawsuits | Integer | Total de processos |
data.totalLawsuitsAsAuthor | Integer | Total de processos como autor |
data.totalLawsuitsAsDefendant | Integer | Total de processos como réu |
data.totalLawsuitsAsOther | Integer | Total de processos como algum outro tipo de parte |
Processos Judiciais e Administrativos (PJ66)
Retorna informações sobre ações judiciais que a pessoa tenha, seja de qualquer tipo (criminal, civil, trabalhista, ...).
Seção: pj_processes_alt
Parâmetro obrigatório: cnpj
Atributo | Tipo | Descrição |
---|---|---|
available | Boolean | Disponibilidade da fonte |
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.total | Number | Quantidade total de processos |
data.results | Array | Lista de processos retornada |
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 da distribuição |
data.results[x].statusDate | String | Data do status |
data.results[x].lawsuitDegree | String | Grau do processo |
data.results[x].physicalLocation | String | Local físico |
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 | Boolean | Se o processo é digital |
data.results[x].lawBranch | String | Ramo do Direito |
data.results[x].segment | String | Segmento |
data.results[x].isJusticeSecret | Boolean | Se é segredo de justiça |
data.results[x].complementaryStatus | String | Status complementar |
data.results[x].observationStatus | String | Status da observação |
data.results[x].court | String | Tribunal |
data.results[x].state | String | UF |
data.results[x].sourceUnit | String | Unidade de origem |
data.results[x].lawsuitUrl | String | URL do processo |
data.results[x].lawsuitValue | Object | Retorno do valor do processo |
data.results[x].lawsuitValue.currency | String | Moeda (R$, U$, etc) |
data.results[x].lawsuitValue.value | Number | Valor |
data.results[x].subjects | String Array | 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 dos 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].authorType | String | Tipo do autor |
Processos com palavras-chave (PJ49)
Retorna informações sobre ações judiciais que a pessoa tenha, seja de qualquer tipo (criminal, civil, trabalhista, ...).
Seção: pj_processes_with_keywords
Parâmetro obrigatório: cnpj
Atributo | Tipo | Descrição |
---|---|---|
available | Boolean | Disponibilidade da fonte |
statusCode | String | Situação da consulta (detalhes) |
query | Object | Parâmetros utilizados na consulta (detalhes) |
query.data.cpf | String | CPF utilizado na consulta |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.total | Number | Quantidade total de processos |
data.results | Array | Lista de processos retornada |
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 da distribuição |
data.results[x].statusDate | String | Data do status |
data.results[x].lawsuitDegree | String | Grau do processo |
data.results[x].physicalLocation | String | Local físico |
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 | Boolean | Se o processo é digital |
data.results[x].lawBranch | String | Ramo do Direito |
data.results[x].segment | String | Segmento |
data.results[x].isJusticeSecret | Boolean | Se é segredo de justiça |
data.results[x].complementaryStatus | String | Status complementar |
data.results[x].observationStatus | String | Status da observação |
data.results[x].court | String | Tribunal |
data.results[x].state | String | UF |
data.results[x].sourceUnit | String | Unidade de origem |
data.results[x].lawsuitUrl | String | URL do processo |
data.results[x].otherFields | Object | Outros campos |
data.results[x].otherFields.juiz | Object | Juiz |
data.results[x].otherFields.juiz.nome | String | Nome do Juiz |
data.results[x].lawsuitValue | Object | Retorno do valor do processo |
data.results[x].lawsuitValue.currency | String | Moeda (R$, U$, etc) |
data.results[x].lawsuitValue.value | Number | Valor |
data.results[x].subjects | String Array | 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 dos 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].authorType | String | Tipo do autor |
Exposição e Perfil na Mídia + Notícias Relacionadas (PJ67)
Retorna indicadores globais que demonstram o nível geral de exposição de uma empresa na mídia, a natureza dessa exposição, conteúdos detalhados identificados e o resultado da análise de sentimento.
Seção: pjMediaProfileAndExposure
Parâmetro obrigatório: cnpj
Atributo | Tipo | Descrição |
---|---|---|
available | Boolean | Disponibilidade da fonte |
statusCode | String | Situação da consulta (detalhes) |
query | Object | Parâmetros utilizados na consulta (detalhes) |
query.data.cnpj | String | CNPJ utilizado na consulta |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.mediaExposureLevel | String | Nível de exposição à mídia |
data.celebrityLevel | String | Nível de celebridade |
data.unpopularityLevel | String | Nível de impopularidade |
data.newsItems | Array | Lista das 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 | Object | 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 | Object | Dicionário com os nomes das entidades e os 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 |
Lista de Sanções da OFAC
Consulta na Lista Cidadãos Especialmente Designados e Pessoas Bloqueadas (SDN) do Escritório de Controle de Ativos Estrangeiros (OFAC). A consulta é feita por nome e é uma consulta de âmbito internacional.
Seção: pjOfacSanctionsList
Parâmetro obrigatório: name
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.sanctionsList | Array | Lista de protocolos encontrados pra o cpf consultado |
data.sanctionsList[x].type | String | Tipo |
data.sanctionsList[x].entityName | String | Nome da empresa |
data.sanctionsList[x].list | String | Lista a qual o nome pertence |
data.sanctionsList[x].program | String | Programa a qual o nome pertence |
data.sanctionsList[x].remarks | String | Observações |
data.sanctionsList[x].identifications | Array | Lista de indentifações conhecidas do nome informado |
data.sanctionsList[x].identifications[x].type | String | Tipo de identificação |
data.sanctionsList[x].identifications[x].number | String | Numero 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 apelidos pelos quais o nome informado também pode ser identificado |
data.sanctionsList[x].aliases[x].type | String | Tipo de apelidos |
data.sanctionsList[x].aliases[x].category | String | Categoria do apelidos |
data.sanctionsList[x].aliases[x].name | String | Nome ou apelido (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 provincia |
data.sanctionsList[x].addresses[x].postalCode | String | Código postal (CEP) |
data.sanctionsList[x].addresses[x].country | String | País |
Verificação de risco para números de telefone
Fornece um indicador do risco para o telefone consultado, bem como uma recomendação quanto ao risco, além de informações que podem ajudar na tomada de decisão.
Seção: phoneTrustScore
Parâmetro obrigatório: phoneNumber
Parâmetros adicionais opcionais: deviceId, accountId, email, originatingIp, accountLifecycleEvent,
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Mensagem de retorno |
data.risk | Object | Descreve a pontuação de risco para o número de telefone informado |
data.risk.level | String | Severidade do risco |
data.risk.recommendation | String | Ação recomendada com base na pontuação de risco |
data.risk.score | Number | O score de risco para o número de telefone informado |
data.riskInsights | Object | Contém o reason code com informações adicionais sobre o risco. |
data.riskInsights.status | Number | O status de processamento do pacote de insights de risco para a solicitação |
data.riskInsights.category | Array | Categoria |
data.riskInsights.a2p | Array | Códigos específicos para mensagens de application-to-person (a2p) |
data.riskInsights.p2p | Array | Códigos específicos para mensagens de person-to-person (p2p) |
data.riskInsights.numberType | Array | Códigos relacionados ao tipo do número |
data.riskInsights.ip | Array | Códigos relacionados à atividade do endereço IP fornecido para este número |
data.riskInsights.email | Array | Códigos relacionados à atividade do endereço de e-mail fornecido para o número de telefone |
Indicador para o risco de troca do cartão SIM
Verifica se o cartão SIM para um número de telefone foi trocado e em caso afirmativo, em que ponto. É avaliada a probabilidade de que a troca do SIM tenha sido por um motivo fraudulento, usando uma escala de 1-4.
Seção: simSwapAlert
Parâmetro obrigatório: phoneNumber (com DDI e DDD)
Observações: Adicionar DDI e DDD para o número de telefone.
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo da situação da consulta |
data.swapDate | String | Se o cartão SIM para o número de telefone foi modificado, este campo indica a data em que ocorreu a alteração. |
data.swapTime | String | Se o cartão SIM para o número de telefone foi modificado, este campo indica a hora da ocorrência. |
data.riskIndicator | Number | Indicador de risco da modificação do cartão SIM para o número de telefone |
data.riskIndicatorDescription | String | Descrição do indicador de risco |
data.referenceId | String | ID de referência da consulta. |
Cadastro em redes sociais e segurança do telefone
Retorna uma análise completa do telefone, inclusive sua presença em redes sociais e outras plataformas digitais, além de importantes informações de segurança sobre este telefone.
Seção: phoneAnalysis
Parâmetro obrigatório: phoneNumber (com DDI e DDD)
Observações: Adicionar DDI e DDD para o número de telefone.
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo da situação da consulta |
data.phoneNumber | Number | Número de telefone |
data.valid | Boolean | Indica se o telefone é válido |
data.disposable | Boolean | Indica se o telefone é descartável |
data.type | String | Indica o tipo de telefone |
data.country | String | O país do telefone |
data.carrier | String | A operadora do telefone |
data.score | Number | Um score de 0 a 100 que indica se o telefone do usuário é fraudulento |
data.accountDetails | Object | Dados de redes sociais associadas ao número de telefone consultado |
data.accountDetails.facebook | Object | Dados do perfil do Facebook associado ao número de telefone |
data.accountDetails.facebook.url | String | URL da foto do usuário nesta plataforma |
data.accountDetails.facebook.name | String | Nome do perfil |
data.accountDetails.facebook.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.facebook.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.google | Object | Dados do perfil do Google associado ao número de telefone |
data.accountDetails.google.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.google.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.instagram | Object | Dados do perfil de Instagram associado ao número de telefone |
data.accountDetails.instagram.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.twitter | Object | Dados do perfil do Twitter associado ao número de telefone |
data.accountDetails.twitter.registered | Boolean | Indica se este telefone esta registrado nesta plataforma |
data.accountDetails.yahoo | Object | Dados do perfil do Yahoo associado ao número de telefone |
data.accountDetails.yahoo.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.telegram | Object | Dados do perfil de Telegram associado ao número de telefone |
data.accountDetails.telegram.lastSeen | String | Data da última atividade nesta plataforma, em UNIX, UTC |
data.accountDetails.telegram.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.telegram.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.whatsapp | Object | Dados do perfil de WhatsApp associado ao número de telefone |
data.accountDetails.whatsapp.lastSeen | String | Data da última atividade nesta plataforma, em UNIX, UTC |
data.accountDetails.whatsapp.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.whatsapp.about | String | Texto "sobre" deste perfil |
data.accountDetails.whatsapp.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.viber | Object | Dados do perfil do Viber associado ao número de telefone |
data.accountDetails.viber.name | String | Nome do perfil |
data.accountDetails.viber.lastSeen | String | Data da última atividade nesta plataforma, em UNIX, UTC |
data.accountDetails.viber.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.viber.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.kakao | Object | Dados do perfil de Kakao associado ao número de telefone |
data.accountDetails.kakao.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.ok | Object | Dados do perfil de Ok associado ao número de telefone |
data.accountDetails.ok.city | String | Cidade do usuário |
data.accountDetails.ok.age | String | Idade do usuário |
data.accountDetails.ok.dateJoined | String | Data de adesão |
data.accountDetails.ok.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.zalo | Object | Dados do perfil de Zalo associado ao número de telefone |
data.accountDetails.zalo.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.line | Object | Dados do perfil de Line associado ao número de telefone |
data.accountDetails.line.name | String | Nome do perfil |
data.accountDetails.line.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.line.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.microsoft | Object | Dados do perfil da Microsoft associado ao número de telefone |
data.accountDetails.microsoft.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.snapchat | Object | Dados do perfil de Snapchat associado ao número de telefone |
data.accountDetails.snapchat.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.accountDetails.skype | Object | Dados do perfil de Skype associado ao número de telefone |
data.accountDetails.skype.country | String | País de relacionamento do perfil |
data.accountDetails.skype.city | String | Cidade do usuário |
data.accountDetails.skype.gender | String | Gênero do usuário |
data.accountDetails.skype.name | String | Nome do perfil |
data.accountDetails.skype.id | String | ID do perfil |
data.accountDetails.skype.handle | String | Identificador do perfil |
data.accountDetails.skype.bio | String | Biografia do perfil |
data.accountDetails.skype.age | String | Idade do usuário |
data.accountDetails.skype.language | String | Linguagem do perfil |
data.accountDetails.skype.state | String | Estado de relacionamento do perfil |
data.accountDetails.skype.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.skype.registered | Boolean | Indica se este telefone está registrado nesta plataforma |
data.appliedRules | Array | Lista de regras configuradas para o motor de scores |
data.appliedRules[x].id | String | Identificador unico da regra |
data.appliedRules[x].name | String | Nome da regra |
data.appliedRules[x].operation | String | Operação da regra |
data.appliedRules[x].score | Number | Score da regra |
data.history | Object | Historico de requisições relacionados ao telefone |
data.history.hits | Number | O número de vezes que este telefone foi buscado |
data.history.customerHits | Number | O número de clientes únicos que buscaram este telefone |
data.history.firstSeen | Number | A data em que este número foi buscado pela primeira vez, em UNIX, UTC, sem milissegundos |
data.history.lastSeen | Number | A data em que este número foi buscado pela última vez, em UNIX, UTC, sem milissegundos |
data.flags | Array | Lista de flags |
data.flags[x].note | String | Nota com informações adicionais sobre a flag |
data.flags[x].date | Number | A data em que a flag foi criada, em UNIX, UTC, sem milissegundos |
data.flags[x].industry | String | Indústria de qual empresa criou a flag |
data.id | String | Um operador único para a chamada |
data.referenceId | String | Id de identificação |
Cadastro em redes sociais e segurança do email
Retorna uma análise do email - sua presença em redes sociais e outras plataformas digitais, além de importantes informações de segurança sobre o email consultado.
Seção: emailAnalysis
Parâmetro obrigatório: email
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo da situação da consulta |
data.email | String | |
data.score | Number | Um score que indica se o email é fraudulento |
data.deliverable | Boolean | Verifica se o endereço de email realmente existe |
data.domainDetails | Object | Detalhes sobre o Domínio do endereço de email |
data.domainDetails.domain | String | Domínio do email |
data.domainDetails.tld | String | Domínio de topo |
data.domainDetails.createdAt | String | Data de criação do Domínio |
data.domainDetails.updatedAt | String | Data de atualização do Domínio |
data.domainDetails.expireDate | String | Data de expiração do Domínio |
data.domainDetails.registered | Boolean | Indica se o Domínio está registrado |
data.domainDetails.registrant | String | Nome da empresa que gerencia o Domínio do email |
data.domainDetails.registeredTo | String | Nome da empresa para o qual o Domínio está registrado |
data.domainDetails.disposable | Boolean | Indica se o Domínio é fraudulento |
data.domainDetails.free | Boolean | Indica se o Domínio é de um provedor grátis(gmail, hotmail, ect.) |
data.domainDetails.custom | Boolean | Indica se este é um Domínio customizado |
data.domainDetails.dmarcEnforced | Boolean | Indica se o Domínio é autenticado por DMARC |
data.domainDetails.spfStrict | Boolean | Indica se o Domínio é o SPF é seguro |
data.domainDetails.validMX | Boolean | Indica se os registros MX do Domínio são validos |
data.domainDetails.acceptAll | Boolean | Indica se o servidor esta configurado para recebers todos os emails neste Domínio |
data.domainDetails.suspiciousTld | Boolean | Indica se o Domínio de topo é suspeito |
data.domainDetails.websiteExists | Boolean | Indica se o Domínio de email possui um website |
data.accountDetails | Object | Dados de redes sociais associadas ao email consultado |
data.accountDetails.facebook | Object | Dados do perfil do Facebook associado ao email |
data.accountDetails.facebook.url | String | URL da foto do usuário nesta plataforma |
data.accountDetails.facebook.name | String | Nome do perfil |
data.accountDetails.facebook.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.facebook.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.google | Object | Dados do perfil do Google associado ao email |
data.accountDetails.google.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.google.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.apple | Object | Dados do perfil da Apple associado ao email |
data.accountDetails.appleregistered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.twitter | Object | Dados do perfil do Twitter associado ao email |
data.accountDetails.twitter.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.microsoft | Object | Dados do perfil da Microsoft associado ao email |
data.accountDetails.microsoft.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.yahoo | Object | Dados do perfil do Yahoo associado ao email |
data.accountDetails.yahoo.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.ebay | Object | Dados do perfil de Skype associado ao email |
data.accountDetails.ebay.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.gravatar | Object | Dados do perfil do Gravatar associado ao email |
data.accountDetails.gravatar.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.instagram | Object | Dados do perfil de Instagram associado ao email |
data.accountDetails.instagram.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.spotify | Object | Dados do perfil de Spotify associado ao email |
data.accountDetails.spotify.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.tumblr | Object | Dados do perfil de Tumblr associado ao email |
data.accountDetails.tumblr.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.linkedin | Object | Dados do perfil de LinkedIn associado ao email |
data.accountDetails.linkedin.url | String | URL do perfil |
data.accountDetails.linkedin.name | String | Nome do perfil |
data.accountDetails.linkedin.company | String | Empresa de perfil |
data.accountDetails.linkedin.title | String | Cargo/título baseado no perfil |
data.accountDetails.linkedin.location | String | Localidade do perfil |
data.accountDetails.linkedin.website | String | Site pessoal do perfil |
data.accountDetails.linkedin.twitter | String | Twitter do perfil |
data.accountDetails.linkedin.photo | String | Url da foto de perfil |
data.accountDetails.linkedin.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.weibo | Object | Dados do perfil de Weibo associado ao email |
data.accountDetails.weibo.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.github | Object | Dados do perfil de Github associado ao email |
data.accountDetails.github.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.vimeo | Object | Dados do perfil de Vimeo associado ao email |
data.accountDetails.vimeo.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.flickr | Object | Dados do perfil de Flickr associado ao email |
data.accountDetails.flickr.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.foursquare | Object | Dados do perfil de Foursquare associado ao email |
data.accountDetails.foursquare.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.lastfm | Object | Dados do perfil de LastFM associado ao email |
data.accountDetails.lastfm.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.myspace | Object | Dados do perfil de MySpace associado ao email |
data.accountDetails.myspace.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.pinterest | Object | Dados do perfil de Pinterets associado ao email |
data.accountDetails.pinterest.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.skype | Object | Dados do perfil de Skype associado ao email |
data.accountDetails.skype.country | String | País de relacionamento do perfil |
data.accountDetails.skype.city | String | Cidade do usuário |
data.accountDetails.skype.gender | String | Gênero do usuário |
data.accountDetails.skype.name | String | Nome do perfil |
data.accountDetails.skype.id | String | ID do perfil |
data.accountDetails.skype.handle | String | Identificador do perfil |
data.accountDetails.skype.bio | String | Biografia do perfil |
data.accountDetails.skype.age | String | Idade do usuário |
data.accountDetails.skype.language | String | Linguagem do perfil |
data.accountDetails.skype.state | String | Estado de relacionamento do perfil |
data.accountDetails.skype.photo | String | URL da foto do usuário nesta plataforma |
data.accountDetails.skype.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.discord | Object | Dados do perfil de Discord associado ao email |
data.accountDetails.discord.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.ok | Object | Dados do perfil de Ok associado ao email |
data.accountDetails.ok.city | String | Cidade do usuário |
data.accountDetails.ok.age | String | Idade do usuário |
data.accountDetails.ok.dateJoined | String | Data de adesão |
data.accountDetails.ok.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.kakao | Object | Dados do perfil de Kakao associado ao email |
data.accountDetails.kakao.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.booking | Object | Dados do perfil de Booking associado ao email |
data.accountDetails.booking.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.airbnb | Object | Dados do perfil de Airbnb associado ao email |
data.accountDetails.airbnb.about | String | Texto "sobre" do perfil |
data.accountDetails.airbnb.createdAt | String | Data de criação do perfil |
data.accountDetails.airbnb.firstName | String | Primeiro nome do perfil |
data.accountDetails.airbnb.identityVerified | String | Status de verificação do perfil |
data.accountDetails.airbnb.location | String | Localização do perfil |
data.accountDetails.airbnb.image | String | Url da foto de perfil |
data.accountDetails.airbnb.revieweeCount | String | Contagem de reviews do perfil |
data.accountDetails.airbnb.trips | String | Contagem de viagens do perfil |
data.accountDetails.airbnb.work | String | Nome da empresa do perfil |
data.accountDetails.airbnb.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.amazon | Object | Dados do perfil de Amazon associado ao email |
data.accountDetails.amazon.registered | Boolean | Indica se este email está registrado nesta plataforma |
data.accountDetails.qzone | Object | Dados do perfil de Qzone associado ao email |
data.accountDetails.qzone.registered | String | Indica se este email está registrado nesta plataforma |
data.accountDetails.breachDetails | Object | Detalhes sobre vazamentos de dados do qual o email foi vítima |
data.accountDetails.breachDetails.breaches | Array | Lista de vazamentos |
data.accountDetails.breachDetails.breaches[x].name | String | Nome da plataforma onde os dados do email foram vazados |
data.accountDetails.breachDetails.breaches[x].domain | String | Domínio da plataforma onde o email foi vazado |
data.accountDetails.breachDetails.breaches[x].date | String | Data do vazamento do email |
data.accountDetails.breachDetails.haveIBeenPwnedListed | Boolean | Indica se o email foi vítima de um vazamento de dados |
data.accountDetails.breachDetails.numberOfBreaches | Number | Indica se o número de vezes em que o email foi vítima de vazamento de dados |
data.accountDetails.breachDetails.firstBreach | String | Data do primeiro vazamento de dados |
data.appliedRules | Array | Lista de regras configuradas para o motor de scores |
data.appliedRules[x].id | String | Identificador unico da regra |
data.appliedRules[x].name | String | Nome da regra |
data.appliedRules[x].operation | String | Operação da regra |
data.appliedRules[x].score | Number | Score da regra |
data.history | Object | Historico de requisições relacionados ao email |
data.history.hits | Number | O número de vezes que este email foi buscado |
data.history.customerHits | Number | O número de clientes únicos que buscaram este email |
data.history.firstSeen | Number | A data em que este email foi buscado pela primeira vez, em UNIX, UTC, sem milissegundos |
data.history.lastSeen | Number | A data em que este email foi buscado pela última vez, em UNIX, UTC, sem milissegundos |
data.flags | Array | Lista de flags |
data.flags[x].note | String | Nota com informações adicionais sobre a flag |
data.flags[x].date | Number | A data em que a flag foi criada, em UNIX, UTC, sem milissegundos |
data.flags[x].industry | String | Indústria de qual empresa criou a flag |
data.id | String | Um operador único para a chamada |
data.referenceId | String | Id de identificação |
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 | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.recordFound | Boolean | Indicativo da presença na lista privada de restrições |
data.cnpj | String | CNPJ |
data.name | String | Nome |
ANTT
Consulta no site da ANTT para identificar se o transportador esta habilitado para realizar atividades.
Seção: antt
Parâmetro obrigatório: cnpj, plate
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.hasRegister | Boolean | Status informando se contém registro |
data.transporter | String | Transportadora |
data.rntrc | String | Número RNTRC |
data.rntrcSituation | String | Status |
data.memberSince | String | Data da primeira relação |
data.expirationDate | String | Data de expiração |
data.city | String | Cidade |
data.message | String | Mensagem presente no cadastro |
Fiscal
Sintegra Data (PJ61)
Consulta informações de uma pessoa jurídica no Cadastro Centralizado de Contribuinte pelo CNPJ e UF, retornando todas as inscrições estaduais encontradas.
Seção: pjSintegraData
Parâmetros obrigatórios: cnpj, uf
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.cnpj | String | CNPJ da empresa |
data.uf | String | UF da empresa |
data.officialName | String | Nome oficial |
data.fantasyName | String | Nome fantasia |
data.stateRegistrationList | Array | Relação de Inscrições Estaduais por CNPJ |
data.stateRegistrationList[x].cnpjStatus | String | Situação do CNPJ |
data.stateRegistrationList[x].stateRegistration | String | Inscrição Estadual (IE) |
data.stateRegistrationList[x].stateRegistrationStatus | String | Situação da Inscrição Estadual |
data.stateRegistrationList[x].stateRegistrationStatusDate | String | Data da situação na UF |
data.stateRegistrationList[x].stateRegistrationType | String | Tipo da Inscrição Estadual |
data.stateRegistrationList[x].stateRegistrationConsignee | String | Informação da IE como Destinatário |
data.stateRegistrationList[x].initialDateActivity | String | Data de início da atividade |
data.stateRegistrationList[x].finalDateActivity | String | Data fim atividade |
data.stateRegistrationList[x].taxRegime | String | Regime de tributação |
data.stateRegistrationList[x].companySize | String | Porte da Empresa |
data.stateRegistrationList[x].mainActivityCnae | String | CNAE Principal |
data.stateRegistrationList[x].historic | Array | Histórico |
data.stateRegistrationList[x].historic[x].nsuNumber | String | Número Sequencial Unico (NSU) Movto. |
data.stateRegistrationList[x].historic[x].uf | String | UF |
data.stateRegistrationList[x].historic[x].cnpj | String | CNPJ da empresa |
data.stateRegistrationList[x].historic[x].cnpjStatus | String | Situação do CNPJ |
data.stateRegistrationList[x].historic[x].stateRegistration | String | Inscrição Estadual (IE) |
data.stateRegistrationList[x].historic[x].stateRegistrationStatus | String | Situação da Inscrição Estadual |
data.stateRegistrationList[x].historic[x].taxRegime | String | Regime de tributação |
data.stateRegistrationList[x].historic[x].situationDate | String | Data da situação |
data.stateRegistrationList[x].historic[x].updateDate | String | Data da atualização |
data.stateRegistrationList[x].historic[x].reason | String | Motivo da atualização |
data.stateRegistrationList[x].address | Object | Endereço |
data.stateRegistrationList[x].address.street | String | Rua |
data.stateRegistrationList[x].address.number | String | Número |
data.stateRegistrationList[x].address.complement | String | Complemento |
data.stateRegistrationList[x].address.neighborhood | String | Bairro |
data.stateRegistrationList[x].address.city | String | Cidade |
data.stateRegistrationList[x].address.state | String | Estado |
data.stateRegistrationList[x].address.zipCode | String | CEP |
Financeiro
Lista de Devedores PGFN (PJ94)
Retorna se o CNPJ consultado está inscrito em dívidas ativas junto à PGFN.
Seção: pjPgfnDebtors
Parâmetro obrigatório: cnpj
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Mensagem decritiva do resultado da consulta |
data.hasDebts | Boolean | Status de divida (true/false) |
data.debtValue | String | Valor devido a PGFN |
Protestos em Cartórios (PJ35)
Quando não existe protestos de título é emitida uma certidão negativa pela IETB. Quando há protestos, são retornadas informações dos títulos protestados: quem protestou e o valor.
Seção: pjProtesto
Parâmetro obrigatório: cnpj
Atributo | Tipo | Descrição |
---|---|---|
available | Boolean | Indica se as informações da consulta estão disponíveis |
statusCode | String | Situação da consulta (detalhes) |
query | Object | Parâmetros utilizados na consulta (detalhes) |
query.data.cnpj | String | CNPJ utilizado na consulta |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.baseStatus | String | Status do documento consultado com relação aos protestos. Indica se existe ou não protesto para a entidade |
data.totalProtests | Integer | Número total de protestos encontrados |
data.notaries | Array | Lista de cartórios participantes |
data.notaries[x].state | String | Estado do cartório onde foi registrado o protesto |
data.notaries[x].city | String | Cidade do cartório participante |
data.notaries[x].description | String | Descrição do cartório participante |
data.notaries[x].address | String | endereço do cartório |
data.notaries[x].phone | String | Telefone do cartório participante |
data.notaries[x].numProtests | Integer | Número de protestos do cartório participante |
data.notaries[x].protests | Array | Lista de protestos |
data.notaries[x].protests[x].debtorDocument | String | Documento do devedor |
data.notaries[x].protests[x].date | Date | Data do protesto |
data.notaries[x].protests[x].value | Date | Valor do protesto |
Relatório SPC + Participações em empresas + Score (PJ63)
Retorna uma coleção de dados sobre a empresa, entre eles: participações em empresas, sócios, administradores, registros de inadimplência, ações judiciais, protestos, etc
Seção: pjSpcCompanyReportParticipationScore
Parâmetro obrigatório: cnpj
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.restriction | Boolean | Indica se a pessoa possui ou não alguma restrição |
data.customer | Object | Dados do consumidor consultado |
data.customer.cnpj | String | Número do CNPJ |
data.customer.cnpjSituationDescription | String | Situação do CNPJ |
data.customer.cnpjSituationDate | String | Data da situação do CNPJ |
data.customer.commercialName | String | Nome comercial |
data.customer.corporateName | String | Razão social |
data.customer.nirenirc | String | Número do NIRC / NIRE |
data.customer.foundationDate | String | Data de fundação |
data.customer.lastRegisterDate | String | Data do último registro |
data.customer.lastRegisterNumber | String | Número do último registro |
data.customer.email | String | |
data.customer.homepage | String | Home |
data.customer.stateRegistration | String | Inscrição estadual |
data.customer.legalNature | Object | Natureza jurídica |
data.customer.legalNature.code | String | Código da natureza jurídica |
data.customer.legalNature.description | String | Descrição da natureza jurídica |
data.customer.mainEconomicActivity | Object | Atividade econômica principal |
data.customer.mainEconomicActivity.code | String | Código da atividade econômica principal |
data.customer.mainEconomicActivity.description | String | Descrição da atividade econômica principal |
data.customer.secondaryEconomicActivities | Array | Atividade econômica secundaria |
data.customer.secondaryEconomicActivities[x].code | String | Código da atividade econômica secundaria |
data.customer.secondaryEconomicActivities[x].description | String | Descrição da atividade econômica secundaria |
data.pjSpellings | Array | Formas de escrita da razão social |
data.pjSpellings[x].corporateName | String | Razão social |
data.address | Object | Endereço |
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.phone | Object | Telefone |
data.phone.ddd | String | DDD |
data.phone.number | String | Número |
data.companyParticipation | Object | Participação em empresas |
data.companyParticipation.total | Integer | Total de participações em empresas |
data.companyParticipation.details | Array | Detalhes de participações em empresas |
data.companyParticipation.details[x].name | String | Nome da empresa |
data.companyParticipation.details[x].restrictionIndicator | Boolean | Indicador de restrição |
data.companyParticipation.details[x].document | String | Número do documento |
data.companyParticipation.details[x].documentSituation | String | Situação do documento |
data.companyParticipation.details[x].relationshipType | String | Tipo de relacionamento |
data.companyParticipation.details[x].lastUpdate | String | Data da última atualização |
data.partner | Object | Sócios |
data.partner.total | Integer | Total de sócios |
data.partner.details | Array | Detalhes dos sócios |
data.partner.details[x].name | String | Nome do sócio |
data.partner.details[x].startDate | String | Data de entrada |
data.partner.details[x].document | String | Número do documento |
data.partner.details[x].documentSituation | String | Situação do documento |
data.partner.details[x].participationPercentage | String | Percentual de participação |
data.partner.details[x].relationshipType | String | Tipo de relacionamento |
data.partner.details[x].nationality | String | Nacionalidade |
data.partner.details[x].lastUpdate | String | Data da última atualização |
data.manager | Object | Administradores |
data.manager.total | Integer | Total de admnistradores |
data.manager.details | Array | Detalhes dos admnistradores |
data.manager.details[x].position | String | Posição |
data.manager.details[x].name | String | Nome do administrador |
data.manager.details[x].maritalStatus | String | Estado civil |
data.manager.details[x].startDate | String | Data de entrada |
data.manager.details[x].exitDate | String | Data de saída |
data.manager.details[x].document | String | Número do documento |
data.manager.details[x].relationshipType | String | Tipo de relacionamento |
data.manager.details[x].nationality | String | Nacionalidade |
data.manager.details[x].lastUpdate | String | Data da última atualização |
data.spc | Object | Registros de inadimplência - SPC |
data.spc.total | Integer | Total de registros |
data.spc.details | Array | Detalhes dos registros |
data.spc.details[x].associateName | String | Nome do associado responsável pela inclusão do registro |
data.spc.details[x].entityName | String | Nome da entidade |
data.spc.details[x].entityCode | String | Código da entidade |
data.spc.details[x].inclusionDate | String | Data de inclusão do registro |
data.spc.details[x].expirationDate | String | Data de vencimento do registro |
data.spc.details[x].contract | String | Contrato |
data.spc.details[x].financialInstitutionRegistration | String | Registro em instituição financeira |
data.spc.details[x].buyerGuarantor | String | O consumidor é o responsável pela compra (comprador) ou fiador/avalista de terceiro |
data.spc.details[x].value | String | Valor do débito |
data.spc.details[x].city | String | Cidade |
data.spc.details[x].state | String | Estado |
data.spc.details[x].ddd | String | DDD do telefone |
data.spc.details[x].number | String | Número do telefone |
data.ccf | Object | Registros de cheques sem fundo |
data.ccf.total | Integer | Total de registros |
data.ccf.details | Object | Detalhes dos registros |
data.ccf.details.origin | String | Origem da informação |
data.ccf.details.quantity | Integer | Detalhes dos registros |
data.ccf.details.motive | Object | Alínea de devolução do cheques |
data.ccf.details.motive.code | String | Código |
data.ccf.details.motive.description | String | Descrição |
data.ccf.details.lastCheck | Object | Detalhes do último cheque |
data.ccf.details.lastCheck.date | String | Data do último cheque |
data.ccf.details.lastCheck.bankData | Object | Detalhes do banco do último cheque |
data.ccf.details.lastCheck.bankData.name | String | Nome do banco |
data.ccf.details.lastCheck.bankData.agencyNumber | String | Número da agência |
data.ccf.details.lastCheck.bankData.code | String | Código |
data.counterOrder | Object | Registros de contra-ordem para os cheques consultados |
data.counterOrder.total | Integer | Total de registros |
data.counterOrderDifferentDocument | Object | Registros de cheque/talão sustado com documento diferente do consultado |
data.counterOrderDifferentDocument.total | Integer | Total de registros |
data.lawsuit | Object | Registros de ações judiciais |
data.lawsuit.total | Integer | Total de registros |
data.lawsuit.lastOccurenceDate | String | Data da última ocorrência |
data.lawsuit.lastOccurenceValue | String | Valor da última ocorrência |
data.lawsuit.details | Array | Detalhes dos registros |
data.lawsuit.details[x].date | String | Data do registro da ação |
data.lawsuit.details[x].value | String | Valor da Ação |
data.lawsuit.details[x].court | String | Área judicial onde tramita a ação |
data.lawsuit.details[x].type | String | Tipo da Ação |
data.lawsuit.details[x].district | Object | Distrito da Ação |
data.lawsuit.details[x].district.city | String | Cidade da Ação |
data.lawsuit.details[x].district.state | String | Estado da Ação |
data.judicialProtest | Object | Registros de protestos |
data.judicialProtest.total | Integer | Total de registros |
data.judicialProtest.monthAndYearFirstOccurence | String | Mês e Ano do primeiro registro |
data.judicialProtest.monthAndYearLastOccurence | String | Mês e Ano do último registro |
data.judicialProtest.lastOccurenceDate | String | Data do último registro |
data.judicialProtest.totalValue | String | Valor total |
data.judicialProtest.details | Array | Detalhes dos registros |
data.judicialProtest.details[x].date | String | Data do registro do protesto |
data.judicialProtest.details[x].value | String | Valor do protesto |
data.judicialProtest.details[x].annotationMotive | String | Descrição da natureza da anotação do registro |
data.judicialProtest.details[x].currency | String | Moeda |
data.judicialProtest.details[x].notarysOffice | Object | Cartório onde o protesto foi registrado |
data.judicialProtest.details[x].notarysOffice.name | String | Nome do cartório |
data.judicialProtest.details[x].notarysOffice.city | String | Cidade onde o protesto foi registrado |
data.judicialProtest.details[x].notarysOffice.state | String | Estado onde o protesto foi registrado |
data.performedConsultations | Object | Informações de consultas realizadas anteriormente para o documento |
data.performedConsultations.total | Integer | Total de consultas realizadas |
data.performedConsultations.totalConsultationDays | Integer | Quantidade de dias consultados |
data.performedConsultations.lastOccurenceDate | Integer | Data da última consulta |
data.performedConsultations.details | Array | Detalhes das consultas realizadas |
data.performedConsultations.details[x].consultationDate | String | Data de execução da consulta |
data.performedConsultations.details[x].entityOriginName | String | Detalhes das consultas realizadas |
data.performedConsultations.details[x].associate | Object | Detalhes das consultas realizadas |
data.performedConsultations.details[x].associate.name | String | Nome do associado que efetuou a consulta |
data.performedConsultations.details[x].associate.originCity | String | Cidade de origem do associado que efetuou a consulta |
data.performedConsultations.details[x].associate.originState | String | Estado de origem do associado que efetuou a consulta |
data.judiciaryInformation | Object | Informações do poder judiciário |
data.judiciaryInformation.total | Integer | Total de informações encontradas |
data.judiciaryInformation.lastOccurenceDate | String | Data da última ocorrência |
data.judiciaryInformation.totalValue | String | Valor total |
data.judiciaryInformation.details | Array | Detalhes das informações do poder judiciário |
data.judiciaryInformation.details[x].documentDate | String | Data do documento |
data.judiciaryInformation.details[x].inclusionDate | String | Data de inclusão do registro |
data.judiciaryInformation.details[x].entityOrigin | String | Origem da entidade |
data.judiciaryInformation.details[x].lawsuitNumber | String | Número do processo |
data.judiciaryInformation.details[x].value | String | Valor total |
data.judiciaryInformation.details[x].court | String | Área judicial onde tramita a ação |
data.judiciaryInformation.details[x].district | Object | Distrito onde tramita a ação |
data.judiciaryInformation.details[x].district.city | String | Cidade onde tramita a ação |
data.judiciaryInformation.details[x].district.state | String | Estado onde tramita a ação |
data.contumaciaSrs | Object | Informações de cheques sustados, extraviados, roubados e cancelados contumaz |
data.contumaciaSrs.total | Integer | Total de cheques |
data.contumaciaSrs.lastOccurenceDate | String | Data da última ocorrência |
data.contumaciaSrs.details | Array | Detalhes dos cheques |
data.contumaciaSrs.details[x].occurenceDate | String | Data da ocorrência |
data.contumaciaSrs.details[x].motive | String | Motivo da ocorrência |
data.contumaciaSrs.details[x].initialCheck | Object | Detalhes do cheque inicial |
data.contumaciaSrs.details[x].initialCheck.number | String | Número do cheque incial |
data.contumaciaSrs.details[x].initialCheck.bankData | Object | Detalhes do banco do cheque inicial |
data.contumaciaSrs.details[x].initialCheck.bankData.name | String | Detalhes dos cheques |
data.contumaciaSrs.details[x].initialCheck.bankData.agencyNumber | String | Número da agência |
data.contumaciaSrs.details[x].initialCheck.bankData.checkingAccount | String | Número da conta corrente |
data.contumaciaSrs.details[x].finalCheck | Object | Detalhes do cheque final |
data.contumaciaSrs.details[x].finalCheck.number | String | Número do cheque final |
data.bankruptcyParticipation | Object | Participação do CNPJ consultado em empresas falidas |
data.bankruptcyParticipation.total | Integer | Total de participações do CNPJ consultado em empresas falidas |
data.financialPending | Object | Registros de inadimplência registrada por diversos setores da econômia em outras fontes de informação |
data.financialPending.total | Integer | Total de registros de inadimplência |
data.financialPending.lastOccurenceDate | String | Data da última ocorrência |
data.financialPending.totalValue | String | Valor total das inadimplências |
data.financialPending.details | Array | Detalhes das inadimplências |
data.financialPending.details[x].guarantor | Boolean | O CNPJ é o avalista |
data.financialPending.details[x].contract | String | Número do contrato |
data.financialPending.details[x].occurenceDate | String | Data da pendência |
data.financialPending.details[x].origin | String | Origem da pendência |
data.financialPending.details[x].occurenceTitle | String | Título da pendência |
data.financialPending.details[x].pendingAmount | String | Valor da pendência |
data.financialPending.details[x].currency | String | Moeda |
data.financialPending.details[x].city | String | Cidade da pendêcia |
data.financialPending.details[x].state | String | Estado da pendêcia |
data.referentialBusiness | Object | Informações referenciais para o estabelecimento de limites de crédito |
data.referentialBusiness.total | Integer | Total de informações encontradas |
data.referentialBusiness.details | Array | Detalhes das informações encontradas |
data.referentialBusiness.details[x].potentialAverageRange | String | Informações da faixa media potêncial |
data.referentialBusiness.details[x].potentialAverageRange.code | String | Código da faixa media potêncial |
data.referentialBusiness.details[x].potentialAverageRange.description | String | Descrição da faixa media potêncial |
data.referentialBusiness.details[x].potentialAverageRange.until | String | Valor máximo da faixa media potêncial |
data.referentialBusiness.details[x].potentialAverageRange.from | String | Valor minimo da faixa media potêncial |
data.referentialBusiness.details[x].potentialValueRange | Object | Descrição da faixa do valor potêncial |
data.referentialBusiness.details[x].potentialValueRange.code | String | Código da faixa do valor potêncial |
data.referentialBusiness.details[x].potentialValueRange.description | String | Descrição da faixa do valor potêncial |
data.referentialBusiness.details[x].businessDescription | String | Descrição do negócio |
data.referentialBusiness.details[x].segmentOriginInformation | String | Segmento da origem da informação |
data.referentialBusiness.details[x].potentialDate | String | Data potêncial |
data.referentialBusiness.details[x].potentialValueUntil | String | Valor potêncial máximo |
data.referentialBusiness.details[x].PotentialValueFrom | String | Valor potêncial minimo |
data.paymentHistory | Object | Informações sobre em relação aos pagamentos no mês atual e nos últimos 13 meses |
data.paymentHistory.total | Integer | Total de pagamentos |
data.paymentHistory.details | Array | Detalhes dos pagamentos |
data.paymentHistory.details[x].range | Object | Faixa de pagamentos |
data.paymentHistory.details[x].range.code | String | Código da faixa de pagamentos |
data.paymentHistory.details[x].range.description | String | Descrição da faixa de pagamentos |
data.paymentHistory.details[x].periodDescription | String | Descrição do periodo |
data.paymentHistory.details[x].percentagePeriodUntil | String | Percentual máximo do periodo |
data.paymentHistory.details[x].percentagePeriodFrom | String | Percentual minimo do periodo |
data.paymentHistory.details[x].sourcesQuantity | Integer | Quantidade de fontes |
data.paymentHistory.details[x].periodQuantityUntil | String | Quantidade máxima do periodo |
data.paymentHistory.details[x].periodQuantityFrom | String | Quantidade minima do periodo |
data.oldestRelationshipWithSuppliers | String | Data mais antiga entre o CNPJ consultado e seus fornecedores |
data.consultationLogs | Object | Informações acerca das consultas sobre a empresa no mês atual e nos 13 meses anteriores |
data.consultationLogs.total | integer | Total de consultas |
data.consultationLogs.details | Array | Detalhes das consultas |
data.consultationLogs.details[x].date | String | Data da consulta |
data.consultationLogs.details[x].bankQuantity | String | Quantidade de consultas realizadas por instituições bancárias |
data.consultationLogs.details[x].companyQuantity | String | Quantidade de consultas realizadas por empresas |
data.lastConsultations | Object | Informações acerca das 5 últimas consultas realizadas ao CNPJ |
data.lastConsultations.total | Integer | Total de consultas |
data.lastConsultations.details | Array | Detalhes das consultas |
data.lastConsultations.details[x].cnpj | String | CNPJ da empresa que realizou a consulta |
data.lastConsultations.details[x].customerName | String | Nome da empresa que realizou a consulta |
data.lastConsultations.details[x].date | String | Data em que a empresa realizou a consulta |
data.lastConsultations.details[x].quantity | Integer | Quantidade de consultas que a empresa realizou |
data.shareCapital | Object | Informações sobre o capital social do CNPJ |
data.shareCapital.nationality | String | Nacionalidade do capital social |
data.shareCapital.nature | String | Natureza do capital social |
data.shareCapital.origin | String | Origem do capital social |
data.shareCapital.lastUpdate | String | Data da última atualização |
data.shareCapital.capitalValue | String | Valor do capital social |
data.shareCapital.authorizedCapitalAmount | String | Valor do capital social autorizado |
data.shareCapital.authorizedCapitalRealized | String | Valor do capital social realizado |
data.predecessor | Object | Razões sociais que antecederam a atual |
data.predecessor.total | Integer | Total de razões sociais que antecederam a atual |
data.predecessor.details | Array | Detalhes das razões sociais que antecederam a atual |
data.predecessor.details[x].motiveData | String | Data da alteração |
data.predecessor.details[x].previousCorporateName | String | Razão social anterior |
data.companyActivity | Object | Informações sobre o ramo de atividade da empresa |
data.companyActivity.cnaeNumber | String | Número do CNAE |
data.companyActivity.purchasePercentage | String | Percentual de compra |
data.companyActivity.salesPercentage | String | Percentual de vendas |
data.companyActivity.employeesQuantity | Integer | Quantidade de empregados |
data.companyActivity.subsidiariesQuantity | Integer | Quantidade de filiais |
data.companyActivity.activityField | String | Ramo de atividade da empresa |
data.subsidiary | Object | Informações sobre as filiais da empresa e a cidade onde estão localizadas |
data.subsidiary.total | Integer | Total de filiais da empresa |
data.subsidiary.details | Array | Detalhes sobre as filiais da empresa |
data.subsidiary.details[x].subsidiaryName | String | Nome da filial |
data.subsidiary.details[x].codeEmbratel | String | Código da Embratel |
data.companyMergerSplit | Object | Informações relativas a fusões, cisões ou incorporações |
data.companyMergerSplit.total | Integer | Total de fusões, cisões ou incorporações |
data.companyMergerSplit.details | Array | Detalhes das fusões, cisões ou incorporações |
data.companyMergerSplit.details[x].updateDate | String | Data da última atualização |
data.companyMergerSplit.details[x].observationsMessage | String | Mensagem ou observações sobre a fusão, cisão ou incorporação |
data.complementaryMessage | Object | Mensagens diversas |
data.complementaryMessage.total | Integer | Mensagens diversas |
data.complementaryMessage.details | Array | Detalhes das mensagens |
data.complementaryMessage.details[x].message | String | Mensagem |
data.complementaryMessage.details[x].origin | String | Origem da mensagem |
data.scorePj | Object | Informações sobre o Score do SPC |
data.scorePj.score | String | Score do SPC |
data.scorePj.scorePjClass | String | Classe do Score |
data.scorePj.horizon | String | Horizonte de cálculo - será sempre 12 (meses) |
data.scorePj.interpretativeMessagingScore | String | Mensagem de escolha da entidade ou associado conforme a faixa de risco |
data.scorePj.probability | String | Probabilidade de inadimplência |
data.scorePj.clientScoreType | String | Tipo de cliente (NOVO - novo no SPC Brasil; RESTRITO: possui restrições; NAO_RESTRITO: não possui restrições) |
CVM Associado (PJ65)
Retorna informações de CNPJ que tenham relação com mercado financeiro
Seção: pjAssociatedCvm
Parâmetro obrigatório: cnpj
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.associates | Array | Descreve os dados dos tipos de cadastro na Comissão de Valores Mobiliarios |
data.associates[x].name | String | Nome da pessoa física |
data.associates[x].type | String | Tipo de cadastro |
data.associates[x].recordDate | String | Data de registro na função |
data.associates[x].situation | String | Situação do Cadastro |
data.associates[x].directors | Array | Lista de objetos que contém dados de diretores |
data.associates[x].directors[x].name | String | Nome da empresa no qual o CPF é diretor |
data.associates[x].directors[x].startDate | String | Data de inicio no cargo como diretor |
data.associates[x].directors[x].instruction | String | Instrução do diretor na empresa |
Penalidades Temporarias na CVM (PJ93)
Consulta na lista de Penalidades Temporárias da CVM se o participante está temporariamente impedido de atuar no mercado de capitais em razão de decisão em Processo Administrativo Sancionador
Seção: pjPenaltiesOnCvm
Parâmetros obrigatórios: name
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.listOfSetences | Array | Lista de membros setenciados/punidos |
data.listOfSetences[x].processNumber | String | Número do Processo |
data.listOfSetences[x].name | String | Participante |
data.listOfSetences[x].decisionType | String | Tipo de Decisão |
data.listOfSetences[x].judgementDate | String | Data do Julgamento CVM |
data.listOfSetences[x].effectiveDate | String | Data de vigência da penalidade |
data.listOfSetences[x].timeOfWithdrawal | String | Tempo de afastamento |
SPC Restrições + Score (PJ99)
Retorna uma coleção de dados sobre a empresa, entre eles: Score, Consultas ao CNPJ, etc.
Seção: pjSpcRestrictionsScore
Parâmetros obrigatórios: cnpj, PJ
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.restriction | Boolean | Indica se a pessoa possui ou não alguma restrição |
data.customer | Object | Dados do consumidor consultado |
data.customer.cnpj | String | Número do CNPJ |
data.customer.StatusDescription | String | Situação do CNPJ |
data.customer.StatusDate | String | Data da situação do CNPJ |
data.customer.address | Object | Endereço |
data.customer.address.street | String | Rua |
data.customer.address.number | String | Número |
data.customer.address.complement | String | Complemento |
data.customer.address.district | String | Bairro |
data.customer.address.zipCode | String | CEP |
data.customer.address.city | String | Cidade |
data.customer.address.state | String | Estado |
data.customer.legalNature | Object | Natureza jurídica |
data.customer.legalNature.code | String | Código da natureza jurídica |
data.customer.legalNature.description | String | Descrição da natureza jurídica |
data.customer.mainEconomicActivity | Object | Atividade econômica principal |
data.customer.mainEconomicActivity.code | String | Código da atividade econômica principal |
data.customer.mainEconomicActivity.description | String | Descrição da atividade econômica principal |
data.spellingLegalEntity | Array | Formas de escrita da razão social |
data.spellingLegalEntity[x].name | String | Razão social |
data.lastTelephoneInformed | Object | Ultimo telefone informado |
data.lastTelephoneInformed.details | Array | Lista com último telefone informado |
data.lastTelephoneInformed.details[x].dateFirstConult | String | Data da primeira consulta de telefone |
data.lastTelephoneInformed.details[x].dateLastConsult | String | Data da ultima consulta de telefone |
data.lastTelephoneInformed.details[x].numberOfConsults | Integer | Numero de consultas |
data.lastTelephoneInformed.details[x].areaCode | String | DDD |
data.lastTelephoneInformed.details[x].number | String | Número |
data.companyActivity | Object | Atividade econômica principal |
data.companyActivity.details | Array | Detalhes da Atividade Econômica |
data.companyActivity.details[x].code | String | Código da atividade econômica principal |
data.companyActivity.details[x].description | String | Descrição da atividade econômica principal |
data.spc | Object | Registros de inadimplência - SPC |
data.spc.total | Integer | Quantidade de registros |
data.spc.dateLastOccurency | String | Data da ultima ocorrência |
data.spc.value | Float | Valor total acumulado |
data.spc.details | Array | Detalhes dos registros |
data.spc.details[x].associateName | String | Nome do associado responsável pela inclusão do registro |
data.spc.details[x].entityName | String | Nome da entidade |
data.spc.details[x].inclusionDate | String | Data de inclusão do registro |
data.spc.details[x].expirationDate | String | Data de vencimento do registro |
data.spc.details[x].contract | String | Contrato |
data.spc.details[x].financialInstitutionRegistration | String | Registro em instituição financeira |
data.spc.details[x].type | String | O consumidor é o responsável pela compra (comprador) ou fiador/avalista de terceiro |
data.spc.details[x].value | Float | Valor do débito |
data.spc.details[x].city | String | Cidade |
data.spc.details[x].state | String | Estado |
data.spc.details[x].phoneAreaCode | String | DDD do telefone |
data.spc.details[x].phoneNumber | String | Número do telefone |
data.lastAddressInformed | Object | Último endereço Informado |
data.lastAddressInformed.details | Array | Lista com ultimos endereços informados |
data.lastAddressInformed.details[x].state | String | Estado |
data.lastAddressInformed.details[x].city | String | Cidade |
data.lastAddressInformed.details[x].street | String | Logradouro |
data.lastAddressInformed.details[x].number | String | Numero |
data.lastAddressInformed.details[x].district | String | Bairro |
data.lastAddressInformed.details[x].complement | String | Complemento |
data.lastAddressInformed.details[x].zipCode | String | CEP |
data.ccf | Object | Registros de cheques sem fundo |
data.ccf.total | Integer | Quantidade de registros |
data.ccf.details | Object | Detalhes dos registros |
data.ccf.details.origin | String | Origem da informação |
data.ccf.details.reasonCode | String | Motivo - Código |
data.ccf.details.reasonDescription | String | Motivo - Descrição |
data.ccf.details.lastCheck | Object | Detalhes do último cheque |
data.ccf.details.lastCheck.date | String | Data do último cheque |
data.ccf.details.lastCheck.name | String | Nome do banco |
data.ccf.details.lastCheck.agencyNumber | String | Número da agência |
data.ccf.details.lastCheck.code | String | Código |
data.countermand | Object | Registros de contra-ordem para os cheques consultados |
data.countermand.total | Integer | Quantidade de registros |
data.countermandDifferentDocument | Object | Registros de cheque/talão sustado com documento diferente do consultado |
data.countermandDifferentDocument.total | Integer | Quantidade total de registros |
data.consultedTelephone | Object | Registros de telefones consultados consultados |
data.consultedTelephone.total | Integer | Quantidade total de registros |
data.bindTelephoneSubscriberConsulted | Object | Registros telefones consultados associados ao inscrito consultados |
data.bindTelephoneSubscriberConsulted.total | Integer | Quantidade total de registros |
data.documentAlert | Object | Registros de alertas de documento consultados |
data.documentAlert.total | Integer | Quantidade total de registros |
data.shopkeeperCheck | Object | Registros de cheque de lojista consultados |
data.shopkeeperCheck.total | Integer | Quantidade total de registros |
data.contumacy | Object | Informações de contumacia |
data.contumacy.total | Integer | Quantidade total de registros |
data.contumacy.firstDayConsultedByBracket | String | Data inicial do período de consulta |
data.contumacy.lastDayConsultedByBracket | String | Data finalo do período de consulta |
data.contumacy.lastOccurenceDate | String | Data da última ocorrência |
data.contumacy.details | Array | Detalhes dos cheques |
data.contumacy.details[x].inclusionDate | String | Data da ocorrência |
data.contumacy.details[x].occurenceDate | String | Data da ocorrência |
data.contumacy.details[x].origin | String | Origem da ocorrência |
data.contumacy.details[x].reasonCode | String | Motivo da ocorrência |
data.contumacy.details[x].reasonDescription | String | Motivo da ocorrência |
data.contumacy.details[x].initialCheckNumber | String | Número do cheque incial |
data.contumacy.details[x].initialCheckBankAgencyNumber | String | Número da agência |
data.contumacy.details[x].initialCheckBankAccountNumber | String | Número da conta corrente |
data.contumacy.details[x].initialCheckBankName | String | Nome do banco |
data.contumacy.details[x].initialCheckBankCode | String | Codigo do banco |
data.contumacy.details[x].finalCheckNumber | String | Número do cheque final |
data.grantedCredit | Object | Registros de crédito concedido consultados |
data.grantedCredit.total | Integer | Quantidade total de registros |
data.queriesPerformed | Object | Informações de consultas realizadas anteriormente para o documento |
data.queriesPerformed.total | Integer | Total consultas realizadas |
data.queriesPerformed.details | Array | Detalhes das consultas realizadas |
data.queriesPerformed.details[x].associateName | String | Nome do associado que efetuou a consulta |
data.queriesPerformed.details[x].consultDate | String | Data de execução da consulta |
data.queriesPerformed.details[x].entityOriginName | String | Detalhes das consultas realizadas |
data.queriesPerformed.details[x].city | String | Cidade de origem do associado que efetuou a consulta |
data.queriesPerformed.details[x].state | String | Estado de origem do associado que efetuou a consulta |
data.judiciaryInformation | Object | Informações do poder judiciário |
data.judiciaryInformation.total | Integer | Quantidade de informações encontradas |
data.judiciaryInformation.lastOccurenceDate | String | Data da última ocorrência |
data.judiciaryInformation.value | Float | Valor total |
data.judiciaryInformation.details | Array | Detalhes das informações do poder judiciário |
data.judiciaryInformation.details[x].documentDate | String | Data do documento |
data.judiciaryInformation.details[x].inclusionDate | String | Data de inclusão do registro |
data.judiciaryInformation.details[x].originEntity | String | Origem da entidade |
data.judiciaryInformation.details[x].lawsuitNumber | String | Número do processo |
data.judiciaryInformation.details[x].value | Float | Valor total |
data.judiciaryInformation.details[x].court | String | Área judicial onde tramita a ação |
data.judiciaryInformation.details[x].courtRegion | String | Comarca onde tramita a ação |
data.judiciaryInformation.details[x].courtState | String | Estado onde tramita a ação |
data.onlineCheckQuerySrs | Object | Informações de cheques sustados, extraviados, roubados e cancelados contumaz |
data.onlineCheckQuerySrs.total | Integer | Total de cheques |
data.spcScore3Months | Object | Informações sobre o Score do SPC |
data.spcScore3Months.class | String | Classe do Score |
data.spcScore3Months.scoreMessage | String | Mensagem de escolha da entidade ou associado conforme a faixa de risco |
data.spcScore3Months.score | String | Score do SPC |
data.spcScore3Months.probability | String | Probabilidade de inadimplência |
data.spcScore3Months.scope | String | Horizonte de cálculo (meses) |
data.spcScore3Months.clientScoreType | String | Tipo de cliente (NOVO - novo no SPC Brasil; RESTRITO: possui restrições; NAO_RESTRITO: não possui restrições) |
data.spcScore12Months | Object | Informações sobre o Score do SPC |
data.spcScore12Months.class | String | Classe do Score |
data.spcScore12Months.scoreMessage | String | Mensagem de escolha da entidade ou associado conforme a faixa de risco |
data.spcScore12Months.score | String | Score do SPC |
data.spcScore12Months.probability | String | Probabilidade de inadimplência |
data.spcScore12Months.scope | String | Horizonte de cálculo (meses) |
data.spcScore12Months.clientScoreType | String | Tipo de cliente (NOVO - novo no SPC Brasil; RESTRITO: possui restrições; NAO_RESTRITO: não possui restrições) |
Participação Societária em Empresa (PJ90)
Retorna o percentual de participação dos sócios de uma empresa.
Seção: pjCompanyOwnersPercentage
Parâmetro obrigatório: cnpj
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.companyShares | Array | Valor da renda estimada |
data.companyShares[x].cnpj | String | CNPJ |
data.companyShares[x].cpf | String | CPF |
data.companyShares[x].corporateName | String | Razão social |
data.companyShares[x].totalShare | String | Porcentagem de participação |
Sistema de Informações de Créditos (PJ96)
Retorna as informações de crédito de uma pessoa.
Seção: pjCreditOperationsSCR
Parâmetros obrigatórios: cnpj, PJ
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Descritivo com situação da consulta |
data.clientCode | String | CNPJ |
data.registrationDate | Date | Data de registro |
data.baseDate | Date | Data base para consulta |
data.assumedCoobligation | Number | Coobrigação assumida em cessão de crédito pelo cliente |
data.receivedCoobligation | Number | Coobrigação recebida em cessão de crédito |
data.processedDocumentsPercentage | Number | Percentual dos documentos 3040 esperados para a data-base e que já foram incorporados a base de dados do SCR no Banco Central, desconsiderando as instituições financeiras dispensadas |
data.processedVolumePercentage | Number | Percentual do volume esperado para a data-base e que já está incorporado a base de dados do SCR no Banco Central, desconsiderando as instituições financeiras dispensadas |
data.totalOfInstituions | String | Quantidade de instituiçõs financeiras (IFs) nas quais o cliente possui operações |
data.totalOfTransactions | String | Quantidade de operações do cliente no SFN |
data.totalDisagreementTransactions | String | Quantidade de operações marcadas com manifestação de discordância |
data.totalSubJudiceTransactions | String | Quantidade de operações marcadas com sub judice |
data.fullLiabilityDisagreement | String | Responsabilidade total de operações marcadas com manifestação de discordância |
data.fullLiabilitySubJudice | String | Responsabilidade total de operações sub judice |
data.indirectVendorRisk | String | Risco indireto assumido pelo cliente em operações de vendor |
data.operationSumaryList | Array | Lista que contém resumo de operações |
data.operationSumaryList[x].modalityCategoryCode | String | Codigo de modalidade da operação |
data.operationSumaryList[x].modalityCategoryDescription | String | Descrição do código de modalidade da operação |
data.operationSumaryList[x].modalitySubCategoryCode | String | Código de subcategoria |
data.operationSumaryList[x].modalitySubCategoryDescription | String | Descrição do código de subcategoria |
data.operationSumaryList[x].listOfDebts | Array | Lista de vencimentos |
data.operationSumaryList[x].listOfDebts[x].expirationCode | String | Código de vencimento |
data.operationSumaryList[x].listOfDebts[x].expirationDescription | String | Descrição do código de vecimento |
data.operationSumaryList[x].listOfDebts[x].value | String | Valor do vencimento |
Trabalhista
Débitos Trabalhistas (PJ98)
Retorna resultado da emissão de certidão negativa de débitos trabalhistas para um dado CNPJ
Seção: pjLaborDebts
Parâmetro obrigatório: cnpj
Atributo | Tipo | Descrição |
---|---|---|
statusCode | String | Situação da consulta (detalhes) |
data | Object | Dados de retorno |
data.message | String | Mensagem de retorno |
data.status | String | Status (CONSTA/ NADA CONSTA) |
data.certificateNumber | String | Número da certidão |
data.certificateValidity | String | Validade da certidão |