Consulta Básica CPF

Descrição

A consulta básica de CPF retorna informações detalhadas sobre o status do documento, incluindo situação cadastral, protocolo da consulta, indicação de óbito (quando disponível) e outros dados relevantes.

Autenticação

Todos os endpoints do Sinky Consulta exigem um header de API Key:

⚠️
Importante: O valor deve ser obtido no painel administrativo da sua conta.

Parâmetros de consulta

A tabela abaixo detalha os campos aceitos na consulta a este dataset.

Campo	Descrição	Dado	Tipo de Campo
document	Documento de identificação	CPF	Obrigatório
type	Identificador do tipo de consulta	BASIC	Obrigatório

Corpo da Resposta

Campo	Tipo	Descrição
`ticketId`	`string`	Identificador da consulta
`executadoEm`	`date`	Data e hora da execução da consulta
`status`	`string`	`'Executado'`	`'Executado com exceção'`. Em caso de execução com exceção o campo `exceptions` será preenchido, porém a request retorna sucesso
`resultado`	`object`	Resposta da Consulta Básica
`exceptions`	`array<object>`	Lista de exceções encontradas durante a execução da consulta. Preenchido apenas quando `status = 'Executado com exceção'`

Estrutura de `exceptions`

Campo	Tipo	Descrição
`message`	`string`	Descrição do erro ocorrido. Exemplos: `"Os slugs informados estão inativos."`, `"Os slugs informados não foram encontrados."`
`slugs`	`array<string>`	Lista dos slugs que ocasionaram a exceção

Estrutura de `resultado`

Campo	Tipo	Descrição
Result	array	Lista com os detalhes do documento consultado
ElapsedMilliseconds	number	Tempo de requisição em milissegundos
QueryDate	Date	Data da consulta realizada
policy	object	Pontos de atenção

Estrutura de `Result`

Campo	Tipo	Descrição
BasicData	object	Dados básicos da pessoa consultada
Collections	object	Presença em Cobrança
KycData	object	Conheça o cliente - KYC (Know Your Customer)
SocialAssistancePrograms	object	Programas de Benefícios e Assistência Social
RelatedPeople	object	Relacionamentos Pessoais
BusinessRelationships	object	Relacionamentos Econômicos
ExtendedEmails	object	Listagem de Emails
ExtendedPhones	object	Listagem de Telefones
ExtendedAddresses	object	Listagem de Endereços
IndebtednessQuestion	object	Probabilidade de Negativação
RegistrationData	object	Dados de registro da pessoa

Estrutura de `BasicData`

Campo	Tipo	Descrição
TaxIdNumber	string	O número do documento da pessoa.
TaxIdCountry	string	País de registro do documento.
AlternativeIdNumbers	object	Números de documentos alternativos referentes à pessoa (passaporte, CNH, Título de Eleitor).
ExtendedDocumentInformation	object	Informações adicionais sobre outros documentos referentes à pessoa.
Name	string	Nome completo da pessoa.
Aliases	object	Possíveis nomes que a pessoa também pode usar (nome social, artístico, apelido criminal).
Gender	string	Gênero da pessoa. Pode ser: `M` ou `F`.
NameWordCount	integer	Número de nomes no nome completo da pessoa.
InputNameMatchPercentage	number	Porcentagem de semelhança entre o nome da pessoa e o nome usado como entrada.
InputMotherNameMatchPercentage	number	Porcentagem de semelhança entre o nome da mãe e o nome usado como entrada.
InputFatherNameMatchPercentage	number	Porcentagem de semelhança entre o nome do pai e o nome usado como entrada.
NumberOfFullNameNamesakes	integer	Quantidade de pessoas com o mesmo nome completo.
NameUniquenessScore	number	Quão único é o nome completo da pessoa (1 = único, 0 = muito comum).
FirstNameUniquenessScore	number	Quão único é o primeiro nome da pessoa.
FirstAndLastNameUniquenessScore	number	Quão único é o primeiro e último nome da pessoa.
BirthDate	string	Data de nascimento da pessoa.
CapturedBirthDateFromRFSource	string	Data de nascimento capturada na Receita Federal (`yyyy-MM-dd`).
IsValidBirthDateInRFSource	boolean	Indica se a data de nascimento capturada na Receita Federal é válida.
InputBirthDateMatch	boolean	Indica se a data de nascimento de entrada é igual à retornada.
Age	integer	Idade da pessoa no momento da consulta.
ZodiacSign	string	Signo do zodíaco da pessoa de acordo com a data de nascimento.
ChineseSign	string	Signo do zodíaco chinês da pessoa de acordo com a data de nascimento.
BirthCountry	string	País de nascimento da pessoa.
MotherName	string	Nome da mãe da pessoa.
FatherName	string	Nome do pai da pessoa.
MaritalStatusData	object	Dados de estado civil da pessoa.
TaxIdStatus	string	Status da pessoa na Receita Federal.
TaxIdOrigin	string	Fonte de onde foi capturada a informação de status do documento.
TaxIdFiscalRegion	string	Região fiscal na qual o documento pertence.
HasObitIndication	boolean	Indica se houve óbito para aquela pessoa.
ObitIndicationOrigin	string	Fonte de onde foi capturada a informação de óbito.
ObitIndicationYear	string	Ano de óbito da pessoa consultada.
TaxIdStatusDate	string	Data da última alteração do status do indivíduo.
TaxIdStatusRegistrationDate	string	Data de registro do documento na Receita Federal.
CreationDate	string	Data de criação do registro nos bancos internos da BDC.
LastUpdateDate	string	Data da última consulta feita à Receita Federal para atualizar o registro.

