Famílias de serviços

O endpoint POST /api/service-api concentra diferentes produtos. A separação por família ajuda a localizar rapidamente o payload correto sem tratar o endpoint como uma lista única e extensa.

Esta página agrupa por família de produto. O catálogo técnico completo, com todos os campos e exemplos de cada service, vive em Serviços de Pessoa Física e Serviços de Pessoa Jurídica — use-os como fonte de referência quando precisar do contrato completo de um service.

Pessoa física

Services de CPF, cadastro, score, compliance e dados complementares.

Pessoa jurídica

Services de CNPJ, cadastro empresarial, sócios, risco e compliance.

Documentos e biometria

OCR, face, liveness, documentoscopia e payloads com imagem.

Risco e validações

Scores, validações, compliance, certidões e sinais de risco.

Como usar esta página

Escolha a família de serviço.
Copie o código service ou confirme o alias de chamada configurado no produto.
Abra POST /api/service-api na API Reference.
Selecione o exemplo correspondente.
Mapeie o response esperado.

Padrão de consumo

Todos os produtos desta página usam a mesma base de chamada:

{
  "service": "codigo_do_servico",
  "cpf": "cpf"
}

O campo service escolhe o produto. Os demais campos variam conforme a consulta: documentos usam imagens ou URLs, serviços PF usam cpf, serviços PJ usam cnpj e algumas certidões exigem dados complementares como uf, rg ou court.

A API valida o service contra os services liberados no produto do cliente. Por isso, em alguns casos o valor enviado na chamada pode ser um alias curto do produto, e não outro alias documentado no catálogo.

Antes de testar com o cliente, confirme o alias no produto, copie esse valor para o body e depois complete os campos obrigatórios da família escolhida.

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`
`SERVICE_PROTEST_PJ`	`SERVICE_PROTEST_CLEARANCE_CERTIFICATE_PJ`

Pense no POST /api/service-api como um executor. A rota é sempre a mesma, mas o serviço executado muda de acordo com o valor enviado em service. Exemplo:

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

Neste caso, a API entende que deve executar o serviço de enriquecimento de dados de pessoa física. Se o service mudar, o produto executado também muda.

Tipo de consulta	Documento principal	Observação
Pessoa física	`cpf`	Pode exigir dados adicionais em certidões, validações ou biometria
Pessoa jurídica	`cnpj`	Pode exigir `uf` em consultas estaduais ou documentos complementares
Documento e biometria	`image1`, `image2`, `selfie1` ou URLs	Use base64 ou URL conforme o produto
Onboarding/documentoscopia assíncrona	`key`	A chave permite consultar o resultado depois

Para implementação, copie o exemplo completo na API Reference e use esta página apenas para escolher rapidamente o produto correto.

Cadastro e identidade PF

Produto	Código `service`	Entrada principal
Enriquecimento de pessoa física	`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`
Endereços	`SERVICE_ADDRESS`	`cpf`
Histórico de telefones	`SERVICE_PHONE_HISTORY`	`cpf`, `birthDate`, `limit`
Histórico de e-mails	`SERVICE_EMAILS_EXTENDED`	`cpf`, `limit`
Pessoas relacionadas	`SERVICE_RELATED_PEOPLE`	`cpf`, `birthDate`
Cartão SUS	`SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF`	`cpf`
Dados pelo telefone	`SERVICE_CONFIRM_PHONE`	`phone`
Dados PIS	`SERVICE_PIS_CONSULTATION`	`cpf`
Validação do E-Social	`SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION`	`cpf`
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`
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`

Documentos e biometria

Nesta família, o payload precisa de mais cuidado: imagem errada, base64 com prefixo ou alias incorreto podem fazer a chamada autenticar e mesmo assim não produzir o retorno esperado. Para OCR, use também o guia OCR via Service API.

Produto	Código `service`	Entrada principal
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, validações e compliance PF

Produto	Código `service`	Entrada principal
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`
Score 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`
Débitos ativos PF	`SERVICE_ACTIVE_DEBT_PF`	`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`
Propensão a apostas online	`SEVICE_ONLINE_BETTING_PROPENSITY`	`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`
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`
Informações financeiras	`SERVICE_FINANCIAL_INFORMATION`	`cpf`
Servidores públicos	`SERVICE_PUBLIC_SERVANTS`	`cpf`

