> ## 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. # Registro programático de conta via Auth API > Crie organizações Didit via Auth API, sem navegador e nativo para agentes. Monte subcontas de KYC com pagamento por chamada e sem contrato. Prompt de registro programático Copiar o prompt para a área de transferência \

\``Programmatically create a pending Didit account — step 1 of the two-step onboarding (no browser, no console).

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

Authentication:
None. This is a public endpoint. (Don't confuse the Auth API host `apx.didit.me/auth/v2` with the verification host `verification.didit.me/v3`.)

Request body:
\- email (string, required) — Any real, deliverable email (personal, work, alias). The verification code is mailed synchronously, so reserved test domains (`@example.com`, `@example.org`, `@*.test`, `@*.example`, `@*.invalid`) get rejected by mail delivery and the call returns `500` — substitute the placeholder with an inbox you can read.
\- password (string, required) — Must satisfy ALL of: minimum 8 characters, ≥1 uppercase letter (A-Z), ≥1 lowercase letter (a-z), ≥1 digit (0-9), ≥1 special character from !@#$%^&*()_+-=[]{}|;:,.<>?. Rules are validated one at a time and the first failure short-circuits.

curl example (replace `you@yourdomain.com` with a real inbox):
curl -X POST https://apx.didit.me/auth/v2/programmatic/register/ \
-H "Content-Type: application/json" \
-d '{
"email": "you@yourdomain.com",
"password": "MyStr0ng!Pass"
}'

Response (201 Created):
\- message (string) — "Registration successful. Check your email for the verification code."
\- email (string) — echoed back.

What happens server-side:
\- A pending account is created (NOT usable yet).
\- A 6-character alphanumeric code (e.g. "A3K9F2") is emailed to the supplied address.
\- The code is valid for 15 minutes. After expiry the registration must be redone.

Failure modes (all 400 unless noted):
\- Field-level: { "email": ["Enter a valid email address."] } or { "password": ["Ensure this field has at least 8 characters."] }.
\- Password-strength failures CURRENTLY return as a BARE ARRAY (no field key), one rule at a time: ["Password must contain at least one uppercase letter."] / lowercase / digit / special character. Known server-side inconsistency — treat as { "password": [...] } client-side.
\- Duplicate email: { "detail": "An account with this email already exists." }
\- 429 — { "detail": "Too many registration attempts. Please try again later.", "wait":  } when more than 5 registrations from the same IP within an hour.
\- 500 — returned (with an HTML body, not JSON) when mail delivery to the supplied address fails synchronously. Most commonly triggered by reserved test domains; use a real inbox.

Rate limits:
5 registrations per IP per hour.

Next step:
After receiving the email, call POST https://apx.didit.me/auth/v2/programmatic/verify-email/ with { "email", "code" } to get your access_token and api_key — see /auth-api/verify-email.

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