Estrutura de `Aliases`

Campo	Tipo	Descrição
CommonName	string	Nome comum da pessoa.
SocialName	string	Nome social da pessoa.
StandardizedName	string	Nome padronizado da pessoa.

Estrutura de `MaritalStatusData`

Campo	Tipo	Descrição
MaritalStatus	string	Estado civil da pessoa.
MaritalStatusSource	string	Fonte em que o dado de estado civil da pessoa foi capturado.
MaritalStatusLastUpdateDate	string	Data de última atualização do estado civil da pessoa.

Estrutura de `Collections`

Campo	Tipo	Descrição
IsCurrentlyOnCollection	boolean	Flag indicando se a pessoa está atualmente em algum processo de cobrança.
TotalCollectionOccurrences	integer	Número de ocorrências de cobrança identificadas para a pessoa em todo o histórico.
TotalCollectionOrigins	integer	Número de origens (processos distintos) de cobrança identificados para a pessoa em todo o histórico.
Last30DaysCollectionOccurrences	integer	Número de ocorrências de cobrança identificadas para a pessoa nos últimos 30 dias.
Last90DaysCollectionOccurrences	integer	Número de ocorrências de cobrança identificadas para a pessoa nos últimos 90 dias.
Last180DaysCollectionOccurrences	integer	Número de ocorrências de cobrança identificadas para a pessoa nos últimos 180 dias.
Last365DaysCollectionOccurrences	integer	Número de ocorrências de cobrança identificadas para a pessoa nos últimos 365 dias.
Last30DaysCollectionOrigins	integer	Número de origens (processos distintos) de cobrança identificados para a pessoa nos últimos 30 dias.
Last90DaysCollectionOrigins	integer	Número de origens (processos distintos) de cobrança identificados para a pessoa nos últimos 90 dias.
Last180DaysCollectionOrigins	integer	Número de origens (processos distintos) de cobrança identificados para a pessoa nos últimos 180 dias.
Last365DaysCollectionOrigins	integer	Número de origens (processos distintos) de cobrança identificados para a pessoa nos últimos 365 dias.
TotalCollectionMonths	integer	Número total de meses em que a pessoa esteve em pelo menos um processo de cobrança.
CurrentConsecutiveCollectionMonths	integer	Número de meses consecutivos (incluindo o atual) no qual a pessoa está em cobrança.
MaxConsecutiveCollectionMonths	integer	Número máximo de meses consecutivos em que a pessoa esteve (ou está) em cobrança.
FirstCollectionDate	string	Data da primeira cobrança registrada para a entidade.
LastCollectionDate	string	Data da última cobrança registrada para a entidade.
CreationDate	string	Data de criação do registro.
LastUpdateDate	string	Data da última atualização do registro.
CollectionOccurrences	integer	Mesmo que `TotalCollectionOccurrences`. Mantido por compatibilidade com versões anteriores da API.
CollectionOrigins	integer	Mesmo que `TotalCollectionOrigins`. Mantido por compatibilidade com versões anteriores da API.

Estrutura de `KycData`

