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

# API de Quadro de Sócios e Administradores (QSA) do Brasil

> Consulte o QSA (sócios e administradores) de empresas do Brasil em base oficial via Didit. Desde $0.20 por consulta, sem contratos nem mínimos.

Retorna os sócios e administradores atuais (QSA) de uma empresa brasileira a partir do cadastro da Receita Federal, com a função e a data de início de cada um. Os CPFs de pessoas físicas aparecem mascarados, como a Receita Federal os publica. A Didit disponibiliza este serviço por meio de `POST /v3/database-validation/` para que você possa verificar os dados enviados em relação à 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 obrigatório
* **Disponibilidade no fluxo de verificação (workflow):** Disponível no fluxo com mapeamento de campos
* **Cobertura:** \~ 100%
* **Preço:** \$0.20 por consulta bem-sucedida

Em um fluxo, `company_registration_number` não é impresso em um documento de identidade, então nenhuma etapa o gera por conta própria. Colete-o a partir de uma resposta de Questionário, de um campo de extração do Document AI ou de um valor que você envia ao criar a sessão, e mapeie-o na etapa de Validação de banco de dados. Enquanto ele não for mapeado, o editor de fluxos mostra este serviço desativado e indica a entrada ausente; em tempo de execução, uma entrada ausente faz com que a verificação seja ignorada antes de qualquer consulta, de modo que você nunca é cobrado por um banco de dados que não pôde ser consultado.

## Parâmetros do corpo

**issuing\_state** `string` *required* (default: BRA)

Código de país ISO 3166-1 alfa-3 deste serviço de banco de dados.

Exemplo: `BRA`

**services** `string` *required* (default: bra\_company\_directors)

Array que contém este ID de serviço. Fixar o serviço mantém a requisição restrita a este banco de dados específico.

Exemplo: `bra_company_directors`

**company\_registration\_number** `string` *required* (default: 11222333000181)

Valor de `company_registration_number` exigido por este serviço de banco de dados.

Exemplo: `11222333000181`

**vendor\_data** `string` (default: user-1234)

Sua referência estável de usuário para esta pessoa, como seu ID interno de usuário. A Didit a usa para vincular verificações avulsas ao mesmo usuário final e reduzir ruído na detecção de duplicados.

Exemplo: `user-1234`

## Regras de entrada e notas de validação

* `company_registration_number` deve 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

```bash cURL theme={null}
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"
```

Toda chamada bem-sucedida retorna HTTP `200`. O campo **`outcome_code`** informa o que de fato aconteceu, distinguindo, por exemplo, uma divergência biométrica real (`BIOMETRIC_NO_MATCH`) de uma selfie que não pôde ser lida (`BIOMETRIC_IMAGE_UNUSABLE`). O `status` exibido é o status padrão do recurso; as [ações de Partial Match / No Match](https://docs.didit.me/pt-br/core-technology/database-validation/database-validation-warnings.md) que você configurou podem substituí-lo.

**`MATCH`**: o registro confirmou a identidade e todos os campos verificados corresponderam.

```json 200 OK — MATCH theme={null}
{
  "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 retornados

Os campos exatos exibidos em `source_data` dependem do que o registro de empresas retorna. O exemplo gerado para `bra_company_directors` documenta atualmente este formato normalizado:

* `directors`
* `registration_number`

## Preços e SLAs

As consultas de Brasil - Sócios e Administradores de Empresas (QSA) são cobradas somente quando a Didit recebe um resultado conclusivo da fonte de validação.

* **Preço por chamada:** \$0.20 USD.
* **Faturamento:** por consulta bem-sucedida. Você não é cobrado quando o registro está inacessível, quando faltam campos obrigatórios ou quando a requisição é rejeitada antes de chegar à fonte.
* **Latência:** p95 típico \< 2 s.
* **Disponibilidade:** 99.9% por trimestre nos sistemas da Didit; a disponibilidade da fonte externa varia conforme o país e o conjunto de dados.

## Continue a leitura

* [Visão geral da Validação de banco de dados no Brasil](https://docs.didit.me/api-reference/database-validation/brazil.md)
* [Visão geral da Validação de banco de dados](https://docs.didit.me/pt-br/core-technology/database-validation/overview.md)
* [Códigos de resultado](https://docs.didit.me/pt-br/core-technology/database-validation/database-validation-outcome-codes.md)


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