\
Colar em ## OpenAPI ````yaml pt-br/openapi-auth.json POST /programmatic/register/ 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/register/: post: tags: - Programmatic Auth summary: Registrar conta description: >- Etapa 1 do onboarding programático. Cria uma conta pendente e envia por e-mail um código de 6 caracteres (TTL de 10 min). O endereço é verificado antes de qualquer conta ser criada: um endereço que não pode receber o código retorna 400 `email_undeliverable`. Limites de requisições: 5/IP/hora, além de uma cota horária compartilhada por rede (/24 para IPv4, /64 para IPv6). operationId: programmatic_register requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RegisterRequest' examples: Gmail: summary: Registrar-se com um Gmail pessoal value: email: you@yourdomain.com password: MyStr0ng!Pass Work: summary: Registrar-se com um e-mail corporativo value: email: you@yourcompany.com password: C0mplex#Pass1 responses: '201': description: >- Cadastro realizado com sucesso. Um código de verificação alfanumérico de 6 caracteres (por exemplo, `A3K9F2`) foi enviado por e-mail ao endereço informado e é válido por 10 minutos. Em seguida, chame `POST /programmatic/verify-email/`. content: application/json: schema: $ref: '#/components/schemas/RegisterResponse' examples: Success: value: message: >- Registration successful. Check your email for the verification code. email: you@yourdomain.com '400': description: >- Erro de validação. O envelope previsto é `{"field": ["..."]}` para erros de campo e `{"detail": "..."}` para erros de regra de negócio (por exemplo, e-mail duplicado). Atualmente, as regras de força da senha respondem com um array simples `["..."]`, uma regra por vez. Essa é uma inconsistência conhecida no servidor; trate a resposta como `{"password": ["..."]}` até que seja corrigida. Quando o endereço não pode receber o código (domínio descartável, reservado ou de teste, sem servidor de e-mail, provável erro de digitação ou endereço que já teve uma devolução), o corpo é `EmailUndeliverableError` com `code: "email_undeliverable"`; nenhuma conta é criada ou alterada. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ValidationError' - $ref: '#/components/schemas/EmailUndeliverableError' examples: MissingFields: summary: Corpo vazio value: email: - This field is required. password: - This field is required. InvalidEmail: summary: E-mail com formato inválido value: email: - Enter a valid email address. PasswordTooShort: summary: Senha com menos de 8 caracteres value: password: - Ensure this field has at least 8 characters. PasswordMissingUppercase: summary: Senha sem letra maiúscula value: - Password must contain at least one uppercase letter. PasswordMissingLowercase: summary: Senha sem letra minúscula value: - Password must contain at least one lowercase letter. PasswordMissingDigit: summary: Senha sem dígito value: - Password must contain at least one digit. PasswordMissingSpecial: summary: Senha sem caractere especial value: - >- Password must contain at least one special character (!@#$%^&*()_+-=[]{}|;:,.<>?). Duplicate: summary: O e-mail já possui uma conta value: detail: An account with this email already exists. EmailUndeliverable: summary: O endereço não pode receber e-mails (domínio descartável) value: detail: >- This email can't receive messages. Please use a different email address. code: email_undeliverable reason: disposable_domain EmailLikelyTypo: summary: Provável erro de digitação no domínio value: detail: >- This email can't receive messages. Please use a different email address. code: email_undeliverable reason: possible_typo suggestion: gmail.com '429': description: >- Limite de requisições atingido. Houve mais de 5 tentativas de cadastro do mesmo IP na última hora, ou a cota por hora da rede do chamador (/24 para IPv4, /64 para IPv6, compartilhada entre cadastro e reenvios de código) se esgotou. Ambos os casos retornam `Retry-After: 3600`. Também é retornado, com um cabeçalho `Retry-After: 5`, quando o serviço está momentaneamente verificando o máximo de senhas ou códigos que consegue ao mesmo tempo; tente novamente após o número de segundos indicado. content: application/json: schema: $ref: '#/components/schemas/RateLimitError' examples: RateLimited: value: detail: Too many registration attempts. Please try again later. 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/register/ \ -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.register( 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.register({ 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.Register(ctx, didit.RegisterRequest{\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.RegisterRequest; // This call needs no API key. Didit client = new Didit(); var result = client.account().register(RegisterRequest.builder() .email("you@yourdomain.com") .password("MyStr0ng!Pass") .build()); System.out.println(result); - lang: php label: PHP source: |- account->register([ '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.register( 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.RegisterAsync(new RegisterRequest { Email = "you@yourdomain.com", Password = "MyStr0ng!Pass", }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: RegisterRequest: type: object required: - email - password properties: email: type: string format: email description: >- Qualquer endereço de e-mail válido (pessoal, profissional, alias). Usado como identificador único da conta. example: you@yourdomain.com password: type: string minLength: 8 description: >- Mínimo de 8 caracteres. Deve conter pelo menos uma letra maiúscula (`A-Z`), uma letra minúscula (`a-z`), um dígito (`0-9`) e um caractere especial dentre `!@#$%^&*()_+-=[]{}|;:,.<>?`. A validação informa uma regra não atendida por vez. example: MyStr0ng!Pass RegisterResponse: type: object properties: message: type: string description: Confirmação legível de que o código de verificação foi enviado. example: Registration successful. Check your email for the verification code. email: type: string format: email description: O e-mail para o qual o código de verificação foi enviado. example: you@yourdomain.com 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. EmailUndeliverableError: type: object description: >- Retornado por `POST /programmatic/register/` quando o endereço não pode receber o código de verificação. A verificação é executada antes que qualquer conta seja criada ou alterada, então nada fica para trás. required: - detail - code - reason properties: detail: type: string description: Mensagem legível. example: >- This email can't receive messages. Please use a different email address. code: type: string enum: - email_undeliverable description: Sempre `email_undeliverable`. reason: type: string enum: - invalid_address - reserved_domain - no_mail_records - disposable_domain - possible_typo - suppressed description: >- Por que o endereço foi recusado: `invalid_address` (não é um endereço válido), `reserved_domain` (um domínio reservado ou de teste, como `example.com`), `no_mail_records` (o domínio não tem servidor de e-mail), `disposable_domain` (um provedor de caixas de e-mail descartáveis), `possible_typo` (um provável erro de digitação de um provedor comum; veja `suggestion`), `suppressed` (o endereço já retornou e-mails ou gerou reclamações). suggestion: type: string description: >- O domínio provavelmente pretendido, presente apenas quando o domínio parece ter um erro de digitação (por exemplo `gmail.com` para `gmial.com`). A API não aceita uma confirmação: registre novamente com o endereço corrigido. example: gmail.com 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.