> ## 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: Obter Credenciais Didit

> Confirme o e-mail com POST /programmatic/verify-email/ e receba tokens, client_id e api_key da Didit. Preço por utilização.



Prompt para verificar o 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",
"data_location": "eu"
}
}

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, in the European Union (data_location "eu"). Its location can be chosen once with PATCH /organizations/me/{org_id}/applications/{app_id}/ before the application is used; see /auth-api/update-application.
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/openapi-auth.json POST /programmatic/verify-email/
openapi: 3.0.0
info:
  version: 1.0.0
  title: Didit Auth API
  description: >-
    API de registo e autenticação programática para programadores e agentes de
    IA. Registe-se em 2 chamadas de API -- sem necessidade de navegador. A
    plataforma de verificação de identidade mais adaptada a agentes.


    ## URL base


    Todos os endpoints nesta especificação estão alojados em
    `https://apx.didit.me/auth/v2`. Este é um anfitrião diferente da API de
    verificação (`https://verification.didit.me/v3`). Não os confunda: este
    anfitrião de autenticação emite os seus **tokens de acesso JWT** e permite
    listar e gerir as suas **organizações** e **aplicações**. O anfitrião de
    verificação é onde chama sessões, fluxos, AML, etc., utilizando a
    **`api_key`** devolvida por esta API.


    ## Como funciona o fluxo de autenticação


    1. `POST /programmatic/register/` — envie e-mail + palavra-passe.

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

    3. `POST /programmatic/verify-email/` — envie o código. Recebe de volta um
    `access_token` JWT, um `refresh_token`, uma organização e uma aplicação
    predefinida com `client_id` + `api_key`.

    4. Guarde a `api_key`. Utilize-a como `x-api-key` em cada chamada para
    `https://verification.didit.me/v3/...`.

    5. A partir de qualquer máquina futura, `POST /programmatic/login/` troca o
    seu e-mail + palavra-passe por um novo JWT; em seguida, chame `GET
    /organizations/me/` e os endpoints de aplicações para recuperar ou renovar
    credenciais.


    O JWT só é necessário para os endpoints de **Gestão de contas** nesta
    especificação; o tráfego da API de verificação utiliza a `api_key` de longa
    duração, não o JWT.


    ## Convenções


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

    - **Utilize um endereço de e-mail real e operacional ao testar `POST
    /programmatic/register/`.** O endpoint envia o código de verificação de
    forma síncrona, pelo que endereços em domínios de teste reservados
    (`@example.com`, `@example.org`, `@*.test`, `@*.example`, `@*.invalid`) são
    recusados pela entrega de correio e o pedido devolve um `500`. Substitua o
    marcador de posição `you@yourdomain.com` nos exemplos por uma caixa de
    entrada que possa realmente consultar.

    - Os erros de validação devolvem HTTP `400` com um de dois formatos:
    `{"field": ["message", ...]}` para problemas a nível de campo, ou
    `{"detail": "message"}` para erros de regras de negócio. Alguns validadores
    (força da palavra-passe no registo, expiração do código na verificação de
    e-mail) respondem atualmente com um array simples `["message"]` em vez do
    formato indexado por campo -- esta é uma inconsistência conhecida do lado do
    servidor, pelo que o código do cliente deve aceitar ambos os formatos.

    - Os erros de autenticação são devolvidos como `{"detail": "..."}` com HTTP
    `401` (token de portador inválido) ou `403` (token de portador em falta /
    permissões insuficientes).

    - As respostas de limite de pedidos 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 de conta com e-mail e palavra-passe: registar, verificar,
      iniciar sessão. Devolve o `access_token` JWT que utiliza nos endpoints de
      Gestão de Contas, além de (na verificação) o `client_id` e a `api_key` da
      sua primeira aplicação.
  - name: Account Management
    description: >-
      Endpoints autenticados (JWT bearer) que listam organizações e criam, obtêm
      ou atualizam aplicações. Utilize-os para recuperar ou rodar a `api_key`
      com a qual autentica as chamadas à API de verificação.
paths:
  /programmatic/verify-email/:
    post:
      tags:
        - Programmatic Auth
      summary: Verificar e-mail e emitir credenciais
      description: >-
        Passo 2 do onboarding. Troca o código de 6 carateres por uma conta
        verificada, uma organização e aplicação predefinidas e um par JWT.
        Guarde a `api_key` devolvida.
      operationId: programmatic_verify_email
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyEmailRequest'
            examples:
              Default:
                summary: Submeter o código do e-mail de registo
                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 novíssima
            aplicação. Guarde a `api_key` de forma segura — é a credencial de
            longa duração utilizada por 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
                      data_location: eu
        '400':
          description: >-
            Erro de validação. O envelope previsto é `{"field": ["..."]}` para
            problemas ao nível do campo e `{"detail": "..."}` para erros de
            regras de negócio (por exemplo, utilizador não encontrado). Os erros
            de código incorreto ou expirado respondem atualmente com um array
            simples `["Invalid or expired verification code."]` --
            inconsistência conhecida do lado do servidor; trate-o como `{"code":
            ["..."]}` até ser corrigido.
          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 carateres
                  value:
                    code:
                      - Ensure this field has at least 6 characters.
                InvalidEmail:
                  summary: E-mail mal formatado
                  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á momentaneamente a verificar tantas palavras-passe ou
            códigos quantos consegue de uma só vez. Enviado com um cabeçalho
            `Retry-After: 5`; tente novamente após o número indicado de
            segundos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
              examples:
                PasswordChecksBusy:
                  summary: Demasiadas verificações de palavra-passe em 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: E-mail utilizado durante `POST /programmatic/register/`.
          example: you@yourdomain.com
        code:
          type: string
          minLength: 6
          maxLength: 6
          description: >-
            Código alfanumérico de 6 carateres 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. Utilize como `Authorization: Bearer <token>`
            para os endpoints de Gestão de Contas em `apx.didit.me/auth/v2`.
        refresh_token:
          type: string
          description: Token de atualização emparelhado com o 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 pretendido é um mapa `{field:
        ["message", ...]}` para erros ao nível do campo ou um envelope de chave
        única `{detail: "..."}` para erros de regras de negócio. Um pequeno
        número de validadores (força da palavra-passe no registo, validade do
        código no verify-email) responde atualmente com um array simples
        `["message"]` -- inconsistência conhecida do lado do servidor. O esquema
        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á-lo sob a forma relevante
        indexada por campo (`{password: [...]}` ou `{code: [...]}`) e o contrato
        do servidor convergirá para essa estrutura.
      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 pedidos ou 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: >-
        Estrutura mínima da organização devolvida em linha 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: >-
        Estrutura mínima da aplicação devolvida em linha por `POST
        /programmatic/verify-email/`. Guarde 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: >-
            Utilize isto como `x-api-key` em todas as chamadas à API de
            verificação. As chaves novas começam por `sk_live_` (aplicação de
            produção) ou `sk_test_` (aplicação de 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.
          example: sk_live_example_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        data_location:
          $ref: '#/components/schemas/ApplicationDataLocation'
    ApplicationDataLocation:
      type: string
      enum:
        - eu
        - au
        - mx
      description: >-
        Onde os dados de verificação da aplicação são armazenados e processados,
        sendo o local selecionado quando a aplicação é criada. `eu` é a União
        Europeia (Irlanda), o padrão. `au` (Austrália, Sydney) e `mx` (México)
        estarão disponíveis em breve: um pedido que os indique responde 400
        `This data location is not available yet.` A aplicação Sandbox de uma
        organização está sempre na União Europeia.
      example: eu

````

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