Brasil - Sócios e Administradores de Empresas (QSA) API

curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=BRA" \
  -F "services=bra_company_directors" \
  -F "vendor_data=user-1234" \
  -F "company_registration_number=11222333000181"

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "BRA",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "bra_company_directors",
      "service_name": "Brazil - Company Partners and Directors (QSA)",
      "source_data": {
        "directors": [
          {
            "document_number": "***.456.789-**",
            "entity_type": "person",
            "name": "MARIA EXEMPLO DA SILVA",
            "role": "SOCIO-ADMINISTRADOR",
            "start_date": "2010-03-15"
          },
          {
            "document_number": "11444777000161",
            "entity_type": "company",
            "name": "HOLDING EXEMPLO S A",
            "role": "SOCIO",
            "start_date": "2018-06-01"
          }
        ],
        "registration_number": "11222333000181"
      },
      "validation": {}
    }
  ]
}

POST

database-validation

curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=BRA" \
  -F "services=bra_company_directors" \
  -F "vendor_data=user-1234" \
  -F "company_registration_number=11222333000181"

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "BRA",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "bra_company_directors",
      "service_name": "Brazil - Company Partners and Directors (QSA)",
      "source_data": {
        "directors": [
          {
            "document_number": "***.456.789-**",
            "entity_type": "person",
            "name": "MARIA EXEMPLO DA SILVA",
            "role": "SOCIO-ADMINISTRADOR",
            "start_date": "2010-03-15"
          },
          {
            "document_number": "11444777000161",
            "entity_type": "company",
            "name": "HOLDING EXEMPLO S A",
            "role": "SOCIO",
            "start_date": "2018-06-01"
          }
        ],
        "registration_number": "11222333000181"
      },
      "validation": {}
    }
  ]
}

Devolve os sócios e administradores atuais (QSA) de uma empresa brasileira, a partir do registo da Receita Federal, com a função e a data de início de cada um. Os CPFs das pessoas singulares são mascarados tal como a Receita Federal os publica. A Didit disponibiliza este serviço através de POST /v3/database-validation/, para que possa validar os dados submetidos face à fonte oficial e receber resultados de correspondência normalizados.

Cobertura

Cobertura: ~ 100%
País: Brasil
ID do serviço: bra_company_directors
Domínio de dados: Governo
Categoria: CompanyRegister

Entradas

Campo	Obrigatório	Exemplo
`company_registration_number`	Sim	`11222333000181`
`vendor_data`	Não	`user-1234`

Entradas obrigatórias: company_registration_number
Entradas opcionais: vendor_data
Consentimento: Não necessário
Disponibilidade no fluxo: Disponível no fluxo, com mapeamento de campos
Cobertura: ~ 100%
Preço: $0.20 por consulta bem-sucedida

Num fluxo, company_registration_number não está impresso num documento de identificação, por isso nenhum passo o produz por si só. Recolha-o a partir de uma resposta de Questionário, de um campo de extração do Document AI ou de um valor que envie ao criar a sessão, e mapeie-o no passo de Validação de base de dados. Enquanto não estiver mapeado, o editor de fluxos mostra este serviço desativado e indica a entrada em falta. Em execução, uma entrada em falta faz com que a verificação seja ignorada antes de qualquer consulta, pelo que nunca lhe é faturada uma consulta a uma base de dados que não pôde ser consultada.

Parâmetros do corpo

string

padrão:"BRA"

obrigatório

Código de país ISO 3166-1 alpha-3 deste serviço de base de dados.Exemplo: BRA

string

padrão:"bra_company_directors"

obrigatório

Array que contém o ID deste serviço. Fixar o serviço mantém o pedido limitado a esta base de dados específica.Exemplo: bra_company_directors

string

padrão:"11222333000181"

obrigatório

Valor de company_registration_number exigido por este serviço de base de dados.Exemplo: 11222333000181

string

padrão:"user-1234"

A sua referência estável de utilizador para esta pessoa, como o ID interno do seu utilizador. A Didit usa-a para associar verificações independentes ao mesmo utilizador final e reduzir o ruído na deteção de duplicados.Exemplo: user-1234

Regras de entrada e notas de validação

company_registration_number tem de corresponder a [0-9A-Za-z]{2}\.?[0-9A-Za-z]{3}\.?[0-9A-Za-z]{3}/?[0-9A-Za-z]{4}-?\d{2}.

Como chamar

curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=BRA" \
  -F "services=bra_company_directors" \
  -F "vendor_data=user-1234" \
  -F "company_registration_number=11222333000181"

Cada chamada bem-sucedida devolve HTTP 200. O campo outcome_code indica o que realmente aconteceu, distinguindo, por exemplo, uma incompatibilidade biométrica real (BIOMETRIC_NO_MATCH) de uma selfie que não pôde ser lida (BIOMETRIC_IMAGE_UNUSABLE). O status apresentado é o estado predefinido da funcionalidade; as suas ações de Correspondência parcial / Sem correspondência configuradas podem substituí-lo.

MATCH: o registo confirmou a identidade e todos os campos verificados correspondem.

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "BRA",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "bra_company_directors",
      "service_name": "Brazil - Company Partners and Directors (QSA)",
      "source_data": {
        "directors": [
          {
            "document_number": "***.456.789-**",
            "entity_type": "person",
            "name": "MARIA EXEMPLO DA SILVA",
            "role": "SOCIO-ADMINISTRADOR",
            "start_date": "2010-03-15"
          },
          {
            "document_number": "11444777000161",
            "entity_type": "company",
            "name": "HOLDING EXEMPLO S A",
            "role": "SOCIO",
            "start_date": "2018-06-01"
          }
        ],
        "registration_number": "11222333000181"
      },
      "validation": {}
    }
  ]
}

Dados devolvidos

Os campos exatos apresentados em source_data dependem do que o registo devolve. O exemplo gerado para bra_company_directors documenta atualmente esta estrutura normalizada:

directors
registration_number

Preços e SLA

As consultas de Brasil - Sócios e administradores de empresas (QSA) só são faturadas quando a Didit recebe um resultado conclusivo da fonte de validação.

Preço por chamada: $0.20 USD.
Faturação: por consulta bem-sucedida. Não lhe é cobrado qualquer valor quando o registo está inacessível, quando faltam campos obrigatórios ou quando o pedido é rejeitado antes de chegar à fonte.
Latência: p95 típico < 2 s.
Disponibilidade: 99.9% por trimestre, do lado da Didit; a disponibilidade da fonte a jusante varia consoante o país e o conjunto de dados.

Continue a ler

Última modificação em 7 de novembro de 2026

​Cobertura

​Entradas

​Parâmetros do corpo

​Regras de entrada e notas de validação

​Como chamar

​Dados devolvidos

​Preços e SLA

​Continue a ler

Cobertura

Entradas

Parâmetros do corpo

Regras de entrada e notas de validação

Como chamar

Dados devolvidos

Preços e SLA

Continue a ler