Campo	Tipo	Descrição
PEPHistory	array of objects	Lista de objetos com o histórico de exposição política.
IsCurrentlyPEP	boolean	Indica se a pessoa é atualmente uma Pessoa Politicamente Exposta (PPE).
SanctionsHistory	array of objects	Lista de objetos com o histórico de sanções e restrições.
IsCurrentlySanctioned	boolean	Indica se a pessoa está atualmente sob alguma sanção.
WasPreviouslySanctioned	boolean	Indica se existiram sanções anteriormente.
Last30DaysSanctions	integer	Quantidade de sanções e restrições encontradas nos últimos 30 dias.
Last90DaysSanctions	integer	Quantidade de sanções e restrições encontradas nos últimos 90 dias.
Last180DaysSanctions	integer	Quantidade de sanções e restrições encontradas nos últimos 180 dias.
Last365DaysSanctions	integer	Quantidade de sanções e restrições encontradas nos últimos 365 dias.
LastYearPEPOccurence	integer	Quantidade de registros de PEP encontrados no último ano.
Last3YearsPEPOccurence	integer	Quantidade de registros de PEP encontrados nos últimos 3 anos.
Last5YearsPEPOccurence	integer	Quantidade de registros de PEP encontrados nos últimos 5 anos.
Last5PlusYearsPEPOccurence	integer	Quantidade de registros de PEP encontrados nos últimos 5 anos ou mais.
FirstPEPOccurenceDate	string	Data do primeiro registro de PEP encontrado para o indivíduo.
LastPEPOccurenceDate	string	Data do último registro de PEP encontrado para o indivíduo.
FirstSanctionDate	string	Data do primeiro registro de sanções encontrado para o indivíduo.
LastSanctionDate	string	Data do último registro de sanções encontrado para o indivíduo.
IsCurrentlyElectoralDonor	boolean	Indica se a entidade doou para partidos/candidatos nas duas últimas eleições.
IsHistoricalElectoralDonor	boolean	Indica se a entidade tem histórico de doação para partidos/candidatos.
TotalElectoralDonations	integer	Total de doações para partidos/candidatos.
TotalElectoralDonationAmount	number	Valor total das doações para partidos/candidatos.
ElectoralDonations	object	Registro das doações para partidos/candidatos por ano de eleição.

Estrutura de `PEPHistory`

Campo	Tipo	Descrição
Level	string	Nível de relacionamento com o PPE.
JobTitle	string	Cargo do PPE.
Department	string	Departamento de atuação da PPE.
Motive	string	Motivo pelo qual o indivíduo é considerado PPE.
Source	string	Fonte.
TaxId	string	Número de documento da pessoa PPE.
StartDate	string	Data que a pessoa passou a ser PPE.
EndDate	string	Data que a pessoa deixou de ser PPE.
CreationDate	string	Data de criação deste registro.
LastUpdateDate	string	Data de última atualização para esse registro.

Estrutura de `SanctionsHistory`

Campo	Tipo	Descrição
Source	string	Fonte da sanção.
Type	string	Tipo de sanção.
StandardizedSanctionType	string	Tipo padronizado de sanção.
MatchRate	number	Indicação do quão próximo o nome se assemelha.
NameUniquenessScore	number	Indica quão único é o nome completo da pessoa (1 = único, 0 = muito comum).
Details	object	Detalhes adicionais sobre a sanção. (possui campos adicionais)
NormalizedDetails	object	Detalhes normalizados adicionais sobre a sanção.
StartDate	string	Data de início da sanção.
EndDate	string	Data de término da sanção.
CreationDate	string	Data de criação do registro da sanção.
LastUpdateDate	string	Data de última atualização para esse registro.
IsCurrentlyPresentOnSource	boolean	Flag marcando se a sanção se encontra presente na fonte desde a última atualização.
WasRecentlyPresentOnSource	boolean	Flag marcando se a sanção esteve recentemente presente na fonte.

Estrutura de `SocialAssistancePrograms`

Campo	Tipo	Descrição
SocialAssistances	array of objects	Lista com o detalhamento dos benefícios recebidos atualmente ou no passado.
TotalAssistances	integer	Total de assistências que a pessoa já recebeu.
TotalActiveAssistances	integer	Total de assistências que a pessoa está recebendo atualmente.
TotalIncome	number	Total de renda sendo recebida através de assistências.
TotalAmountReceived	number	Valor total recebido pela pessoa no somatório de todas as parcelas.
TotalInstallmentsReceived	integer	Quantidade total de parcelas de assistência social recebidas ao longo da vida.
IsReceivingAssistance	boolean	Flag indicando se a pessoa está atualmente recebendo alguma assistência.

Estrutura de `SocialAssistances`

Campo	Tipo	Descrição
ProgramName	string	Nome do programa de benefício.
ProgramCountry	string	País em que o programa é aplicado.
ProgramState	string	Estado em que o programa é aplicado.
AssistanceStartDate	string	Data em que a pessoa começou a receber seus benefícios.
AssistanceEndDate	string	Data em que a pessoa parou de receber seus benefícios.
AssistanceAmount	number	Quantia recebida pelo programa de assistência por mês.
AssistanceTotalAmount	number	Quantia recebida pelo programa de assistência no total.
TotalInstallments	integer	Quantidade total de parcelas recebidas até o momento.
AssistanceDetails	object	Detalhes adicionais que podem estar ocultos ou disfarçados. (possui campos adicionais)
CreationDate	string	Data de criação do registro.
LastUpdateDate	string	Data da última atualização do registro.

Estrutura de `RelatedPeople`

