> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.omni-ward.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Executar serviços

> 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.



## OpenAPI

````yaml POST /v1/services
openapi: 3.1.0
info:
  title: Omni-Ward API
  version: 1.0.0
  description: >-
    Consultas de pessoa física e jurídica por um único endpoint, e sessões de
    verificação para o SDK.
servers:
  - url: https://api.omni-ward.com
    description: >-
      A chave de API define o ambiente: ow_test_ para sandbox, ow_live_ para
      produção.
security: []
paths:
  /v1/services:
    post:
      tags:
        - Consultas
      summary: Executar serviços
      description: >-
        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.
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
            maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                services:
                  minItems: 1
                  maxItems: 20
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 80
                    enum:
                      - SERVICE_ACTIVE_DEBT_PF
                      - SERVICE_ACTIVE_DEBT_PJ
                      - SERVICE_ADDRESS
                      - SERVICE_ARREST_WARRANT
                      - SERVICE_CIVIL_CONSTRUCTION
                      - SERVICE_COMPANY_EVOLUTION
                      - SERVICE_COMPANY_KYC_OWNERS
                      - SERVICE_COMPANY_RELATIONSHIP
                      - SERVICE_COMPANY_RFB_OWNERS
                      - SERVICE_COMPLIANCE_BET_PJ
                      - SERVICE_CONFIRM_PHONE
                      - SERVICE_CORPORATE_DATA_ENRICHMENT
                      - SERVICE_CORPORATE_TIES_PERSON
                      - SERVICE_CPF_ADDRESS_VALIDATION
                      - SERVICE_CPF_NAME_CHECK
                      - SERVICE_CPF_PHONE_VALIDATION
                      - SERVICE_CPF_QUERY_HISTORY
                      - SERVICE_CREDIT_RISK_COMPANY
                      - SERVICE_CREDIT_RISK_SIGNALS_PERSON
                      - SERVICE_CREDIT_SCORE
                      - SERVICE_CREDIT_SCORE_ALT_COMPANY
                      - SERVICE_CREDIT_SCORE_ALT_PERSON
                      - SERVICE_CRIMINAL_RECORD_FEDERAL
                      - SERVICE_CUSTOM_SCORE_COMPANY
                      - SERVICE_DAS_MEI
                      - SERVICE_DEMOGRAPHIC_DATA_CPF
                      - SERVICE_DOMAINS_CNPJ
                      - SERVICE_DOMAINS_CPF
                      - SERVICE_ECONOMIC_GROUP_KYC_COMPANY
                      - SERVICE_ECONOMIC_RELATIONSHIP
                      - SERVICE_EMAILS_EXTENDED
                      - SERVICE_EMAIL_VALIDATION
                      - SERVICE_EMPLOYEES_KYC
                      - SERVICE_FACE_INDEX
                      - SERVICE_FACE_MATCH_CPF
                      - SERVICE_FGTS
                      - SERVICE_FINANCIAL_INFORMATION
                      - SERVICE_FIRST_LEVEL_PARTNER
                      - SERVICE_FRAUD_RISK_SCORE
                      - SERVICE_HISTORY_BASIC_DATA
                      - SERVICE_JURIDICAL_PROCESSES
                      - SERVICE_JURIDICAL_PROCESSES_PJ
                      - SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS
                      - SERVICE_LABOR_LAWSUITS
                      - SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY
                      - SERVICE_MARKETPLACE_DATA
                      - SERVICE_MEDIA_PROFILE_EXPOSURE_PF
                      - SERVICE_MEDIA_PROFILE_EXPOSURE_PJ
                      - SERVICE_MEI
                      - SERVICE_MERCHANT_CATEGORY_DATA
                      - SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF
                      - SERVICE_ONE_SCORE_COMPANY
                      - SERVICE_ONE_SCORE_PERSON
                      - SERVICE_ONLINE_ADS
                      - SERVICE_OWNERS_LAWSUITS_DISTRIBUTION
                      - SERVICE_OWNER_PARTICIPATION_DATA_COMPANY
                      - SERVICE_PCD_COMPANY
                      - SERVICE_PERSON_DATA_ENRICHMENT
                      - SERVICE_PERSON_KYC
                      - SERVICE_PF_FINANCIAL_AND_ADDRESS
                      - SERVICE_PGFN_COMPANY
                      - SERVICE_PGMEI
                      - SERVICE_PHONES_EXTENDED_COMPANY
                      - SERVICE_PHONE_HISTORY
                      - SERVICE_PROFESSIONAL_HISTORY
                      - SERVICE_PUBLIC_PROJECTS
                      - SERVICE_PUBLIC_SERVANTS
                      - SERVICE_REGISTRATION_DATA_CNPJ
                      - SERVICE_RELATED_PEOPLE
                      - SERVICE_RFB_PF
                      - SERVICE_RFB_PJ
                      - SERVICE_RF_QSA
                      - SERVICE_SIMPLES_COMPANY
                      - SERVICE_SOCIAL_ASSISTANCE_EXTENDED
                      - SERVICE_SYNDICATE_AGREEMENTS
                      - SERVICE_ULTIMATE_BENEFICIAL_OWNERS
                      - SEVICE_ONLINE_BETTING_PROPENSITY
                  description: >-
                    Aliases dos serviços, de 1 a 20, sem repetir. Veja o
                    catálogo de serviços.
                  example:
                    - SERVICE_RFB_PJ
                cpf:
                  type: string
                  maxLength: 20
                  description: >-
                    CPF, com ou sem pontuação. Obrigatório nos serviços que o
                    usam.
                  example: '00000000000'
                cnpj:
                  type: string
                  maxLength: 20
                  description: >-
                    CNPJ, com ou sem pontuação. Obrigatório nos serviços que o
                    usam.
                  example: '00000000000000'
                phone:
                  type: string
                  maxLength: 20
                  description: >-
                    Telefone com DDD, só dígitos. Obrigatório nos serviços que o
                    usam.
                  example: '11999999999'
                email:
                  type: string
                  maxLength: 254
                  description: Endereço de e-mail. Obrigatório nos serviços que o usam.
                  example: pessoa@exemplo.com
                face:
                  type: string
                  maxLength: 6000000
                  description: >-
                    Foto do rosto em base64, com ou sem o prefixo
                    `data:image/...;base64,`. Obrigatório nos serviços que o
                    usam.
                  example: /9j/4AAQSkZJRgABAQ…
                name:
                  type: string
                  maxLength: 120
                  description: Nome completo. Obrigatório nos serviços que o usam.
                  example: NOME DA PESSOA
                birthDate:
                  type: string
                  maxLength: 10
                  description: >-
                    Data de nascimento, no formato AAAA-MM-DD. Obrigatório nos
                    serviços que o usam.
                  example: '1990-01-31'
                motherName:
                  type: string
                  maxLength: 120
                  description: Nome completo da mãe. Obrigatório nos serviços que o usam.
                  example: NOME DA MÃE
                fatherName:
                  type: string
                  maxLength: 120
                  description: Nome completo do pai. Obrigatório nos serviços que o usam.
                  example: NOME DO PAI
                zipcode:
                  type: string
                  maxLength: 9
                  description: CEP, 8 dígitos. Obrigatório nos serviços que o usam.
                  example: '01001000'
                numberAddress:
                  type: string
                  maxLength: 10
                  description: Número do endereço. Obrigatório nos serviços que o usam.
                  example: '100'
                purpose:
                  type: string
                  minLength: 5
                  maxLength: 300
                  description: >-
                    Finalidade do tratamento. Obrigatória quando algum serviço
                    trata dados pessoais, biométricos ou restritivos.
                  example: Abertura de conta
              required:
                - services
              additionalProperties: false
            examples:
              varios:
                summary: Vários serviços
                value:
                  services:
                    - SERVICE_CORPORATE_DATA_ENRICHMENT
                    - SERVICE_RFB_PF
                    - SERVICE_EMAIL_VALIDATION
                  cnpj: '00000000000000'
                  cpf: '00000000000'
                  email: pessoa@exemplo.com
                  purpose: Abertura de conta
              SERVICE_LABOR_LAWSUITS:
                summary: Ações Trabalhistas (SERVICE_LABOR_LAWSUITS)
                value:
                  services:
                    - SERVICE_LABOR_LAWSUITS
                  cnpj: '00000000000000'
              SERVICE_SYNDICATE_AGREEMENTS:
                summary: Acordos Sindicais (SERVICE_SYNDICATE_AGREEMENTS)
                value:
                  services:
                    - SERVICE_SYNDICATE_AGREEMENTS
                  cnpj: '00000000000000'
              SERVICE_CRIMINAL_RECORD_FEDERAL:
                summary: >-
                  Antecedentes criminais federais
                  (SERVICE_CRIMINAL_RECORD_FEDERAL)
                value:
                  services:
                    - SERVICE_CRIMINAL_RECORD_FEDERAL
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_ONLINE_ADS:
                summary: Anúncios Online (SERVICE_ONLINE_ADS)
                value:
                  services:
                    - SERVICE_ONLINE_ADS
                  cnpj: '00000000000000'
              SERVICE_PGMEI:
                summary: Arrecadação Simples Nacional - MEI (SERVICE_PGMEI)
                value:
                  services:
                    - SERVICE_PGMEI
                  cnpj: '00000000000000'
              SERVICE_ULTIMATE_BENEFICIAL_OWNERS:
                summary: Beneficiários Finais (SERVICE_ULTIMATE_BENEFICIAL_OWNERS)
                value:
                  services:
                    - SERVICE_ULTIMATE_BENEFICIAL_OWNERS
                  cnpj: '00000000000000'
                  purpose: Abertura de conta
              SERVICE_SOCIAL_ASSISTANCE_EXTENDED:
                summary: >-
                  Benefícios sociais estendidos
                  (SERVICE_SOCIAL_ASSISTANCE_EXTENDED)
                value:
                  services:
                    - SERVICE_SOCIAL_ASSISTANCE_EXTENDED
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_FACE_INDEX:
                summary: Busca de face na base (SERVICE_FACE_INDEX)
                value:
                  services:
                    - SERVICE_FACE_INDEX
                  face: /9j/4AAQSkZJRgABAQ…
                  purpose: Abertura de conta
              SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF:
                summary: Cartão SUS (SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF)
                value:
                  services:
                    - SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_MERCHANT_CATEGORY_DATA:
                summary: Categoria Comercial (SERVICE_MERCHANT_CATEGORY_DATA)
                value:
                  services:
                    - SERVICE_MERCHANT_CATEGORY_DATA
                  cnpj: '00000000000000'
              SERVICE_COMPLIANCE_BET_PJ:
                summary: Compliance de casas de apostas (SERVICE_COMPLIANCE_BET_PJ)
                value:
                  services:
                    - SERVICE_COMPLIANCE_BET_PJ
                  cnpj: '00000000000000'
              SERVICE_CPF_NAME_CHECK:
                summary: Conferência de CPF e nome (SERVICE_CPF_NAME_CHECK)
                value:
                  services:
                    - SERVICE_CPF_NAME_CHECK
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_MEI:
                summary: Consulta de MEI (SERVICE_MEI)
                value:
                  services:
                    - SERVICE_MEI
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_CORPORATE_TIES_PERSON:
                summary: >-
                  Consulta de Vínculos Societários
                  (SERVICE_CORPORATE_TIES_PERSON)
                value:
                  services:
                    - SERVICE_CORPORATE_TIES_PERSON
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_PCD_COMPANY:
                summary: Cota de PCD (SERVICE_PCD_COMPANY)
                value:
                  services:
                    - SERVICE_PCD_COMPANY
                  cnpj: '00000000000000'
              SERVICE_REGISTRATION_DATA_CNPJ:
                summary: Dados cadastrais de CNPJ (SERVICE_REGISTRATION_DATA_CNPJ)
                value:
                  services:
                    - SERVICE_REGISTRATION_DATA_CNPJ
                  cnpj: '00000000000000'
              SERVICE_DEMOGRAPHIC_DATA_CPF:
                summary: Dados demográficos (SERVICE_DEMOGRAPHIC_DATA_CPF)
                value:
                  services:
                    - SERVICE_DEMOGRAPHIC_DATA_CPF
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_PF_FINANCIAL_AND_ADDRESS:
                summary: >-
                  Dados financeiros e endereços
                  (SERVICE_PF_FINANCIAL_AND_ADDRESS)
                value:
                  services:
                    - SERVICE_PF_FINANCIAL_AND_ADDRESS
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_CONFIRM_PHONE:
                summary: Dados pelo telefone (SERVICE_CONFIRM_PHONE)
                value:
                  services:
                    - SERVICE_CONFIRM_PHONE
                  phone: '11999999999'
                  purpose: Abertura de conta
              SERVICE_DAS_MEI:
                summary: DAS MEI na Receita (SERVICE_DAS_MEI)
                value:
                  services:
                    - SERVICE_DAS_MEI
                  cnpj: '00000000000000'
              SERVICE_ACTIVE_DEBT_PJ:
                summary: Débitos ativos (SERVICE_ACTIVE_DEBT_PJ)
                value:
                  services:
                    - SERVICE_ACTIVE_DEBT_PJ
                  cnpj: '00000000000000'
              SERVICE_PGFN_COMPANY:
                summary: Débitos com a PGFN (SERVICE_PGFN_COMPANY)
                value:
                  services:
                    - SERVICE_PGFN_COMPANY
                  cnpj: '00000000000000'
              SERVICE_OWNERS_LAWSUITS_DISTRIBUTION:
                summary: >-
                  Distribuição de Processos dos Sócios
                  (SERVICE_OWNERS_LAWSUITS_DISTRIBUTION)
                value:
                  services:
                    - SERVICE_OWNERS_LAWSUITS_DISTRIBUTION
                  cnpj: '00000000000000'
                  purpose: Abertura de conta
              SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY:
                summary: >-
                  Distribuição de Processos Judiciais
                  (SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY)
                value:
                  services:
                    - SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY
                  cnpj: '00000000000000'
              SERVICE_ACTIVE_DEBT_PF:
                summary: Dívida ativa (SERVICE_ACTIVE_DEBT_PF)
                value:
                  services:
                    - SERVICE_ACTIVE_DEBT_PF
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_DOMAINS_CPF:
                summary: Domínios (SERVICE_DOMAINS_CPF)
                value:
                  services:
                    - SERVICE_DOMAINS_CPF
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_DOMAINS_CNPJ:
                summary: Domínios CNPJ (SERVICE_DOMAINS_CNPJ)
                value:
                  services:
                    - SERVICE_DOMAINS_CNPJ
                  cnpj: '00000000000000'
              SERVICE_ADDRESS:
                summary: Endereços (SERVICE_ADDRESS)
                value:
                  services:
                    - SERVICE_ADDRESS
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_CORPORATE_DATA_ENRICHMENT:
                summary: Enriquecimento de dados (SERVICE_CORPORATE_DATA_ENRICHMENT)
                value:
                  services:
                    - SERVICE_CORPORATE_DATA_ENRICHMENT
                  cnpj: '00000000000000'
              SERVICE_PERSON_DATA_ENRICHMENT:
                summary: Enriquecimento de dados (SERVICE_PERSON_DATA_ENRICHMENT)
                value:
                  services:
                    - SERVICE_PERSON_DATA_ENRICHMENT
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_COMPANY_EVOLUTION:
                summary: Evolução da Empresa (SERVICE_COMPANY_EVOLUTION)
                value:
                  services:
                    - SERVICE_COMPANY_EVOLUTION
                  cnpj: '00000000000000'
              SERVICE_MEDIA_PROFILE_EXPOSURE_PF:
                summary: >-
                  Exposição e perfil na mídia
                  (SERVICE_MEDIA_PROFILE_EXPOSURE_PF)
                value:
                  services:
                    - SERVICE_MEDIA_PROFILE_EXPOSURE_PF
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_MEDIA_PROFILE_EXPOSURE_PJ:
                summary: >-
                  Exposição e perfil na mídia dos sócios
                  (SERVICE_MEDIA_PROFILE_EXPOSURE_PJ)
                value:
                  services:
                    - SERVICE_MEDIA_PROFILE_EXPOSURE_PJ
                  cnpj: '00000000000000'
              SERVICE_FGTS:
                summary: FGTS (SERVICE_FGTS)
                value:
                  services:
                    - SERVICE_FGTS
                  cnpj: '00000000000000'
              SERVICE_CREDIT_RISK_SIGNALS_PERSON:
                summary: Flags Negativos (SERVICE_CREDIT_RISK_SIGNALS_PERSON)
                value:
                  services:
                    - SERVICE_CREDIT_RISK_SIGNALS_PERSON
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_HISTORY_BASIC_DATA:
                summary: Histórico de Dados Básicos (SERVICE_HISTORY_BASIC_DATA)
                value:
                  services:
                    - SERVICE_HISTORY_BASIC_DATA
                  cnpj: '00000000000000'
              SERVICE_EMAILS_EXTENDED:
                summary: Histórico de e-mails (SERVICE_EMAILS_EXTENDED)
                value:
                  services:
                    - SERVICE_EMAILS_EXTENDED
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_PHONE_HISTORY:
                summary: Histórico de telefones (SERVICE_PHONE_HISTORY)
                value:
                  services:
                    - SERVICE_PHONE_HISTORY
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_PROFESSIONAL_HISTORY:
                summary: Histórico profissional (SERVICE_PROFESSIONAL_HISTORY)
                value:
                  services:
                    - SERVICE_PROFESSIONAL_HISTORY
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_FINANCIAL_INFORMATION:
                summary: Informações financeiras (SERVICE_FINANCIAL_INFORMATION)
                value:
                  services:
                    - SERVICE_FINANCIAL_INFORMATION
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_PERSON_KYC:
                summary: KYC e compliance (SERVICE_PERSON_KYC)
                value:
                  services:
                    - SERVICE_PERSON_KYC
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_ECONOMIC_GROUP_KYC_COMPANY:
                summary: >-
                  KYC e Compliance do Grupo Econômico
                  (SERVICE_ECONOMIC_GROUP_KYC_COMPANY)
                value:
                  services:
                    - SERVICE_ECONOMIC_GROUP_KYC_COMPANY
                  cnpj: '00000000000000'
              SERVICE_EMPLOYEES_KYC:
                summary: KYC e Compliance dos Funcionários (SERVICE_EMPLOYEES_KYC)
                value:
                  services:
                    - SERVICE_EMPLOYEES_KYC
                  cnpj: '00000000000000'
                  purpose: Abertura de conta
              SERVICE_COMPANY_KYC_OWNERS:
                summary: KYC e compliance dos sócios (SERVICE_COMPANY_KYC_OWNERS)
                value:
                  services:
                    - SERVICE_COMPANY_KYC_OWNERS
                  cnpj: '00000000000000'
                  purpose: Abertura de conta
              SERVICE_ARREST_WARRANT:
                summary: Mandado de prisão (SERVICE_ARREST_WARRANT)
                value:
                  services:
                    - SERVICE_ARREST_WARRANT
                  cpf: '00000000000'
                  name: NOME DA PESSOA
                  motherName: NOME DA MÃE
                  fatherName: NOME DO PAI
                  birthDate: '1990-01-31'
                  purpose: Abertura de conta
              SERVICE_MARKETPLACE_DATA:
                summary: Marketplaces (SERVICE_MARKETPLACE_DATA)
                value:
                  services:
                    - SERVICE_MARKETPLACE_DATA
                  cnpj: '00000000000000'
              SERVICE_CIVIL_CONSTRUCTION:
                summary: Obras Civis (SERVICE_CIVIL_CONSTRUCTION)
                value:
                  services:
                    - SERVICE_CIVIL_CONSTRUCTION
                  cnpj: '00000000000000'
              SERVICE_SIMPLES_COMPANY:
                summary: Optante pelo Simples Nacional (SERVICE_SIMPLES_COMPANY)
                value:
                  services:
                    - SERVICE_SIMPLES_COMPANY
                  cnpj: '00000000000000'
              SERVICE_OWNER_PARTICIPATION_DATA_COMPANY:
                summary: >-
                  Percentual de Participação Societária
                  (SERVICE_OWNER_PARTICIPATION_DATA_COMPANY)
                value:
                  services:
                    - SERVICE_OWNER_PARTICIPATION_DATA_COMPANY
                  cnpj: '00000000000000'
                  purpose: Abertura de conta
              SERVICE_RELATED_PEOPLE:
                summary: Pessoas relacionadas (SERVICE_RELATED_PEOPLE)
                value:
                  services:
                    - SERVICE_RELATED_PEOPLE
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_JURIDICAL_PROCESSES_PJ:
                summary: Processos jurídicos (SERVICE_JURIDICAL_PROCESSES_PJ)
                value:
                  services:
                    - SERVICE_JURIDICAL_PROCESSES_PJ
                  cnpj: '00000000000000'
              SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS:
                summary: >-
                  Processos jurídicos dos sócios
                  (SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS)
                value:
                  services:
                    - SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS
                  cnpj: '00000000000000'
                  purpose: Abertura de conta
              SERVICE_JURIDICAL_PROCESSES:
                summary: >-
                  Processos jurídicos e administrativos
                  (SERVICE_JURIDICAL_PROCESSES)
                value:
                  services:
                    - SERVICE_JURIDICAL_PROCESSES
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_PUBLIC_PROJECTS:
                summary: Projetos Públicos (SERVICE_PUBLIC_PROJECTS)
                value:
                  services:
                    - SERVICE_PUBLIC_PROJECTS
                  cnpj: '00000000000000'
              SEVICE_ONLINE_BETTING_PROPENSITY:
                summary: Propensão a apostas online (SEVICE_ONLINE_BETTING_PROPENSITY)
                value:
                  services:
                    - SEVICE_ONLINE_BETTING_PROPENSITY
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_CPF_QUERY_HISTORY:
                summary: Quem consultou o CPF (SERVICE_CPF_QUERY_HISTORY)
                value:
                  services:
                    - SERVICE_CPF_QUERY_HISTORY
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_RF_QSA:
                summary: Receita Federal - QSA (SERVICE_RF_QSA)
                value:
                  services:
                    - SERVICE_RF_QSA
                  cnpj: '00000000000000'
                  purpose: Abertura de conta
              SERVICE_COMPANY_RELATIONSHIP:
                summary: Relacionamentos da empresa (SERVICE_COMPANY_RELATIONSHIP)
                value:
                  services:
                    - SERVICE_COMPANY_RELATIONSHIP
                  cnpj: '00000000000000'
              SERVICE_ECONOMIC_RELATIONSHIP:
                summary: Relacionamentos econômicos (SERVICE_ECONOMIC_RELATIONSHIP)
                value:
                  services:
                    - SERVICE_ECONOMIC_RELATIONSHIP
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_CREDIT_RISK_COMPANY:
                summary: Risco de crédito (SERVICE_CREDIT_RISK_COMPANY)
                value:
                  services:
                    - SERVICE_CREDIT_RISK_COMPANY
                  cnpj: '00000000000000'
              SERVICE_CREDIT_SCORE:
                summary: Score de crédito (SERVICE_CREDIT_SCORE)
                value:
                  services:
                    - SERVICE_CREDIT_SCORE
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_CREDIT_SCORE_ALT_PERSON:
                summary: Score de Crédito (SERVICE_CREDIT_SCORE_ALT_PERSON)
                value:
                  services:
                    - SERVICE_CREDIT_SCORE_ALT_PERSON
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_ONE_SCORE_PERSON:
                summary: Score de Crédito Multidados (SERVICE_ONE_SCORE_PERSON)
                value:
                  services:
                    - SERVICE_ONE_SCORE_PERSON
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_ONE_SCORE_COMPANY:
                summary: Score de Crédito Multidados PJ (SERVICE_ONE_SCORE_COMPANY)
                value:
                  services:
                    - SERVICE_ONE_SCORE_COMPANY
                  cnpj: '00000000000000'
              SERVICE_CREDIT_SCORE_ALT_COMPANY:
                summary: Score de Crédito PJ (SERVICE_CREDIT_SCORE_ALT_COMPANY)
                value:
                  services:
                    - SERVICE_CREDIT_SCORE_ALT_COMPANY
                  cnpj: '00000000000000'
              SERVICE_CUSTOM_SCORE_COMPANY:
                summary: Score de Crédito PJ (SERVICE_CUSTOM_SCORE_COMPANY)
                value:
                  services:
                    - SERVICE_CUSTOM_SCORE_COMPANY
                  cnpj: '00000000000000'
              SERVICE_FRAUD_RISK_SCORE:
                summary: Score de risco de fraude (SERVICE_FRAUD_RISK_SCORE)
                value:
                  services:
                    - SERVICE_FRAUD_RISK_SCORE
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_PUBLIC_SERVANTS:
                summary: Servidores públicos (SERVICE_PUBLIC_SERVANTS)
                value:
                  services:
                    - SERVICE_PUBLIC_SERVANTS
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_FIRST_LEVEL_PARTNER:
                summary: Sócios de primeiro nível (SERVICE_FIRST_LEVEL_PARTNER)
                value:
                  services:
                    - SERVICE_FIRST_LEVEL_PARTNER
                  cnpj: '00000000000000'
                  purpose: Abertura de conta
              SERVICE_COMPANY_RFB_OWNERS:
                summary: Sócios na Receita Federal (SERVICE_COMPANY_RFB_OWNERS)
                value:
                  services:
                    - SERVICE_COMPANY_RFB_OWNERS
                  cnpj: '00000000000000'
                  purpose: Abertura de conta
              SERVICE_RFB_PJ:
                summary: Status do CNPJ na Receita Federal (SERVICE_RFB_PJ)
                value:
                  services:
                    - SERVICE_RFB_PJ
                  cnpj: '00000000000000'
              SERVICE_RFB_PF:
                summary: Status do CPF na Receita Federal (SERVICE_RFB_PF)
                value:
                  services:
                    - SERVICE_RFB_PF
                  cpf: '00000000000'
                  purpose: Abertura de conta
              SERVICE_PHONES_EXTENDED_COMPANY:
                summary: Telefones (SERVICE_PHONES_EXTENDED_COMPANY)
                value:
                  services:
                    - SERVICE_PHONES_EXTENDED_COMPANY
                  cnpj: '00000000000000'
              SERVICE_CPF_ADDRESS_VALIDATION:
                summary: Validação de CPF com endereço (SERVICE_CPF_ADDRESS_VALIDATION)
                value:
                  services:
                    - SERVICE_CPF_ADDRESS_VALIDATION
                  cpf: '00000000000'
                  zipcode: '01001000'
                  numberAddress: '100'
                  purpose: Abertura de conta
              SERVICE_CPF_PHONE_VALIDATION:
                summary: Validação de CPF com telefone (SERVICE_CPF_PHONE_VALIDATION)
                value:
                  services:
                    - SERVICE_CPF_PHONE_VALIDATION
                  cpf: '00000000000'
                  phone: '11999999999'
                  purpose: Abertura de conta
              SERVICE_EMAIL_VALIDATION:
                summary: Validação de e-mail (SERVICE_EMAIL_VALIDATION)
                value:
                  services:
                    - SERVICE_EMAIL_VALIDATION
                  email: pessoa@exemplo.com
                  purpose: Abertura de conta
              SERVICE_FACE_MATCH_CPF:
                summary: Validação facial por CPF (SERVICE_FACE_MATCH_CPF)
                value:
                  services:
                    - SERVICE_FACE_MATCH_CPF
                  cpf: '00000000000'
                  face: /9j/4AAQSkZJRgABAQ…
                  purpose: Abertura de conta
      responses:
        '200':
          description: >-
            Requisição processada. Confira o `status` de cada item: um serviço
            pode falhar sem afetar os outros.
          content:
            application/json:
              schema:
                type: object
                required:
                  - results
                  - totalCostMinor
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/ServiceResult'
                  totalCostMinor:
                    type: integer
                    description: Total cobrado, em centavos.
              example:
                results:
                  - service: SERVICE_RFB_PJ
                    status:
                      code: 200
                      message: Success
                    result:
                      company_name: texto
                      company_fantasy_name: texto
                      state_foundation_company: texto
                      nire: 0
                      capital: texto
                      capital_rs: texto
                      activities: texto
                      founded_date: '2020-01-01'
                      legal_nature_code: texto
                      legal_nature_activity: texto
                      regime: texto
                      status: texto
                      status_date: '2020-01-01'
                      outcome: clear
                    simulated: false
                    costMinor: 50
                totalCostMinor: 50
        '401':
          description: Chave de API ausente, inválida ou revogada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: O saldo não cobre todos os serviços pedidos. Nada foi executado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: insufficient_credits
                  message: >-
                    Saldo de créditos insuficiente para todos os serviços
                    solicitados.
                  correlationId: 4f1c9a7e-2b1d-4c55-9a51-0d2f6f1c2a10
                  details:
                    requiredMinor: '180'
                    availableMinor: '100'
        '422':
          description: >-
            Algum serviço não pode ser executado. Nada foi consultado nem
            cobrado. `details.results` lista os problemas por serviço.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: validation_failed
                  message: >-
                    Alguns serviços não podem ser executados. Nada foi
                    consultado nem cobrado.
                  correlationId: 4f1c9a7e-2b1d-4c55-9a51-0d2f6f1c2a10
                  details:
                    results:
                      - service: SERVICE_RFB_PF
                        status:
                          code: 422
                          message: Validation failed
                        result: null
                        errors:
                          - field: cpf
                            code: required
                            message: 'Informe CPF: este serviço exige o campo.'
                      - service: SERVICE_CONFIRM_PHONE
                        status:
                          code: 422
                          message: Validation failed
                        result: null
                        errors:
                          - field: phone
                            code: invalid
                            message: 'Telefone inválido: envie DDD e número, só dígitos.'
      security:
        - apiKey: []
components:
  schemas:
    ServiceResult:
      type: object
      required:
        - service
        - status
        - result
      properties:
        service:
          type: string
          description: O alias pedido.
          example: SERVICE_RFB_PF
        status:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: integer
              example: 200
            message:
              type: string
              example: Success
          description: Resultado deste serviço. 200 quando a consulta foi feita.
        result:
          type:
            - object
            - 'null'
          additionalProperties: true
          description: >-
            Dados da consulta. O formato depende do serviço. `null` quando este
            serviço falhou.
        simulated:
          type: boolean
          description: '`true` quando os dados são fictícios (sandbox).'
        costMinor:
          type: integer
          description: Valor cobrado por este serviço, em centavos.
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          description: Presente quando este serviço falhou.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            correlationId:
              type: string
            details: {}
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Chave de API criada no console: `ow_test_…` (sandbox) ou `ow_live_…`
        (produção).

````

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