> ## 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 verificação de e-mail: obtenha credenciais Didit

> POST /programmatic/verify-email/ confirma o e-mail e retorna tokens de acesso, client_id e api_key da Didit. Onboarding para agentes, pago por uso.



Prompt para verificar e-mail e obter credenciais
        Copiar o prompt para a área de transferência



      
      

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



      
      

Colar em



## OpenAPI

````yaml pt-br/openapi-auth.json POST /programmatic/verify-email/
openapi: 3.0.0
info:
  version: 1.0.0
  title: Didit Auth API
  description: >-
    API de registro e autenticação programáticos para desenvolvedores e agentes
    de IA. Registre-se em 2 chamadas de API, sem precisar de navegador. A
    plataforma de verificação de identidade mais amigável para agentes.


    ## URL base


    Todos os endpoints desta especificação ficam hospedados em
    `https://apx.didit.me/auth/v2`. Esse host é diferente do host da API de
    verificação (`https://verification.didit.me/v3`). Não confunda os dois: este
    host de autenticação emite seus **tokens de acesso JWT** e permite listar e
    gerenciar suas **organizações** e **aplicações**. O host de verificação é
    onde você chama sessões, fluxos, AML etc., autenticando-se com a
    **`api_key`** retornada por esta API.


    ## Como funciona o fluxo de autenticação


    1. `POST /programmatic/register/`: envie e-mail + senha.

    2. Receba por e-mail um código alfanumérico de 6 caracteres.

    3. `POST /programmatic/verify-email/`: envie o código. Você recebe um
    `access_token` JWT, um `refresh_token`, uma organização e uma aplicação
    padrão com `client_id` + `api_key`.

    4. Guarde a `api_key`. Use-a como `x-api-key` em todas as chamadas para
    `https://verification.didit.me/v3/...`.

    5. Em qualquer máquina, no futuro, `POST /programmatic/login/` troca seu
    e-mail + senha por um JWT novo; depois chame `GET /organizations/me/` e os
    endpoints de aplicação para recuperar ou rotacionar credenciais.


    O JWT só é necessário para os endpoints de **Account Management** desta
    especificação; o tráfego da API de verificação usa a `api_key` de longa
    duração, não o JWT.


    ## Convenções


    - Todos os corpos de requisição e resposta são JSON (`Content-Type:
    application/json`).

    - **Use um endereço de e-mail real, que receba mensagens, ao testar `POST
    /programmatic/register/`.** O endpoint envia o código de verificação de
    forma síncrona, então endereços em domínios de teste reservados
    (`@example.com`, `@example.org`, `@*.test`, `@*.example`, `@*.invalid`) são
    recusados pela entrega de e-mail e a requisição retorna `500`. Substitua o
    placeholder `you@yourdomain.com` dos exemplos por uma caixa de entrada que
    você consiga ler de fato.

    - Erros de validação retornam HTTP `400` com um de dois envelopes:
    `{"field": ["message", ...]}` para problemas em nível de campo, ou
    `{"detail": "message"}` para erros de regra de negócio. Alguns validadores
    (força da senha no registro, expiração do código no verify-email) respondem
    atualmente com um array simples `["message"]` em vez do formato indexado por
    campo. Trata-se de uma inconsistência conhecida do lado do servidor, então o
    código do cliente deve aceitar os dois formatos.

    - Erros de autenticação retornam como `{"detail": "..."}` com HTTP `401`
    (bearer token inválido) ou `403` (bearer token ausente / privilégios
    insuficientes).

    - Respostas de limite de requisições incluem um campo `wait` com o tempo de
    espera em segundos.
servers:
  - url: https://apx.didit.me/auth/v2
    description: Servidor de autenticação de produção
security: []
tags:
  - name: Programmatic Auth
    description: >-
      Ciclo de vida da conta com e-mail e senha: registro, verificação e login.
      Retorna o `access_token` JWT que você usa nos endpoints de gerenciamento
      de conta, além (na verificação) do `client_id` e da `api_key` da sua
      primeira aplicação.
  - name: Account Management
    description: >-
      Endpoints autenticados (JWT bearer) que listam organizações e criam,
      consultam ou atualizam aplicações. Use-os para recuperar ou rotacionar a
      `api_key` com a qual você autentica as chamadas da API de verificação.