Campo	Tipo	Descrição
PersonalRelationships	array of objects	Lista de objetos com os detalhes dos relacionamentos.
TotalRelationships	integer	Quantidade total de relacionamentos associados à entidade.
TotalRelatives	integer	Quantidade total de relacionamentos do tipo `RELATIVE` (parentes).
TotalNeighbors	integer	Quantidade total de relacionamentos do tipo `NEIGHBOR` (vizinhos).
TotalSpouses	integer	Quantidade total de relacionamentos do tipo `SPOUSE` (cônjuges).
TotalCoworkers	integer	Quantidade total de relacionamentos do tipo `COWORKER` (colegas de trabalho).
TotalHousehold	integer	Quantidade total de relacionamentos do tipo `HOUSEHOLD` (no mesmo endereço).
TotalPartners	integer	Quantidade total de relacionamentos do tipo `PARTNER` (parceiros comerciais).
TotalCollegeClass	integer	Quantidade total de relacionamentos do tipo `COLLEGE CLASS` (colegas de sala).

Estrutura de `PersonalRelationships`

Campo	Tipo	Descrição
RelatedEntityTaxIdNumber	string	Número de identificação fiscal da entidade relacionada.
RelatedEntityTaxIdType	string	Tipo de identificação fiscal da entidade relacionada.
RelatedEntityTaxIdCountry	string	País de identificação do contribuinte relacionado.
RelatedEntityName	string	Nome da entidade relacionada.
RelationshipType	string	Tipo de relacionamento (`RELATIVE`, `HOUSEHOLD`, `SPOUSE`, `PARTNER`, `NEIGHBOR`, `CO-WORKER`, etc.).
RelationshipLevel	string	Nível de relacionamento (`DIRECT`, `SECOND-LEVEL`, `THIRD-LEVEL`).
RelationshipStartDate	string	Data em que o relacionamento se iniciou.
RelationshipEndDate	string	Data em que o relacionamento se encerrou.
CreationDate	string	Data de criação deste registro.
LastUpdateDate	string	Data da última atualização deste registro.

Estrutura de `BusinessRelationships`

Campo	Tipo	Descrição
BusinessRelationships	array of objects	Lista de objetos com o detalhamento dos relacionamentos de negócio da pessoa.
TotalRelationships	integer	Quantidade total de relacionamentos da pessoa.
TotalOwnerships	integer	Quantidade total de empresas possuídas pela pessoa.
TotalEmployments	integer	Quantidade total de empregados da pessoa.
TotalPartners	integer	Quantidade total de parceiros.
TotalClients	integer	Quantidade total de clientes.
TotalSuppliers	integer	Quantidade total de fornecedores.

Estrutura de `BusinessRelationships List`

Campo	Tipo	Descrição
PreviousLevelRelatedEntityTaxIdNumber	string	Número do documento da entidade de nível anterior à entidade relacionada.
RelatedEntityTaxIdNumber	string	Número de identificação fiscal da entidade relacionada.
RelatedEntityTaxIdType	string	Tipo de identificação fiscal da entidade relacionada.
RelatedEntityTaxIdCountry	string	País de identificação fiscal da entidade relacionada.
RelatedEntityName	string	Nome da entidade relacionada.
RelationshipName	string	Nome do relacionamento.
RelationshipType	string	Tipo do relacionamento.
RelationshipSubtype	string	Subtipo do relacionamento.
RelationshipLevel	string	Nível do relacionamento.
RelationshipStartDate	string	Data de início do relacionamento.
RelationshipEndDate	string	Data de término do relacionamento.
IsCurrentlyActive	boolean	Indica se o relacionamento está ativo.
IsFromHeadQuartersData	boolean	Indica se o relacionamento foi baseado em informações da empresa matriz.
CreationDate	string	Data de criação do registro.
LastUpdateDate	string	Data de última atualização do registro.
AdditionalDetails	object	Objeto contendo detalhes a mais do relacionamento.

Estrutura de `ExtendedEmails`

Campo	Tipo	Descrição
TotalEmails	integer	Quantidade total de e-mails encontrados para a entidade.
TotalActiveEmails	integer	Quantidade total de e-mails ativos encontrados para a entidade.
TotalWorkEmails	integer	Quantidade total de e-mails de trabalho encontrados para a entidade.
TotalPersonalEmails	integer	Quantidade total de e-mails pessoais encontrados para a entidade.
TotalUniqueEmails	integer	Quantidade total de e-mails encontrados que estão associados apenas com essa entidade.
TotalEmailPassages	integer	Quantidade total de passagens dessa entidade com algum e-mail.
TotalBadEmailPassages	integer	Quantidade total de passagens suspeitas dessa entidade com algum e-mail.
TotalLast3MonthsPassages	integer	Quantidade total de passagens para esta entidade nos últimos 3 meses.
TotalLast6MonthsPassages	integer	Quantidade total de passagens para esta entidade nos últimos 6 meses.
TotalLast12MonthsPassages	integer	Quantidade total de passagens para esta entidade nos últimos 12 meses.
TotalLast18MonthsPassages	integer	Quantidade total de passagens para esta entidade nos últimos 18 meses.
OldestEmailPassageDate	string	Data da primeira passagem dessa entidade com algum e-mail.
NewestEmailPassageDate	string	Data da última passagem dessa entidade com algum e-mail.
Emails	array of objects	Lista de objetos com informações detalhadas de cada um dos e-mails encontrados.

