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

# Autenticação da API: Pedidos Seguros à API de KYC

> Autentique pedidos à API Didit com o cabeçalho x-api-key. Chaves inválidas ou expiradas devolvem 401 e chaves em falta devolvem 403.



Prompt de autenticação da API
        Copiar o prompt para a área de transferência



      
      

\<pre>

\````# Goal — authenticate against Didit's REST API

Two hosts, two auth schemes. Never mix them up.

\## Host map

\| Host | Surface | Auth header |
\|---|---|---|
\| `https://verification.didit.me` | Verification API — sessions, workflows, entities, transactions, standalone APIs, lists, webhooks, billing (every `/v3/...` route) | `x-api-key: <DIDIT_API_KEY>` |
\| `https://apx.didit.me` | Account / organization / application management (`/auth/v2/programmatic/...`, `/auth/v2/organizations/...`) | `Authorization: Bearer <JWT access_token>` |

The verification API does **not** use OAuth Bearer tokens. It uses a long-lived API key on the `x-api-key` header. Treat the key as a server-side secret — never ship it to a browser or mobile bundle.

\## How to obtain the api_key (no console UI needed)

\<Warning>
Substitute `you@yourdomain.com` below with a real inbox. The register endpoint sends the verification code synchronously, so reserved test domains (`@example.com`, `@example.org`, `@*.test`, `@*.example`, `@*.invalid`) get refused by mail delivery and the call returns a `500`.
\</Warning>

