Serviços de Pessoa Física

Os serviços de pessoa física permitem consultar, validar e enriquecer dados de CPF em fluxos de onboarding, KYC, prevenção à fraude, análise cadastral, biometria, documentos, compliance e dados eleitorais. Todos são executados pelo endpoint central de serviços. O campo service define qual produto será processado, e os demais campos variam conforme a consulta escolhida. Antes de montar o body, confira no produto do cliente qual alias está liberado. Esse é o valor que deve ir no campo service.

POST /api/service-api

Nos exemplos de curl, {base_url} representa a URL do ambiente escolhido:

Ambiente	Base URL
Homologação	`https://backoffice-hml.idcerberus.com`
Produção	`https://backoffice.idcerberus.com`

Exemplo de requisição:

{
  "service": "SERVICE_PERSON_DATA_ENRICHMENT",
  "cpf": "cpf"
}

Como usar este catálogo

Esta é a referência técnica completa de pessoa física — use-a quando precisar do contrato completo de um service. Para navegar por objetivo ou família de produto primeiro, veja Escolha o serviço certo, Matriz de serviços ou Famílias de serviços. Use esta página para consultar a lista completa de serviços de CPF, seus códigos service, campos principais e exemplos mais extensos de request e response.

O catálogo mostra o nome funcional e o alias documentado do service. Se o produto do cliente tiver sido configurado com alias curto, use o alias do produto no campo service. Isso evita erro de acesso mesmo quando o produto está ativo.

Passo rápido para evitar erro:

Abra o produto do cliente no Backoffice.
Confirme o alias liberado para o serviço.
Envie esse alias no campo service.
Use os demais campos da tabela como entrada principal da consulta.

Alias documentado	Alias curto do produto
`SERVICE_DIGITAL_DOCUMENTOSCOPY`	`SERVICE_DOCUMENTOSCOPY`
`SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT`	`SERVICE_DIGITAL_DOCUMENTOSCOPY`
`SERVICE_ECONOMIC_RELATIONSHIP`	`economic_relationships`
`SERVICE_EMAIL_VALIDATION`	`SERVICE_EMAIL_VALIDATION1`
`SERVICE_PROTEST_CLEARANCE_CERTIFICATE`, `SERVICE_PROTEST_PF`	`SERVICE_PROTEST_CLEARANCE_CERTIFICATE`

OCR, documentoscopia, FaceMatch e Liveness precisam de imagem/base64, URL ou key real para retornar dados completos. Payload curto ajuda a validar autenticação, acesso ao produto e formato básico da chamada, mas não valida o retorno completo do processamento.

Guias relacionados

Guia	Quando usar
Escolha o serviço certo	Para decidir o service pelo caso de uso.
Famílias de serviços	Para navegar por grupo de produto.
OCR via Service API	Para payloads de documento, imagem, base64 e exemplos de retorno.
API Reference	Para detalhes endpoint a endpoint.

Status e erros

No retorno das consultas, a API inclui um objeto status que indica o status da consulta. Esse objeto apresenta os atributos code e message, usados para interpretar o processamento técnico.