Estrutura de `Emails`

Campo	Tipo	Descrição
MatchRate	number	Match rate deste e-mail com o input.
EmailAddress	string	Endereço de e-mail.
Domain	string	Domínio do endereço de e-mail (depois do símbolo `@`).
UserName	string	Nome do usuário (antes do símbolo `@`).
Type	string	Tipo do e-mail (`WORK`, `PERSONAL`, etc.).
EmailEntityAge	integer	Idade do e-mail para esta entidade.
EmailAssociationClassification	object	Informações sobre classificação da associação de e-mail. (possui campos adicionais)
EmailCurrentlyInRFSite	boolean	Indica se o e-mail está no site da Receita Federal atualmente.
UserNameTotalPassages	integer	Total de passagens do nome de usuário do e-mail.
UserNameFirstPassageDate	string	Data de primeira passagem do nome de usuário do e-mail.
UserNameLastPassageDate	string	Data da última passagem do nome de usuário do e-mail.
UserNameBadPassages	integer	Quantidade de passagens ruins do nome de usuário do e-mail.
UserNameCrawlingPassages	integer	Quantidade de passagens de nome de usuário do e-mail encontradas via captura.
UserNameValidationPassages	integer	Quantidade de passagens de nome de usuário do e-mail encontradas via validações.
UserNameQueryPassages	integer	Quantidade de passagens do nome de usuário do e-mail encontradas via consultas.
EmailEntityTotalPassages	integer	Total de passagens do e-mail com essa entidade.
EmailEntityBadPassages	integer	Total de passagens avaliadas como 'ruins' com essa entidade.
EmailEntityCrawlingPassages	integer	Total de passagens referentes a capturas feitas na internet com essa entidade.
EmailEntityValidationPassages	integer	Total de passagens incluindo algum tipo de validação com essa entidade.
EmailEntityQueryPassages	integer	Total de passagens referente a alguma consulta com essa entidade.
EmailEntityMonthAveragePassages	number	Média mensal de passagens do e-mail com essa entidade.
EmailGlobalAge	integer	Idade global do e-mail.
EmailGlobalTotalPassages	integer	Total de passagens do e-mail.
EmailGlobalBadPassages	integer	Total de passagens avaliadas como 'ruins'.
EmailGlobalCrawlingPassages	integer	Total de passagens referentes a capturas feitas na internet.
EmailGlobalValidationPassages	integer	Total de passagens incluindo algum tipo de validação.
EmailGlobalQueryPassages	integer	Total de passagens referente a alguma consulta por query.
EmailGlobalMonthAveragePassages	number	Média mensal de passagens do e-mail.
Last3MonthsPassages	integer	Total de passagens nos últimos 3 meses.
Last6MonthsPassages	integer	Total de passagens nos últimos 6 meses.
Last12MonthsPassages	integer	Total de passagens nos últimos 12 meses.
Last18MonthsPassages	integer	Total de passagens nos últimos 18 meses.
EmailNumberOfEntities	integer	Número de entidades relacionadas a esse e-mail.
EmailNumberOfFamilyRelatedEntities	integer	Número de pessoas da família do CPF que estão associadas a esse e-mail.
EmailNumberOfRelatedEntities	integer	Número de entidades relacionadas com o CPF consultado que estão associadas a esse e-mail.
Priority	integer	Indica a prioridade do email.

Estrutura de `EmailAssociationClassification`

Campo	Tipo	Descrição
ClassificationType	string	Indica a relação de propriedade entre o CPF e o endereço de e-mail associado.
ClassificationDescription	string	Descrição — Indica a relação de propriedade entre o CPF e o endereço de e-mail associado.
ContactAssociationIndex	string	Indica o índice da força de associação entre o contato e o e-mail.

Estrutura de `ExtendedPhones`

Campo	Tipo	Descrição
TotalPhones	integer	Quantidade total de telefones encontrados para a entidade.
TotalActivePhones	integer	Quantidade total de telefones ativos encontrados para a entidade.
TotalWorkPhones	integer	Quantidade total de telefones de trabalho encontrados para a entidade.
TotalPersonalPhones	integer	Quantidade total de telefones pessoais encontrados para a entidade.
TotalUniquePhones	integer	Quantidade total de telefones encontrados associados apenas para a entidade.
TotalPhonePassages	integer	Quantidade total de passagens dessa entidade com algum telefone.
TotalBadPhonePassages	integer	Quantidade total de passagens suspeitas dessa entidade com algum telefone.
TotalLast3MonthsPassages	integer	Quantidade total de passagens dessa entidade nos últimos 3 meses.
TotalLast6MonthsPassages	integer	Quantidade total de passagens dessa entidade nos últimos 6 meses.
TotalLast12MonthsPassages	integer	Quantidade total de passagens dessa entidade nos últimos 12 meses.
TotalLast18MonthsPassages	integer	Quantidade total de passagens dessa entidade nos últimos 18 meses.
NextPageId	string	Número de identificação da página seguinte.
OldestPhonePassageDate	string	Data da primeira passagem dessa entidade com algum telefone.
NewestPhonePassageDate	string	Data da última passagem dessa entidade com algum telefone.
Phones	array of objects	Lista de objetos com informações detalhadas de cada um dos telefones encontrados.