paths:
  /programmatic/verify-email/:
    post:
      tags:
        - Programmatic Auth
      summary: Verificar e-mail e emitir credenciais
      description: >-
        Etapa 2 do onboarding. Troca o código de 6 caracteres por uma conta
        verificada, uma organização e uma aplicação padrão, e um par de JWTs.
        Armazene a `api_key` retornada.
      operationId: programmatic_verify_email
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyEmailRequest'
            examples:
              Default:
                summary: Enviar o código do e-mail de cadastro
                value:
                  email: you@yourdomain.com
                  code: A3K9F2
      responses:
        '200':
          description: >-
            E-mail verificado. A resposta contém tokens para esta API de
            autenticação, além do `client_id` e da `api_key` da nova aplicação.
            Armazene a `api_key` com segurança: ela é a credencial de longa
            duração usada em todas as chamadas à API de verificação.
          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: >-
            Erro de validação. O envelope previsto é `{"field": ["..."]}` para
            problemas de campo e `{"detail": "..."}` para erros de regra de
            negócio (por exemplo, usuário não encontrado). Atualmente, os erros
            de código incorreto ou expirado respondem com um array simples
            `["Invalid or expired verification code."]`. Essa é uma
            inconsistência conhecida no servidor; trate a resposta como
            `{"code": ["..."]}` até que seja corrigida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              examples:
                MissingFields:
                  summary: Corpo vazio
                  value:
                    email:
                      - This field is required.
                    code:
                      - This field is required.
                CodeTooShort:
                  summary: Código com menos de 6 caracteres
                  value:
                    code:
                      - Ensure this field has at least 6 characters.
                InvalidEmail:
                  summary: E-mail com formato inválido
                  value:
                    email:
                      - Enter a valid email address.
                InvalidCode:
                  summary: Código incorreto ou expirado
                  value:
                    - Invalid or expired verification code.
                UserNotFound:
                  summary: Nenhuma conta pendente para esse e-mail
                  value:
                    detail: User not found.
        '429':
          description: >-
            O serviço está verificando momentaneamente o máximo de senhas ou
            códigos que consegue ao mesmo tempo. Enviado com o cabeçalho
            `Retry-After: 5`; tente novamente após o número de segundos
            indicado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
              examples:
                PasswordChecksBusy:
                  summary: Muitas verificações de senha em andamento
                  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: E-mail usado em `POST /programmatic/register/`.
          example: you@yourdomain.com
        code:
          type: string
          minLength: 6
          maxLength: 6
          description: >-
            Código alfanumérico de 6 caracteres do e-mail de verificação. Os
            códigos expiram 10 minutos após o envio do código mais recente.
          example: A3K9F2
    VerifyEmailResponse:
      type: object
      properties:
        access_token:
          type: string
          description: >-
            JWT assinado com RS256. Use como `Authorization: Bearer <token>` nos
            endpoints de Account Management em `apx.didit.me/auth/v2`.
        refresh_token:
          type: string
          description: Token de atualização associado ao token de acesso.
        expires_in:
          type: integer
          description: Tempo de vida do token de acesso em segundos (padrão 86400).
          example: 86400
        organization:
          $ref: '#/components/schemas/OrganizationSummary'
        application:
          $ref: '#/components/schemas/ApplicationCredentialsSummary'
    ValidationError:
      description: >-
        Corpo do erro de validação. O envelope previsto é um mapa `{field:
        ["message", ...]}` para erros no nível de campo ou um envelope de chave
        única `{detail: "..."}` para erros de regra de negócio. Alguns
        validadores (força da senha no cadastro, validade do código na
        verificação de e-mail) atualmente respondem com um array simples
        `["message"]`, uma inconsistência conhecida no servidor. O schema abaixo
        mantém essa ramificação de array simples para que o código de cliente
        gerado a partir desta especificação desserialize as respostas atuais,
        mas o novo código de cliente deve tratá-la como a forma correspondente
        com chave de campo (`{password: [...]}` ou `{code: [...]}`), e o
        contrato do servidor vai convergir para esse formato.
      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: >-
        Resposta de limite de requisições ou de bloqueio progressivo. `wait` é o
        tempo de espera em segundos.
      properties:
        detail:
          type: string
          example: >-
            Too many login attempts from this IP address. Please wait before
            trying again.
    OrganizationSummary:
      type: object
      description: >-
        Formato mínimo da organização retornado diretamente por `POST
        /programmatic/verify-email/`.
      properties:
        uuid:
          type: string
          format: uuid
          example: a1b2c3d4-5678-90ab-cdef-111111111111
        name:
          type: string
          example: developer
    ApplicationCredentialsSummary:
      type: object
      description: >-
        Formato mínimo da aplicação retornado diretamente por `POST
        /programmatic/verify-email/`. Salve a `api_key` imediatamente.
      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: >-
            Use isto como `x-api-key` em todas as chamadas da API de
            verificação. Novas chaves começam com `sk_live_` (aplicação de
            produção) ou `sk_test_` (aplicação de sandbox), seguidas de 43
            caracteres seguros para URL (letras, dígitos, `-` e `_`). Chaves
            criadas antes deste formato não têm prefixo e continuam funcionando
            sem alterações.
          example: sk_live_example_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

````

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