> ## 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 Login Programático: Tokens de Autenticação

> POST /programmatic/login/ da Didit: autenticação headless. Devolve tokens de acesso diretamente, sem 2FA. Para agentes e MCP, preço por utilização.



Prompt de início de sessão programático
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`Exchange a verified Didit account's email + password for a fresh JWT access token (headless, no browser).

Endpoint:
POST https://apx.didit.me/auth/v2/programmatic/login/

Authentication:
None. Email + password is the credential.

Request body:
\- email (string, required) — Same email used at /programmatic/register/.
\- password (string, required) — Plain password (HTTPS only).

Account requirements:
The account must have a verified email and password. Accounts created through POST /programmatic/register/ work immediately after email verification. Console-created email/password accounts can also use this endpoint. OAuth-only console accounts must set a password first.

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

Response (200 OK):
\- access_token (string) — RS256 JWT. Pass as "Authorization: Bearer <access_token>" on every Account Management endpoint at apx.didit.me/auth/v2. DO NOT use against verification.didit.me — that host uses x-api-key.
\- refresh_token (string) — RS256 JWT for refresh flows.
\- expires_in (integer) — Default 86400 (24 hours).

Token shape:
\- 24-hour default lifetime.
\- RS256-signed.
\- No browser session is required.

Brute-force protection:
\- Progressive account lockout per email: 5 consecutive failures = 15 min lockout, 10 = 1 hour, 20 = 24 hours.
\- Per-IP rate limit: 20 attempts/minute and 100 attempts/hour.

Failure modes:
\- 400 — { "email": ["..."] } / { "password": ["..."] } field-level errors.
\- 401 — { "detail": "Invalid email or password." }
\- 403 — { "detail": "..." } when SSO policy blocks password login for the account.
\- 429 — { "detail": "Too many login attempts.", "wait": <seconds> } on lockout or per-IP limit. Honour the wait value before retrying.

Recovering your api_key:
After a successful login, call GET /organizations/me/ to enumerate organizations and applications, then GET /organizations/me/{org_id}/applications/{app_id}/ to read the api_key — see /auth-api/get-credentials.

Where to use access_token vs api_key:
\- access_token (Bearer) → https://apx.didit.me/auth/v2/... (org / app management).
\- api_key (x-api-key) → https://verification.didit.me/v3/... (sessions, workflows, billing).

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/login/
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/login/:
    post:
      tags:
        - Programmatic Auth
      summary: Autenticação programática
      description: >-
        Autentique qualquer conta Didit de e-mail/palavra-passe verificada e
        receba um par de JWT RS256 (tempo de vida predefinido de 86400s). Contas
        de e-mail/palavra-passe criadas na consola podem usar este endpoint;
        contas da consola apenas com OAuth devem definir uma palavra-passe
        primeiro.
      operationId: programmatic_login
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginRequest'
            examples:
              Default:
                summary: Autenticação programática
                value:
                  email: you@yourdomain.com
                  password: MyStr0ng!Pass
      responses:
        '200':
          description: >-
            Início de sessão bem-sucedido. Devolve um par JWT novo. Utilize o
            `access_token` como `Authorization: Bearer <token>` em
            `/organizations/me/...` para consultar o `org_id`, `app_id` e
            `api_key`. Quando a conta tem uma aplicação autenticadora ou uma
            passkey, a resposta inclui `2fa_required: true` e um `temp_token` em
            vez dos tokens.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
              examples:
                Success:
                  value:
                    access_token: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
                    refresh_token: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
                    expires_in: 86400
                    message: Login successful
        '400':
          description: Erro de validação. Problemas ao nível do campo no corpo do pedido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              examples:
                MissingFields:
                  summary: Corpo vazio
                  value:
                    email:
                      - This field is required.
                    password:
                      - This field is required.
                InvalidEmail:
                  summary: E-mail mal formatado
                  value:
                    email:
                      - Enter a valid email address.
        '401':
          description: Autenticação recusada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthError'
              examples:
                InvalidCredentials:
                  summary: >-
                    E-mail + palavra-passe não correspondem (também devolvido
                    quando a conta não existe, para evitar a enumeração de
                    utilizadores)
                  value:
                    detail: Invalid email or password.
                NotVerified:
                  summary: A conta existe, mas o e-mail ainda não foi verificado
                  value:
                    detail: Please verify your email address before logging in.
                SSORequired:
                  summary: A conta pertence a uma organização que exige SSO
                  value:
                    detail:
                      error: sso_required
                      message: Your organization 'Acme Corp' requires SSO login.
                      organization_name: Acme Corp
                      organization_slug: acme-corp
                      sso_url: /sso/acme-corp
        '403':
          description: >-
            A conta foi recuperada e tem de configurar um novo método de início
            de sessão antes de poder iniciar sessão. Foi enviada uma ligação por
            e-mail para o endereço da conta para o fazer. Uma conta cuja
            organização imponha SSO recebe `403` com `error: sso_required`,
            `organization_name`, `organization_slug` e `sso_url`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecoverySetupRequiredError'
              examples:
                RecoverySetupRequired:
                  summary: Conta recuperada ainda sem método de início de sessão
                  value:
                    recovery_setup_required: true
                    setup_link_sent: true
                    message: >-
                      You recovered your account. Open the link we emailed you
                      to set up a new sign-in method.
                    code: recovery_setup_required
        '429':
          description: >-
            Conta bloqueada (demasiadas falhas recentes neste e-mail) ou IP com
            limite de pedidos atingido (demasiadas tentativas a partir deste
            endereço). Também devolvido, com um cabeçalho `Retry-After: 5`,
            quando o serviço está momentaneamente a verificar o número máximo de
            palavras-passe ou códigos em simultâneo; tente novamente após o
            número de segundos indicado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
              examples:
                AccountLocked:
                  summary: Bloqueio progressivo acionado
                  value:
                    detail: >-
                      Account temporarily locked due to too many failed login
                      attempts. Please try again later.
                IPRateLimited:
                  summary: Mais de 20/min ou 100/hora a partir deste endereço IP
                  value:
                    detail: >-
                      Too many login attempts from this IP address. Please wait
                      before trying again.
                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/login/ \
              -H "Content-Type: application/json" \
              -d '{
                "email": "you@yourdomain.com",
                "password": "MyStr0ng!Pass"
              }'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

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

            result = client.account.login(
                email="you@yourdomain.com",
                password="MyStr0ng!Pass",
            )
            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.login({
              email: "you@yourdomain.com",
              password: "MyStr0ng!Pass",
            });
            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.Login(ctx, didit.LoginRequest{\n\tEmail:    \"you@yourdomain.com\",\n\tPassword: \"MyStr0ng!Pass\",\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.LoginRequest;

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

            var result = client.account().login(LoginRequest.builder()
                    .email("you@yourdomain.com")
                    .password("MyStr0ng!Pass")
                    .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->login([
                'email' => 'you@yourdomain.com',
                'password' => 'MyStr0ng!Pass',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.account.login(
              email: "you@yourdomain.com",
              password: "MyStr0ng!Pass"
            )
            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.LoginAsync(new LoginRequest
            {
                Email = "you@yourdomain.com",
                Password = "MyStr0ng!Pass",
            });
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    LoginRequest:
      type: object
      required:
        - email
        - password
      properties:
        email:
          type: string
          format: email
          example: you@yourdomain.com
        password:
          type: string
          example: MyStr0ng!Pass
    LoginResponse:
      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.
        refresh_token:
          type: string
        expires_in:
          type: integer
          description: 'Tempo de vida do token de acesso em segundos (padrão: 86400).'
          example: 86400
        message:
          type: string
          example: Login successful
    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.
    AuthError:
      type: object
      description: Envelope de erro de autenticação / autorização / não encontrado.
      properties:
        detail:
          type: string
          example: Invalid access token
    RecoverySetupRequiredError:
      type: object
      description: >-
        A conta foi recuperada e ainda não tem nenhum método de início de sessão
        configurado. Não são emitidos tokens; foi enviada uma ligação de
        utilização única por e-mail para o endereço da conta para configurar um
        novo método. Abra-a, configure o método e, em seguida, inicie sessão
        novamente.
      required:
        - recovery_setup_required
        - setup_link_sent
        - message
        - code
      properties:
        recovery_setup_required:
          type: boolean
          example: true
        setup_link_sent:
          type: boolean
          example: true
        message:
          type: string
          example: >-
            You recovered your account. Open the link we emailed you to set up a
            new sign-in method.
        code:
          type: string
          enum:
            - recovery_setup_required
          example: recovery_setup_required
    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.

````

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