Estrutura de `Phones`

Campo	Tipo	Descrição
MatchRate	number	Match rate deste telefone com o input.
Number	string	O número deste telefone da pessoa.
AreaCode	string	O código de área do número.
CountryCode	string	O código do país do número.
Complement	string	Complemento (ramal).
Type	string	Indica o tipo do telefone.
PhoneCurrentlyInRFSite	boolean	Indica se o telefone está presente no site da Receita Federal.
PhoneEntityAge	integer	Idade da entidade relacionada ao telefone.
PhoneEntityTotalPassages	integer	Total de passagens do telefone com essa entidade.
PhoneEntityBadPassages	integer	Total de passagens ruins do telefone com essa entidade.
PhoneEntityCrawlingPassages	integer	Total de passagens capturadas do telefone com essa entidade.
PhoneEntityValidationPassages	integer	Total de passagens incluindo algum tipo de validação com essa entidade.
PhoneEntityQueryPassages	integer	Total de passagens do telefone com essa entidade referentes a alguma consulta.
PhoneEntityMonthAveragePassages	number	Média total de passagens capturadas do telefone com essa entidade.
PhoneGlobalAge	integer	Idade global das passagens do telefone.
PhoneGlobalTotalPassages	integer	Total de passagens globais do telefone.
PhoneGlobalBadPassages	integer	Total de passagens ruins globais do telefone.
PhoneGlobalCrawlingPassages	integer	Total de passagens globais capturadas do telefone.
PhoneGlobalValidationPassages	integer	Total de passagens globais incluindo algum tipo de validação.
PhoneGlobalQueryPassages	integer	Total de passagens globais do telefone referentes a alguma consulta.
PhoneGlobalMonthAveragePassages	number	Média total de passagens globais capturadas do telefone com essa entidade.
Last3MonthsPassages	integer	Quantidade total de passagens desse telefone nos últimos 3 meses.
Last6MonthsPassages	integer	Quantidade total de passagens desse telefone nos últimos 6 meses.
Last12MonthsPassages	integer	Quantidade total de passagens desse telefone nos últimos 12 meses.
Last18MonthsPassages	integer	Quantidade total de passagens desse telefone nos últimos 18 meses.
PhoneNumberOfEntities	integer	Quantidade de entidades relacionadas a esse telefone.
PhoneNumberOfFamilyRelatedEntities	integer	Quantidade de entidades da família do CPF relacionado a esse telefone.
PhoneNumberOfRelatedEntities	integer	Quantidade de entidades relacionadas ao CPF associado a esse telefone.
Priority	integer	Indica a prioridade do telefone.
IsMainForEntity	boolean	Indica se o telefone é o principal da entidade.
IsRecentForEntity	boolean	Indica se o telefone é recente para a entidade.
IsMainForOtherEntity	boolean	Indica se o telefone é o principal de outra entidade.
IsRecentForOtherEntity	boolean	Indica se o telefone é recente para outra entidade.
IsActive	boolean	Indica se o telefone está ativo para a entidade.
IsLikelyFromAccountant	boolean	Indica se este telefone está em lista de possíveis contatos de contadores.
IsInDoNotCallList	boolean	Indica se o telefone foi cadastrado em uma lista de não perturbe.
CurrentCarrier	string	Operadora atual do telefone.
PlanType	string	Tipo do plano do telefone.
LastValidationDate	string	Data de última validação do telefone.
EntityFirstPassageDate	string	Data da primeira passagem do telefone com essa entidade.
EntityLastPassageDate	string	Data da última passagem do telefone com essa entidade.
GlobalFirstPassageDate	string	Data da primeira passagem do telefone.
GlobalLastPassageDate	string	Data da última passagem do telefone.
CreationDate	string	Data de criação.
LastUpdateDate	string	Data de última atualização para esse registro.
PortabilityHistory	array of objects	Lista de objetos detalhando o histórico de eventos de portabilidade.
HasOptIn	boolean	Sinalizador que indica se houve aceitação explícita por este número de telefone em nosso banco de dados.

Estrutura de `PortabilityHistory`