\```bash
\# 1) Register — emails a 6-char code (15 min TTL).
\#    Password rules: ≥8 chars, 1 uppercase, 1 lowercase, 1 digit, 1 special.
curl -X POST https://apx.didit.me/auth/v2/programmatic/register/ \
-H "Content-Type: application/json" \
-d '{"email": "you@yourdomain.com", "password": "StrongP@ss1"}'

\# 2) Verify email — returns api_key inline.
curl -X POST https://apx.didit.me/auth/v2/programmatic/verify-email/ \
-H "Content-Type: application/json" \
-d '{"email": "you@yourdomain.com", "code": "A3K9F2"}'
\# 200 -> { access_token, refresh_token, organization, application: { api_key, client_id, uuid } }
\```

Persist `response.application.api_key` as the env var `DIDIT_API_KEY`.
New keys start with `sk_live_` (live application) or `sk_test_` (sandbox application), followed by 43 URL-safe characters.
Keys created before this format have no prefix and keep working, so never validate a key by its prefix.

\## Recover the key (lost it)

\```bash
\# Log back in to get a fresh JWT
TOK=$(curl -s -X POST https://apx.didit.me/auth/v2/programmatic/login/ \
-H "Content-Type: application/json" \
-d '{"email":"you@yourdomain.com","password":"StrongP@ss1"}' | jq -r .access_token)

\# Find your org and app
curl https://apx.didit.me/auth/v2/organizations/me/ -H "Authorization: Bearer $TOK"
curl https://apx.didit.me/auth/v2/organizations/me/$ORG_ID/applications/$APP_ID/ \
-H "Authorization: Bearer $TOK"
\# Response.api_key is your key.
\```

\## Calling the verification API

\```bash
curl -X POST https://verification.didit.me/v3/session/ \
-H "x-api-key: $DIDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"workflow_id":"<WORKFLOW_ID>","vendor_data":"user-42","callback":"https://myapp.com/return"}'
\```

\## Failure modes

\| Status | Meaning | Fix |
\|---|---|---|
\| `401` on verification.didit.me | `x-api-key` header wrong, malformed, revoked or expired | Re-fetch via the recover-key flow above, or use a key that has not expired |
\| `403` on verification.didit.me | No `x-api-key` header, a scoped key without access to this resource or action, or a key called from an address outside its IP list | Use a key with that access (Developers -> API keys in the console) |
\| `403` with `"code": "application_deleted"` on verification.didit.me | The key's application was deleted. You get this for a few minutes after the deletion; after that the key is refused like any invalid key | Do not retry: the application and its keys no longer exist. Use a key of an application that exists |
\| `404` on a session route | The session is outside the scoped key's workflows or statuses | Use a key whose limits include that session |
\| `403` on apx.didit.me | JWT `Authorization` header missing or expired | Call `POST /auth/v2/programmatic/login/` again |
\| `429` | Rate limit; response includes a `wait` field (seconds) | Back off, then retry |

\## Sources of truth
\- /openapi-auth.json — every account / org / app endpoint
\- /openapi-25.json — every verification endpoint
\- /integration/integration-prompt — end-to-end integration recipe````

\</pre>



      
      

Colar em

## Encontrar a sua chave de APINo Didit, as chaves de API estão associadas ao âmbito de uma **Aplicação** específica na sua conta. Uma Aplicação é um espaço de trabalho onde pode configurar fluxos e gerir verificações para um projeto ou ambiente específico.Cada Aplicação recebe uma chave de API primária com acesso total quando a cria. Pode adicionar mais chaves além desta, cada uma apenas com o acesso de que um serviço ou parceiro necessita. Para encontrar as suas chaves:**1. Iniciar sessão na Business Console**Aceda à [**Didit Business Console**](https://business.didit.me) e inicie sessão.**2. Selecionar a sua Aplicação**Escolha a **Aplicação** com a qual pretende trabalhar a partir do menu pendente no topo.**3. Abrir as chaves de API**Navegue até **Developers -> API keys** na barra lateral esquerda.**4. Copiar ou criar uma chave**A chave **Primária** é o segredo da própria Aplicação. Crie uma nova chave para atribuir a um serviço ou parceiro o seu próprio segredo, com o acesso de que necessita.> [!WARNING]
>
> **A sua chave de API é um segredo — trate-a como uma palavra-passe.**
>
> A chave primária concede acesso total à API em nome da sua Aplicação. Nunca a exponha em código de frontend, repositórios públicos ou bundles do lado do cliente. Mantenha-a sempre exclusivamente no lado do servidor.### Formato da chave de APIAs novas chaves de API começam com `sk_live_` para uma aplicação em produção ou `sk_test_` para uma aplicação em sandbox, seguidas de 43 carateres seguros para URL (letras, dígitos, `-` e `_`).
As chaves criadas antes deste formato não têm prefixo e continuam a funcionar sem alterações.
Envie a chave completa, prefixo incluído, no cabeçalho `x-api-key`, e não rejeite uma chave por não ter prefixo.## Encontrar o seu ID da organizaçãoO seu **ID da organização** é o UUID que identifica a sua organização. É utilizado em caminhos da API com âmbito de organização, tais como `/auth/v2/organizations/me/{org_id}/applications/`. Pode copiá-lo diretamente da Business Console, sem necessidade de efetuar chamadas de API:**1. Abrir as definições da organização**Na [**Didit Business Console**](https://business.didit.me), aceda a **Definições da Organização**.**2. Copiar o ID da organização**O campo **ID da organização** mostra o UUID da sua organização junto ao nome da mesma, com um botão para copiar para a área de transferência.***## Fazer pedidos autenticadosPara autenticar um pedido à API, inclua a sua chave de API secreta no cabeçalho HTTP `x-api-key`.Eis um exemplo de um pedido autenticado para o endpoint `Create Session`:```shell cURL theme={null}
curl --request POST \
     --url https://verification.didit.me/v3/session/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: YOUR_API_KEY' \
     --data '
{
  "workflow_id": "WORKFLOW_ID",
  "vendor_data": "USER_ID",
  "callback": "CALLBACK_URL"
}
'
```***## Tratamento de errosSe a sua chave de API estiver incorreta, malformada ou revogada, a API devolve `401 Unauthorized`:```json theme={null}
{
  "detail": "Authentication credentials were not provided or are invalid."
}
```Uma chave expirada também devolve `401`, com `"detail": "This API key has expired."`.
Um pedido sem chave devolve `403` com `"detail": "You do not have permission to perform this action."`.| Código de estado | Significado |
| - | - |
| **401** | A chave de API está incorreta, malformada, revogada ou expirada |
| **403** | Não foi enviada nenhuma chave de API, a chave não tem acesso ao recurso ou ação solicitada, ou o pedido teve origem num endereço fora da lista de IP da chave |
| **403** com `"code": "application_deleted"` | A chave pertence a uma aplicação que foi eliminada. A API responde com isto durante alguns minutos após a eliminação e, em seguida, recusa a chave como qualquer chave inválida. Não tente novamente: a aplicação e as suas chaves já não existem. |
| **404** | Numa rota de sessão: a sessão está fora dos fluxos ou estados da chave |A página [Erros da API](https://docs.didit.me/pt/integration/api-errors.md) lista todos os estados, corpos e códigos.***## Chaves de API com âmbito limitadoAtribua a cada serviço ou parceiro a sua própria chave em vez de partilhar a primária.
Cada chave tem o seu próprio nível de acesso a cada recurso: sem acesso, de leitura ou de escrita (sessões, decisões, ficheiros multimédia, pessoas, empresas, transações, fluxos, webhooks, definições da aplicação, analítica), e limites opcionais a determinados fluxos, apenas a sessões aprovadas, a uma lista de endereços IP e a uma data de validade.
Pode fazer a rotação de uma chave, mantendo uma sobreposição de 24 horas, e revogá-la de imediato.As chaves criadas antes da introdução do acesso com âmbito limitado mantêm o acesso total.Consulte [Chaves de API](https://docs.didit.me/pt/console/api-keys.md) para conhecer as predefinições, os recursos que cada uma abrange e como a API responde a uma chave com âmbito limitado.> [!TIP]
>
> Se receber um erro `401`, verifique se está a utilizar a chave de API correta para a Aplicação certa e confirme que esta não foi regenerada.


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