> ## 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 d'actualització de l'estat de cribratge AML > Estableix l'estat del cribratge AML d'una sessió, com Aprovada després de revisar-ne les coincidències, sense canviar la decisió global de la sessió a Didit. Prompt de l'API per actualitzar l'estat de la comprovació AML Copia el prompt al porta-retalls \

\`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.`

\
Enganxa a Per decidir sobre coincidències individuals en lloc de tota la comprovació, utilitza [Actualitza l'estat de coincidència AML](https://docs.didit.me/ca/sessions-api/update-aml-hit-status.md). Per saber com es generen els resultats del cribratge i els seus estats, consulta [Cribratge AML](https://docs.didit.me/ca/core-technology/aml-screening/overview.md). ## OpenAPI ````yaml ca/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 verificació d'identitat. Autentica't amb la capçalera x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/session/{sessionId}/update-aml-status/: patch: tags: - Sessions summary: Actualitzar l'estat d'una comprovació d'AML description: >- Estableix l'estat de la comprovació de cribratge AML d'una sessió en el seu conjunt (l'`status` d'una entrada `aml_screenings[]` a la decisió de la sessió), per exemple `Approved` després que el teu equip hagi resolt totes les coincidències. Funciona per a ID de sessions de KYC i KYB; passa `node_id` (paràmetre de consulta o camp del cos) si la sessió ha executat més d'un pas d'AML; en cas contrari, s'actualitza la comprovació d'AML més recent. Quan l'estat canvia realment, es registra una entrada d'activitat `AML_STATUS_UPDATED` i s'envia un [webhook](https://docs.didit.me/ca/integration/webhooks) `data.updated`; enviar l'estat actual retorna `200` i no canvia res. L'estat de la sessió no es torna a calcular: utilitza `PATCH /v3/session/{sessionId}/update-status/` per a la decisió de la sessió i `PATCH /v3/session/{sessionId}/update-aml-hit-status/` per a coincidències individuals. Una clau d'API amb abast limitat requereix `decisions: write`. operationId: patch_v3_session_update_aml_status parameters: - name: sessionId in: path required: true description: >- UUID de la sessió de verificació (el `session_id` retornat per `POST /v3/session/`). Accepta tant IDs de sessió de Verificació d'usuaris (KYC) com de Verificació d'empreses (KYB): el servidor resol l'ID entre tots dos tipus de sessió. Ha de ser un UUID ben format; un valor mal format no coincideix amb la ruta i retorna un `404` en HTML. schema: type: string format: uuid example: 11111111-2222-3333-4444-555555555555 - name: node_id in: query required: false description: >- ID del node del graf del flux de treball de la comprovació AML que cal actualitzar. Només cal quan la sessió ha executat més d'un pas AML. Té preferència sobre `node_id` al cos. 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: Nou estat de la comprovació AML. example: Approved node_id: type: string description: >- ID del node del graf del flux de treball de la comprovació AML, com a alternativa al paràmetre de consulta. example: feature_aml_1 example: status: Approved responses: '200': description: >- Estat de la comprovació AML establert (o sense canvis si ja tenia aquest 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: Estat de la comprovació AML ara. previous_status: type: string enum: - Not Finished - Approved - Declined - In Review - Resub Requested description: >- Estat abans de la crida. Igual a `status` quan no hi ha cap canvi. example: message: AML status updated successfully status: Approved previous_status: In Review '400': description: >- Error de validació: falta `status` o no és un dels valors permesos. La cerca de la comprovació AML s'executa primer, de manera que una sessió sense comprovació AML retorna `404` fins i tot amb un cos no vàlid. content: application/json: examples: Missing status: summary: Cos buit o sense estat value: status: - This field is required. Invalid status: summary: status no és a l'enumeració value: status: - '"Cleared" is not a valid choice.' '401': description: >- La clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna `401`: una clau absent, no vàlida o revocada retorna `403`. content: application/json: schema: type: object properties: detail: type: string description: Missatge d'error fàcil de llegir. examples: Expired key: summary: La data de caducitat de la clau ha passat value: detail: This API key has expired. '403': description: >- Fallada d'autenticació o d'autorització. Si falta la clau es retorna `403`, igual que amb una clau d'una altra aplicació, una clau amb àmbit sense el permís que necessita aquest endpoint o una sol·licitud des de fora de la llista d'adreces IP permeses de la clau; una clau incorrecta, revocada o caducada retorna `401`. Distingeix-les pel camp `detail`. content: application/json: schema: type: object properties: detail: type: string description: Missatge d'error fàcil de llegir. examples: Missing or invalid credentials: summary: >- Falta la capçalera x-api-key, o la clau ha fallat la validació value: detail: >- Authentication credentials were not provided or are invalid. Other application: summary: >- Una clau vàlida que pertany a una aplicació diferent de la de la sessió value: detail: You do not have permission to perform this action. Scoped key without decisions write: summary: >- A la clau amb abast li manca el permís d'escriptura de decisions value: detail: This API key has no write access to decisions. IP not allowed: summary: >- Sol·licitud des de fora de la llista d'adreces IP permeses de la clau value: detail: This API key can't be used from this IP address. '404': description: >- La sessió no existeix, s'ha suprimit o queda fora dels límits d'una clau amb abast limitat, o no té cap comprovació AML (per al `node_id` indicat). La cerca de la sessió s'executa abans de comprovar les credencials, de manera que un `sessionId` desconegut retorna `404` fins i tot sense una clau vàlida. content: application/json: schema: type: object properties: detail: type: string description: Missatge d'error fàcil de llegir. examples: Unknown session: summary: No existeix cap sessió amb aquest ID, o s'ha suprimit value: detail: Not found. Outside key limits: summary: >- La sessió queda fora dels límits d'una clau amb abast limitat (també es retorna per a una sessió suprimida fa uns moments) value: detail: Session not found. No AML check: summary: La sessió no ha executat mai cap pas d'AML value: detail: The session does not have an AML check. No AML check for node: summary: node_id no coincideix amb cap comprovació AML de la sessió value: detail: >- The session does not have an AML check for node 'feature_aml_2'. '429': description: >- S'ha superat el límit de freqüència: 300 sol·licituds d'escriptura (POST, PATCH, DELETE) per minut per clau d'API. Espera els segons indicats a `Retry-After` abans de reintentar; les capçaleres `X-RateLimit-*` mostren el pressupost restant. content: application/json: schema: type: object properties: detail: type: string description: Missatge d'error fàcil de llegir. examples: Rate limited: summary: Pressupost per al minut actual esgotat value: detail: >- Write request rate limit exceeded. You can make up to 300 requests per minute. headers: Retry-After: description: Segons que cal esperar abans de reintentar. 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: >- La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.