Matriz de serviços

Esta matriz ajuda a localizar rapidamente qual serviço usar antes de abrir o payload completo no API Reference.

Esta página é um atalho por objetivo. 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.

Todos os itens abaixo são executados por POST /api/service-api, exceto os endpoints de autenticação, onboarding e customers. No endpoint central, o campo service escolhe o produto.

Pessoa física

Os serviços de OCR ficam nesta matriz, mas os payloads completos estão no guia OCR via Service API. Use esse guia quando a chamada envolver image1, image2, base64, URL de imagem ou documentType.

Objetivo	Serviço	Entrada principal	Quando usar
Enriquecer dados cadastrais	`SERVICE_PERSON_DATA_ENRICHMENT`	`cpf`	Obter dados básicos de identificação
Consultar CPF na Receita	`SERVICE_RFB_PF`	`cpf`	Validar situação cadastral do CPF
Consultar CPF na Receita on-demand	`SERVICE_RFB_PF_ON_DEMAND`	`cpf`	Buscar dados cadastrais no momento da consulta
Consolidar modelagem de dados PF	`SERVICE_PERSON_DATA_MODELING`	`cpf`	Reunir sinais cadastrais, contatos, vínculos e risco em texto consolidado
Gerar resumo analítico de pessoa	`SERVICE_PERSON_AI_PROMPT`	`cpf`	Apoiar leitura de dados consolidados com uma resposta textual
Extrair dados de documento via OCR React	`SERVICE_OCR`	`documentType`, `image1`, `image2`	Ler RG/CIN, CNH, OAB, RNE/CRNM, passaporte ou identificar automaticamente
Ler documento de emancipação	`SERVICE_OCR_EMANCIPATION`	`image1`	Extrair texto e dados possíveis de documento variável
Ler comprovante de endereço	`SERVICE_OCR_PROOF_OF_ADDRESS`	`image1`	Extrair nome, endereço, datas e valores quando disponíveis
Buscar face na base	`SERVICE_FACE_INDEX`	`image1`	Procurar rosto em base indexada e retornar CPF/similaridade quando houver
Comparar faces	`SERVICE_FACE_MATCH`	`image1`, `image2`	Comparar selfie com documento ou outra imagem
Validar CNH no DataValid	`SERVICE_DATAVALID_CNH`	`cpf`, `image1`	Validar dados de CNH com apoio do validação documental
Consultar PEP	`SERVICE_PEP`	`cpf`	Avaliar exposição política
Consultar KYC/compliance PF	`SERVICE_PERSON_KYC`	`cpf`	Análise mais ampla de compliance
Consultar risco financeiro	`SERVICE_FINANCIAL_RISK_SCORE`	`cpf`, `birthDate`	Obter score e leitura resumida de risco financeiro
Consultar score de crédito	`SERVICE_CREDIT_SCORE`	`cpf`	Obter score de crédito
Consultar score inadimplência	`SERVICE_DEFAULT_RISK_SCORE`	`cpf`	Avaliar risco de inadimplência
Consultar dados demográficos	`SERVICE_DEMOGRAPHIC_DATA_CPF`	`cpf`, `birthDate`	Obter indicadores demográficos do CPF
Consultar indicadores de atividades	`SERVICE_ACTIVITIES_INDICATORS`	`cpf`	Obter sinais profissionais e de atividade
Consultar domínios PF	`SERVICE_DOMAINS_CPF`	`cpf`	Buscar domínios e sinais digitais associados ao CPF
Consultar prêmios e certificações	`SERVICE_AWARDS_AND_CERTIFICATIONS_CPF`	`cpf`	Obter prêmios/certificações encontrados
Consultar benefícios sociais familiares	`SERVICE_FAMILY_SOCIAL_BENEFITS`	`cpf`	Verificar benefícios sociais familiares
Consultar benefícios sociais estendidos	`SERVICE_SOCIAL_ASSISTANCE_EXTENDED`	`cpf`	Verificar benefícios sociais estendidos
Consultar processos	`SERVICE_JURIDICAL_PROCESSES`	`cpf`	Levantar processos jurídicos e administrativos
Consultar histórico profissional	`SERVICE_PROFESSIONAL_HISTORY`	`cpf`	Recuperar vínculos profissionais
Consultar histórico profissional do titular	`SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY`	`cpf`, `birthDate`	Recuperar vínculos em que a pessoa aparece como titular ou sócia
Consultar dados financeiros e endereços	`SERVICE_PF_FINANCIAL_AND_ADDRESS`	`cpf`, `birthDate`	Combinar dados cadastrais, endereços e informações financeiras
Consultar propensão a apostas online	`SEVICE_ONLINE_BETTING_PROPENSITY`	`cpf`	Avaliar sinais de propensão a apostas online
Consultar histórico de telefones	`SERVICE_PHONE_HISTORY`	`cpf`, `birthDate`, `limit`	Recuperar telefones associados ao CPF
Consultar histórico de e-mails	`SERVICE_EMAILS_EXTENDED`	`cpf`, `limit`	Recuperar e-mails associados ao CPF
Consultar pessoas relacionadas	`SERVICE_RELATED_PEOPLE`	`cpf`, `birthDate`	Mapear vínculos pessoais associados ao CPF
Validar CPF com telefone	`SERVICE_CPF_PHONE_VALIDATION`	`cpf`, `phone`	Conferir associação entre CPF e telefone
Validar CPF com endereço	`SERVICE_CPF_ADDRESS_VALIDATION`	`cpf`, `zipcode`, `numberAddress`	Conferir associação entre CPF e endereço
Consultar e-mails de pessoas relacionadas	`SERVICE_RELATED_PEOPLE_EMAILS`	`cpf`	Mapear e-mails associados a pessoas relacionadas ao CPF
Consultar telefones de pessoas relacionadas	`SERVICE_RELATED_PEOPLE_PHONES`	`cpf`	Mapear telefones associados a pessoas relacionadas ao CPF
Consultar endereços de pessoas relacionadas	`SERVICE_RELATED_PEOPLE_ADDRESSES`	`cnpj`	Mapear endereços associados a pessoas relacionadas ao CNPJ
Consultar score de crédito	`SERVICE_QUOD_CREDIT_SCORE_PERSON`	`cpf`	Obter score de crédito com nível e classificação de risco
Consultar score de crédito multidados	`SERVICE_BOAVISTA_ONE_SCORE_PERSON`	`cpf`	Obter score de crédito multidados com nível e classificação de risco
Consultar dados restritivos de crédito	`SERVICE_BOAVISTA_CREDIT_SCORE_PERSON`	`cpf`	Verificar indicativo e quantidade de restrições de crédito
Consultar flags negativos de crédito	`SERVICE_QUOD_CREDIT_RISK_PERSON`	`cpf`	Verificar flags negativos e nível de risco de crédito
Consultar local de votação no TSE	`SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF`	`cpf`, `birthDate`, `motherName`	Obter local de votação, situação eleitoral e biometria no TSE
Consultar antecedentes criminais civis	`SERVICE_CRIMINAL_RECORD_CIVIL`	`cpf`, `rg`, `uf`	Verificar ocorrências criminais em bases estaduais
Consultar antecedentes criminais federais	`SERVICE_CRIMINAL_RECORD_FEDERAL`	`cpf`	Verificar ocorrências criminais em bases federais
Consultar cartão SUS	`SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF`	`cpf`	Obter número do Cartão Nacional de Saúde e dados de nascimento
Consultar certidão de Nada Consta	`SERVICE_NOTHING_RECORD_LAWSUITS`	`cpf`, `court`, `uf`, `sphere`	Emitir certidão de nada consta em tribunal e esfera específicos
Consultar certidão negativa de protesto	`SERVICE_PROTEST_CLEARANCE_CERTIFICATE`	`cpf`	Verificar protestos em cartório para o CPF
Consultar certidão negativa de protesto (alias curto)	`SERVICE_PROTEST_PF`	`cpf`	Verificar protestos em cartório para o CPF, quando o produto usa o alias curto
Consultar MEI	`SERVICE_MEI`	`cpf`	Verificar empresas MEI associadas ao CPF
Consultar dados eleitorais de candidato	`SERVICE_ELECTION_CANDIDATE_DATA_CPF`	`cpf`	Levantar histórico de candidaturas eleitorais
Consultar dados pelo telefone	`SERVICE_CONFIRM_PHONE`	`phone`	Obter dados de possível titular a partir do telefone
Consultar dados PIS	`SERVICE_PIS_CONSULTATION`	`cpf`	Verificar número e status do PIS/NIS associado ao CPF
Consultar dívida ativa	`SERVICE_ACTIVE_DEBT_PF`	`cpf`	Verificar débitos ativos vinculados ao CPF
Consultar doações eleitorais	`SERVICE_ELECTORAL_DONORS_CPF`	`cpf`	Levantar doações eleitorais realizadas pelo CPF
Consultar documentoscopia digital	`SERVICE_DIGITAL_DOCUMENTOSCOPY`	`key`, `image1`, `image2`, `selfie1`	Processar documento, imagem e selfie em um fluxo único
Consultar endereços	`SERVICE_ADDRESS`	`cpf`	Recuperar endereços associados ao CPF
Consultar envolvimento político	`SERVICE_POLITICAL_INVOLVEMENT`	`cpf`	Consolidar candidaturas, cargos, doações e vínculos políticos
Consultar envolvimento político PF	`SERVICE_POLITICAL_INVOLVEMENT_CPF`	`cpf`	Consolidar candidaturas, cargos, doações e vínculos políticos
Consultar exposição e perfil na mídia	`SERVICE_MEDIA_PROFILE_EXPOSURE_PF`	`cpf`	Avaliar notícias, notoriedade e alertas de mídia associados ao CPF
Consultar histórico familiar político	`SERVICE_FAMILY_POLITICAL_HISTORY_CPF`	`cpf`	Levantar vínculos políticos de familiares do CPF
Consultar informações financeiras	`SERVICE_FINANCIAL_INFORMATION`	`cpf`	Obter renda presumida e indicadores financeiros estimados
Consultar mandado de prisão	`SERVICE_ARREST_WARRANT`	`nome`, `motherName`, `fatherName`, `birthDate`, `cpf`	Verificar existência de mandado de prisão
Consultar prestadores de serviço eleitorais	`SERVICE_ELECTORAL_PROVIDERS_CPF`	`cpf`	Levantar prestações de serviço eleitorais vinculadas ao CPF
Consultar relacionamentos econômicos	`SERVICE_ECONOMIC_RELATIONSHIP`	`cpf`	Mapear vínculos econômicos associados ao CPF
Consultar resultado da documentoscopia digital	`SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT`	`key`	Obter o resultado já processado da documentoscopia pela chave
Consultar score de risco de fraude	`SERVICE_FRAUD_RISK_SCORE`	`cpf`, `factor`	Avaliar propensão de fraude com base em fator de risco
Consultar servidores públicos	`SERVICE_PUBLIC_SERVANTS`	`cpf`	Verificar vínculos com o serviço público
Consultar validação de e-mail	`SERVICE_EMAIL_VALIDATION`	`email`	Validar formato, domínio e risco de um e-mail
Consultar validação do E-Social	`SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION`	`cpf`	Validar qualificação cadastral no E-Social

