> ## 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 verificación de email: obtén credenciales de Didit

> Con POST /programmatic/verify-email/ Didit confirma el email y entrega tokens de acceso, client_id y api_key. Onboarding para agentes, pago por uso.



Prompt para verificar el correo electrónico y obtener credenciales
        Copiar el prompt al portapapeles



      
      

\<pre>

\`Exchange the email verification code for usable Didit credentials — step 2 of programmatic onboarding.

Endpoint:
POST https://apx.didit.me/auth/v2/programmatic/verify-email/

Authentication:
None. The email + code pair is the credential.

Request body:
\- email (string, required) — Same email used in /programmatic/register/.
\- code (string, required) — 6-character alphanumeric code from the registration email (e.g. "A3K9F2"). Valid for 15 minutes.

curl example:
curl -X POST https://apx.didit.me/auth/v2/programmatic/verify-email/ \
-H "Content-Type: application/json" \
-d '{
"email": "you@yourdomain.com",
"code": "A3K9F2"
}'

Response (200 OK):
\{
"access_token": "eyJ...RS256 JWT",
"refresh_token": "eyJ...RS256 JWT",
"expires_in": 86400,
"organization": {
"uuid": "a1b2c3d4-5678-...",
"name": "you"
},
"application": {
"uuid": "b2c3d4e5-6789-...",
"name": "you",
"client_id": "S9LIYGSoWNuGMLHsvEt9dQ",
"api_key": "sk_live_example_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}

What happens server-side:
1\. The pending account is marked email-verified.
2\. A default organization is created (named after the local part of the email, e.g. "you" from "you@yourdomain.com").
3\. A default application is created inside the organization with a fresh client_id and api_key.
4\. JWTs are issued (RS256, default 24h / 86400 seconds lifetime).

How to use the response:
\- application.api_key → set as the x-api-key header on EVERY call to https://verification.didit.me/v3/... (sessions, workflows, questionnaires, billing, etc.). PERSIST IT SECURELY. You can read it again later with GET /organizations/me/{org_id}/applications/{app_id}/.
\- access_token → use as "Authorization: Bearer <access_token>" against Account Management endpoints on https://apx.didit.me/auth/v2 (e.g. to create more applications).
\- refresh_token → exchange for a new access_token after expiry.

Save the api_key, the organization.uuid (org_id), and the application.uuid (app_id) — you will need all three to manage applications later.

Failure modes (400 unless noted):
\- Field-level: { "email": ["Enter a valid email address."] } or { "code": ["Ensure this field has at least 6 characters."] }.
\- Wrong or expired code CURRENTLY returns a BARE ARRAY ["Invalid or expired verification code."] — known server-side inconsistency; treat as { "code": [...] } client-side.
\- Unknown email: { "detail": "User not found." }

Recovery if you lose the api_key later:
Call POST /programmatic/login/ with email + password to get a fresh access_token, then GET /organizations/me/{org_id}/applications/{app_id}/ to read the api_key back. See /auth-api/login and /auth-api/get-credentials.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\</pre>



      
      

Pegar en



## OpenAPI

````yaml es/openapi-auth.json POST /programmatic/verify-email/
openapi: 3.0.0
info:
  version: 1.0.0
  title: Didit Auth API
  description: >-
    API de registro y autenticación programáticos para desarrolladores y agentes
    de IA. Regístrate en 2 llamadas a la API, sin necesidad de navegador. La
    plataforma de verificación de identidad más adaptada a los agentes.


    ## URL base


    Todos los endpoints de esta especificación están alojados en
    `https://apx.didit.me/auth/v2`. Es un host distinto al de la API de
    verificación (`https://verification.didit.me/v3`). No los confundas: este
    host de autenticación emite tus **tokens de acceso JWT** y te permite listar
    y gestionar tus **organizaciones** y **aplicaciones**. El host de
    verificación es donde llamas a sesiones, flujos, AML, etc., autenticándote
    con la **`api_key`** que devuelve esta API.


    ## Cómo funciona el flujo de autenticación


    1. `POST /programmatic/register/`: envía el correo electrónico y la
    contraseña.

    2. Recibe por correo electrónico un código alfanumérico de 6 caracteres.

    3. `POST /programmatic/verify-email/`: envía el código. Recibes un
    `access_token` JWT, un `refresh_token`, una organización y una aplicación
    predeterminada con `client_id` y `api_key`.

    4. Guarda la `api_key`. Úsala como `x-api-key` en cada llamada a
    `https://verification.didit.me/v3/...`.

    5. Desde cualquier equipo en el futuro, `POST /programmatic/login/`
    intercambia tu correo electrónico y contraseña por un JWT nuevo; después
    llama a `GET /organizations/me/` y a los endpoints de aplicaciones para
    recuperar o rotar las credenciales.


    El JWT solo es necesario para los endpoints de **gestión de la cuenta** de
    esta especificación; el tráfico de la API de verificación usa la `api_key`
    de larga duración, no el JWT.


    ## Convenciones


    - Todos los cuerpos de solicitud y respuesta son JSON (`Content-Type:
    application/json`).

    - **Usa una dirección de correo electrónico real y que pueda recibir
    mensajes cuando pruebes `POST /programmatic/register/`.** El endpoint envía
    el código de verificación de forma síncrona, por lo que el servicio de
    entrega de correo rechaza las direcciones de dominios de prueba reservados
    (`@example.com`, `@example.org`, `@*.test`, `@*.example`, `@*.invalid`) y la
    solicitud devuelve un `500`. Sustituye el marcador `you@yourdomain.com` de
    los ejemplos por una bandeja de entrada que puedas leer.

    - Los errores de validación devuelven HTTP `400` con uno de dos formatos:
    `{"field": ["message", ...]}` para problemas a nivel de campo, o `{"detail":
    "message"}` para errores de reglas de negocio. Algunos validadores (la
    robustez de la contraseña en el registro y la caducidad del código en
    verify-email) responden actualmente con un array simple `["message"]` en
    lugar del formato con claves por campo; es una incoherencia conocida del
    servidor, por lo que el código cliente debe aceptar ambos formatos.

    - Los errores de autenticación se devuelven como `{"detail": "..."}` con
    HTTP `401` (token bearer no válido) o `403` (falta el token bearer o los
    privilegios son insuficientes).

    - Las respuestas de límite de solicitudes incluyen un campo `wait` con el
    tiempo de espera en segundos.
