> ## 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. # Consultar status do step-up | API de Autenticação Didit > GET /step-up/{step_up_id}/ retorna status, método e nível de um step-up no Didit. Execute a ação sensível só com status aprovado. > [!WARNING] > > A autenticação é nova. Esses endpoints são servidos pelo emissor da sua aplicação, como `https://.auth.didit.me`, e não aceitam sua chave de API da Didit. Um step-up pertence à sessão que o criou: requisições com o token de acesso de outra sessão retornam `404`. Um step-up `pending` passa a aparecer como `expired` depois que seus 30 minutos se esgotam. ## OpenAPI ````yaml pt-br/openapi-authentication.json GET /step-up/{step_up_id}/ openapi: 3.0.3 info: title: Didit Authentication API version: 1.0.0 description: >- Os endpoints voltados ao servidor do Didit Authentication, o produto de login para os usuários finais da sua aplicação. O Authentication é **novo** e chega à produção na versão de 2026-11-01. ## URL base Cada aplicação é o seu próprio emissor OpenID Connect, e todos os endpoints abaixo são servidos na raiz desse emissor: - `https://.auth.didit.me` para uma aplicação de produção, ou `https://.sandbox.auth.didit.me` para uma aplicação de sandbox. - O seu próprio domínio personalizado, depois de ativado. Ele passa então a substituir o host padrão como emissor: novos tokens o indicam em `iss`, o discovery aponta para ele e a chave publicável muda. Tokens de acesso emitidos sob o host padrão falham em `/session/`, `/step-up/` e `/monitoring-token/` até serem renovados. Produção e sandbox são aplicações separadas, portanto são emissores separados, com chaves separadas. A chave publicável é `pk_live_` (produção) ou `pk_test_` (sandbox) seguida da codificação base64url sem preenchimento do emissor, sem barra final: decodifique-a para descobrir o emissor. Ela é um identificador público, não uma credencial. Os mesmos endpoints JSON também são servidos em `https://apx.didit.me/auth/v2/authentication/{application_id}/`. Os tokens sempre indicam o emissor acima, seja qual for o endereço que os emitiu. ## Credenciais Estes endpoints nunca recebem a sua chave de API do Didit nem um token do console. - O discovery, o JWKS e `POST /token/` não recebem credencial. Os clientes são públicos: não há client secret, e um código de autorização fica vinculado ao seu verificador PKCE (`S256`). O `client_id` é o ID da sua aplicação. - `/session/`, `/step-up/` e `/monitoring-token/` recebem o token de acesso da pessoa: `Authorization: Bearer `. Cada chamada bem-sucedida conta como atividade na sessão, então reinicia o tempo limite de inatividade da sessão. ## Corpos de requisição Todo endpoint que recebe um corpo aceita corpos JSON, form-encoded e multipart. Este documento lista JSON, além de form-encoded para `POST /token/`, como os clientes OAuth o enviam. Um campo que o endpoint não aceita recebe `400 {"": "unknown_field"}`. ## Tokens - **Token de acesso**: um JWT ES256 com o cabeçalho `typ: at+jwt`, válido por no máximo 5 minutos e nunca por mais tempo que a sua sessão. Claims: `AccessTokenClaims`. - **ID token**: um JWT ES256 com o cabeçalho `typ: JWT`. Claims: `IDTokenClaims`. Ele nunca é aceito como token de acesso. - **Refresh token**: uma string aleatória que é rotacionada a cada uso. Enviar novamente um refresh token já usado revoga a sessão. Verifique um token com as chaves de `GET /.well-known/jwks.json`: o algoritmo deve ser `ES256`, `typ` deve corresponder ao tipo de token, `iss` deve ser igual ao emissor que você configurou e `aud` ao ID da sua aplicação. A verificação offline só percebe uma sessão revogada quando o token de acesso dela expira; `GET /session/` é a verificação instantânea. ## Erros | Corpo | Quando | | --- | --- | | `{"error": ""}` | Erros de `POST /token/`, todos com status `400`, no formato de corpo da [RFC 6749, seção 5.2](https://www.rfc-editor.org/rfc/rfc6749#section-5.2): `invalid_grant`, `invalid_client` e o `mfa_required` do Didit. Erros de serviço: `temporarily_unavailable`, `monitoring_unavailable`, `monitoring_disabled`. | | `{"": [""]}` ou `{"": ""}` | Um campo da requisição falhou na validação. `non_field_errors` indica uma regra que envolve vários campos, e `unknown_field`, um campo que o endpoint não aceita. | | `{"detail": ""}` | `401` (`invalid_token`), `403` (`origin_not_allowed`), `404` (aplicação ou step-up desconhecidos) e `429` (limite de requisições). Também `400` para um corpo que não pode ser interpretado (`JSON parse error - ...`), `405` para um método que o endpoint não atende e `415` para um `Content-Type` não suportado. | Um `401` também traz `WWW-Authenticate: Bearer`, e um `429` traz `Retry-After` em segundos. Duas recusas não são JSON. Um endereço que não é um emissor é recusado antes de chegar a estes endpoints, por exemplo com um `404` vazio para um nome `*.auth.didit.me` não utilizado. Um `step_up_id` que não é um UUID recebe uma página `404`. ## Limites de requisições Uma requisição precisa passar por duas camadas. **Limites por endpoint**, contados por endereço IP do cliente, por aplicação e por endpoint: - Discovery e JWKS: 1.200 requisições por minuto e 12.000 por hora. - Todos os demais endpoints: 30 requisições por minuto e 300 por hora. `GET` e `DELETE /session/` compartilham a mesma contagem. Acima de um limite: `429 {"detail": "Too many requests from this IP address. Please wait before trying again. Expected available in 60 seconds."}`, ou `3600 seconds` para o limite por hora. **Proteção contra bots**, em todo `POST` e `DELETE`. Seus buckets são compartilhados por todas as requisições `POST` e `DELETE` da aplicação, incluindo as etapas de login hospedadas, e são reabastecidos continuamente: - 60 requisições por minuto por endereço IP do cliente. - 30 requisições por minuto por dispositivo, para requisições que identificam o seu dispositivo, como fazem os SDKs de navegador e nativos. - 1.000 requisições por minuto para a aplicação inteira, somando todos os endereços IP. Acima de um bucket: `429 {"detail": "rate_limited Expected available in N seconds."}` (`1 second.` quando N é 1). O bucket por IP abrange vários endpoints, então um único endereço que mistura chamadas de token, step-up e logout pode esgotá-lo antes de atingir qualquer limite por endpoint. O bucket da aplicação conta todos os clientes da aplicação, incluindo navegadores. As duas camadas respondem antes de o endpoint ser executado, então uma requisição que recebeu `429` não foi executada: tente novamente depois de `Retry-After`, inclusive no caso de uma renovação. ## Requisições do navegador Uma requisição que traz um cabeçalho `Origin` deve vir de uma das origens da própria aplicação ou de suas origens permitidas; caso contrário, recebe `403 origin_not_allowed`. Requisições de servidor para servidor não enviam `Origin`. ## Fora do escopo deste documento Estas rotas atendem às páginas hospedadas, aos SDKs de navegador e nativos e a agentes de IA. Elas não fazem parte do contrato de servidor, e os SDKs de servidor não as chamam: - Etapas de login: `POST /authorize/`, `POST /password/`, `/email/*`, `/phone/*`, `/password-reset/*`, `/passkeys/*`, `/mfa/*`, `/social/*` e `/protection/complete/`. - Páginas hospedadas e callbacks: `/sign-in`, `/magic`, `/invite`, `/reset`, `/verify/`, `/sso/*`, `/wallet/callback/`, `/logo/` e os arquivos de associação de apps nativos em `/.well-known/`. - Acesso de agentes: `/agents/*` e `/grants/`, incluindo `GET /agents/session/`, a verificação em tempo real do token de acesso de um agente de IA. O acesso de agentes não faz parte desta versão do contrato. - A API de gerenciamento do console para o Authentication, que recebe sessões do console. Os eventos do Authentication ainda não são entregues como webhooks, por isso este documento não define nenhum webhook. servers: - url: https://{issuer} description: 'O emissor da sua aplicação: a origem do login.' variables: issuer: default: your-app.auth.didit.me description: >- O host do emissor: `.auth.didit.me` (produção), `.sandbox.auth.didit.me` (sandbox) ou o seu domínio personalizado ativo. security: [] tags: - name: Issuer description: Chaves de descoberta e de assinatura, para verificar tokens. - name: Tokens description: Os grants de código de autorização e de refresh. - name: Sessions description: Verifica e encerra a sessão vinculada a um token de acesso. - name: Step-ups description: Verificação antes de uma ação sensível. - name: Monitoring description: Credenciais do dispositivo para eventos de monitoramento de transações. paths: /step-up/{step_up_id}/: get: tags: - Step-ups summary: Obter um step-up description: >- O status atual do step-up. Chame-o com um token de acesso da mesma sessão que criou o step-up e aja somente quando `status` for `approved`. operationId: authentication_retrieve_step_up parameters: - name: step_up_id in: path required: true description: >- O `id` retornado por `POST /step-up/`, que também é o parâmetro de consulta `step_up` no seu `return_to`. Um valor que não seja um UUID recebe uma página `404`, não JSON. schema: type: string format: uuid example: 94efc2c3-ca84-42fe-900b-6fb61669a7a1 responses: '200': description: O step-up. headers: Cache-Control: description: 'Sempre `no-store`: nunca armazene esta resposta em cache.' schema: type: string example: no-store Pragma: description: Sempre `no-cache`. schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/StepUp' examples: Approved: summary: 'Aprovado: pode prosseguir' value: id: 94efc2c3-ca84-42fe-900b-6fb61669a7a1 rule: payout method: selfie status: approved level: liveness_face_match amount: '900.00' currency: USD created_at: '2026-10-17T10:41:14.894632Z' completed_at: '2026-10-17T10:43:02.118204Z' expires_at: '2026-10-17T11:11:14.894581Z' Pending: summary: Ainda não finalizado value: id: 94efc2c3-ca84-42fe-900b-6fb61669a7a1 rule: payout method: selfie status: pending level: null amount: '900.00' currency: USD created_at: '2026-10-17T10:41:14.894632Z' completed_at: null expires_at: '2026-10-17T11:11:14.894581Z' '401': $ref: '#/components/responses/InvalidToken' '403': $ref: '#/components/responses/OriginNotAllowed' '404': description: >- Nenhuma verificação step-up com este ID pertence a esta sessão, ou a aplicação é desconhecida. headers: Cache-Control: description: 'Sempre `no-store`: nunca armazene esta resposta em cache.' schema: type: string example: no-store Pragma: description: Sempre `no-cache`. schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/Detail' examples: StepUpNotFound: summary: Step-up desconhecido value: detail: No VerificationCheck matches the given query. '429': $ref: '#/components/responses/RateLimited' '503': $ref: '#/components/responses/TemporarilyUnavailable' security: - AccessToken: [] components: schemas: StepUp: type: object description: Uma verificação na qual a pessoa precisa ser aprovada antes da ação. required: - id - rule - method - status - level - amount - currency - created_at - completed_at - expires_at properties: id: type: string format: uuid example: 94efc2c3-ca84-42fe-900b-6fb61669a7a1 rule: type: string enum: - payout - device - bank - contact description: >- A regra que a exigiu. Quando várias se aplicam, aquela com o método mais forte. example: payout method: type: string enum: - liveness - selfie - full_id description: >- O que a pessoa faz: `liveness`, `selfie` (prova de vida comparada com o rosto que a Didit já tem) ou `full_id` (documento e selfie). Quando a Didit ainda não tem nenhum rosto da pessoa, `selfie` passa a ser `full_id` assim que ela abre `verification_url`. example: selfie status: type: string enum: - pending - review - approved - declined - expired - superseded description: >- Aja somente em caso de `approved`. `review` aguarda a revisão da sua equipe. `declined` não é definitivo enquanto `verification_url` funcionar: a pessoa pode tentar novamente, e o step-up volta para `pending`. `superseded` significa que outra verificação assumiu a verificação dele, ou que o resultado não era para este step-up: crie um novo. example: pending level: type: string nullable: true enum: - liveness - liveness_face_match - full_id - null description: O nível alcançado pela verificação, depois de aprovada. example: null amount: type: string nullable: true description: O valor do pagamento, com duas casas decimais. example: '900.00' currency: type: string nullable: true example: USD created_at: type: string format: date-time example: '2026-10-17T10:41:14.894632Z' completed_at: type: string format: date-time nullable: true example: null expires_at: type: string format: date-time description: >- 30 minutos após a criação. Ao ler um step-up, primeiro é coletado qualquer resultado que sua verificação tenha alcançado, então ele ainda pode retornar `approved`, `review` ou `declined` após esse prazo; um que ainda esteja `pending` retorna `expired`. example: '2026-10-17T11:11:14.894581Z' Detail: type: object required: - detail properties: detail: type: string example: invalid_token OAuthError: title: OAuth error type: object description: Um erro OAuth (RFC 6749, seção 5.2) ou um erro de serviço. required: - error properties: error: type: string example: invalid_grant responses: InvalidToken: description: >- O token de acesso está ausente, malformado ou expirado. Ou foi assinado por outro emissor ou outra chave, é um ID token ou um token de agente, ou foi substituído por uma renovação (refresh). Também pode ser que a sessão dele tenha sido revogada, expirado por inatividade, ultrapassado seu tempo de vida ou deixado de atender à sua política de MFA, ou que a pessoa tenha sido bloqueada ou o e-mail dela não esteja mais verificado. Peça à pessoa que faça login novamente. headers: WWW-Authenticate: description: '`Bearer`.' schema: type: string example: Bearer Cache-Control: description: 'Sempre `no-store`: nunca armazene esta resposta em cache.' schema: type: string example: no-store Pragma: description: Sempre `no-cache`. schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/Detail' examples: InvalidToken: summary: Token de acesso rejeitado value: detail: invalid_token OriginNotAllowed: description: >- A requisição trouxe um `Origin` que não é o da própria aplicação nem está entre suas origens permitidas. Requisições de servidor não enviam `Origin`. headers: Cache-Control: description: 'Sempre `no-store`: nunca armazene esta resposta em cache.' schema: type: string example: no-store Pragma: description: Sempre `no-cache`. schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/Detail' examples: OriginNotAllowed: summary: Origem não permitida value: detail: origin_not_allowed RateLimited: description: >- Muitas requisições deste endereço IP para este endpoint ou, em um `POST` ou `DELETE`, um bucket de proteção contra bots está vazio. Nada foi executado: aguarde `Retry-After` segundos e tente novamente. headers: Retry-After: description: Segundos de espera antes de tentar novamente. schema: type: integer example: 60 Cache-Control: description: 'Sempre `no-store`: nunca armazene esta resposta em cache.' schema: type: string example: no-store Pragma: description: Sempre `no-cache`. schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/Detail' examples: RateLimited: summary: Limite do endpoint value: detail: >- Too many requests from this IP address. Please wait before trying again. Expected available in 60 seconds. BotProtection: summary: Limite de proteção contra bots (POST e DELETE) value: detail: rate_limited Expected available in 2 seconds. TemporarilyUnavailable: description: >- Um serviço do qual a requisição depende está temporariamente indisponível. Tente novamente com backoff. headers: Cache-Control: description: 'Sempre `no-store`: nunca armazene esta resposta em cache.' schema: type: string example: no-store Pragma: description: Sempre `no-cache`. schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/OAuthError' examples: TemporarilyUnavailable: summary: Tentar novamente mais tarde value: error: temporarily_unavailable securitySchemes: AccessToken: type: http scheme: bearer bearerFormat: JWT description: >- O token de acesso da pessoa obtido em `POST /token/`: um JWT ES256 com o cabeçalho `typ: at+jwt`, válido por no máximo 5 minutos. Não é a sua chave de API da Didit. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.