> ## 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. # Atualizar status da verificação AML via API > Com a API da Didit, defina o status da verificação AML de uma sessão, como Approved após revisar correspondências, sem mudar a decisão da sessão. Prompt da API de atualização do status da verificação AML Copiar o prompt para a área de transferência \

\`Set the status of the AML screening check of a Didit verification session through the API.

Endpoint:
PATCH https://verification.didit.me/v3/session/{session_id}/update-aml-status/

Authentication:
Send my Didit API key in the x-api-key header. A scoped key needs decisions: write.

Goal:
\- Record my compliance decision on a session's AML check as a whole (the status of an aml_screenings[] entry in the session decision), for example Approved after my team cleared every hit.

Request body (JSON):
\- status (required): "Approved", "Declined", "In Review", "Not Finished" or "Resub Requested".
\- node_id (optional): the workflow node ID of the AML check when the session ran several AML steps. It can also be sent as the node_id query parameter. Without it the most recent AML check is updated.

Behavior:
\- Works for user (KYC) and business (KYB) session IDs.
\- Only the AML check changes. The session status is not recomputed: use PATCH /v3/session/{session_id}/update-status/ to change the session decision, and PATCH /v3/session/{session_id}/update-aml-hit-status/ to mark individual hits.
\- When the status changes, Didit adds an AML_STATUS_UPDATED activity entry and sends a data.updated webhook.
\- Sending the status the check already has returns 200 and changes nothing (no activity entry, no webhook).

Example call:
curl -X PATCH "https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-aml-status/" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"status": "Approved"}'

What to read from the response:
\- status: the AML check status now.
\- previous_status: the status before the call (equal to status when nothing changed).

Failure modes:
\- 400: status missing or not one of the allowed values.
\- 401: the API key has expired.
\- 403: missing key (a wrong, revoked or expired key gets 401), a key of another application, a scoped key without decisions: write, or a request from outside the key's IP allowlist.
\- 404: the session does not exist, was deleted, or is outside a scoped key's limits, or it has no AML check (for that node_id). This is checked before the body, so it wins over a 400.

Side effects: changes the AML check status, adds an activity entry and sends a data.updated webhook (only when the status changed).

For the full integration shape, see /integration/integration-prompt.`

