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

# Comece aqui

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

A API da Omni-Ward tem duas partes:

> [card] [Consultas](https://api-docs.omni-ward.com/consultas/como-funciona.md)
>
> Um único endpoint, `POST /v1/services`, executa vários serviços de uma vez com os mesmos identificadores.

> [card] [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 no app, e o resultado chega por webhook.

## Caminho mais curto

**1. Crie a conta e a chave**

No [console](https://app.omni-ward.com), crie a organização e uma chave de sandbox com o escopo `capabilities:execute`.

**2. Faça a primeira consulta**

Siga o [Quickstart](https://api-docs.omni-ward.com/quickstart.md): uma consulta de CNPJ no sandbox, com dados fictícios.

**3. Escolha os serviços**

Navegue pelo [catálogo de serviços](https://api-docs.omni-ward.com/servicos/pessoa-juridica.md) ou pelos [casos de uso](https://api-docs.omni-ward.com/consultas/casos-de-uso.md).

**4. Vá para produção**

Solicite o acesso a produção no console. Veja [Ambientes](https://api-docs.omni-ward.com/ambientes.md).

## Exemplo rápido

```bash theme={null}
curl --request POST 'https://api.omni-ward.com/v1/services' \
  --header 'Authorization: Bearer $OMNI_WARD_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "services": ["SERVICE_RFB_PJ", "SERVICE_RF_QSA"],
    "cnpj": "11222333000181",
    "purpose": "Cadastro de fornecedor"
  }'
```


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