Certidões e judicial PF

Produto	Código `service`	Entrada principal
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`
Processos jurídicos	`SERVICE_JURIDICAL_PROCESSES`	`cpf`
Mandado de prisão	`SERVICE_ARREST_WARRANT`	`cpf`, `nome`, `birthDate`

Político e eleitoral

Produto	Código `service`	Entrada principal
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`
Histórico familiar político	`SERVICE_FAMILY_POLITICAL_HISTORY_CPF`	`cpf`
Prestadores eleitorais PF	`SERVICE_ELECTORAL_PROVIDERS_CPF`	`cpf`
Envolvimento político PF	`SERVICE_POLITICAL_INVOLVEMENT_CPF`	`cpf`

Cadastro e regularidade PJ

Produto	Código `service`	Entrada principal
Enriquecimento de pessoa jurídica	`SERVICE_CORPORATE_DATA_ENRICHMENT`	`cnpj`
Status do CNPJ na Receita Federal	`SERVICE_RFB_PJ`	`cnpj`
CNPJ na Receita Federal on-demand	`SERVICE_RFB_PJ_ON_DEMAND`	`cnpj`
SINTEGRA	`SERVICE_SINTEGRA_CONSULTATION`	`cnpj`, `uf`
Dados cadastrais de CNPJ	`SERVICE_REGISTRATION_DATA_CNPJ`	`cnpj`
Domínios CNPJ	`SERVICE_DOMAINS_CNPJ`	`cnpj`
Endereços estendidos de empresa	`SERVICE_ADDRESSES_EXTENDED_CNPJ`	`cnpj`
Doações eleitorais PJ	`SERVICE_ELECTORAL_DONORS_CNPJ`	`cnpj`
Fornecedores eleitorais PJ	`SERVICE_ELECTORAL_PROVIDERS_CNPJ`	`cnpj`
DAS MEI	`SERVICE_DAS_MEI`	`cnpj`
Projetos Públicos	`SERVICE_PUBLIC_PROJECTS`	`cnpj`
Obras Civis	`SERVICE_CIVIL_CONSTRUCTION`	`cnpj`

Sócios, relacionamentos e compliance PJ