Campo	Tipo	Descrição
OriginalCarrier	string	Nome da operadora original do número de telefone.
NewCarrier	string	Nome da nova operadora do número de telefone.
PortabilityDate	string	Data em que ocorreu a portabilidade do número de telefone.

Estrutura de `ExtendedAddresses`

Campo	Tipo	Descrição
TotalAddresses	integer	Quantidade total de endereços encontrados para a entidade.
TotalActiveAddresses	integer	Quantidade total de endereços ativos encontrados para a entidade.
TotalWorkAddresses	integer	Quantidade total de endereços de trabalho encontrados para a entidade.
TotalPersonalAddresses	integer	Quantidade total de endereços pessoais encontrados para a entidade.
TotalUniqueAddresses	integer	Quantidade total de endereços encontrados que estão associados apenas com essa entidade.
TotalAddressPassages	integer	Quantidade total de passagens dessa entidade com algum endereço.
TotalBadAddressPassages	integer	Quantidade total de passagens suspeitas dessa entidade com algum endereço.
Last3MonthsAddressesPassages	integer	Quantidade de passagens dessa entidade com algum endereço nos últimos 3 meses.
Last6MonthsAddressesPassages	integer	Quantidade de passagens dessa entidade com algum endereço nos últimos 6 meses.
Last12MonthsAddressesPassages	integer	Quantidade de passagens dessa entidade com algum endereço nos últimos 12 meses.
Last18MonthsAddressesPassages	integer	Quantidade de passagens dessa entidade com algum endereço nos últimos 18 meses.
OldestAddressPassageDate	string	Data da primeira passagem dessa entidade com algum endereço.
NewestAddressPassageDate	string	Data da última passagem dessa entidade com algum endereço.
Addresses	array of objects	Lista de objetos com informações detalhadas de cada um dos endereços encontrados.

Estrutura de `Addresses`

Campo	Tipo	Descrição
MatchRate	number	Match rate deste endereço com o input.
Typology	string	Tipo do Logradouro (Rua, Avenida, etc.).
Title	string	Titularidade do endereço (i.e Praça, Nossa Senhora, Barão).
AddressMain	string	Núcleo do endereço.
Number	string	Número de porta do endereço.
Complement	string	Complemento do endereço (i.e. Bloco, Apartamento, etc...).
Neighborhood	string	Bairro do endereço.
ZipCode	string	Código postal do endereço.
City	string	Cidade do endereço.
State	string	Sigla do estado do endereço (i.e. SP, RJ, etc...).
Country	string	País do endereço.
Type	string	Tipo do endereço (HOME, WORK ou OFFICIAL REGISTRATION).
AddressCurrentlyInRFSite	boolean	Indica se o endereço está no site da Receita Federal atualmente.
ComplementType	string	Tipo de endereço calculado a partir do complemento (APARTMENT, HOUSE, etc).
BuildCode	string	Mesmo que o Building Code (mantido para evitar inconsistências).
BuildingCode	string	Código alfanumérico que identifica unicamente um prédio ou construção.
HouseholdCode	string	Código que identifica unicamente cada unidade individual do prédio.
AddressEntityAge	integer	Idade da entidade do endereço.
AddressEntityTotalPassages	integer	Total de passagens do endereço com essa entidade.
AddressEntityBadPassages	integer	Total de passagens avaliadas como 'suspeitas' com essa entidade.
AddressEntityCrawlingPassages	integer	Total de passagens referentes a capturas feitas na internet com essa entidade.
AddressEntityValidationPassages	integer	Total de passagens incluindo algum tipo de validação com essa entidade.
AddressEntityQueryPassages	integer	Total de passagens referente a alguma consulta com essa entidade.
AddressEntityMonthAveragePassages	number	Média mensal de passagens do endereço com essa entidade.
AddressGlobalAge	integer	Idade global do endereço.
AddressGlobalTotalPassages	integer	Total de passagens do endereço.
AddressGlobalBadPassages	integer	Total de passagens avaliadas como 'suspeitas'.
AddressGlobalCrawlingPassages	integer	Total de passagens referentes a capturas feitas na internet.
AddressGlobalValidationPassages	integer	Total de passagens incluindo algum tipo de validação.
AddressGlobalQueryPassages	integer	Total de passagens referente a alguma consulta.
AddressGlobalMonthAveragePassages	number	Média mensal de passagens do endereço.
Last3MonthsPassages	integer	Total de passagens para este endereço nos últimos 3 meses.
Last6MonthsPassages	integer	Total de passagens para este endereço nos últimos 6 meses.
Last12MonthsPassages	integer	Total de passagens para este endereço nos últimos 12 meses.
Last18MonthsPassages	integer	Total de passagens para este endereço nos últimos 18 meses.
AddressNumberOfEntities	integer	Número de entidades relacionadas a esse endereço.
Priority	integer	Indica a prioridade do endereço.
IsMainForEntity	boolean	Indica se o endereço é o principal para essa entidade.
IsIndirectAssociation	boolean	Indica se o endereço é uma associação indireta para esta entidade.
IndirectAssociationRelationshipType	string	Tipo de relacionamento do endereço associado (MOTHER, FATHER, SON, BROTHER, SPOUSE).
IsRecentForEntity	boolean	Indica se o endereço é recente para essa entidade.
IsMainForOtherEntity	boolean	Indica se o endereço é o principal para outra entidade.
IsRecentForOtherEntity	boolean	Indica se o endereço é recente para outra entidade.
IsActive	boolean	Indica se este endereço está ativo para esta entidade.
IsRatified	boolean	Indica se o endereço foi ratificado junto à base de referência dos correios (DNE ou similar).
IsLikelyFromAccountant	boolean	Indica se este endereço está em lista de possíveis contatos de contadores.
LastValidationDate	string	Data da última validação deste endereço para esta entidade.
EntityFirstPassageDate	string	Data da primeira passagem do endereço com essa entidade.
EntityLastPassageDate	string	Data da última passagem do endereço com essa entidade.
GlobalFirstPassageDate	string	Data da primeira passagem do endereço.
GlobalLastPassageDate	string	Data da última passagem do endereço.
CreationDate	string	Data em que o registro foi criado.
LastUpdateDate	string	Data da última atualização do registro.
HasOptIn	boolean	Sinalizador que indica se houve aceitação de encomendas e propagandas explícita por este endereço.
Latitude	number	Latitude do endereço.
Longitude	number	Longitude do endereço.