servers:
  - url: https://apx.didit.me/auth/v2
    description: Servidor de autenticación de producción
security: []
tags:
  - name: Programmatic Auth
    description: >-
      Ciclo de vida de la cuenta con correo electrónico y contraseña: registro,
      verificación e inicio de sesión. Devuelve el `access_token` JWT que usas
      con los endpoints de gestión de cuentas y, además (al verificar), el
      `client_id` y la `api_key` de tu primera aplicación.
  - name: Account Management
    description: >-
      Endpoints autenticados (JWT bearer) que listan organizaciones y crean,
      obtienen o actualizan aplicaciones. Úsalos para recuperar o rotar la
      `api_key` con la que autenticas las llamadas a la API de verificación.
paths:
  /programmatic/verify-email/:
    post:
      tags:
        - Programmatic Auth
      summary: Verificar el correo electrónico y emitir credenciales
      description: >-
        Paso 2 del onboarding. Canjea el código de 6 caracteres por una cuenta
        verificada, una organización y una aplicación predeterminadas y un par
        de JWT. Guarda el `api_key` devuelto.
      operationId: programmatic_verify_email
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyEmailRequest'
            examples:
              Default:
                summary: Enviar el código del correo electrónico de registro
                value:
                  email: you@yourdomain.com
                  code: A3K9F2
      responses:
        '200':
          description: >-
            Correo electrónico verificado. La respuesta contiene los tokens para
            esta API de autenticación, además del `client_id` y la `api_key` de
            la aplicación recién creada. Guarda la `api_key` de forma segura: es
            la credencial de larga duración que se usa en todas las llamadas a
            la API de verificación.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyEmailResponse'
              examples:
                Success:
                  value:
                    access_token: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
                    refresh_token: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
                    expires_in: 86400
                    organization:
                      uuid: a1b2c3d4-5678-90ab-cdef-111111111111
                      name: developer
                    application:
                      uuid: b2c3d4e5-6789-01bc-defg-222222222222
                      name: developer
                      client_id: S9LIYGSoWNuGMLHsvEt9dQ
                      api_key: sk_live_example_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        '400':
          description: >-
            Error de validación. El formato previsto es `{"field": ["..."]}`
            para los problemas de campo y `{"detail": "..."}` para los errores
            de reglas de negocio (por ejemplo, usuario no encontrado). Los
            errores de código incorrecto o expirado responden actualmente con un
            array simple `["Invalid or expired verification code."]`; es una
            inconsistencia conocida del servidor, así que trátalo como `{"code":
            ["..."]}` hasta que se corrija.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              examples:
                MissingFields:
                  summary: Cuerpo vacío
                  value:
                    email:
                      - This field is required.
                    code:
                      - This field is required.
                CodeTooShort:
                  summary: Código de menos de 6 caracteres
                  value:
                    code:
                      - Ensure this field has at least 6 characters.
                InvalidEmail:
                  summary: Correo electrónico con formato incorrecto
                  value:
                    email:
                      - Enter a valid email address.
                InvalidCode:
                  summary: Código incorrecto o expirado
                  value:
                    - Invalid or expired verification code.
                UserNotFound:
                  summary: No hay ninguna cuenta pendiente para ese correo electrónico
                  value:
                    detail: User not found.
        '429':
          description: >-
            El servicio está comprobando en este momento tantas contraseñas o
            códigos como puede a la vez. Se envía con un encabezado
            `Retry-After: 5`; vuelve a intentarlo tras el número de segundos
            indicado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
              examples:
                PasswordChecksBusy:
                  summary: Demasiadas comprobaciones de contraseña en curso
                  value:
                    detail: >-
                      Too many sign-in attempts are being processed right now.
                      Please try again in a few seconds.
      security:
        - {}
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >-
            curl -X POST https://apx.didit.me/auth/v2/programmatic/verify-email/
            \
              -H "Content-Type: application/json" \
              -d '{
                "email": "you@yourdomain.com",
                "code": "A3K9F2"
              }'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # This call needs no API key.
            client = Didit()

            result = client.account.verify_email(
                email="you@yourdomain.com",
                code="A3K9F2",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // This call needs no API key.
            const didit = new Didit();

            const result = await didit.account.verifyEmail({
              email: "you@yourdomain.com",
              code: "A3K9F2",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// This call needs no API key.\nclient := didit.NewClient()\n\nresult, err := client.Account.VerifyEmail(ctx, didit.VerifyEmailRequest{\n\tEmail: \"you@yourdomain.com\",\n\tCode:  \"A3K9F2\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.VerifyEmailRequest;


            // This call needs no API key.

            Didit client = new Didit();


            var result =
            client.account().verifyEmail(VerifyEmailRequest.builder()
                    .email("you@yourdomain.com")
                    .code("A3K9F2")
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // This call needs no API key.
            $didit = new DiditClient();

            $result = $didit->account->verifyEmail([
                'email' => 'you@yourdomain.com',
                'code' => 'A3K9F2',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # This call needs no API key.
            didit = Didit::Client.new

            result = didit.account.verify_email(
              email: "you@yourdomain.com",
              code: "A3K9F2"
            )
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // This call needs no API key.

            using var client = new DiditClient();


            var result = await client.Account.VerifyEmailAsync(new
            VerifyEmailRequest

            {
                Email = "you@yourdomain.com",
                Code = "A3K9F2",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    VerifyEmailRequest:
      type: object
      required:
        - email
        - code
      properties:
        email:
          type: string
          format: email
          description: Correo electrónico usado durante `POST /programmatic/register/`.
          example: you@yourdomain.com
        code:
          type: string
          minLength: 6
          maxLength: 6
          description: >-
            Código alfanumérico de 6 caracteres del correo de verificación. Los
            códigos expiran 10 minutos después del envío del código más
            reciente.
          example: A3K9F2
    VerifyEmailResponse:
      type: object
      properties:
        access_token:
          type: string
          description: >-
            JWT firmado con RS256. Úsalo como `Authorization: Bearer <token>`
            para los endpoints de gestión de cuentas en `apx.didit.me/auth/v2`.
        refresh_token:
          type: string
          description: Token de actualización asociado al token de acceso.
        expires_in:
          type: integer
          description: >-
            Vida útil del token de acceso en segundos (valor predeterminado:
            86400).
          example: 86400
        organization:
          $ref: '#/components/schemas/OrganizationSummary'
        application:
          $ref: '#/components/schemas/ApplicationCredentialsSummary'
    ValidationError:
      description: >-
        Cuerpo del error de validación. El formato previsto es un mapa `{field:
        ["message", ...]}` para los errores a nivel de campo o un formato de una
        sola clave `{detail: "..."}` para los errores de reglas de negocio.
        Algunos validadores (la seguridad de la contraseña en el registro y la
        validez del código en la verificación del correo electrónico) responden
        actualmente con un array simple `["message"]`: es una inconsistencia
        conocida del servidor. El esquema siguiente conserva esa variante de
        array simple para que el código cliente generado a partir de esta
        especificación deserialice las respuestas actuales, pero el código
        cliente nuevo debe tratarla como la forma indexada por el campo
        correspondiente (`{password: [...]}` o `{code: [...]}`), y el contrato
        del servidor convergerá en esa forma.
      oneOf:
        - type: object
          additionalProperties:
            type: array
            items:
              type: string
          example:
            email:
              - Enter a valid email address.
        - type: object
          properties:
            detail:
              type: string
          example:
            detail: An account with this email already exists.
        - type: array
          items:
            type: string
          example:
            - Invalid or expired verification code.
    RateLimitError:
      type: object
      description: >-
        Respuesta de límite de solicitudes o de bloqueo progresivo. `wait` es el
        tiempo de espera en segundos.
      properties:
        detail:
          type: string
          example: >-
            Too many login attempts from this IP address. Please wait before
            trying again.
    OrganizationSummary:
      type: object
      description: >-
        Estructura mínima de la organización que `POST
        /programmatic/verify-email/` devuelve directamente en la respuesta.
      properties:
        uuid:
          type: string
          format: uuid
          example: a1b2c3d4-5678-90ab-cdef-111111111111
        name:
          type: string
          example: developer
    ApplicationCredentialsSummary:
      type: object
      description: >-
        Estructura mínima de la aplicación que `POST
        /programmatic/verify-email/` devuelve directamente en la respuesta.
        Guarda la `api_key` de inmediato.
      properties:
        uuid:
          type: string
          format: uuid
          example: b2c3d4e5-6789-01bc-defg-222222222222
        name:
          type: string
          example: developer
        client_id:
          type: string
          example: S9LIYGSoWNuGMLHsvEt9dQ
        api_key:
          type: string
          description: >-
            Úsala como `x-api-key` en cada llamada a la API de verificación. Las
            claves nuevas empiezan por `sk_live_` (aplicación de producción) o
            `sk_test_` (aplicación de sandbox), seguidas de 43 caracteres
            seguros para URL (letras, dígitos, `-` y `_`). Las claves creadas
            antes de este formato no tienen prefijo y siguen funcionando sin
            cambios.
          example: sk_live_example_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

````

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