# Omni-Ward

> Consultas de pessoa física e jurídica e verificação de identidade por API.

- [Comece aqui](https://api-docs.omni-ward.com/index.md): Consultas de pessoa física e jurídica e verificação de identidade por API.
- [Quickstart](https://api-docs.omni-ward.com/quickstart.md): Sua primeira consulta no sandbox em poucos minutos.
- [Autenticação](https://api-docs.omni-ward.com/autenticacao.md): Chave de API no header Authorization.
- [Ambientes](https://api-docs.omni-ward.com/ambientes.md): Sandbox para testar, produção para consultas reais.
- [Como funciona](https://api-docs.omni-ward.com/consultas/como-funciona.md): Um endpoint, vários serviços, um resultado por serviço.
- [Campos do request](https://api-docs.omni-ward.com/consultas/campos.md): Cada identificador é enviado uma vez e vale para todos os serviços que o usam.
- [Status e erros](https://api-docs.omni-ward.com/consultas/erros.md): A validação vale para a requisição inteira; a execução, para cada serviço.
- [Serviços por caso de uso](https://api-docs.omni-ward.com/consultas/casos-de-uso.md): Encontre o serviço a partir do objetivo da integração.
- [Onboarding com SDK](https://api-docs.omni-ward.com/sdk/visao-geral.md): Seu back-end cria a sessão, o SDK abre a verificação, o resultado chega por webhook.
- [Web e React](https://api-docs.omni-ward.com/sdk/web.md): Abra a verificação por popup ou redirecionamento.
- [React Native](https://api-docs.omni-ward.com/sdk/react-native.md): iOS e Android com WebView.
- [Webhooks](https://api-docs.omni-ward.com/webhooks.md): Eventos assinados com HMAC-SHA256.
- [Idempotência e limites](https://api-docs.omni-ward.com/idempotencia-e-limites.md): Repita chamadas com segurança e respeite os limites de taxa.
- [IA e LLMs](https://api-docs.omni-ward.com/ia-e-llms.md): Use esta documentação com assistentes de código e agentes.
- [Changelog](https://api-docs.omni-ward.com/changelog.md): Mudanças na API.
- [Catálogo: Pessoa física](https://api-docs.omni-ward.com/servicos/pessoa-fisica.md): 37 serviços de pessoa física disponíveis no endpoint único.
- [Catálogo: Pessoa jurídica](https://api-docs.omni-ward.com/servicos/pessoa-juridica.md): 40 serviços de pessoa jurídica disponíveis no endpoint único.
- [Antecedentes criminais federais](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-criminal-record-federal.md): SERVICE_CRIMINAL_RECORD_FEDERAL · Consulta se a pessoa possui antecedentes criminais Federal
- [Benefícios sociais estendidos](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-social-assistance-extended.md): SERVICE_SOCIAL_ASSISTANCE_EXTENDED · Consulta de Beneficios Sociais
- [Busca de face na base](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-face-index.md): SERVICE_FACE_INDEX · Face Index
- [Cartão SUS](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-ondemand-sus-card-person-cpf.md): SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF · Consulta o Cartão Nacional de Saúde (SUS) da pessoa a partir de fontes públicas estaduais.
- [Conferência de CPF e nome](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-cpf-name-check.md): SERVICE_CPF_NAME_CHECK · Consulta o nome cadastrado para um CPF e compara com o nome informado, quando fornecido.
- [Consulta de MEI](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-mei.md): SERVICE_MEI · Consulta do MEI
- [Consulta de Vínculos Societários](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-corporate-ties-person.md): SERVICE_CORPORATE_TIES_PERSON · Vínculos societários da pessoa a partir do CPF.
- [Dados demográficos](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-demographic-data-cpf.md): SERVICE_DEMOGRAPHIC_DATA_CPF · Consulta informações sócio-demográficas associadas ao CPF consultado, retornando classe social, faixa de renda estimada, escolaridade, origem dos dados, nível de agregação e registros encontrados.
- [Dados financeiros e endereços](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-pf-financial-and-address.md): SERVICE_PF_FINANCIAL_AND_ADDRESS · Consulta de Cpf,Endereço e Informações Financeiras
- [Dados pelo telefone](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-confirm-phone.md): SERVICE_CONFIRM_PHONE · Obtenção de dados pelo Telefone
- [Dívida ativa](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-active-debt-pf.md): SERVICE_ACTIVE_DEBT_PF · Consulta se há debitos ativos
- [Domínios](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-domains-cpf.md): SERVICE_DOMAINS_CPF · Consulta de domínios associados ao CPF consultado, retornando a quantidade total de domínios, quantidade de domínios ativos e lista de domínios encontrados.
- [Endereços](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-address.md): SERVICE_ADDRESS · Consulta de Endereços
- [Enriquecimento de dados](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-person-data-enrichment.md): SERVICE_PERSON_DATA_ENRICHMENT · Enriquecimentos de dados de Pessoa Física
- [Exposição e perfil na mídia](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-media-profile-exposure-pf.md): SERVICE_MEDIA_PROFILE_EXPOSURE_PF · Dados de exposição e perfil na mídia para pessoa física
- [Flags Negativos](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-credit-risk-signals-person.md): SERVICE_CREDIT_RISK_SIGNALS_PERSON · Consulta apontamentos negativos, endividamento e quantidade de protestos registrados.
- [Histórico de e-mails](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-emails-extended.md): SERVICE_EMAILS_EXTENDED · Consulta de histórico de e-mails
- [Histórico de telefones](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-phone-history.md): SERVICE_PHONE_HISTORY · Consulta de Histórico de Telefones
- [Histórico profissional](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-professional-history.md): SERVICE_PROFESSIONAL_HISTORY · Histórico profissional
- [Informações financeiras](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-financial-information.md): SERVICE_FINANCIAL_INFORMATION · Consulta de Informações Financeiras
- [KYC e compliance](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-person-kyc.md): SERVICE_PERSON_KYC · Kyc e compliance pessoa física
- [Mandado de prisão](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-arrest-warrant.md): SERVICE_ARREST_WARRANT · Consulta de Mandado de Prisão
- [Pessoas relacionadas](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-related-people.md): SERVICE_RELATED_PEOPLE · Consulta de Pessoas Relacionadas
- [Processos jurídicos e administrativos](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-juridical-processes.md): SERVICE_JURIDICAL_PROCESSES · Consulta de Processos Jurídicos
- [Propensão a apostas online](https://api-docs.omni-ward.com/servicos/pessoa-fisica/sevice-online-betting-propensity.md): SEVICE_ONLINE_BETTING_PROPENSITY · Propensão a casa de apostas
- [Quem consultou o CPF](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-cpf-query-history.md): SERVICE_CPF_QUERY_HISTORY · Empresas e pessoas que consultaram o CPF na plataforma no período (90 dias por padrão). CPFs de pessoas aparecem mascarados.
- [Relacionamentos econômicos](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-economic-relationship.md): SERVICE_ECONOMIC_RELATIONSHIP · Relacionamentos Econômicos
- [Score de crédito](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-credit-score.md): SERVICE_CREDIT_SCORE · Consulta score de crédito de pessoa física pelo CPF informado.
- [Score de Crédito](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-credit-score-alt-person.md): SERVICE_CREDIT_SCORE_ALT_PERSON · Consulta score de crédito de pessoa física pelo CPF informado.
- [Score de Crédito Multidados](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-one-score-person.md): SERVICE_ONE_SCORE_PERSON · Consulta score de crédito multidados de pessoa física pelo CPF informado
- [Score de risco de fraude](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-fraud-risk-score.md): SERVICE_FRAUD_RISK_SCORE · Score de risco de fraude
- [Servidores públicos](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-public-servants.md): SERVICE_PUBLIC_SERVANTS · Consulta de Serviços Públicos
- [Status do CPF na Receita Federal](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-rfb-pf.md): SERVICE_RFB_PF · Consulta do CPF na Receita Federal
- [Validação de CPF com endereço](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-cpf-address-validation.md): SERVICE_CPF_ADDRESS_VALIDATION · Validação de CPF e Endereço
- [Validação de CPF com telefone](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-cpf-phone-validation.md): SERVICE_CPF_PHONE_VALIDATION · Validação de CPF com Telefone
- [Validação de e-mail](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-email-validation.md): SERVICE_EMAIL_VALIDATION · Validação de e-mail
- [Validação facial por CPF](https://api-docs.omni-ward.com/servicos/pessoa-fisica/service-face-match-cpf.md): SERVICE_FACE_MATCH_CPF · Validação Facial CPF
- [Ações Trabalhistas](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-labor-lawsuits.md): SERVICE_LABOR_LAWSUITS · Consulta certidão on-demand informando se há processos trabalhistas tramitando relacionados à empresa consultada, físicos ou eletrônicos.
- [Acordos Sindicais](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-syndicate-agreements.md): SERVICE_SYNDICATE_AGREEMENTS · Consulta dos acordos sindicais firmados entre a empresa e os sindicatos que representam seus funcionários.
- [Anúncios Online](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-online-ads.md): SERVICE_ONLINE_ADS · Consulta anúncios online vinculados à empresa, identificando perfis de vendedor em portais de classificados e marketplaces peer-to-peer.
- [Arrecadação Simples Nacional - MEI](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-pgmei.md): SERVICE_PGMEI · Consulta o Documento de Arrecadação do Simples Nacional (DAS) para Microempreendedores Individuais (MEI), com histórico de arrecadação mensal e status de pagamento.
- [Beneficiários Finais](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-ultimate-beneficial-owners.md): SERVICE_ULTIMATE_BENEFICIAL_OWNERS · Identificação dos beneficiários finais da empresa, com cálculo do percentual de participação societária acumulado (inclusive por cadeias indiretas), conforme limiar legal de 25% definido pela Receita Federal.
- [Categoria Comercial](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-merchant-category-data.md): SERVICE_MERCHANT_CATEGORY_DATA · Consulta da categorização da empresa de acordo com o MCC (Merchant Category Code), por associação direta com a Abecs ou inferido pelo CNAE.
- [Compliance de casas de apostas](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-compliance-bet-pj.md): SERVICE_COMPLIANCE_BET_PJ · Compliance de casa de apostas PJ
- [Cota de PCD](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-pcd-company.md): SERVICE_PCD_COMPANY · Certidão de cumprimento da cota legal de contratação de pessoas com deficiência e beneficiários reabilitados da Previdência Social.
- [Dados cadastrais de CNPJ](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-registration-data-cnpj.md): SERVICE_REGISTRATION_DATA_CNPJ · Consulta dados cadastrais e contatos associados ao CNPJ consultado, retornando razão social, nome fantasia, situação cadastral, atividade principal, natureza jurídica, data de fundação, telefones, e-mails e endereços encontrados.
- [DAS MEI na Receita](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-das-mei.md): SERVICE_DAS_MEI · Consulta de DAS MEI na receita
- [Débitos ativos](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-active-debt-pj.md): SERVICE_ACTIVE_DEBT_PJ · Consulta de débitos ativos PJ
- [Débitos com a PGFN](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-pgfn-company.md): SERVICE_PGFN_COMPANY · Certidão de Débitos Relativos a Créditos Tributários Federais e à Dívida Ativa da União junto à Procuradoria-Geral da Fazenda Nacional (PGFN).
- [Distribuição de Processos dos Sócios](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-owners-lawsuits-distribution.md): SERVICE_OWNERS_LAWSUITS_DISTRIBUTION · Consulta dados agregados sobre a distribuição de processos judiciais envolvendo os sócios da empresa consultada, com indicadores resumidos por tipo, tribunal, status, estado e papel da parte.
- [Distribuição de Processos Judiciais](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-lawsuits-distribution-data-company.md): SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY · Consulta dados agregados sobre a distribuição de processos judiciais nos quais a empresa consultada está envolvida, com indicadores resumidos por tipo, tribunal, status, estado e papel da parte.
- [Domínios CNPJ](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-domains-cnpj.md): SERVICE_DOMAINS_CNPJ · Consulta de sites e domínios associados ao CNPJ, incluindo atividade, SSL, provedor, tecnologias, redes sociais, pagamentos, WHOIS e vínculos com sócios encontrados.
- [Enriquecimento de dados](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-corporate-data-enrichment.md): SERVICE_CORPORATE_DATA_ENRICHMENT · Consulta dados cadastrais e contatos associados ao CNPJ consultado, retornando razão social, nome fantasia, situação cadastral, atividade principal, natureza jurídica, data de fundação, telefones, e-mails e endereços encontrados.
- [Evolução da Empresa](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-company-evolution.md): SERVICE_COMPANY_EVOLUTION · Consulta da evolução temporal de capital, quantidade de funcionários, filiais e sócios da empresa, com tendência de crescimento.
- [Exposição e perfil na mídia dos sócios](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-media-profile-exposure-pj.md): SERVICE_MEDIA_PROFILE_EXPOSURE_PJ · Dados de exposição e perfil na mídia para pessoa jurídica
- [FGTS](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-fgts.md): SERVICE_FGTS · Consulta a certidão de regularidade do empregador perante o FGTS, informando o status da situação da empresa consultada.
- [Histórico de Dados Básicos](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-history-basic-data.md): SERVICE_HISTORY_BASIC_DATA · Consulta do histórico de alterações cadastrais básicas do CNPJ: nome, regime tributário, situação cadastral, CNAE e capital social.
- [KYC e Compliance do Grupo Econômico](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-economic-group-kyc-company.md): SERVICE_ECONOMIC_GROUP_KYC_COMPANY · Consulta indicadores agregados de KYC e compliance regulatório do grupo econômico completo do CNPJ, incluindo exposição política (PEP) e sanções nacionais e internacionais.
- [KYC e Compliance dos Funcionários](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-employees-kyc.md): SERVICE_EMPLOYEES_KYC · Consulta indicadores de KYC e compliance regulatório dos funcionários vinculados à empresa, incluindo classificações de Pessoa Politicamente Exposta (PEP) e sanções nacionais e internacionais.
- [KYC e compliance dos sócios](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-company-kyc-owners.md): SERVICE_COMPANY_KYC_OWNERS · Consulta do KYC e Complice de Sócios
- [Marketplaces](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-marketplace-data.md): SERVICE_MARKETPLACE_DATA · Consulta a presença da empresa em marketplaces, incluindo lojas operadas, produtos listados e avaliações.
- [Obras Civis](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-civil-construction.md): SERVICE_CIVIL_CONSTRUCTION · Consulta de obras civis vinculadas ao CNPJ, conforme registros do Cadastro Nacional de Obras (CNO).
- [Optante pelo Simples Nacional](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-simples-company.md): SERVICE_SIMPLES_COMPANY · Consulta pública de optantes pelo Simples Nacional e pelo SIMEI, disponível no site da Receita Federal.
- [Percentual de Participação Societária](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-owner-participation-data-company.md): SERVICE_OWNER_PARTICIPATION_DATA_COMPANY · Consulta o percentual de participação societária de cada sócio da empresa pelo CNPJ informado.
- [Processos jurídicos](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-juridical-processes-pj.md): SERVICE_JURIDICAL_PROCESSES_PJ · Consulta de Processos Jurídicos de Empresa
- [Processos jurídicos dos sócios](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-juridical-processes-pj-owners.md): SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS · Consulta do Processos Jurídicos de Sócios
- [Projetos Públicos](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-public-projects.md): SERVICE_PUBLIC_PROJECTS · Consulta de projetos com financiamento de órgãos públicos associados à empresa, incluindo fonte do recurso, modalidade e valores contratado e desembolsado.
- [Receita Federal - QSA](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-rf-qsa.md): SERVICE_RF_QSA · Consulta o quadro societário-administrativo (QSA) do CNPJ informado, com os dados cadastrais da matriz e a lista de sócios e administradores, a partir da consulta pública da Receita Federal.
- [Relacionamentos da empresa](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-company-relationship.md): SERVICE_COMPANY_RELATIONSHIP · Consulta de Relacionamentos de um Empresa
- [Risco de crédito](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-credit-risk-company.md): SERVICE_CREDIT_RISK_COMPANY · Risco de crédito para empresas
- [Score de Crédito Multidados PJ](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-one-score-company.md): SERVICE_ONE_SCORE_COMPANY · Consulta score de crédito multidados de pessoa jurídica pelo CNPJ informado
- [Score de Crédito PJ](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-credit-score-alt-company.md): SERVICE_CREDIT_SCORE_ALT_COMPANY · Consulta score de crédito de pessoa jurídica pelo CNPJ informado
- [Score de Crédito PJ](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-custom-score-company.md): SERVICE_CUSTOM_SCORE_COMPANY · Consulta score de crédito Quantum de pessoa jurídica pelo CNPJ informado.
- [Sócios de primeiro nível](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-first-level-partner.md): SERVICE_FIRST_LEVEL_PARTNER · Consulta de Sócios de Primeiro Nível
- [Sócios na Receita Federal](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-company-rfb-owners.md): SERVICE_COMPANY_RFB_OWNERS · Consulta de sócios na receita federal
- [Status do CNPJ na Receita Federal](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-rfb-pj.md): SERVICE_RFB_PJ · Consulta do CNPJ na Receita Federal
- [Telefones](https://api-docs.omni-ward.com/servicos/pessoa-juridica/service-phones-extended-company.md): SERVICE_PHONES_EXTENDED_COMPANY · Consulta dos telefones associados à empresa, com indicadores de validade, prioridade e origem.
- [Executar serviços](https://api-docs.omni-ward.com/api-reference/executar-servicos.md): Executa um ou mais serviços de consulta com os mesmos identificadores. Todos os serviços são validados antes de qualquer consulta; se algum não puder rodar, a resposta é 422 e nada é cobrado. Depois, os serviços rodam ao mesmo tempo e a resposta traz um item por alias, na ordem pedida.
- [Criar sessão](https://api-docs.omni-ward.com/api-reference/criar-sessao.md): Cria uma sessão de verificação a partir de um workflow publicado e devolve o link que o SDK abre. Chame do seu back-end.
- [Criar sessão de identidade](https://api-docs.omni-ward.com/api-reference/criar-sessao-de-identidade.md): Atalho para criar uma sessão de verificação de identidade. Chame do seu back-end.
- [Consultar sessão](https://api-docs.omni-ward.com/api-reference/consultar-sessao.md): Situação da sessão, resultados de cada etapa e linha do tempo. Use depois do webhook `verification.completed` ou para acompanhar o andamento.
- [Gerar novo link](https://api-docs.omni-ward.com/api-reference/gerar-novo-link.md): Emite um novo link para a mesma sessão. O link anterior deixa de valer.
- [Gerar relatório PDF](https://api-docs.omni-ward.com/api-reference/gerar-relatorio.md): Gera o relatório final da sessão em PDF.

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.