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

# Autenticación de la API: solicitudes seguras a la API KYC

> Autentica las solicitudes a la API de Didit con una clave de API en el encabezado x-api-key. Clave incorrecta o expirada: 401; sin clave: 403.



Prompt de autenticación de la API
        Copiar el prompt al portapapeles



      
      

\<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>



      
      

Pegar en

## Dónde encontrar tu clave de APIEn Didit, las claves de API están asociadas a una **Application** concreta de tu cuenta. Una Aplicación es un espacio de trabajo donde puedes configurar flujos de trabajo y gestionar las verificaciones de un proyecto o entorno determinado.Cada Aplicación recibe al crearse una clave de API principal con acceso completo. Puedes añadir más claves junto a ella, cada una con solo el acceso que necesita un servicio o un socio. Para encontrar tus claves:**1. Inicia sesión en la Business Console**Ve a la [**Didit Business Console**](https://business.didit.me) e inicia sesión.**2. Selecciona tu Aplicación**Elige la **Application** con la que quieres trabajar en el menú desplegable de la parte superior.**3. Abre las claves de API**Ve a **Developers -> API keys** en la barra lateral izquierda.**4. Copia o crea una clave**La clave **Primary** es el secreto propio de la Aplicación. Crea una clave nueva para darle a un servicio o a un socio su propio secreto, con el acceso que necesita.> [!WARNING]
>
> **Tu clave de API es un secreto: trátala como una contraseña.**
>
> La clave principal da acceso completo a la API en nombre de tu Aplicación. Nunca la expongas en código frontend, repositorios públicos ni bundles del lado del cliente. Guárdala siempre solo en el servidor.### Formato de la clave de APILas claves de API nuevas empiezan por `sk_live_` en una aplicación de producción o por `sk_test_` en una aplicación de sandbox, seguidas de 43 caracteres aptos para URL (letras, dígitos, `-` y `_`).
Las claves creadas antes de este formato no tienen prefijo y siguen funcionando sin cambios.
Envía la clave completa, con el prefijo incluido, en el encabezado `x-api-key`, y no rechaces una clave por no tener prefijo.## Dónde encontrar el ID de tu organizaciónEl **ID de la organización** es el UUID que identifica a tu organización. Lo usas en rutas de la API asociadas a la organización, como `/auth/v2/organizations/me/{org_id}/applications/`. Puedes copiarlo directamente desde la Business Console, sin necesidad de llamar a la API:**1. Abre la configuración de la organización**En la [**Didit Business Console**](https://business.didit.me), ve a **Configuración de la organización**.**2. Copia el ID de la organización**El campo **ID de la organización** muestra el UUID de tu organización junto a su nombre, con un botón para copiarlo al portapapeles.***## Cómo hacer solicitudes autenticadasPara autenticar una solicitud a la API, incluye tu clave de API secreta en el encabezado HTTP `x-api-key`.Este es un ejemplo de solicitud autenticada al 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"
}
'
```***## Gestión de erroresSi tu clave de API es incorrecta, tiene un formato no válido o ha sido revocada, la API devuelve `401 Unauthorized`:```json theme={null}
{
  "detail": "Authentication credentials were not provided or are invalid."
}
```Una clave expirada también devuelve `401`, con `"detail": "This API key has expired."`.
Una solicitud sin clave devuelve `403` con `"detail": "You do not have permission to perform this action."`.| Código de estado | Significado |
| - | - |
| **401** | La clave de API es incorrecta, tiene un formato no válido, ha sido revocada o ha expirado |
| **403** | No se envió ninguna clave de API, la clave no tiene acceso al recurso o a la acción solicitados, o la solicitud procede de una dirección fuera de la lista de IP de la clave |
| **403** con `"code": "application_deleted"` | La clave pertenece a una aplicación que se ha eliminado. La API devuelve esta respuesta durante unos minutos tras la eliminación y después rechaza la clave como cualquier clave no válida. No reintentes: la aplicación y sus claves ya no existen. |
| **404** | En una ruta de sesión: la sesión está fuera de los flujos o estados de la clave |La página de [errores de la API](https://docs.didit.me/es/integration/api-errors.md) recoge todos los estados, cuerpos y códigos.***## Claves de API con alcance limitadoDa a cada servicio o socio su propia clave en lugar de compartir la principal.
Cada clave tiene su propio acceso: ninguno, lectura o escritura para cada recurso (sesiones, decisiones, archivos multimedia, personas, empresas, transacciones, flujos, webhooks, configuración de la aplicación, analíticas), y límites opcionales a algunos flujos, solo a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad.
Puedes rotar una clave con un solapamiento de 24 horas y revocarla al instante.Las claves creadas antes de que existiera el acceso con alcance limitado conservan el acceso completo.Consulta [Claves de API](https://docs.didit.me/es/console/api-keys.md) para ver los ajustes predefinidos, los recursos que cubre cada uno y cómo responde la API cuando se usa una clave con alcance limitado.> [!TIP]
>
> Si recibes un error `401`, comprueba que estás usando la clave de API correcta para la aplicación adecuada y que no se ha regenerado.


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