\
Colar em Para decidir sobre correspondências individuais em vez da verificação inteira, use [Atualizar o status de um hit AML](https://docs.didit.me/pt-br/sessions-api/update-aml-hit-status.md). Para saber como os resultados e os status da análise são gerados, consulte [Análise AML](https://docs.didit.me/pt-br/core-technology/aml-screening/overview.md). ## OpenAPI ````yaml pt-br/openapi-25.json PATCH /v3/session/{sessionId}/update-aml-status/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/session/{sessionId}/update-aml-status/: patch: tags: - Sessions summary: Atualizar o status de uma verificação AML description: >- Define o status da verificação de Análise AML de uma sessão como um todo (o `status` de uma entrada `aml_screenings[]` na decisão da sessão), por exemplo `Approved` depois que sua equipe liberou todos os resultados. Funciona para IDs de sessão de KYC e KYB; informe `node_id` (parâmetro de consulta ou campo do corpo) quando a sessão executou mais de uma etapa AML; caso contrário, a verificação AML mais recente é atualizada. Quando o status de fato muda, uma entrada de atividade `AML_STATUS_UPDATED` é registrada e um [webhook](https://docs.didit.me/pt-br/integration/webhooks) `data.updated` é enviado; enviar o status atual retorna `200` e não altera nada. O status da sessão não é recalculado: use `PATCH /v3/session/{sessionId}/update-status/` para a decisão da sessão e `PATCH /v3/session/{sessionId}/update-aml-hit-status/` para resultados individuais. Uma chave de API com escopo precisa de `decisions: write`. operationId: patch_v3_session_update_aml_status parameters: - name: sessionId in: path required: true description: >- UUID da sessão de verificação (o `session_id` retornado por `POST /v3/session/`). Aceita IDs de sessão tanto de Verificação de usuários (KYC) quanto de Verificação de empresas (KYB): o servidor resolve o ID entre os dois tipos de sessão. Deve ser um UUID bem formado; um valor malformado não corresponde à rota e retorna um `404` em HTML. schema: type: string format: uuid example: 11111111-2222-3333-4444-555555555555 - name: node_id in: query required: false description: >- ID do nó do grafo do fluxo da verificação AML a ser atualizada. Necessário apenas quando a sessão executou mais de uma etapa AML. Tem precedência sobre `node_id` no corpo. schema: type: string example: feature_aml_1 requestBody: required: true content: application/json: schema: type: object required: - status properties: status: type: string enum: - Not Finished - Approved - Declined - In Review - Resub Requested description: Novo status da verificação AML. example: Approved node_id: type: string description: >- ID do nó do grafo do fluxo da verificação AML, como alternativa ao parâmetro de consulta. example: feature_aml_1 example: status: Approved responses: '200': description: >- Status da verificação AML definido (ou inalterado quando já tinha esse valor). content: application/json: schema: type: object required: - message - status - previous_status properties: message: type: string description: Sempre `AML status updated successfully`. status: type: string enum: - Not Finished - Approved - Declined - In Review - Resub Requested description: Status atual da verificação AML. previous_status: type: string enum: - Not Finished - Approved - Declined - In Review - Resub Requested description: >- Status antes da chamada. Igual a `status` quando nada mudou. example: message: AML status updated successfully status: Approved previous_status: In Review '400': description: >- Erro de validação: `status` ausente ou fora dos valores permitidos. A busca da verificação AML é executada primeiro, então uma sessão sem verificação AML retorna `404` mesmo com um corpo inválido. content: application/json: examples: Missing status: summary: Corpo vazio ou sem status value: status: - This field is required. Invalid status: summary: status não está no enum value: status: - '"Cleared" is not a valid choice.' '401': description: >- A chave de API com escopo expirou. Este é o único caso que retorna `401`: uma chave ausente, inválida ou revogada retorna `403`. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Expired key: summary: A data de validade da chave já passou value: detail: This API key has expired. '403': description: >- Falha de autenticação ou autorização. Uma chave ausente retorna `403`, assim como uma chave de outra aplicação, uma chave com escopo sem a permissão exigida por este endpoint e uma requisição de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada retorna `401`. Diferencie-as pelo `detail`. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Missing or invalid credentials: summary: Cabeçalho x-api-key ausente, ou a chave falhou na validação value: detail: >- Authentication credentials were not provided or are invalid. Other application: summary: >- Uma chave válida que pertence a uma aplicação diferente da aplicação da sessão value: detail: You do not have permission to perform this action. Scoped key without decisions write: summary: 'Chave com escopo sem decisions: write' value: detail: This API key has no write access to decisions. IP not allowed: summary: Requisição de fora da lista de IPs permitidos da chave value: detail: This API key can't be used from this IP address. '404': description: >- A sessão não existe, foi excluída ou está fora dos limites de uma chave com escopo, ou não tem verificação AML (para o `node_id` informado). A busca da sessão é feita antes da verificação da credencial, então um `sessionId` desconhecido retorna `404` mesmo sem uma chave válida. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Unknown session: summary: Não existe nenhuma sessão com este ID, ou ela foi excluída value: detail: Not found. Outside key limits: summary: >- A sessão está fora dos limites de uma chave com escopo (também retornado para uma sessão excluída há instantes) value: detail: Session not found. No AML check: summary: A sessão nunca executou uma etapa AML value: detail: The session does not have an AML check. No AML check for node: summary: node_id não corresponde a uma verificação AML da sessão value: detail: >- The session does not have an AML check for node 'feature_aml_2'. '429': description: >- Limite de requisições excedido: 300 requisições de escrita (POST, PATCH, DELETE) por minuto por chave de API. Aguarde `Retry-After` segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*` mostram a cota. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Rate limited: summary: Orçamento do minuto atual esgotado value: detail: >- Write request rate limit exceeded. You can make up to 300 requests per minute. headers: Retry-After: description: Segundos de espera antes de tentar novamente. schema: type: integer minimum: 1 example: 30 security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X PATCH 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-aml-status/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"status": "Approved"}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.sessions.update_aml_status( "11111111-2222-3333-4444-555555555555", status="Approved", ) print(result) - lang: javascript label: Node.js source: >- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.sessions.updateAmlStatus("11111111-2222-3333-4444-555555555555", { status: "Approved", }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateAMLStatus(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsUpdateAMLStatusParams{\n\tStatus: \"Approved\",\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.SessionsUpdateAmlStatusParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.sessions().updateAmlStatus("11111111-2222-3333-4444-555555555555", SessionsUpdateAmlStatusParams.builder() .status(SessionsUpdateAmlStatusParams.Status.of("Approved")) .build()); System.out.println(result); - lang: php label: PHP source: >- sessions->updateAmlStatus('11111111-2222-3333-4444-555555555555', [ 'status' => 'Approved', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.sessions.update_aml_status( "11111111-2222-3333-4444-555555555555", status: "Approved" ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Sessions.UpdateAmlStatusAsync("11111111-2222-3333-4444-555555555555", new SessionsUpdateAmlStatusParams { Status = "Approved", }); Console.WriteLine(JsonSerializer.Serialize(result)); components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.