Pessoa jurídica

Objetivo	Serviço	Entrada principal	Quando usar
Enriquecer dados cadastrais	`SERVICE_CORPORATE_DATA_ENRICHMENT`	`cnpj`	Obter dados da empresa na Receita Federal
Consultar status do CNPJ	`SERVICE_RFB_PJ`	`cnpj`	Validar situação cadastral da empresa
Consultar CNPJ na Receita on-demand	`SERVICE_RFB_PJ_ON_DEMAND`	`cnpj`	Buscar dados cadastrais da empresa no momento da consulta
Consultar dados cadastrais de CNPJ	`SERVICE_REGISTRATION_DATA_CNPJ`	`cnpj`	Obter cadastro empresarial retornado pela base
Ler cartão CNPJ	`SERVICE_OCR_CNPJ_CARD`	`image1`	Extrair CNPJ e texto OCR do cartão CNPJ
Consultar SINTEGRA	`SERVICE_SINTEGRA_CONSULTATION`	`cnpj`, `uf`	Verificar inscrição e situação estadual
Consultar domínios CNPJ	`SERVICE_DOMAINS_CNPJ`	`cnpj`	Buscar domínios e sinais digitais associados à empresa
Consultar relacionamentos	`SERVICE_COMPANY_RELATIONSHIP`	`cnpj`	Entender vínculos societários e de empresa
Consultar sócios na Receita Federal	`SERVICE_COMPANY_RFB_OWNERS`	`cnpj`	Recuperar dados cadastrais dos sócios na Receita
Consultar sócios de primeiro nível	`SERVICE_FIRST_LEVEL_PARTNER`	`cnpj`	Avaliar círculo de pessoas relacionadas
Consultar KYC dos sócios	`SERVICE_COMPANY_KYC_OWNERS`	`cnpj`	Avaliar PEP, sanções e compliance dos sócios
Consultar processos PJ	`SERVICE_JURIDICAL_PROCESSES_PJ`	`cnpj`	Levantar processos jurídicos da empresa
Consultar processos dos sócios	`SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS`	`cnpj`	Levantar processos relacionados aos sócios
Consultar doações eleitorais PJ	`SERVICE_ELECTORAL_DONORS_CNPJ`	`cnpj`	Avaliar doações eleitorais associadas à empresa
Consultar doações eleitorais dos sócios	`SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ`	`cnpj`	Avaliar doações eleitorais associadas aos sócios
Consultar fornecedores eleitorais PJ	`SERVICE_ELECTORAL_PROVIDERS_CNPJ`	`cnpj`	Avaliar prestação de serviços eleitorais associada ao CNPJ
Consultar débitos ativos PJ	`SERVICE_ACTIVE_DEBT_PJ`	`cnpj`	Verificar débitos com o governo
Consultar protestos PJ	`SERVICE_PROTEST_PJ`	`cnpj`	Emitir ou consultar certidão/protestos
Consultar compliance de apostas	`SERVICE_COMPLIANCE_BET`	`cnpj`	Avaliar exposição relacionada a apostas
Consultar compliance de apostas	`SERVICE_COMPLIANCE_BET_PJ`	`cnpj`	Avaliar exposição relacionada a apostas
Consultar risco de crédito PJ	`SERVICE_CREDIT_RISK_COMPANY`	`cnpj`	Obter score, rating e risco esperado de crédito PJ
Consultar score de crédito PJ	`SERVICE_QUOD_CREDIT_SCORE_COMPANY`	`cnpj`	Obter score de crédito PJ com nível e classificação de risco
Consultar score de crédito Quantum PJ	`SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY`	`cnpj`	Obter score de crédito Quantum PJ
Identificar beneficiários finais	`SERVICE_ULTIMATE_BENEFICIAL_OWNERS`	`cnpj`	Calcular percentual de participação acumulado, inclusive por cadeias indiretas
Consultar percentual de participação societária	`SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY`	`cnpj`	Obter percentual de participação de cada sócio da empresa
Consultar projetos públicos	`SERVICE_PUBLIC_PROJECTS`	`cnpj`	Verificar projetos com financiamento de órgãos públicos
Consultar obras civis	`SERVICE_CIVIL_CONSTRUCTION`	`cnpj`	Verificar obras civis vinculadas ao CNPJ (CNO)
Consultar débitos com a PGFN	`SERVICE_PGFN_COMPANY`	`cnpj`	Emitir certidão de débitos tributários federais e dívida ativa da união
Consultar cota de PCD	`SERVICE_PCD_COMPANY`	`cnpj`	Verificar cumprimento da cota legal de PCD e reabilitados
Consultar certidão negativa correcional CGU	`SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY`	`cnpj`	Verificar punições vigentes em CEIS, CNEP e CEPIM
Consultar certidão negativa CNJ	`SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY`	`cnpj`	Verificar condenações cíveis por improbidade administrativa e inelegibilidade
Consultar certidão negativa de débitos estaduais	`SERVICE_STATE_DEBT_CERTIFICATE_COMPANY`	`cnpj`	Verificar débitos estaduais em qualquer UF
Consultar optante pelo Simples Nacional	`SERVICE_SIMPLES_COMPANY`	`cnpj`	Verificar situação como optante pelo Simples Nacional e SIMEI
Consultar KYC do grupo econômico	`SERVICE_ECONOMIC_GROUP_KYC_COMPANY`	`cnpj`	Obter indicadores agregados de PEP e sanções do grupo econômico
Consultar DAS MEI na Receita	`SERVICE_DAS_MEI`	`cnpj`	Verificar situação fiscal e pagamentos do DAS MEI
Consultar endereços estendidos	`SERVICE_ADDRESSES_EXTENDED_CNPJ`	`cnpj`	Obter a lista completa de endereços do CNPJ
Consultar exposição e perfil na mídia dos sócios	`SERVICE_MEDIA_PROFILE_EXPOSURE_PJ`	`cnpj`	Avaliar notícias e alertas de mídia relacionados aos sócios
Consultar score de crédito multidados PJ	`SERVICE_BOAVISTA_ONE_SCORE_COMPANY`	`cnpj`	Obter score de crédito multidados PJ
Consultar dados restritivos PJ	`SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY`	`cnpj`	Verificar indicativo e quantidade de restrições de crédito PJ
Consultar flags negativos PJ	`SERVICE_QUOD_CREDIT_RISK_COMPANY`	`cnpj`	Verificar flags negativos e nível de risco de crédito PJ
Consultar ações trabalhistas	`SERVICE_LABOR_LAWSUITS`	`cnpj`	Verificar processos trabalhistas relacionados à empresa
Consultar acordos sindicais	`SERVICE_SYNDICATE_AGREEMENTS`	`cnpj`	Verificar acordos firmados entre a empresa e sindicatos
Consultar anúncios online	`SERVICE_ONLINE_ADS`	`cnpj`	Identificar anúncios vinculados à empresa em portais e marketplaces
Consultar arrecadação Simples Nacional - MEI	`SERVICE_PGMEI`	`cnpj`	Verificar guias e situação do DAS-MEI
Consultar avaliações e reputação	`SERVICE_REPUTATIONS_AND_REVIEWS`	`cnpj`	Consolidar reputação da empresa em plataformas de avaliação
Consultar categoria comercial	`SERVICE_MERCHANT_CATEGORY_DATA`	`cnpj`	Obter a categorização MCC da empresa
Consultar dados de fundos de investimento	`SERVICE_INVESTMENT_FUND_DATA`	`cnpj`	Obter dados cadastrais e operacionais de fundos vinculados ao CNPJ
Consultar distribuição de processos dos sócios	`SERVICE_OWNERS_LAWSUITS_DISTRIBUTION`	`cnpj`	Obter estatísticas agregadas dos processos dos sócios
Consultar distribuição de processos judiciais	`SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY`	`cnpj`	Obter estatísticas agregadas dos processos da empresa
Consultar evolução da empresa	`SERVICE_COMPANY_EVOLUTION`	`cnpj`	Acompanhar evolução de capital, funcionários, filiais e sócios
Consultar FGTS	`SERVICE_FGTS`	`cnpj`	Verificar certidão de regularidade perante o FGTS
Consultar histórico de dados básicos	`SERVICE_HISTORY_BASIC_DATA`	`cnpj`	Acompanhar alterações cadastrais básicas do CNPJ ao longo do tempo
Consultar influência do quadro societário	`SERVICE_OWNERS_INFLUENCE`	`cnpj`	Avaliar influência inferida do quadro societário
Consultar KYC e compliance dos funcionários	`SERVICE_EMPLOYEES_KYC`	`cnpj`	Verificar PEP e sanções dos funcionários da empresa
Consultar marketplaces	`SERVICE_MARKETPLACE_DATA`	`cnpj`	Verificar presença e desempenho da empresa em marketplaces
Consultar Receita Federal - QSA	`SERVICE_RF_QSA`	`cnpj`	Obter o quadro societário-administrativo completo do CNPJ
Consultar relacionamentos do grupo econômico	`SERVICE_ECONOMIC_GROUP_RELATIONSHIPS`	`cnpj`	Mapear entidades do mesmo grupo econômico do CNPJ
Consultar telefones	`SERVICE_PHONES_EXTENDED_COMPANY`	`cnpj`	Obter telefones associados à empresa com indicadores de validade

Fluxos fora do service-api

Objetivo	Endpoint	Quando usar
Gerar token JWT	`POST /api/token-generate`	Antes de chamadas protegidas
Gerar token de onboarding	`POST /api/token-history-onboarding`	Antes de iniciar integração via SDK
Consultar onboarding	`GET /api/onboarding/report/{tokenOnboarding}`	Para recuperar resultado estruturado em JSON
Baixar relatório de onboarding	`GET /api/history-onboarding-report/{tokenOnboarding}`	Para obter o PDF final
Consultar cliente	`GET /api/customer`	Para localizar cliente por CPF ou CNPJ
Alterar status de cliente	`POST /api/changeStatusOfCustomer`	Para ativar ou desativar cliente

Próximo passo

Depois de escolher o serviço, abra POST /api/service-api na API Reference e copie o exemplo correspondente.