Produto	Código `service`	Entrada principal
Relacionamentos de empresa	`SERVICE_COMPANY_RELATIONSHIP`	`cnpj`
Sócios na Receita Federal	`SERVICE_COMPANY_RFB_OWNERS`	`cnpj`
Sócios de primeiro nível	`SERVICE_FIRST_LEVEL_PARTNER`	`cnpj`
Processos jurídicos PJ	`SERVICE_JURIDICAL_PROCESSES_PJ`	`cnpj`
Processos jurídicos dos sócios	`SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS`	`cnpj`
KYC e compliance dos sócios	`SERVICE_COMPANY_KYC_OWNERS`	`cnpj`
Exposição e perfil na mídia dos sócios	`SERVICE_MEDIA_PROFILE_EXPOSURE_PJ`	`cnpj`
Doações eleitorais dos sócios	`SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ`	`cnpj`
Débitos ativos PJ	`SERVICE_ACTIVE_DEBT_PJ`	`cnpj`
Protesto PJ	`SERVICE_PROTEST_PJ`	`cnpj`
Compliance de apostas	`SERVICE_COMPLIANCE_BET`	`cnpj`
Compliance de apostas PJ	`SERVICE_COMPLIANCE_BET_PJ`	`cnpj`
Risco de crédito PJ	`SERVICE_CREDIT_RISK_COMPANY`	`cnpj`
Score de Crédito PJ	`SERVICE_QUOD_CREDIT_SCORE_COMPANY`	`cnpj`
Score de Crédito Multidados PJ	`SERVICE_BOAVISTA_ONE_SCORE_COMPANY`	`cnpj`
Dados Restritivos PJ	`SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY`	`cnpj`
Flags Negativos PJ	`SERVICE_QUOD_CREDIT_RISK_COMPANY`	`cnpj`
Score de Crédito Quantum PJ	`SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY`	`cnpj`
Ações Trabalhistas	`SERVICE_LABOR_LAWSUITS`	`cnpj`
Acordos Sindicais	`SERVICE_SYNDICATE_AGREEMENTS`	`cnpj`
Anúncios Online	`SERVICE_ONLINE_ADS`	`cnpj`
Arrecadação Simples Nacional - MEI	`SERVICE_PGMEI`	`cnpj`
Avaliações e Reputação	`SERVICE_REPUTATIONS_AND_REVIEWS`	`cnpj`
Categoria Comercial	`SERVICE_MERCHANT_CATEGORY_DATA`	`cnpj`
Dados de Fundos de Investimento	`SERVICE_INVESTMENT_FUND_DATA`	`cnpj`
Distribuição de Processos dos Sócios	`SERVICE_OWNERS_LAWSUITS_DISTRIBUTION`	`cnpj`
Distribuição de Processos Judiciais	`SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY`	`cnpj`
Evolução da Empresa	`SERVICE_COMPANY_EVOLUTION`	`cnpj`
FGTS	`SERVICE_FGTS`	`cnpj`
Histórico de Dados Básicos	`SERVICE_HISTORY_BASIC_DATA`	`cnpj`
Influência do Quadro Societário	`SERVICE_OWNERS_INFLUENCE`	`cnpj`
KYC e Compliance dos Funcionários	`SERVICE_EMPLOYEES_KYC`	`cnpj`
Marketplaces	`SERVICE_MARKETPLACE_DATA`	`cnpj`
Receita Federal - QSA	`SERVICE_RF_QSA`	`cnpj`
Relacionamentos do Grupo Econômico	`SERVICE_ECONOMIC_GROUP_RELATIONSHIPS`	`cnpj`
Telefones	`SERVICE_PHONES_EXTENDED_COMPANY`	`cnpj`
Beneficiários Finais	`SERVICE_ULTIMATE_BENEFICIAL_OWNERS`	`cnpj`
Percentual de Participação Societária	`SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY`	`cnpj`
Débitos com a PGFN	`SERVICE_PGFN_COMPANY`	`cnpj`
Cota de PCD	`SERVICE_PCD_COMPANY`	`cnpj`
Certidão Negativa Correcional CGU	`SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY`	`cnpj`
Certidão Negativa CNJ	`SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY`	`cnpj`
Certidão Negativa de Débitos Estaduais	`SERVICE_STATE_DEBT_CERTIFICATE_COMPANY`	`cnpj`
Optante pelo Simples Nacional	`SERVICE_SIMPLES_COMPANY`	`cnpj`
KYC e Compliance do Grupo Econômico	`SERVICE_ECONOMIC_GROUP_KYC_COMPANY`	`cnpj`
OCR de cartão CNPJ	`SERVICE_OCR_CNPJ_CARD`	`image1`

Primeiros passos

Suporte e referência

Fluxos principais

POST /api/service-api

Pessoas

Empresas

Catálogo técnico

Famílias de serviços

Famílias de serviços

Pessoa física

Pessoa jurídica

Documentos e biometria

Risco e validações

Como usar esta página

Padrão de consumo

Cadastro e identidade PF

Documentos e biometria

Risco, validações e compliance PF

Certidões e judicial PF

Político e eleitoral

Cadastro e regularidade PJ

Sócios, relacionamentos e compliance PJ

​Famílias de serviços

Pessoa física

Pessoa jurídica

Documentos e biometria

Risco e validações

​Como usar esta página

​Padrão de consumo

​Cadastro e identidade PF

​Documentos e biometria

​Risco, validações e compliance PF

​Certidões e judicial PF

​Político e eleitoral

​Cadastro e regularidade PJ

​Sócios, relacionamentos e compliance PJ

Famílias de serviços

Como usar esta página

Padrão de consumo

Cadastro e identidade PF

Documentos e biometria

Risco, validações e compliance PF

Certidões e judicial PF

Político e eleitoral

Cadastro e regularidade PJ

Sócios, relacionamentos e compliance PJ