{
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Para detalhes de tratamento, consulte Status e erros.

Serviços disponíveis

Cadastro e identidade

Serviço	Código `service`	Campos principais
Enriquecimento de dados de PF	`SERVICE_PERSON_DATA_ENRICHMENT`	`cpf`
Status do CPF na Receita Federal	`SERVICE_RFB_PF`	`cpf`, `dataDeNascimento`
CPF na Receita Federal on-demand	`SERVICE_RFB_PF_ON_DEMAND`	`cpf`
Modelagem de dados de pessoa física	`SERVICE_PERSON_DATA_MODELING`	`cpf`
Prompt de IA para pessoa	`SERVICE_PERSON_AI_PROMPT`	`cpf`
Consulta de MEI	`SERVICE_MEI`	`cpf`
Dados pelo telefone	`SERVICE_CONFIRM_PHONE`	`phone`
Endereços	`SERVICE_ADDRESS`	`cpf`
Histórico de telefones	`SERVICE_PHONE_HISTORY`	`cpf`, `birthDate`, `limit`
Pessoas relacionadas	`SERVICE_RELATED_PEOPLE`	`cpf`, `birthDate`
Histórico de e-mails	`SERVICE_EMAILS_EXTENDED`	`cpf`, `limit`
Relacionamentos econômicos	`SERVICE_ECONOMIC_RELATIONSHIP`	`cpf`
Histórico profissional	`SERVICE_PROFESSIONAL_HISTORY`	`cpf`
Histórico profissional do titular	`SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY`	`cpf`, `birthDate`
Dados financeiros e endereços PF	`SERVICE_PF_FINANCIAL_AND_ADDRESS`	`cpf`, `birthDate`
Dados demográficos	`SERVICE_DEMOGRAPHIC_DATA_CPF`	`cpf`, `birthDate`
Indicadores de atividades	`SERVICE_ACTIVITIES_INDICATORS`	`cpf`
Domínios PF	`SERVICE_DOMAINS_CPF`	`cpf`
Cartão SUS	`SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF`	`cpf`
E-mails de Pessoas Relacionadas	`SERVICE_RELATED_PEOPLE_EMAILS`	`cpf`
Telefones de Pessoas Relacionadas	`SERVICE_RELATED_PEOPLE_PHONES`	`cpf`
Endereços de Pessoas Relacionadas	`SERVICE_RELATED_PEOPLE_ADDRESSES`	`cnpj`
TSE - Local de votação	`SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF`	`cpf`, `birthDate`, `motherName`

Biometria e documentos

Serviço	Código `service`	Campos principais
OCR React	`SERVICE_OCR`	`documentType`, `image1`, `image2`
OCR de emancipação	`SERVICE_OCR_EMANCIPATION`	`image1`
OCR de comprovante de endereço	`SERVICE_OCR_PROOF_OF_ADDRESS`	`image1`
Busca de face na base	`SERVICE_FACE_INDEX`	`image1`
FaceMatch	`SERVICE_FACE_MATCH`	`image1`, `image2`
Score biométrico / Validação de CNH no DataValid	`SERVICE_DATAVALID_CNH`	`cpf`, `image1`
Documentoscopia digital	`SERVICE_DIGITAL_DOCUMENTOSCOPY`	`key`, `image1`, `image2`, `selfie1`
Resultado da documentoscopia	`SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT`	`key`

Risco, compliance e validações

Serviço	Código `service`	Campos principais
Pessoa politicamente exposta	`SERVICE_PEP`	`cpf`
KYC e compliance de pessoa física	`SERVICE_PERSON_KYC`	`cpf`, `birthDate`
Exposição e perfil na mídia PF	`SERVICE_MEDIA_PROFILE_EXPOSURE_PF`	`cpf`
Dívida ativa PF / Débitos ativos PF	`SERVICE_ACTIVE_DEBT_PF`	`cpf`
Score de risco de fraude	`SERVICE_FRAUD_RISK_SCORE`	`cpf`, `factor`
Risco financeiro	`SERVICE_FINANCIAL_RISK_SCORE`	`cpf`, `birthDate`
Score de inadimplência	`SERVICE_DEFAULT_RISK_SCORE`	`cpf`
Score de crédito	`SERVICE_CREDIT_SCORE`	`cpf`
Score de Crédito	`SERVICE_QUOD_CREDIT_SCORE_PERSON`	`cpf`
Score de Crédito Multidados	`SERVICE_BOAVISTA_ONE_SCORE_PERSON`	`cpf`
Dados Restritivos	`SERVICE_BOAVISTA_CREDIT_SCORE_PERSON`	`cpf`
Flags Negativos	`SERVICE_QUOD_CREDIT_RISK_PERSON`	`cpf`
Nada consta em ações judiciais	`SERVICE_NOTHING_RECORD_LAWSUITS`	`cpf`, `court`, `uf`, `sphere`
Antecedentes criminais federais	`SERVICE_CRIMINAL_RECORD_FEDERAL`	`cpf`
Antecedentes criminais civis	`SERVICE_CRIMINAL_RECORD_CIVIL`	`cpf`, `rg`, `uf`
Certidão negativa de protesto	`SERVICE_PROTEST_CLEARANCE_CERTIFICATE`	`cpf`
Validação de e-mail	`SERVICE_EMAIL_VALIDATION`	`email`
Validação de CPF com telefone	`SERVICE_CPF_PHONE_VALIDATION`	`cpf`, `phone`
Validação de CPF com endereço	`SERVICE_CPF_ADDRESS_VALIDATION`	`cpf`, `zipcode`, `numberAddress`
Informações financeiras	`SERVICE_FINANCIAL_INFORMATION`	`cpf`
Dados PIS	`SERVICE_PIS_CONSULTATION`	`cpf`
Prêmios e certificações	`SERVICE_AWARDS_AND_CERTIFICATIONS_CPF`	`cpf`
Benefícios sociais familiares	`SERVICE_FAMILY_SOCIAL_BENEFITS`	`cpf`
Benefícios sociais estendidos	`SERVICE_SOCIAL_ASSISTANCE_EXTENDED`	`cpf`
Validação E-Social	`SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION`	`cpf`, `nit`
Processos jurídicos	`SERVICE_JURIDICAL_PROCESSES`	`cpf`
Servidores públicos	`SERVICE_PUBLIC_SERVANTS`	`cpf`
Propensão a apostas online	`SEVICE_ONLINE_BETTING_PROPENSITY`	`cpf`
Mandado de prisão	`SERVICE_ARREST_WARRANT`	`nome`, `motherName`, `fatherName`, `birthDate`, `cpf`
Dados eleitorais de candidato	`SERVICE_ELECTION_CANDIDATE_DATA_CPF`	`cpf`
Doações eleitorais PF	`SERVICE_ELECTORAL_DONORS_CPF`	`cpf`
Envolvimento político	`SERVICE_POLITICAL_INVOLVEMENT`	`cpf`
Envolvimento político PF	`SERVICE_POLITICAL_INVOLVEMENT_CPF`	`cpf`
Histórico familiar político	`SERVICE_FAMILY_POLITICAL_HISTORY_CPF`	`cpf`
Prestadores de serviço eleitorais PF	`SERVICE_ELECTORAL_PROVIDERS_CPF`	`cpf`

Consultas avançadas adicionadas

Alguns serviços retornam informações consolidadas ou análises derivadas de fontes complementares. Eles seguem o mesmo padrão de chamada do endpoint POST /api/service-api, mas podem ter respostas mais amplas conforme a disponibilidade dos dados na consulta.

Serviço	Quando usar	Exemplo de body
`SERVICE_RFB_PF_ON_DEMAND`	Buscar o CPF na Receita Federal em tempo de consulta	`{ "service": "SERVICE_RFB_PF_ON_DEMAND", "cpf": "cpf" }`
`SERVICE_PERSON_DATA_MODELING`	Consolidar dados de modelagem, contatos, vínculos, processos e endereços	`{ "service": "SERVICE_PERSON_DATA_MODELING", "cpf": "cpf" }`
`SERVICE_PERSON_AI_PROMPT`	Gerar resumo analítico textual a partir dos dados consolidados da pessoa	`{ "service": "SERVICE_PERSON_AI_PROMPT", "cpf": "cpf" }`
`SERVICE_DATAVALID_CNH`	Validar CNH com apoio do validação documental	`{ "service": "SERVICE_DATAVALID_CNH", "cpf": "cpf", "image1": "base64" }`
`SERVICE_FINANCIAL_RISK_SCORE`	Consultar score de risco financeiro	`{ "service": "SERVICE_FINANCIAL_RISK_SCORE", "cpf": "cpf" }`
`SERVICE_PF_FINANCIAL_AND_ADDRESS`	Combinar dados cadastrais, endereços e informações financeiras	`{ "service": "SERVICE_PF_FINANCIAL_AND_ADDRESS", "cpf": "cpf" }`
`SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY`	Retornar histórico profissional em que a pessoa aparece como titular ou sócia	`{ "service": "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY", "cpf": "cpf" }`
`SEVICE_ONLINE_BETTING_PROPENSITY`	Avaliar propensão a apostas online	`{ "service": "SEVICE_ONLINE_BETTING_PROPENSITY", "cpf": "cpf" }`

O alias SEVICE_ONLINE_BETTING_PROPENSITY está documentado sem a letra R em SERVICE porque essa é a grafia implementada no backend. Não altere essa grafia sem validação técnica, pois a chamada pode deixar de ser reconhecida.

Exemplos

Enriquecimento de dados de pessoa física

A consulta de enriquecimento de dados de pessoa física retorna informações de uma pessoa física existente no site da Receita Federal. O retorno pode incluir status cadastral, protocolo da consulta, indicação de óbito quando disponível e outras informações relacionadas ao CPF consultado. As informações dessa consulta são obtidas a partir da consulta pública de pessoa física no site da Receita Federal.

POST /api/service-api

Autorização:

Authorization: Bearer {jwt_token}
Content-Type: application/json

Body:

{
  "service": "SERVICE_PERSON_DATA_ENRICHMENT",
  "cpf": "cpf"
}

Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF
`result.status`	Status na base da Receita Federal
`result.statusDate`	Data do status na base da Receita Federal
`result.name`	Nome
`result.fatherName`	Nome do pai
`result.motherName`	Nome da mãe
`result.birthdate`	Data de nascimento
`result.birthCountry`	País de nascimento
`result.dead`	Indicação de óbito
`result.deathYear`	Ano do óbito
`result.gender`	Gênero
`result.age`	Idade
`result.origin`	Origem das informações
`result.fiscalRegion`	Região fiscal do CPF
`result.numberOfPeopleWithTheSameName`	Quantidade de pessoas com o mesmo nome completo
`result.nameWordCount`	Quantidade de nomes no nome completo
`result.nameUniqueScore`	Score de unicidade do nome, em que `1` indica único e `0` extremamente comum
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_PERSON_DATA_ENRICHMENT",
    "cpf": "cpf"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "06319423196",
    "status": "REGULAR",
    "statusDate": "2022-05-29T00:00:00",
    "name": "NOME DA PESSOA",
    "gender": "M",
    "fatherName": "NOME DO PAI",
    "motherName": "NOME DA MÃE",
    "birthdate": "1998-07-05",
    "birthCountry": "BRASILEIRA",
    "dead": false,
    "country": "BRAZIL",
    "fiscalRegion": "DF-GO-MS-MT-TO",
    "numberOfPeopleWithTheSameName": "3",
    "nameWordCount": "3",
    "nameUniqueScore": "0.994",
    "origin": "RECEITA FEDERAL",
    "age": 24
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Status do CPF na Receita Federal

A consulta de status do CPF na Receita Federal retorna a situação cadastral de um CPF existente na base pública da Receita Federal.

POST /api/service-api

Autorização:

Authorization: Bearer {jwt_token}
Content-Type: application/json

Body:

{
  "service": "SERVICE_RFB_PF",
  "cpf": "cpf",
  "dataDeNascimento": "yyyy-MM-dd (opcional)"
}

Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF
`result.status`	Status na base da Receita Federal
`result.statusDate`	Data do status na base da Receita Federal
`result.origin`	Origem das informações
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_RFB_PF",
    "cpf": "cpf",
    "dataDeNascimento": "yyyy-MM-dd (opcional) "
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "123414124",
    "status": "REGULAR",
    "name": "NOME EXEMPLO",
    "birthDate": "yyyy-MM-ddT00:00",
    "dead": false,
    "origin": "RECEITA FEDERAL",
    "age": 30
  },
  "status": {
    "code": 200,
    "message": "Consulta de API Realizada com Sucesso"
  },
  "externalId": "1782ea0a-8663-41a8-b156-688527f5363b"
}

CPF na Receita Federal on-demand

Executa a consulta do CPF na Receita Federal em modo on-demand. Use quando for necessário buscar ou atualizar os dados cadastrais diretamente no momento da requisição.

{
  "service": "SERVICE_RFB_PF_ON_DEMAND",
  "cpf": "cpf"
}

Exemplo de resposta:

{
  "result": {
    "cpf": "123414124",
    "status": "REGULAR",
    "name": "NOME EXEMPLO",
    "birthDate": "1994-05-21T00:00",
    "dead": false,
    "origin": "RECEITA FEDERAL",
    "age": 30
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Modelagem de dados de pessoa física

Consolida informações de modelagem, histórico de telefones, processos, relacionamentos econômicos, histórico profissional e endereços para apoiar análises mais completas de uma pessoa.

{
  "service": "SERVICE_PERSON_DATA_MODELING",
  "cpf": "cpf"
}

Exemplo de resposta:

{
  "result": {
    "modelData": "Dados de modelagem consolidados para o CPF consultado."
  },
  "results": [
    {
      "modelData": "Dados de modelagem consolidados para o CPF consultado."
    }
  ],
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Prompt de IA para pessoa

Gera um resumo analítico a partir de dados consolidados da pessoa consultada. Esse serviço é útil quando a integração precisa transformar múltiplos sinais em uma explicação textual estruturada.

{
  "service": "SERVICE_PERSON_AI_PROMPT",
  "cpf": "cpf"
}

Exemplo de resposta:

{
  "result": {
    "modelData": "Resumo analítico gerado a partir dos dados consolidados da pessoa consultada."
  },
  "results": [
    {
      "modelData": "Resumo analítico gerado a partir dos dados consolidados da pessoa consultada."
    }
  ],
  "status": {
    "code": 200,
    "message": "Success"
  }
}

OCR React

Use SERVICE_OCR para extrair dados de documentos de identificação como RG/CIN, CNH, OAB, RNE/CRNM e PASSAPORTE. Para deixar a API identificar o documento, envie documentType: IDENTIFICATION_DOCUMENT.

POST /api/service-api

Autorização:

Authorization: Bearer {jwt_token}
Content-Type: application/json

Body:

{
  "service": "SERVICE_OCR",
  "documentType": "CNH",
  "image1": "base64"
}

Tipos de documento suportados:

Documento	Valor
CNH	`CNH`
RG / CIN	`RG`
OAB	`OAB`
RNE / CRNM	`RNE`
Passaporte	`PASSAPORT`
Identificação automática	`IDENTIFICATION_DOCUMENT`

Para respostas completas por tipo de documento, consulte Documentos de identificação. Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_OCR",
    "documentType": "CNH",
    "image1": "base64"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "06319423196",
    "name": "NOME DA PESSOA",
    "fatherName": "NOME DO PAI",
    "motherName": "NOME DA MÃE",
    "birthDate": "1992-01-05",
    "cnhCategory": "AB",
    "cnhNumber": "07796497926",
    "emissionPlace": "DETRAN DE",
    "rg": "3451620",
    "rgIssuer": "SSP/UF",
    "cnhIssueDate": "2020-04-13",
    "renach": "DF767732467",
    "state": "DF"
  },
  "status": {
    "code": 200,
    "message": "OCR realizado com sucesso"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}

FaceMatch

Esse serviço compara duas imagens e retorna a similaridade entre as pessoas nas imagens. As imagens podem ser enviadas em base64 ou por URL, conforme a integração.

POST /api/service-api

Autorização:

Authorization: Bearer {jwt_token}
Content-Type: application/json

Body:

{
  "service": "SERVICE_FACE_MATCH",
  "image1": "base64",
  "image2": "base64"
}

Campos principais do retorno:

Campo	Descrição
`result.status`	Status da similaridade facial das imagens
`result.similarity`	Similaridade facial das imagens
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_FACE_MATCH",
    "image1": "base64",
    "image2": "base64"
  }'

Exemplo de resposta:

{
  "result": {
    "status": "Face picture match",
    "similarity": 99.95
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Pessoa politicamente exposta

Consulta o CPF de um indivíduo e retorna se a pessoa é politicamente exposta.

{
  "service": "SERVICE_PEP",
  "cpf": "cpf"
}

Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF
`result.status`	Status indicando se a pessoa é politicamente exposta
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_PEP",
    "cpf": "cpf"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "74768289096",
    "status": "Pessoa não exposta politicamente"
  },
  "status": {
    "code": 200,
    "message": "success"
  }
}

KYC e compliance de pessoa física

Consolida sinais de compliance de uma pessoa física, incluindo exposição PEP, sanções atuais e histórico de ocorrências encontradas nas bases consultadas.

{
  "service": "SERVICE_PERSON_KYC",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}

Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF consultado
`result.isPep`	Indica se a pessoa é politicamente exposta
`result.isCurrentlySanctioned`	Indica se existe sanção vigente associada à pessoa
`result.sanctionsHistory`	Histórico de sanções encontradas
`result.pepHistories`	Histórico de exposição PEP
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo de resposta:

{
  "result": {
    "cpf": "12345678901",
    "isPep": false,
    "isCurrentlySanctioned": false,
    "sanctionsHistory": [],
    "pepHistories": []
  },
  "status": {
    "code": 200,
    "message": "Consulta de API Realizada com Sucesso"
  }
}

Exposição e perfil na mídia de pessoa física

Consulta exposição pública e perfil de mídia associado ao CPF, incluindo nível de exposição, celebridade, impopularidade, unicidade do nome e notícias relacionadas quando disponíveis.

{
  "service": "SERVICE_MEDIA_PROFILE_EXPOSURE_PF",
  "cpf": "cpf"
}

Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF consultado
`result.mediaExposureLevel`	Nível de exposição em mídia
`result.celebrityLevel`	Nível de notoriedade pública
`result.unpopularityLevel`	Nível de impopularidade
`result.fullName`	Nome completo retornado
`result.shortName`	Nome curto retornado
`result.fullNameUniquenessScore`	Score de unicidade do nome completo
`result.shortNameUniquenessScore`	Score de unicidade do nome curto
`result.newsItems`	Notícias relacionadas encontradas

Exemplo de resposta:

{
  "result": {
    "cpf": "12345678901",
    "mediaExposureLevel": "MEDIUM",
    "celebrityLevel": "LOW",
    "unpopularityLevel": "LOW",
    "fullName": "NOME EXEMPLO",
    "shortName": "NOME EXEMPLO",
    "fullNameUniquenessScore": 0.98,
    "shortNameUniquenessScore": 0.91,
    "newsItems": [
      {
        "title": "Notícia de exemplo",
        "url": "https://www.exemplo.com/noticia",
        "publicationDate": "2024-01-15",
        "sentimentAnalysis": "NEUTRAL"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Consulta de API Realizada com Sucesso"
  }
}

Dívida ativa - Pessoa Física

Consulta a situação dos débitos relativos a créditos tributários federais e à Dívida Ativa da União, disponível na Receita Federal e na Procuradoria-Geral da Fazenda Nacional (PGFN).

{
  "service": "SERVICE_ACTIVE_DEBT_PF",
  "cpf": "cpf"
}

Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF
`result.status`	Status da dívida ativa
`result.statusDate`	Data do status
`result.origin`	Origem do status
`result.validDate`	Data de validade
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --data '{
    "service": "SERVICE_ACTIVE_DEBT_PF",
    "cpf": "cpf"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "88154726068",
    "status": "NEGATIVA",
    "statusDate": "2022-08-16",
    "origin": "Receita-Federal PGFN",
    "validDate": "0001-01-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Score de risco de fraude

O score de risco de fraude mede a propensão de fraude de uma interação associada a um CPF. Essa propensão é calculada a partir de inferência estatística baseada em informações históricas de fraude e apoia decisões de prevenção à fraude e análise de risco.

{
  "service": "SERVICE_FRAUD_RISK_SCORE",
  "cpf": "cpf",
  "factor": "minRisk or minattrition"
}

Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF
`result.score`	Score de risco de fraude
`result.factor`	Status de risco retornado pela DataRisk: `HIGH RISK`, `MEDIUM RISK` ou `LOW RISK`
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_FRAUD_RISK_SCORE",
    "cpf": "cpf",
    "factor": "minRisk or minattrition"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "80246074507",
    "score": "8.0691",
    "factor": "MEDIUM RISK",
    "message": "Success calculating score"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Risco financeiro

Calcula um score de risco financeiro para o CPF informado. A resposta retorna o score normalizado e uma mensagem com a leitura resumida da análise.

{
  "service": "SERVICE_FINANCIAL_RISK_SCORE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}

Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF consultado
`result.score`	Score calculado
`result.message`	Mensagem com score e interpretação de risco
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo de resposta:

{
  "result": {
    "cpf": "80246074507",
    "score": "650",
    "message": "Score: 650 | Análise: RISCO MÉDIO"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Score de inadimplência

O score de inadimplência identifica o nível de risco de inadimplência de um cliente ou prospecto. O resultado varia de 0 a 1000; quanto maior o valor, menor o risco de inadimplência.

{
  "service": "SERVICE_DEFAULT_RISK_SCORE",
  "cpf": "cpf"
}

Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF
`result.score`	Score de inadimplência
`result.origin`	Origem do score
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_DEFAULT_RISK_SCORE",
    "cpf": "cpf"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "{80246074507}",
    "status": "REGULAR",
    "origin": "Datarisk",
    "score": "462",
    "rank": "E",
    "expectedDefault": "58.94%",
    "processType": "SEM PROCESSOS"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Score biométrico

A consulta de score biométrico compara um CPF e uma selfie com imagens presentes em bases do Governo Federal, como CPF, CNPJ e CNH. O retorno indica o índice de similaridade encontrado.

{
  "service": "SERVICE_DATAVALID_CNH",
  "cpf": "cpf",
  "image1": "{base64Image}"
}

Campo	Descrição
`result.cpf`	CPF
`result.status`	Status da consulta do score biométrico
`result.message`	Mensagem da consulta
`result.similarity`	Score de similaridade da imagem com a base do Governo Federal
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_DATAVALID_CNH",
    "cpf": "cpf",
    "image1": "{base64Image}"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "73583960149",
    "status": "Altíssima probabilidade",
    "message": "Biometrics exist at the base of the Government",
    "similarity": 99.66
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Validação de CNH no DataValid

Valida dados de CNH com apoio do validação documental. O serviço recebe o CPF e a imagem de referência, normalmente em base64, para executar a validação disponível na integração.

{
  "service": "SERVICE_DATAVALID_CNH",
  "cpf": "cpf",
  "image1": "base64"
}

Exemplo de resposta:

{
  "result": {
    "cpf": "73583960149"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Atualmente, o retorno exposto por este serviço pode ser mínimo e variar conforme a disponibilidade da integração validação documental. Use o status da chamada e os campos retornados em result como contrato efetivo da resposta.

Certidão de Nada Consta - Ações Judiciais

Emite uma certidão de Nada Consta em tribunais regionais federais. Na esfera eleitoral, a consulta está disponível apenas para fontes do TRF1 e TRF4.

{
  "service": "SERVICE_NOTHING_RECORD_LAWSUITS",
  "cpf": "cpf",
  "court": "TRF1",
  "uf": "uf",
  "sphere": "CIVIL"
}

Parâmetros opcionais:

Campo	Descrição
`court`	Tribunal: `TRF1`, `TRF2`, `TRF3`, `TRF4` ou `TRF5`
`uf`	UF da federação brasileira
`sphere`	Esfera: `CIVIL`, `CRIMINAL` ou `ELEITORAL`

Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF
`result.status`	Status do Nada Consta
`result.origin`	Origem do Nada Consta
`result.uf`	UF do Nada Consta, quando retornado com essa nomenclatura
`result.state`	Tribunal ou estado retornado no exemplo da API
`result.name`	Nome do indivíduo
`result.certificateNumber`	Número da certidão
`result.certificateText`	Texto da certidão
`result.expirationDate`	Data de expiração
`result.emissionDate`	Data de emissão
`result.type`	Tipo da certidão
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_NOTHING_RECORD_LAWSUITS",
    "cpf": "cpf",
    "court": "TRF1",
    "uf": "uf",
    "sphere": "CIVIL"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "80246074507",
    "status": "NADA CONSTA",
    "origin": "NadaConsta",
    "state": "TRF1",
    "name": "Fulano",
    "certificateNumber": "212312312311231",
    "certificateText": "A Polícia Federal CERTIFICA, após pesquisa no Sistema Nacional de Informações Criminais - SINIC, que até a presente data, NÃO CONSTA decisão judicial condenatória com trânsito em julgado* em nome de NOME DA PESSOA, nascido(a) aos 05/07/1998",
    "expirationDate": "2022-10-20",
    "emissionDate": "2022-10-20",
    "type": "CIVEL E CRIMINAL"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Certidão de antecedentes criminais - Federal

Emite uma certidão de antecedentes criminais junto à Polícia Federal. Quando não há antecedentes, o status do resultado retorna como NADA CONSTA.

{
  "service": "SERVICE_CRIMINAL_RECORD_FEDERAL",
  "cpf": "cpf"
}

Campo	Descrição
`result.cpf`	CPF
`result.status`	Status da certidão criminal
`result.expirationDate`	Data de expiração da certidão
`result.certificateNumber`	Número da certidão criminal
`result.certificateText`	Texto da certidão criminal
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_CRIMINAL_RECORD_FEDERAL",
    "cpf": "cpf"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "80246074507",
    "status": "NADA CONSTA",
    "certificateNumber": "79222652022",
    "certificateText": "A Polícia Federal CERTIFICA, após pesquisa no Sistema Nacional de Informações Criminais - SINIC, que até a presente data, NÃO CONSTA decisão judicial condenatória com trânsito em julgado* em nome de NOME DA PESSOA, nascido(a) aos 05/07/1998",
    "expirationDate": "2022-10-20"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Certidão de antecedentes criminais - Civil

Emite uma certidão de antecedentes criminais junto à Polícia Civil do estado consultado. Caso a pessoa não possua antecedentes, o status do resultado retorna como NADA CONSTA. Quando houver antecedentes, a descrição dos registros não é retornada por essa consulta.

{
  "service": "SERVICE_CRIMINAL_RECORD_CIVIL",
  "cpf": "cpf",
  "rg": "rg",
  "uf": "uf"
}

Parâmetros aceitos:

Campo	Descrição	Valor aceito
`cpf`	Número do CPF	Qualquer texto
`rg`	Número do RG da identidade	Qualquer texto
`uf`	UF do estado	Qualquer texto
`motherName`	Nome da mãe	Qualquer texto
`fatherName`	Nome do pai	Qualquer texto
`rgIssuingAgency`	Órgão emissor do documento	Qualquer texto
`rgIssuingUf`	Estado do órgão emissor do documento	Qualquer texto
`rgExpeditionDate`	Data de emissão do documento	Qualquer data válida
`dateFormat`	Formato da data de emissão do documento	Exemplo: `yyyy-MM-dd`
`placeOfBirth`	Local de nascimento	Qualquer texto
`address`	Endereço	Qualquer texto
`numberAddress`	Número do endereço	Qualquer número
`zipcode`	CEP	Qualquer texto
`neighborhood`	Bairro	Qualquer texto
`city`	Cidade	Qualquer texto

Obrigatoriedade de parâmetros por estado:

Estado	CPF	UF	RG	MOTHERNAME	FATHERNAME	RGISSUINGAGENCY	RGISSUINGUF	RGEXPEDITIONDATE	DATEFORMAT	PLACEOFBIRTH	ADDRESS	NUMBERADDRESS	NEIGHBORHOOD	CITY	ZIPCODE
MG	Obrigatório	Obrigatório	Obrigatório	Semi-obrigatório	-	-	-	-	-	-	-	-	-	-	-
CE	Obrigatório	Obrigatório	Obrigatório	Semi-obrigatório	-	-	-	-	-	-	-	-	-	-	-
RR	Obrigatório	Obrigatório	Obrigatório	Semi-obrigatório	-	-	-	-	-	-	-	-	-	-	-
MT	Obrigatório	Obrigatório	Obrigatório	Semi-obrigatório	Opcional	Obrigatório	Obrigatório	-	-	Obrigatório	-	-	-	-	-
RJ	Obrigatório	Obrigatório	Obrigatório	Semi-obrigatório	Opcional	Obrigatório	-	Obrigatório	-	-	Semi-obrigatório	Semi-obrigatório	Semi-obrigatório	Semi-obrigatório	Semi-obrigatório
PE	Obrigatório	Obrigatório	Obrigatório	Semi-obrigatório	-	Obrigatório	Obrigatório	-	-	Obrigatório	Semi-obrigatório	-	Semi-obrigatório	Semi-obrigatório	-
PA	Obrigatório	Obrigatório	Obrigatório	Semi-obrigatório	-	-	Obrigatório	-	-	Obrigatório	-	-	-	-	-
MS	Obrigatório	Obrigatório	Obrigatório	Semi-obrigatório	-	Obrigatório	Obrigatório	-	-	-	-	-	-	-	-
SE	Obrigatório	Obrigatório	Obrigatório	Semi-obrigatório	Opcional	-	-	-	-	-	-	-	-	-	-
BA	Obrigatório	Obrigatório	Obrigatório	Semi-obrigatório	Opcional	-	-	-	-	-	-	-	-	-	-
SP	Obrigatório	Obrigatório	Obrigatório	Semi-obrigatório	Opcional	-	-	Obrigatório	Obrigatório	-	-	-	-	-	-
ES	Obrigatório	Obrigatório	Obrigatório	Semi-obrigatório	Opcional	-	Obrigatório	-	-	-	-	-	-	-	-
RS	Obrigatório	Obrigatório	Obrigatório	-	-	-	-	-	-	-	-	-	-	-	-

Estados disponíveis para consulta: BA, CE, ES, MG, MS, MT, PA, PE, RJ, RR, RS, SE e SP. Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF
`result.status`	Status da certidão criminal
`result.uf`	UF consultada
`result.emissionDate`	Data de emissão da certidão
`result.expirationDate`	Data de expiração da certidão, quando retornada
`result.certificateNumber`	Número da certidão criminal
`result.certificateText`	Texto da certidão criminal
`result.origin`	Origem da certidão
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_CRIMINAL_RECORD_CIVIL",
    "cpf": "cpf",
    "rg": "rg",
    "uf": "uf"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "80246074507",
    "status": "NADA CONSTA",
    "uf": "BA",
    "emissionDate": "00:00 de 20/12/2022",
    "certificateNumber": "A5FD4A36-3F31-4F75-8AF0-103B7BB66212",
    "certificateText": "Antecedentes Criminais CERTIFICADO DE ANTECEDENTES CRIMINAIS Nome: NOME DA PESSOA Número do Rg: 14781688 Nome do Pai: NOME DO PAI Nome da Mãe: NOME DA MÃE Data de Nascimento: 19/6/1997 Naturalidade: \"Certifico que o requerente acima qualificado NÃO registra antecedentes criminais até a presente data no Centro de Documentação e Estatística Policial (CEDEP), da Polícia Civil \". IMPORTANTE: Este certificado é válido somente com a apresentação da cédula de Identidade expedida pelo Instituto de Identificação Pedro Melo/DPT/SSP. Este certificado foi emitido terça-feira, 20 de dezembro de 2022 e está disponível para consulta no endereço http://www.ba.gov.br/antecedentes/validar_atestado.asp, informando o código A5FD4A36-3F31-4F75-8AF0-103B7BB66212 Obs: Este certificado tem validade até a data 20/3/2023 Imprimir Fechar Janela",
    "origin": "PoliciaCivilAntecedentes"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Certidão negativa de protesto

Consulta informações de protestos em cartórios. Quando não existem protestos de títulos contra o indivíduo, retorna uma certidão emitida pelo Instituto de Estudos de Protestos de Títulos do Brasil.

{
  "service": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE",
  "cpf": "cpf"
}

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE",
    "cpf": "cpf"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "77272722134",
    "protestos": [
      {
        "cartorio": "CARTÓRIO LARANJEIRAS - 32º OFÍCIO DE NOTAS DO RIO DE JANEIRO",
        "cidade": "RIO DE JANEIRO",
        "quantidadeTitulos": "",
        "endereco": "R. DAS LARANJEIRAS - LARANJEIRAS, RIO DE JANEIRO - RJ, 22221-060",
        "telefone": "19 3396-2809",
        "protestos": [
          {
            "cpfCnpj": "00000000000000",
            "data": "2017-10-10",
            "dataProtesto": "2017-10-10",
            "dataVencimento": "",
            "valor": "9.900,00"
          },
          {
            "cpfCnpj": "00000000000000",
            "data": "2018-01-01",
            "dataProtesto": "2018-01-01",
            "dataVencimento": "",
            "valor": "16.000,00"
          }
        ]
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Validação de e-mail

Realiza uma verificação em tempo real do e-mail informado, aplicada a cenários como prevenção à fraude, identificação correta de e-mail, marketing, campanhas e envio de cobranças.

{
  "service": "SERVICE_EMAIL_VALIDATION",
  "email": "[email protected]"
}

Status possíveis:

Status	Descrição
`VALID`	O e-mail é válido e não apresenta restrições
`INVALID`	O e-mail é inválido
`UNKNOWN`	A validação não foi concluída no tempo limite

Campos principais do retorno:

Campo	Descrição
`result.email`	E-mail
`result.status`	Status do e-mail
`result.normalizedEmail`	E-mail normalizado
`result.address`	Endereço
`result.account`	Conta do e-mail
`result.domain`	Domínio do e-mail
`result.disposable`	Indica se o e-mail é temporário
`result.roleAddress`	Indica se o e-mail referencia um grupo
`result.riskyAccount`	Indica padrão de conta de risco
`result.riskyDomain`	Indica padrão de domínio de risco
`result.junk`	Indica possibilidade de spam ou lixo eletrônico
`result.limited`	Indica regras de filtragem por volume
`result.acceptAll`	Indica se o domínio aceita qualquer e-mail
`result.possibleSpamTrap`	Indica possível e-mail armadilha
`result.wasSyntaxValid`	Indica se a sintaxe original é válida
`result.wasSyntaxNormalized`	Indica se a sintaxe foi normalizada
`result.wasOwnershipFound`	Indica se foi encontrada propriedade do domínio
`result.possibleStoogeDomain`	Indica possível domínio laranja
`result.domainType`	Tipo do domínio
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "service": "SERVICE_EMAIL_VALIDATION",
    "email": "[email protected]"
  }'

Exemplo de resposta:

{
  "result": {
    "email": "[email protected]",
    "status": "VALID",
    "normalizedEmail": "[email protected]",
    "address": "[email protected]",
    "account": "teste",
    "domain": "test.com",
    "disposable": false,
    "roleAddress": false,
    "riskyAccount": false,
    "riskyDomain": false,
    "junk": false,
    "limited": false,
    "acceptAll": false,
    "possibleSpamTrap": false,
    "wasSyntaxValid": true,
    "wasSyntaxNormalized": false,
    "wasSiteFound": true,
    "wasOwnershipFound": false,
    "possibleStoogeDomain": false,
    "domainType": "BLOG"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Validação de CPF com telefone

Verifica a associação entre CPF e número de telefone nas principais operadoras do Brasil. Esse serviço pode apoiar redução de custos e validações antes de envios de mensagens.

{
  "service": "SERVICE_CPF_PHONE_VALIDATION",
  "cpf": "cpf",
  "phone": "11900000000"
}

Campo	Descrição
`result.cpf`	CPF
`result.phone`	Telefone
`result.operator`	Nome da operadora retornado no exemplo da API
`result.carrierName`	Nome da operadora, quando retornado com essa nomenclatura
`result.validCarrierPhone`	Indica se o telefone é válido
`result.matchRateCpfPhone`	Taxa de correspondência entre CPF e telefone
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_CPF_PHONE_VALIDATION",
    "cpf": "cpf",
    "phone": "11900000000"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "80246074507",
    "phone": "5561982358585",
    "operator": "OPERADORA EXEMPLO",
    "validCarrierPhone": true,
    "matchRateCpfPhone": 100
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Validação de CPF com endereço

Valida a associação entre CPF e endereço nas principais operadoras de telefonia do Brasil. Essa consulta ajuda a verificar se o indivíduo está associado ao endereço informado e também apoia verificações relacionadas à localização.

{
  "service": "SERVICE_CPF_ADDRESS_VALIDATION",
  "cpf": "cpf",
  "zipcode": "00000-000",
  "numberAddress": 13
}

Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF
`result.zipcode`	CEP
`result.numberAddress`	Número do endereço
`result.carrierName`	Nome da operadora de telefonia
`result.zipCodeMatchRate`	Taxa de correspondência entre CPF e CEP
`result.numberMatchRate`	Taxa de correspondência entre CPF, CEP e número informado
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --data '{
    "service": "SERVICE_CPF_ADDRESS_VALIDATION",
    "cpf": "cpf",
    "zipcode": "00000-000",
    "numberAddress": 13
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "80246074507",
    "message": "Customer not found",
    "carrierName": "CLARO S.A.",
    "zipcode": "00000000",
    "zipCodeMatchRate": -1,
    "numberMatchRate": -1,
    "numberAddress": "13"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Consulta de informações financeiras

Consulta informações financeiras associadas ao CPF informado.

POST /api/service-api

Autorização:

Authorization: Bearer {jwt_token}

Body:

{
  "service": "SERVICE_FINANCIAL_INFORMATION",
  "cpf": "cpf"
}

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_FINANCIAL_INFORMATION",
    "cpf": "cpf"
  }'

Esse serviço não possui exemplo de body de resposta JSON nesta referência.

Consulta de dados PIS

A consulta de dados do PIS busca informações do Programa de Integração Social disponíveis no portal do Cadastro Nacional de Informações Sociais (CNIS).

POST /api/service-api

Autorização:

Authorization: Bearer {jwt_token}
Content-Type: application/json

Body:

{
  "service": "SERVICE_PIS_CONSULTATION",
  "cpf": "cpf"
}

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_PIS_CONSULTATION",
    "cpf": "cpf"
  }'

Esse serviço aparece como indisponível nesta referência e não possui body de resposta documentado. A validação do E-Social consulta o status cadastral do indivíduo no E-Social. Embora a consulta possa usar o NIT, esse campo não é obrigatório. Caso o NIT não seja enviado, a API utiliza o dado disponível na base.

POST /api/service-api

Autorização:

Authorization: Bearer {jwt_token}

Body:

{
  "service": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION",
  "cpf": "cpf",
  "nit": "(opcional)"
}

Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF
`result.status`	Status da validação cadastral
`result.message`	Mensagem da consulta
`result.name`	Nome
`result.birthdate`	Data de nascimento
`result.pis`	Número do PIS
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Authorization: Bearer {jwt_token}' \
  --data '{
    "service": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION",
    "cpf": "cpf",
    "nit": "(opcional)"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "80246074507",
    "status": "VERIFIED",
    "message": "Os dados estão corretos.",
    "name": "NOME EXEMPLO",
    "birthdate": "1971-11-23",
    "pis": "12460888617"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Documentoscopia digital

Esse serviço realiza a extração das informações do documento enviado e executa FaceMatch entre a selfie informada e o documento, podendo também comparar com bases do governo.

{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY",
  "key": "84bfcd2e-2336-4e30-bcab-15348b7890b5",
  "image1": "base64",
  "image2": "base64",
  "selfie1": "base64"
}

Campos de entrada:

Campo	Descrição
`key`	Chave usada para consultar o resultado da documentoscopia. Pode ser um UUID ou outra chave definida pela integração
`image1`	Documento em base64, PDF ou imagem, com a parte frontal do RG ou CNH. Também pode conter a foto da CNH completa. Campo obrigatório
`image2`	Documento em base64 com a parte de trás do RG ou CNH. Campo opcional
`selfie1`	Selfie da pessoa do documento para FaceMatch. Campo opcional

Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF
`result.name`	Nome
`result.fatherName`	Nome do pai
`result.motherName`	Nome da mãe
`result.birthdate`	Data de nascimento
`result.cnhCategory`	Categoria da CNH
`result.expeditionDate`	Data de expedição
`result.rg`	Número do RG
`result.rgUf`	UF do RG
`result.reanch`	Número do RENACH
`result.place`	Local de emissão do documento
`result.validDate`	Data de validade
`result.biometry`	FaceMatch entre documento e selfie na base do governo
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --data '{
    "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY",
    "key": "84bfcd2e-2336-4e30-bcab-15348b7890b5",
    "image1": "base64",
    "image2": "base64",
    "selfie1": "base64"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "80246074507",
    "name": "NOME DA PESSOA",
    "fatherName": "NOME DO PAI",
    "motherName": "NOME DA MÃE",
    "birthdate": "1984-05-21",
    "cnhCategory": "AD",
    "expeditionDate": "19/03/2021",
    "rg": "3261880",
    "rgUf": "DF",
    "reanch": "DF765309297",
    "place": "Distrito Federal, Goiás, Mato Grosso, Mato Grosso do Sul ou Tocantins",
    "validDate": "2026-02-24",
    "biometry": 1
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Consulta do resultado da documentoscopia digital

Consulta o resultado da documentoscopia digital usando a chave informada na requisição de criação.

{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT",
  "key": "de0cd562-5962-40bd-8f94-5a7184ecde0e"
}

Campos principais do retorno:

Campo	Descrição
`result.cpf`	CPF
`result.name`	Nome
`result.fatherName`	Nome do pai
`result.motherName`	Nome da mãe
`result.birthdate`	Data de nascimento
`result.cnhCategory`	Categoria da CNH
`result.cnhNumber`	Número da CNH
`result.expeditionDate`	Data de expedição
`result.rg`	Número do RG
`result.rgUf`	UF do RG
`result.doc`	Tipo de documento
`result.place`	Local de emissão do documento
`result.validDate`	Data de validade do documento
`result.reanch`	Número do RENACH
`result.biometry`	FaceMatch documento x selfie na base do governo
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --data '{
    "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT",
    "key": "de0cd562-5962-40bd-8f94-5a7184ecde0e"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "80246074507",
    "name": "NOME DA PESSOA",
    "fatherName": "NOME DO PAI",
    "motherName": "NOME DA MÃE",
    "birthdate": "1992-01-05",
    "cnhCategory": "AB",
    "cnhNumber": "07796497926",
    "expeditionDate": "2020-04-13",
    "rg": "3451620",
    "rgUf": "DF",
    "doc": "CNH",
    "place": "BRASILIA-DISTRITO FEDERAL, DF",
    "validDate": "2021-02-13",
    "REANCH": "DF767732467",
    "biometry": 3
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Consulta de MEI

Consulta os MEIs que um CPF possui.

{
  "service": "SERVICE_MEI",
  "cpf": "cpf"
}

Campos principais do retorno:

Campo	Descrição
`result.meis`	Empresas MEI do CPF informado
`result.meis.cpf`	CPF
`result.meis.cnpj`	CNPJ do MEI
`result.meis.companyName`	Nome da empresa
`result.meis.sector`	Setor da empresa
`result.meis.classification`	Classificação da empresa
`result.meis.startDate`	Data de início da empresa
`result.meis.endDate`	Data de fim da empresa
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --data '{
    "service": "SERVICE_MEI",
    "cpf": "cpf"
  }'

Exemplo de resposta:

{
  "result": {
    "meis": [
      {
        "cpf": "34449772040",
        "cnpj": "22745099000193",
        "companyName": "EMPRESA MEI EXEMPLO",
        "sector": "PRIVATE - 9511800 - REPARACAO E MANUTENCAO DE COMPUTADORES E DE EQUIPAMENTOS PERIFERICOS",
        "classification": "SELF-EMPLOYED",
        "startDate": "2022-02-03",
        "endDate": "2022-02-10"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Processos jurídicos e administrativos

Consulta processos jurídicos e administrativos associados ao CPF informado.

{
  "service": "SERVICE_JURIDICAL_PROCESSES",
  "cpf": "cpf"
}

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_JURIDICAL_PROCESSES",
    "cpf": "cpf"
  }'

Exemplo de resposta:

{
  "result": {
    "processes": [
      {
        "cpf": "",
        "numberLegalProcess": "",
        "trialCourt": "",
        "processDate": "",
        "mainSubjectProcess": "",
        "classification": "",
        "relatedParties": ""
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Consulta de servidores públicos

Consulta vínculos relacionados a servidores públicos para o CPF informado.

{
  "service": "SERVICE_PUBLIC_SERVANTS",
  "cpf": "cpf"
}

Campos principais do retorno:

Campo	Descrição
`result.totalPublicPositions`	Total de vínculos ou posições públicas encontradas
`result.inServiceServices`	Total de vínculos públicos em serviço
`result.income`	Valor de renda retornado pela consulta
`result.isCurrentlyPublicServant`	Indica se a pessoa é atualmente servidora pública
`result.professionalHistory`	Histórico profissional relacionado ao serviço público
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_PUBLIC_SERVANTS",
    "cpf": "cpf"
  }'

Exemplo de resposta:

{
  "result": {
    "totalPublicPositions": 6,
    "inServiceServices": 0,
    "income": 0,
    "isCurrentlyPublicServant": false,
    "professionalHistory": []
  },
  "status": {
    "code": 400,
    "message": "Failed to fetch information"
  }
}

Consulta de endereços

Consulta endereços associados ao CPF informado.

{
  "service": "SERVICE_ADDRESS",
  "cpf": "cpf"
}

Campos principais do retorno:

Campo	Descrição
`result.addresses`	Lista de endereços associados ao CPF
`result.addresses.zipcode`	CEP
`result.addresses.country`	País
`result.addresses.address`	Logradouro
`result.addresses.city`	Cidade
`result.addresses.addressType`	Tipo do endereço
`result.addresses.neighborhood`	Bairro
`result.addresses.state`	UF
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_ADDRESS",
    "cpf": "cpf"
  }'

Exemplo de resposta:

{
  "result": {
    "addresses": [
      {
        "zipcode": "",
        "country": "BRASIL",
        "address": "",
        "city": "SALVADOR",
        "addressType": "HOME",
        "neighborhood": "GRACA",
        "state": "BA"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Consulta de relacionamentos econômicos

Consulta relacionamentos econômicos associados ao CPF informado.

{
  "service": "SERVICE_ECONOMIC_RELATIONSHIP",
  "cpf": "cpf"
}

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_ECONOMIC_RELATIONSHIP",
    "cpf": "cpf"
  }'

O retorno desse serviço não foi informado no trecho atual da documentação antiga.

Consulta do histórico profissional

Consulta histórico profissional associado ao CPF informado.

{
  "service": "SERVICE_PROFESSIONAL_HISTORY",
  "cpf": "cpf"
}

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_PROFESSIONAL_HISTORY",
    "cpf": "cpf"
  }'

Exemplo de resposta:

{
  "result": {
    "professionalHistory": [
      {
        "endDate": "2007-12-23",
        "companyName": "CRN CURSOS PROFISSIONALIZANTES LTDA",
        "cnpj": "05731652000209",
        "classification": "EMPLOYEE",
        "sector": "PRIVATE - 8599604 - TREINAMENTO EM DESENVOLVIMENTO PROFISSIONAL E GERENCIAL",
        "startDate": "2004-02-10"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Consulta de dados pelo telefone

Consulta dados da pessoa a partir do telefone informado.

{
  "service": "SERVICE_CONFIRM_PHONE",
  "phone": "+5561123456789"
}

Campo	Descrição
`cpf`	CPF
`name`	Nome da pessoa
`phone`	Telefone consultado

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_CONFIRM_PHONE",
    "phone": "+5561123456789"
  }'

Exemplo de resposta:

{
  "result": {
    "cpf": "11111111111",
    "name": "NOME DA PESSOA",
    "phone": "+5561123456789"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Consulta de mandado de prisão

Consulta mandado de prisão associado aos dados informados.

{
  "service": "SERVICE_ARREST_WARRANT",
  "nome": "nome",
  "motherName": "nome da mãe",
  "fatherName": "nome do pai",
  "birthDate": "dd/MM/yyyy",
  "cpf": "cpf"
}

Campo	Descrição
`message`	Mensagem de retorno
`arrestWarrantFound`	Indica se existe mandado de prisão

Consulta de débitos ativos

Consulta débitos ativos associados ao CPF informado.

{
  "service": "SERVICE_ACTIVE_DEBT_PF",
  "cpf": "cpf"
}

Campo	Descrição
`result.totalDebtValue`	Valor total dos débitos
`result.totalDebts`	Quantidade total de débitos
`result.debts`	Lista de débitos
`status.code`	Código da mensagem de status
`status.message`	Mensagem do código de status

Consulta de dados eleitorais de um candidato

Consulta dados eleitorais associados a um candidato.

{
  "service": "SERVICE_ELECTION_CANDIDATE_DATA_CPF",
  "cpf": "cpf"
}

Campos principais do retorno:

Campo	Descrição
`hasRunForOffice`	Indica se o indivíduo já concorreu a algum cargo público
`hasBeenElected`	Indica se o indivíduo já foi eleito
`numberOfTimesRanForOffice`	Número de vezes que concorreu a cargos públicos
`numberOfTimesElected`	Número de vezes que foi eleito
`lastElectedRole`	Último cargo para o qual foi eleito
`electionData`	Dados detalhados sobre candidaturas e eleições
`accountability`	Dados de prestação de contas
`assetsList`	Lista de bens declarados
`suppliersRanking`	Ranking de fornecedores
`donorsRanking`	Ranking de doadores

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_ELECTION_CANDIDATE_DATA_CPF",
    "cpf": "cpf"
  }'

Exemplo de resposta:

{
  "result": {
    "hasRunForOffice": true,
    "hasBeenElected": true,
    "numberOfTimesRanForOffice": 1,
    "numberOfTimesElected": 1,
    "lastElectedRole": "Presidente",
    "firstElectionYearRanForOffice": "2000",
    "lastElectionYearRanForOffice": "2020",
    "firstElectionYearElected": "2000",
    "lastElectionYearElected": "2020",
    "electionData": [
      {
        "ballotName": "ROG***NHO",
        "ballotNumber": 77789,
        "fullName": "CAR***************************IRA",
        "normalizedName": "CAR***************************IRA",
        "docNumber": "832*****753",
        "voterNumber": "079******370",
        "url": "https://divulgacandcontas.tse.jus.br/divulga/rest/v1/candidatura/buscar/2020/58955/2030402020/candidato/190000751750",
        "electionYear": "2020",
        "electionType": "Municipal",
        "applicationRole": "Vereador",
        "applicationPlace": "SÃO FIDÉLIS",
        "applicationUf": "RJ",
        "campaignCNPJ": "38646823000161",
        "status": "Eleito por QP",
        "wasElected": true,
        "candidateSituation": "Consta da urna",
        "applicationSituation": "Deferido",
        "partyNumber": 77,
        "partyAcronym": "SOLIDARIEDADE",
        "partyName": "Sol*******ade",
        "campaignSpendingFirstRound": 122565.82,
        "totalAssetsValue": 93100,
        "assetsList": [
          {
            "description": "economia pessoal",
            "type": "Dinheiro em espécie - moeda nacional",
            "value": 8100
          }
        ],
        "accountability": {
          "accountabilityControlNumber": "777***************502",
          "consolidatedRevenueValues": {
            "totalReceivedResources": 13390.8,
            "totalFinancialResources": 9230
          },
          "consolidatedExpensesValues": {
            "expensesThreshold": 122565.82,
            "totalExpensesContracted": 9230
          }
        }
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Consulta de doações eleitorais

Consulta doações eleitorais realizadas por uma pessoa.

{
  "service": "SERVICE_ELECTORAL_DONORS_CPF",
  "cpf": "cpf"
}

Campos principais do retorno:

Campo	Descrição
`totalDonationsAmount`	Quantidade total de doações realizadas
`totalDonatedValue`	Valor total doado
`quantityOfDonationsLastElection`	Quantidade de doações na última eleição
`quantityOfDonationsLastTwoElections`	Quantidade de doações nas últimas duas eleições
`quantityOfDonationsLastThreeElection`	Quantidade de doações nas últimas três eleições
`donatedValueLastElection`	Valor doado na última eleição
`donatedValueLastTwoElections`	Valor doado nas últimas duas eleições
`donatedValueLastThreeElection`	Valor doado nas últimas três eleições
`partiesThatReceivedDonation`	Lista dos partidos que receberam doações
`maxDonationValue`	Valor máximo de uma doação
`averageDonationValue`	Valor médio das doações
`minDonationValue`	Valor mínimo de uma doação
`electionDonationData`	Dados detalhados das doações realizadas em eleições
`electionDonationData.politicianBallotNumber`	Número na urna do político que recebeu a doação
`electionDonationData.politicianFullName`	Nome completo do político que recebeu a doação
`electionDonationData.electionYear`	Ano da eleição em que a doação foi realizada
`electionDonationData.partyName`	Nome do partido que recebeu a doação
`electionDonationData.donationsAmount`	Quantidade de doações feitas para o político ou partido
`electionDonationData.totalDonationValue`	Valor total das doações feitas para o político ou partido
`electionDonationData.isCrowdfunding`	Indica se a doação foi realizada via crowdfunding
`electionDonationData.donationRecipient`	Destinatário da doação
`electionDonationData.isCrossDonation`	Indica se a doação foi cruzada
`electionDonationData.partyCrossDonationValue`	Valor da doação cruzada para o partido

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_ELECTORAL_DONORS_CPF",
    "cpf": "cpf"
  }'

Exemplo de resposta:

{
  "result": {
    "totalDonationsAmount": 15,
    "totalDonatedValue": 57930428,
    "quantityOfDonationsLastElection": 0,
    "quantityOfDonationsLastTwoElections": 0,
    "quantityOfDonationsLastThreeElection": 1,
    "donatedValueLastElection": 0,
    "donatedValueLastTwoElections": 0,
    "donatedValueLastThreeElection": 25000000,
    "partiesThatReceivedDonation": [
      "PSDB",
      "PST",
      "PRP",
      "PFL",
      "MDB"
    ],
    "maxDonationValue": 57030000,
    "averageDonationValue": 8275775.5,
    "minDonationValue": 684,
    "electionDonationData": [
      {
        "politicianBallotNumber": 0,
        "politicianFullName": "HEN**********************LES",
        "electionYear": "2002",
        "partyName": "P**B",
        "donationsAmount": "6",
        "totalDonationValue": 887050.1,
        "isCrowdfunding": false,
        "donationRecipient": "CANDIDATE",
        "isCrossDonation": false,
        "partyCrossDonationValue": 0
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Consulta de envolvimento político

Consulta indicadores de envolvimento político de uma pessoa.

{
  "service": "SERVICE_POLITICAL_INVOLVEMENT",
  "cpf": "cpf"
}

Campo	Descrição
`electionsCount`	Número de eleições nas quais o indivíduo participou
`isCurrentlyInOffice`	Indica se está atualmente em cargo público
`wasFormerlyElected`	Indica se já foi eleito anteriormente
`isPep`	Indica se é Pessoa Politicamente Exposta
`amountDonated`	Valor total doado
`amountReceived`	Valor total recebido
`politicalInvolvementScore`	Pontuação de envolvimento político

Exemplo com curl:

curl --location '{base_url}/api/service-api' \
  --header 'Content-Type: application/json' \
  --data '{
    "service": "SERVICE_POLITICAL_INVOLVEMENT",
    "cpf": "cpf"
  }'

Exemplo de resposta:

{
  "result": {
    "electionsCount": 5,
    "isCurrentlyInOffice": true,
    "wasFormerlyElected": true,
    "isPep": true,
    "amountDonated": 19804076,
    "amountReceived": 20599420,
    "politicalInvolvementScore": 1
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Consulta de histórico familiar político

Consulta histórico político familiar de uma pessoa.

{
  "service": "SERVICE_FAMILY_POLITICAL_HISTORY_CPF",
  "cpf": "cpf"
}

Campos principais do retorno:

Alguns campos abaixo mantêm a grafia original retornada pela API, mesmo quando ela parece inconsistente. Isso evita divergência entre a documentação e o contrato real do response.

Campo	Descrição
`totalMembers`	Número total de membros da família
`policalMembers`	Número de membros políticos na família
`currentlyElectedMembers`	Número de membros atualmente eleitos
`totalDisputedElections`	Total de eleições disputadas pela família
`totalWonElections`	Total de eleições ganhas
`familyFirstDisputedElectionYear`	Ano da primeira eleição disputada pela família
`familyFirstWonElectionYear`	Ano da primeira eleição ganha pela família
`familyLastDisputedElectionYear`	Ano da última eleição disputada pela família
`familyLastWonElectionYear`	Ano da última eleição ganha pela família
`relationshipTypeWithMoreWonElections`	Tipo de relação com mais eleições ganhas
`relationshipTypeWithMoreDisputedElections`	Tipo de relação com mais eleições disputadas
`highestDisputedPolicalPosition`	Posição política mais alta disputada
`highestHeldPolicalPosition`	Posição política mais alta ocupada
`electionsTimeline`	Linha do tempo de eleições disputadas
`disputedPoliticalPositionsDistribution`	Distribuição dos cargos disputados
`heldPoliticalPositionsDistribution`	Distribuição dos cargos ocupados
`totalDisputedElectionsByRelationshipType`	Total de eleições disputadas por tipo de relação
`totalWonElectionsByRelationshipType`	Total de eleições ganhas por tipo de relação
`totalDisputedElectionsByPartyAcronym`	Total de eleições disputadas por sigla partidária
`totalDisputedElectionsByRegion`	Total de eleições disputadas por região

Exemplo de resposta:

{
  "result": {
    "totalMembers": 10,
    "policalMembers": 3,
    "currentlyElectedMembers": 2,
    "totalDisputedElections": 22,
    "totalWonElections": 11,
    "familyFirstDisputedElectionYear": 1998,
    "familyFirstWonElectionYear": 1998,
    "familyLastDisputedElectionYear": 2022,
    "familyLastWonElectionYear": 2022,
    "relationshipTypeWithMoreWonElections": "SON",
    "relationshipTypeWithMoreDisputedElections": "SON",
    "highestDisputedPolicalPosition": "PRESIDENTE",
    "highestHeldPolicalPosition": "PRESIDENTE",
    "electionsTimeline": [
      {
        "eelationshipType": "SELF",
        "electionYear": 2022,
        "electionType": "FEDERAL",
        "electionRegion": "BRASIL - BR",
        "role": "PRESIDENTE",
        "partyAcronym": "PL",
        "wasElected": false
      }
    ],
    "disputedPoliticalPositionsDistribution": {
      "DEPUTADO FEDERAL": 9,
      "VEREADOR": 9,
      "PRESIDENTE": 2,
      "PREFEITO": 2
    },
    "heldPoliticalPositionsDistribution": {
      "DEPUTADO FEDERAL": 6,
      "VEREADOR": 4,
      "PRESIDENTE": 1
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Consulta de prestadores de serviço eleitorais

Consulta prestadores de serviço eleitorais associados à pessoa.

{
  "service": "SERVICE_ELECTORAL_PROVIDERS_CPF",
  "cpf": "cpf"
}

Campos principais do retorno:

Campo	Descrição
`name`	Nome do indivíduo ou entidade
`partiesThatReceivedProvision`	Lista dos partidos que receberam provisões
`electionProvisionData`	Dados detalhados sobre provisões eleitorais
`politicianBallotNumber`	Número na urna do político que recebeu a provisão
`politicianFullName`	Nome completo do político que recebeu a provisão
`politicianDocNumber`	Número do documento do político
`partyName`	Nome do partido que recebeu a provisão
`provisionRequester`	Solicitante da provisão
`electionYear`	Ano da eleição
`applicationRole`	Cargo ao qual o candidato se candidatou
`numberOfProvisions`	Número de provisões feitas
`totalProvisionValue`	Valor total das provisões
`crossDonationFlagFound`	Indica se foi encontrada doação cruzada
`entityCrossDonationValue`	Valor da doação cruzada pela entidade
`entityCrossDonationYield`	Rendimento da doação cruzada pela entidade
`crossDonationRelationshipLevel`	Nível de relacionamento da doação cruzada
`minProvisionValue`	Valor mínimo de provisão
`maxProvisionValue`	Valor máximo de provisão
`avgProvisionValue`	Valor médio das provisões

​Serviços de Pessoa Física

​Como usar este catálogo

​Guias relacionados

​Status e erros

​Serviços disponíveis

​Cadastro e identidade

​Biometria e documentos

​Risco, compliance e validações

​Consultas avançadas adicionadas

​Exemplos

​Enriquecimento de dados de pessoa física

​Status do CPF na Receita Federal

​CPF na Receita Federal on-demand

​Modelagem de dados de pessoa física

​Prompt de IA para pessoa

​OCR React

​FaceMatch

​Pessoa politicamente exposta

​KYC e compliance de pessoa física

​Exposição e perfil na mídia de pessoa física

​Dívida ativa - Pessoa Física

​Score de risco de fraude

​Risco financeiro

​Score de inadimplência

​Score biométrico

​Validação de CNH no DataValid

​Certidão de Nada Consta - Ações Judiciais

​Certidão de antecedentes criminais - Federal

​Certidão de antecedentes criminais - Civil

​Certidão negativa de protesto

​Validação de e-mail

​Validação de CPF com telefone

​Validação de CPF com endereço

​Consulta de informações financeiras

​Consulta de dados PIS

​Validação do E-Social

​Documentoscopia digital

​Consulta do resultado da documentoscopia digital

​Consulta de MEI

​Processos jurídicos e administrativos

​Consulta de servidores públicos

​Consulta de endereços

​Consulta de relacionamentos econômicos

​Consulta do histórico profissional

​Consulta de dados pelo telefone

​Consulta de mandado de prisão

​Consulta de débitos ativos

​Consulta de dados eleitorais de um candidato

​Consulta de doações eleitorais

​Consulta de envolvimento político

​Consulta de histórico familiar político

​Consulta de prestadores de serviço eleitorais

Serviços de Pessoa Física

Como usar este catálogo

Guias relacionados

Status e erros

Serviços disponíveis

Cadastro e identidade

Biometria e documentos

Risco, compliance e validações

Consultas avançadas adicionadas

Exemplos

Enriquecimento de dados de pessoa física

Status do CPF na Receita Federal

CPF na Receita Federal on-demand

Modelagem de dados de pessoa física

Prompt de IA para pessoa

OCR React

FaceMatch

Pessoa politicamente exposta

KYC e compliance de pessoa física

Exposição e perfil na mídia de pessoa física

Dívida ativa - Pessoa Física

Score de risco de fraude

Risco financeiro

Score de inadimplência

Score biométrico

Validação de CNH no DataValid

Certidão de Nada Consta - Ações Judiciais

Certidão de antecedentes criminais - Federal

Certidão de antecedentes criminais - Civil

Certidão negativa de protesto

Validação de e-mail

Validação de CPF com telefone

Validação de CPF com endereço

Consulta de informações financeiras

Consulta de dados PIS

Validação do E-Social

Documentoscopia digital

Consulta do resultado da documentoscopia digital

Consulta de MEI

Processos jurídicos e administrativos

Consulta de servidores públicos

Consulta de endereços

Consulta de relacionamentos econômicos

Consulta do histórico profissional

Consulta de dados pelo telefone

Consulta de mandado de prisão

Consulta de débitos ativos

Consulta de dados eleitorais de um candidato

Consulta de doações eleitorais

Consulta de envolvimento político

Consulta de histórico familiar político

Consulta de prestadores de serviço eleitorais