Estrutura de `IndebtednessQuestion`

Campo	Tipo	Descrição
LikelyInDebt	boolean	Indica se o indivíduo está inadimplente ou negativado.

Estrutura de `RegistrationData`

Campo	Tipo	Descrição
BasicData	object	Objeto contendo dados básicos comuns em formulários de cadastro.
Emails	object	Objeto com dados dos e-mails primário e secundário da empresa.
Addresses	object	Objeto com dados dos endereços primário e secundário da empresa.
Phones	object	Objeto com dados dos telefones primário e secundário da empresa.

Estrutura de `policy`

Campo	Tipo	Descrição
`score`	integer	Score
`evaluations`	array<object>	Lista de avaliações realizadas
`evaluations[].message`	string	Mensagem descritiva da avaliação
`evaluations[].risk`	string	Nível de risco identificado na avaliação
`evaluations[].score`	integer	Pontuação atribuída para a avaliação
`totalScore`	integer	Score Total
`maxScore`	integer	Score máximo possível
`percentageScore`	number($double)	Percentual da pontuação obtida em relação à máxima
`normalizedScore`	integer	Pontuação normalizada
`attentionPoints`	array<object>	Pontos de atenção identificados
`attentionPoints[].message`	string	Mensagem do ponto de atenção
`attentionPoints[].risk`	string	Nível de risco do ponto de atenção

Descrição

Autenticação

Parâmetros de consulta

Corpo da Resposta

Estrutura de exceptions

Estrutura de resultado

Estrutura de Result

Estrutura de BasicData

Estrutura de Aliases

Estrutura de MaritalStatusData

Estrutura de Collections

Estrutura de KycData

Estrutura de PEPHistory

Estrutura de SanctionsHistory

Estrutura de SocialAssistancePrograms

Estrutura de SocialAssistances

Estrutura de RelatedPeople

Estrutura de PersonalRelationships

Estrutura de BusinessRelationships

Estrutura de BusinessRelationships List

Estrutura de ExtendedEmails

Estrutura de Emails

Estrutura de EmailAssociationClassification

Estrutura de ExtendedPhones

Estrutura de Phones

Estrutura de PortabilityHistory

Estrutura de ExtendedAddresses

Estrutura de Addresses

Estrutura de IndebtednessQuestion

Estrutura de RegistrationData

Estrutura de policy

Estrutura de `exceptions`

Estrutura de `resultado`

Estrutura de `Result`

Estrutura de `BasicData`

Estrutura de `Aliases`

Estrutura de `MaritalStatusData`

Estrutura de `Collections`

Estrutura de `KycData`

Estrutura de `PEPHistory`

Estrutura de `SanctionsHistory`

Estrutura de `SocialAssistancePrograms`

Estrutura de `SocialAssistances`

Estrutura de `RelatedPeople`

Estrutura de `PersonalRelationships`

Estrutura de `BusinessRelationships`

Estrutura de `BusinessRelationships List`

Estrutura de `ExtendedEmails`

Estrutura de `Emails`

Estrutura de `EmailAssociationClassification`

Estrutura de `ExtendedPhones`

Estrutura de `Phones`

Estrutura de `PortabilityHistory`

Estrutura de `ExtendedAddresses`

Estrutura de `Addresses`

Estrutura de `IndebtednessQuestion`

Estrutura de `RegistrationData`

Estrutura de `policy`