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

# Quickstart

> Sua primeira consulta no sandbox em poucos minutos.

**1. Ative o produto**

No console, abra o **Marketplace** e ative **Verificação de Empresas**. Consultas de produtos não ativados são recusadas.

**2. Crie uma chave de sandbox**

Em **Chaves de API**, crie uma chave com o escopo `capabilities:execute`. Ela começa com `ow_test_` e aparece uma única vez.

```bash theme={null}
export OMNI_WARD_API_KEY=ow_test_...
```

**3. Consulte um CNPJ**

```bash cURL theme={null}
curl --request POST 'https://api.omni-ward.com/v1/services' \
  --header "Authorization: Bearer $OMNI_WARD_API_KEY" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $(uuidgen)" \
  --data '{"services": ["SERVICE_RFB_PJ"], "cnpj": "11222333000181"}'
```

```javascript Node.js theme={null}
const res = await fetch('https://api.omni-ward.com/v1/services', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.OMNI_WARD_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({ services: ['SERVICE_RFB_PJ'], cnpj: '11222333000181' }),
});
console.log(await res.json());
```

```python Python theme={null}
import os, uuid, requests

res = requests.post(
    "https://api.omni-ward.com/v1/services",
    headers={"Authorization": f"Bearer {os.environ['OMNI_WARD_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
    json={"services": ["SERVICE_RFB_PJ"], "cnpj": "11222333000181"},
    timeout=90,
)
print(res.json())
```

**4. Leia o resultado**

```json theme={null}
{
  "results": [
    {
      "service": "SERVICE_RFB_PJ",
      "status": { "code": 200, "message": "Success" },
      "result": { "cnpj": "11222333000181", "legalName": "Empresa Simulada 1122 LTDA", "status": "ATIVA", "outcome": "clear" },
      "simulated": true,
      "costMinor": 50
    }
  ],
  "totalCostMinor": 50
}
```

No sandbox, `simulated` é sempre `true` e os créditos não têm valor monetário.

## Entradas de teste no sandbox

| CNPJ | Resultado |
| - | - |
| `11222333000181` | Sem alertas (`outcome: "clear"`) |
| `99999999000191` | Com alertas (`outcome: "alert"`) |

Qualquer CPF válido funciona no sandbox, por exemplo `52998224725`.


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