Services por caso de uso
Use esta página quando souber o objetivo da integração, mas ainda não souber qualservice chamar.
Depois de escolher o service, abra o catálogo de pessoa física ou pessoa jurídica para copiar o request completo.
Pessoa física
CPF, dados cadastrais, OCR, biometria, risco, compliance e contatos.
Pessoa jurídica
CNPJ, Receita Federal, risco de crédito, sócios, domínios, compliance e OCR.
Receitas prontas
Fluxos prontos com payload, retorno esperado e erro comum.
Como escolher
- Comece pelo objetivo da consulta.
- Copie o
serviceindicado. - Abra o catálogo de pessoa física ou jurídica para ver payload e retorno.
- Se for OCR, confira o guia de imagem antes de testar.
- Se quiser um fluxo pronto, use Receitas prontas.
Biometria e documentos
| Objetivo | Service | Documento |
|---|---|---|
| Busca de face na base | SERVICE_FACE_INDEX | CPF |
| Documentoscopia digital | SERVICE_DIGITAL_DOCUMENTOSCOPY | CPF |
| FaceMatch | SERVICE_FACE_MATCH | CPF |
| OCR de cartão CNPJ | SERVICE_OCR_CNPJ_CARD | CNPJ |
| OCR de emancipação | SERVICE_OCR_EMANCIPATION | CPF |
| OCR React | SERVICE_OCR | CPF |
| Resultado da documentoscopia digital | SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT | CPF |
| Score biométrico | SERVICE_DATAVALID_CNH | CPF |
Contatos, sites e relacionamentos
| Objetivo | Service | Documento |
|---|---|---|
| Dados financeiros e endereços | SERVICE_PF_FINANCIAL_AND_ADDRESS | CPF |
| Dados pelo telefone | SERVICE_CONFIRM_PHONE | CPF |
| Distribuição de Processos dos Sócios | SERVICE_OWNERS_LAWSUITS_DISTRIBUTION | CNPJ |
| Doações eleitorais dos sócios | SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ | CNPJ |
| Domínios | SERVICE_DOMAINS_CPF | CPF |
| Domínios CNPJ | SERVICE_DOMAINS_CNPJ | CNPJ |
| E-mails de Pessoas Relacionadas | SERVICE_RELATED_PEOPLE_EMAILS | CPF |
| Endereços | SERVICE_ADDRESS | CPF |
| Endereços de Pessoas Relacionadas | SERVICE_RELATED_PEOPLE_ADDRESSES | CPF |
| Endereços estendidos | SERVICE_ADDRESSES_EXTENDED_CNPJ | CNPJ |
| Exposição e perfil na mídia dos sócios | SERVICE_MEDIA_PROFILE_EXPOSURE_PJ | CNPJ |
| Histórico de e-mails | SERVICE_EMAILS_EXTENDED | CPF |
| Histórico de telefones | SERVICE_PHONE_HISTORY | CPF |
| KYC e compliance dos sócios | SERVICE_COMPANY_KYC_OWNERS | CNPJ |
| OCR de comprovante de endereço | SERVICE_OCR_PROOF_OF_ADDRESS | CPF |
| Pessoas relacionadas | SERVICE_RELATED_PEOPLE | CPF |
| Processos jurídicos dos sócios | SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS | CNPJ |
| Receita Federal - QSA | SERVICE_RF_QSA | CNPJ |
| Relacionamentos da empresa | SERVICE_COMPANY_RELATIONSHIP | CNPJ |
| Relacionamentos do Grupo Econômico | SERVICE_ECONOMIC_GROUP_RELATIONSHIPS | CNPJ |
| Relacionamentos econômicos | SERVICE_ECONOMIC_RELATIONSHIP | CPF |
| Sócios de primeiro nível | SERVICE_FIRST_LEVEL_PARTNER | CNPJ |
| Sócios na Receita Federal | SERVICE_COMPANY_RFB_OWNERS | CNPJ |
| Telefones | SERVICE_PHONES_EXTENDED_COMPANY | CNPJ |
| Telefones de Pessoas Relacionadas | SERVICE_RELATED_PEOPLE_PHONES | CPF |
| Validação de CPF com endereço | SERVICE_CPF_ADDRESS_VALIDATION | CPF |
| Validação de CPF com telefone | SERVICE_CPF_PHONE_VALIDATION | CPF |
| Validação de e-mail | SERVICE_EMAIL_VALIDATION | CPF |
Dados cadastrais e Receita Federal
| Objetivo | Service | Documento |
|---|---|---|
| Arrecadação Simples Nacional - MEI | SERVICE_PGMEI | CNPJ |
| Cartão SUS | SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF | CPF |
| CNPJ na Receita Federal on-demand | SERVICE_RFB_PJ_ON_DEMAND | CNPJ |
| Consulta de MEI | SERVICE_MEI | CPF |
| CPF na Receita Federal on-demand | SERVICE_RFB_PF_ON_DEMAND | CPF |
| Dados cadastrais de CNPJ | SERVICE_REGISTRATION_DATA_CNPJ | CNPJ |
| Dados demográficos | SERVICE_DEMOGRAPHIC_DATA_CPF | CPF |
| Dados PIS | SERVICE_PIS_CONSULTATION | CPF |
| DAS MEI na Receita | SERVICE_DAS_MEI | CNPJ |
| Enriquecimento de dados | SERVICE_PERSON_DATA_ENRICHMENT | CPF |
| Enriquecimento de dados | SERVICE_CORPORATE_DATA_ENRICHMENT | CNPJ |
| Prêmios e certificações | SERVICE_AWARDS_AND_CERTIFICATIONS_CPF | CPF |
| SINTEGRA | SERVICE_SINTEGRA_CONSULTATION | CNPJ |
| Status do CNPJ na Receita Federal | SERVICE_RFB_PJ | CNPJ |
| Status do CPF na Receita Federal | SERVICE_RFB_PF | CPF |
| TSE - Local de votação | SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF | CPF |
| Validação do E-Social | SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION | CPF |
Dados eleitorais e PEP
| Objetivo | Service | Documento |
|---|---|---|
| Dados eleitorais de candidato | SERVICE_ELECTION_CANDIDATE_DATA_CPF | CPF |
| Doações eleitorais | SERVICE_ELECTORAL_DONORS_CPF | CPF |
| Doações eleitorais | SERVICE_ELECTORAL_DONORS_CNPJ | CNPJ |
| Envolvimento político | SERVICE_POLITICAL_INVOLVEMENT | CPF |
| Envolvimento político PF | SERVICE_POLITICAL_INVOLVEMENT_CPF | CPF |
| Fornecedores eleitorais | SERVICE_ELECTORAL_PROVIDERS_CNPJ | CNPJ |
| Histórico familiar político | SERVICE_FAMILY_POLITICAL_HISTORY_CPF | CPF |
| KYC e compliance | SERVICE_PERSON_KYC | CPF |
| KYC e Compliance do Grupo Econômico | SERVICE_ECONOMIC_GROUP_KYC_COMPANY | CNPJ |
| KYC e Compliance dos Funcionários | SERVICE_EMPLOYEES_KYC | CNPJ |
| Pessoa politicamente exposta | SERVICE_PEP | CPF |
| Prestadores de serviço eleitorais | SERVICE_ELECTORAL_PROVIDERS_CPF | CPF |
Jurídico, certidões e protestos
| Objetivo | Service | Documento |
|---|---|---|
| Ações Trabalhistas | SERVICE_LABOR_LAWSUITS | CNPJ |
| Antecedentes criminais civis | SERVICE_CRIMINAL_RECORD_CIVIL | CPF |
| Antecedentes criminais federais | SERVICE_CRIMINAL_RECORD_FEDERAL | CPF |
| Certidão de Nada Consta | SERVICE_NOTHING_RECORD_LAWSUITS | CPF |
| Certidão negativa de protesto | SERVICE_PROTEST_CLEARANCE_CERTIFICATE | CPF |
| Certidão negativa de protesto | SERVICE_PROTEST_PJ | CNPJ |
| Certidão negativa de protesto PF | SERVICE_PROTEST_PF | CPF |
| Distribuição de Processos Judiciais | SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY | CNPJ |
| Mandado de prisão | SERVICE_ARREST_WARRANT | CPF |
| Processos jurídicos | SERVICE_JURIDICAL_PROCESSES_PJ | CNPJ |
| Processos jurídicos e administrativos | SERVICE_JURIDICAL_PROCESSES | CPF |
KYC, compliance e exposição
| Objetivo | Service | Documento |
|---|---|---|
| Compliance de casas de apostas | SERVICE_COMPLIANCE_BET_PJ | CNPJ |
| Compliance de casas de apostas (alias curto) | SERVICE_COMPLIANCE_BET | CNPJ |
| Exposição e perfil na mídia | SERVICE_MEDIA_PROFILE_EXPOSURE_PF | CPF |
| Propensão a apostas online | SEVICE_ONLINE_BETTING_PROPENSITY | CPF |
Outros services
| Objetivo | Service | Documento |
|---|---|---|
| Acordos Sindicais | SERVICE_SYNDICATE_AGREEMENTS | CNPJ |
| Anúncios Online | SERVICE_ONLINE_ADS | CNPJ |
| Avaliações e Reputação | SERVICE_REPUTATIONS_AND_REVIEWS | CNPJ |
| Beneficiários Finais | SERVICE_ULTIMATE_BENEFICIAL_OWNERS | CNPJ |
| Benefícios sociais estendidos | SERVICE_SOCIAL_ASSISTANCE_EXTENDED | CPF |
| Benefícios sociais familiares | SERVICE_FAMILY_SOCIAL_BENEFITS | CPF |
| Categoria Comercial | SERVICE_MERCHANT_CATEGORY_DATA | CNPJ |
| Certidão Negativa CNJ | SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY | CNPJ |
| Certidão Negativa Correcional CGU | SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY | CNPJ |
| Cota de PCD | SERVICE_PCD_COMPANY | CNPJ |
| Dados de Fundos de Investimento | SERVICE_INVESTMENT_FUND_DATA | CNPJ |
| Evolução da Empresa | SERVICE_COMPANY_EVOLUTION | CNPJ |
| FGTS | SERVICE_FGTS | CNPJ |
| Flags Negativos | SERVICE_QUOD_CREDIT_RISK_PERSON | CPF |
| Flags Negativos PJ | SERVICE_QUOD_CREDIT_RISK_COMPANY | CNPJ |
| Histórico de Dados Básicos | SERVICE_HISTORY_BASIC_DATA | CNPJ |
| Histórico profissional | SERVICE_PROFESSIONAL_HISTORY | CPF |
| Histórico profissional do titular | SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY | CPF |
| Indicadores de atividades | SERVICE_ACTIVITIES_INDICATORS | CPF |
| Influência do Quadro Societário | SERVICE_OWNERS_INFLUENCE | CNPJ |
| Marketplaces | SERVICE_MARKETPLACE_DATA | CNPJ |
| Modelagem de dados | SERVICE_PERSON_DATA_MODELING | CPF |
| Obras Civis | SERVICE_CIVIL_CONSTRUCTION | CNPJ |
| Optante pelo Simples Nacional | SERVICE_SIMPLES_COMPANY | CNPJ |
| Percentual de Participação Societária | SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY | CNPJ |
| Projetos Públicos | SERVICE_PUBLIC_PROJECTS | CNPJ |
| Prompt de IA para pessoa | SERVICE_PERSON_AI_PROMPT | CPF |
| Servidores públicos | SERVICE_PUBLIC_SERVANTS | CPF |
Risco, crédito e dívidas
| Objetivo | Service | Documento |
|---|---|---|
| Certidão Negativa de Débitos Estaduais | SERVICE_STATE_DEBT_CERTIFICATE_COMPANY | CNPJ |
| Dados Restritivos | SERVICE_BOAVISTA_CREDIT_SCORE_PERSON | CPF |
| Dados Restritivos PJ | SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY | CNPJ |
| Débitos ativos | SERVICE_ACTIVE_DEBT_PJ | CNPJ |
| Débitos com a PGFN | SERVICE_PGFN_COMPANY | CNPJ |
| Dívida ativa | SERVICE_ACTIVE_DEBT_PF | CPF |
| Informações financeiras | SERVICE_FINANCIAL_INFORMATION | CPF |
| Risco de crédito | SERVICE_CREDIT_RISK_COMPANY | CNPJ |
| Risco financeiro | SERVICE_FINANCIAL_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 |
| Score de Crédito Multidados PJ | SERVICE_BOAVISTA_ONE_SCORE_COMPANY | CNPJ |
| Score de Crédito PJ | SERVICE_QUOD_CREDIT_SCORE_COMPANY | CNPJ |
| Score de Crédito Quantum PJ | SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY | CNPJ |
| Score de inadimplência | SERVICE_DEFAULT_RISK_SCORE | CPF |
| Score de risco de fraude | SERVICE_FRAUD_RISK_SCORE | CPF |