---
updatedAt: 2026-04-28T22:24:58.000Z
agentTools:
  projectIndex: https://docs.vouched.id/llms.txt
---

# Retrieve AML Result (Enhanced Screening and Monitoring)

AML Enhanced Screening and Monitoring helps assess and track financial crime risk for individuals and entities. It delivers an initial screening with optional ongoing monitoring, providing structured results and automated updates as risk profiles change.

**If you would like to start using AML Enhanced Screening and Monitoring, please contact Support by filing a ticket [here](https://vouchedhelp.zendesk.com/hc/en-us/requests/new).**

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "version": "0.13.13",
    "title": "Vouched API",
    "description": "Official Vouched REST API.\n\n## Environments\n\nThe `servers` list below has two production hosts: `verify.vouched.id` (US) and\n`verify.eu.vouched.id` (EU). A separate **sandbox** deployment runs the same service with\n`SANDBOX_MODE` enabled, where only the identity-verification job endpoints are mounted —\n`GET`/`POST /api/jobs`, `GET`/`DELETE /api/jobs/{id}`, `GET /api/jobs/{id}/download` and\n`POST /api/jobs/session`. Every other endpoint **under `/api`** in this document returns **404**\nin sandbox, including AML, SSN, TIN, DOB, invites and CrossCheck.\n\nThe provider webhook receivers are the exception: `/api/tin/webhook`,\n`/api/dlv/webhook/license-validation`, `/v1/sendgrid/email/send` and `/v1/twilio/sms/send` are\nregistered outside the sandbox gate and remain available.\n",
    "x-logo": {
      "url": "https://i.pinimg.com/originals/88/29/2f/88292f8ffd6231d0c41634f2e707c34a.png",
      "altText": "Vouched logo"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "servers": [
    {
      "url": "https://verify.vouched.id",
      "description": "US (default)"
    },
    {
      "url": "https://verify.eu.vouched.id",
      "description": "EU"
    }
  ],
  "tags": [
    {
      "name": "aml",
      "description": "This is the section where you will do actions for all things related to AML."
    }
  ],
  "paths": {
    "/api/v2/aml/{id}": {
      "get": {
        "description": "AML Enhanced Screening and Monitoring helps assess and track financial crime risk for individuals and entities. It delivers an initial screening with optional ongoing monitoring, providing structured results and automated updates as risk profiles change.\n\n**If you would like to start using AML Enhanced Screening and Monitoring, please contact Support by filing a ticket [here](https://vouchedhelp.zendesk.com/hc/en-us/requests/new).**",
        "summary": "Retrieve AML Result (Enhanced Screening and Monitoring)",
        "operationId": "get-aml-enhanced-monitoring",
        "security": [
          {
            "X-API-Key": []
          }
        ],
        "tags": [
          "aml"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "The AML job ID.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "AML job result. This response structure is also identical to the POST 200 [response](/reference/submit-aml-enhanced-monitoring).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/aml_v2_response"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "X-API-Key": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "The authentication private key"
      }
    },
    "schemas": {
      "error": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "\nError type code.\n- InvalidRequestError - The request is invalid.\n\n  - Parameters sent in the request are invalid.\n\n\n- FaceMatchError - The face match score was lower than the threshold.\n\n  - Category: faceMatch\n\n  - Faces obtained from the ID and Selfie images do not match.\n\n\n- NameMatchError - The name match score was lower than the threshold.\n\n  - The name provided by the user and the name extracted from the ID do not match.\n\n  - Eg: User Provided Name - Dave Smith, Extracted Name - David Smith\n\n\n- BarcodeMatchError - The barcode match score was lower than the threshold.\n\n  - The data provided by the user and the data extracted from the barcode do not match. \n\n  - Eg: User Provided Name - Dave Smith, Extracted Name - David Smith\n\n\n- BirthDateMatchError - The birth date match score was lower than the threshold.\n\n  - The birth date provided by the user and the data extracted from the ID do not match.\n\n  - Eg: User Provided DOB - 01/09/1992, Extracted DOB - 09/01/1992\n\n  - Eg: User Provided DOB - 11/09/1992, Extracted DOB - 12/09/1992\n\n\n- ExpiredIdError - The ID’s expiration date has passed.\n\n  - The expiration date extracted from the ID indicates that it has expired.\n\n- InvalidIdPhotoError - The ID is invalid.\n\n  - Category: id\n\n  - The image submitted does not qualify as an ID. The ID image may be of lower quality, have blur, glare or it may be too dark, and hence the data could not be extracted.\n\n- InvalidUserPhotoError - The user photo (selfie) is invalid.\n\n  - Category: selfie\n\n  - The image submitted does not qualify as a selfie.\n\n- BarcodeDetectError - The barcode could not be detected on the ID.\n- AuthenticationError - The request could not be authenticated.\n\n  - The key could not be verified.\n\n- NotFoundError - The requested resource does not exist, or is not visible to this account.\n- ConflictError - The request conflicts with the current state of the resource.\n- AccountConfigErrorType - The feature is not enabled for this account.\n- SSNAccountConfigErrorType - SSN verification is not enabled for this account. Returned by the SSN endpoints in place of `AccountConfigErrorType`.\n- SSNUnprocessableEntityErrorType - The eCBSV request contains incorrectly formatted or missing data.\n- UnknownSystemError - A unknown system error occurred.\n- LivenessSkippedError - Selfie liveness was skipped.\n- LivenessScoreError - The selfie liveness score was below the threshold.\n- LivenessCompletionError - The selfie liveness check did not complete.\n- DarkWebError - The dark web check result was below the threshold.\n- ipAddressError - The IP address check result was below the threshold.\n- AMLError - The AML screening result was below the threshold.\n- MissingIdentityErrorType - No identity document was supplied.\n- RestrictedIdDocumentError - The identity document did not meet the account's configured constraints.\n- CrosscheckIdentityError - The CrossCheck identity score was below the threshold.\n- StableSelfiePatternError - An unstable selfie pattern was detected.\n- StableIdPatternError - An unstable ID pattern was detected.\n- DocumentVoidedError - The document has been voided.\n- DlvError - The ID did not pass Driver's License Verification.",
            "enum": [
              "InvalidRequestError",
              "FaceMatchError",
              "NameMatchError",
              "BarcodeMatchError",
              "BarcodeDetectError",
              "BirthDateMatchError",
              "ExpiredIdError",
              "InvalidIdPhotoError",
              "InvalidUserPhotoError",
              "AuthenticationError",
              "NotFoundError",
              "ConflictError",
              "AccountConfigErrorType",
              "SSNAccountConfigErrorType",
              "SSNUnprocessableEntityErrorType",
              "UnknownSystemError",
              "LivenessSkippedError",
              "LivenessScoreError",
              "LivenessCompletionError",
              "DarkWebError",
              "ipAddressError",
              "AMLError",
              "MissingIdentityErrorType",
              "RestrictedIdDocumentError",
              "CrosscheckIdentityError",
              "StableSelfiePatternError",
              "StableIdPatternError",
              "DocumentVoidedError",
              "DlvError"
            ]
          },
          "message": {
            "type": "string",
            "description": "Details on the occurring error."
          },
          "warning": {
            "type": "boolean",
            "description": "Is this a warning?"
          },
          "suggestion": {
            "example": "John Smith",
            "description": "A suggestion for matching name.",
            "type": "string"
          }
        }
      },
      "errors": {
        "type": "object",
        "description": "One or more errors describing why the request failed.",
        "required": [
          "errors"
        ],
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/error"
            }
          }
        }
      },
      "token_error_response": {
        "type": "object",
        "description": "Returned by the JWT middleware, which runs ahead of all routers and so can answer any path. Note this is a single `error` string, not the `errors` array used by the rest of the API.",
        "properties": {
          "error": {
            "type": "string",
            "enum": [
              "Token expired",
              "Token malformed"
            ]
          }
        }
      },
      "aml_v2_listing": {
        "type": "object",
        "description": "Details of a matched listing for a risk profile.",
        "properties": {
          "amlTypes": {
            "type": "array",
            "description": "The AML types associated with this listing (e.g. sanction, pep, warning).",
            "items": {
              "type": "string"
            }
          },
          "listName": {
            "type": [
              "string",
              "null"
            ],
            "description": "The name of the matched list."
          },
          "listingStartedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "The datetime the entity was added to the list."
          },
          "listingEndedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "The datetime the entity was removed from the list."
          },
          "url": {
            "type": [
              "string",
              "null"
            ],
            "description": "The public URL of the list."
          },
          "countryCodes": {
            "type": "array",
            "description": "ISO 3166-1 alpha-2 country codes associated with the listing.",
            "items": {
              "type": "string"
            }
          },
          "politicalPositions": {
            "type": "array",
            "description": "Political positions associated with the individual, if applicable.",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "aml_v2_monitoring_risk": {
        "type": "object",
        "description": "A risk profile change detected during ongoing monitoring.",
        "properties": {
          "changeType": {
            "type": "string",
            "description": "The type of change detected for this risk."
          },
          "receivedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The datetime this monitoring alert was received."
          },
          "akas": {
            "type": "array",
            "description": "Alternative names (also known as) for the matched entity.",
            "items": {
              "type": "string"
            }
          },
          "matchingName": {
            "type": [
              "string",
              "null"
            ],
            "description": "The name that was matched for this risk profile."
          },
          "datesOfBirth": {
            "type": "array",
            "description": "Dates of birth associated with the matched entity.",
            "items": {
              "type": "string"
            }
          },
          "listings": {
            "type": "array",
            "description": "List of matched listings for this risk profile.",
            "items": {
              "$ref": "#/components/schemas/aml_v2_listing"
            }
          }
        }
      },
      "aml_v2_monitoring": {
        "type": [
          "object",
          "null"
        ],
        "description": "Ongoing monitoring data for the AML job. This will be null if monitoring is not enabled for the account.",
        "properties": {
          "startedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The datetime monitoring started."
          },
          "endedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "The datetime monitoring ended, or null if still active."
          },
          "durationDays": {
            "type": [
              "integer",
              "null"
            ],
            "description": "The number of days monitoring has been or was active. This will be null if monitoring is enabled and indefinite. Contact Support for time length options."
          },
          "risks": {
            "type": "array",
            "description": "Risk changes detected during monitoring.",
            "items": {
              "$ref": "#/components/schemas/aml_v2_monitoring_risk"
            }
          }
        }
      },
      "verification_property": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 255,
            "description": "Name of the property"
          },
          "value": {
            "type": "string",
            "maxLength": 1024,
            "description": "Value of the property"
          }
        },
        "required": [
          "name",
          "value"
        ]
      },
      "verification_properties": {
        "type": "array",
        "description": "Optional list of arbitrary customer supplied properties, echoed back on the job response and omitted from it when none were sent. Intended for attributing the result in your own system — send an identifier you can look up rather than the record itself. At most 5 entries. The same values are also returned for this job by `GET /api/jobs` under `request.properties`, where they are `null` rather than omitted when none were sent.",
        "maxItems": 5,
        "items": {
          "$ref": "#/components/schemas/verification_property"
        }
      },
      "aml_v2_request": {
        "type": "object",
        "description": "AML Enhanced Screening and Monitoring Request",
        "properties": {
          "firstName": {
            "type": "string",
            "description": "The person's first name."
          },
          "middleName": {
            "type": "string",
            "description": "The person's middle name."
          },
          "fullName": {
            "type": "string",
            "description": "The person's full name. This field is mutually exclusive with firstName, middleName, lastName, title, and suffix — if fullName is provided, those fields are ignored and only fullName is used for screening. Note that lastName is still required for submission even when fullName is provided."
          },
          "lastName": {
            "type": "string",
            "description": "The person's last name."
          },
          "title": {
            "type": "string",
            "description": "The person's title (e.g. Mr, Mrs, Dr)."
          },
          "suffix": {
            "type": "string",
            "description": "The person's name suffix (e.g. Jr, Sr, III)."
          },
          "birthDay": {
            "type": "integer",
            "minimum": 1,
            "maximum": 31,
            "description": "The person's birth day (1-31)."
          },
          "birthMonth": {
            "type": "integer",
            "minimum": 1,
            "maximum": 12,
            "description": "The person's birth month (1-12)."
          },
          "birthYear": {
            "type": "integer",
            "description": "The person's birth year (e.g. 1990)."
          },
          "birthCountry": {
            "type": "string",
            "description": "ISO 3166-1 alpha-2 country code (uppercase) of the person's birth country."
          },
          "gender": {
            "type": "string",
            "description": "The person's gender.",
            "enum": [
              "MALE",
              "FEMALE",
              "NOT_KNOWN",
              "OTHER"
            ]
          },
          "email": {
            "type": "string",
            "description": "The person's email address.",
            "format": "email"
          },
          "phone": {
            "type": "string",
            "description": "The person's phone number in E.164 format (e.g. +14155552671)."
          },
          "addressLine1": {
            "type": "string",
            "description": "Address line 1."
          },
          "addressLine2": {
            "type": "string",
            "description": "Address line 2."
          },
          "addressCity": {
            "type": "string",
            "description": "Address city."
          },
          "addressSubdivision": {
            "type": "string",
            "description": "Address state or subdivision."
          },
          "addressPostalCode": {
            "type": "string",
            "description": "Address postal code."
          },
          "addressCountry": {
            "type": "string",
            "description": "ISO 3166-1 alpha-2 country code (uppercase) of the address."
          },
          "addressType": {
            "type": "string",
            "description": "The type of address.",
            "enum": [
              "RESIDENTIAL_ADDRESS",
              "MAILING_ADDRESS",
              "OPERATING_ADDRESS",
              "REGISTRATION_ADDRESS",
              "BILLING_ADDRESS"
            ]
          },
          "residenceCountry": {
            "type": "string",
            "description": "ISO 3166-1 alpha-2 country code (uppercase) of the person's country of residence."
          },
          "residenceStatus": {
            "type": "string",
            "description": "The person's residence status.",
            "enum": [
              "RESIDENT",
              "PERMANENT_RESIDENT",
              "NON_RESIDENT",
              "TAX_RESIDENT"
            ]
          },
          "idExpiryDateDay": {
            "type": "integer",
            "description": "ID document expiry day (1-31)."
          },
          "idExpiryDateMonth": {
            "type": "integer",
            "description": "ID document expiry month (1-12)."
          },
          "idExpiryDateYear": {
            "type": "integer",
            "description": "ID document expiry year."
          },
          "idIssueDateDay": {
            "type": "integer",
            "description": "ID document issue day (1-31)."
          },
          "idIssueDateMonth": {
            "type": "integer",
            "description": "ID document issue month (1-12)."
          },
          "idIssueDateYear": {
            "type": "integer",
            "description": "ID document issue year."
          },
          "idCountry": {
            "type": "string",
            "description": "ISO 3166-1 alpha-2 country code (uppercase) of the ID document."
          },
          "idNumber": {
            "type": "string",
            "description": "The ID document number."
          },
          "idType": {
            "type": "string",
            "description": "The type of ID document.",
            "enum": [
              "SOCIAL_SECURITY_NUMBER",
              "DRIVING_LICENCE",
              "PASSPORT",
              "IDENTITY_CARD",
              "TAX_REGISTRATION",
              "ALIEN_IDENTIFICATION",
              "EMPLOYER_IDENTIFICATION",
              "OTHER"
            ]
          },
          "callbackUrl": {
            "type": "string",
            "description": "URL to receive a webhook callback when the AML job completes. NOTE this will also be used for monitoring updates if enabled for the account. The response structure will be identical to the 200 response of this endpoint.",
            "format": "uri"
          },
          "associatedJobId": {
            "type": "string",
            "description": "Existing Vouched IDV job ID to be linked to this AML job. This is purely for data tracking purposes. There are no side effects."
          },
          "properties": {
            "$ref": "#/components/schemas/verification_properties"
          }
        },
        "required": [
          "lastName"
        ]
      },
      "aml_v2_risk": {
        "type": "object",
        "description": "A risk profile matched during AML screening.",
        "properties": {
          "akas": {
            "type": "array",
            "description": "Alternative names (also known as) for the matched entity.",
            "items": {
              "type": "string"
            }
          },
          "matchingName": {
            "type": [
              "string",
              "null"
            ],
            "description": "The name that was matched for this risk profile."
          },
          "datesOfBirth": {
            "type": "array",
            "description": "Dates of birth associated with the matched entity.",
            "items": {
              "type": "string"
            }
          },
          "listings": {
            "type": "array",
            "description": "List of matched listings for this risk profile.",
            "items": {
              "$ref": "#/components/schemas/aml_v2_listing"
            }
          }
        }
      },
      "aml_v2_response": {
        "type": "object",
        "description": "AML Enhanced Screening and Monitoring Response",
        "required": [
          "id",
          "request",
          "initialScreening"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "The job ID."
          },
          "request": {
            "$ref": "#/components/schemas/aml_v2_request"
          },
          "initialScreening": {
            "type": "object",
            "description": "Results from the initial AML Enhanced Screening.",
            "required": [
              "submittedAt",
              "updatedAt",
              "status",
              "monitoringEnabled"
            ],
            "properties": {
              "submittedAt": {
                "type": "string",
                "format": "date-time",
                "description": "The datetime the screening was submitted."
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "description": "The datetime the screening was last updated."
              },
              "status": {
                "type": "string",
                "description": "The execution status of the screening.",
                "enum": [
                  "pending",
                  "complete",
                  "error"
                ]
              },
              "approved": {
                "type": [
                  "boolean",
                  "null"
                ],
                "description": "Whether the screening was approved (true), rejected (false), or not yet decided (null)."
              },
              "monitoringEnabled": {
                "type": "boolean",
                "description": "Whether ongoing monitoring is enabled for this job."
              },
              "risks": {
                "type": "array",
                "description": "Risk profiles matched during the initial screening.",
                "items": {
                  "$ref": "#/components/schemas/aml_v2_risk"
                }
              }
            }
          },
          "monitoring": {
            "$ref": "#/components/schemas/aml_v2_monitoring"
          },
          "version": {
            "type": "string",
            "description": "Present only for jobs created before Enhanced Screening."
          }
        }
      }
    },
    "responses": {
      "400": {
        "description": "InvalidRequestError - The request is invalid. An aborted or oversized request is answered with this status and an empty body instead of the envelope below.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/errors"
            },
            "example": {
              "errors": [
                {
                  "type": "InvalidRequestError",
                  "message": "Invalid request"
                }
              ]
            }
          }
        }
      },
      "401": {
        "description": "The request could not be authenticated. Credential rejection returns an `AuthenticationError` envelope; a malformed or expired bearer token is rejected earlier by the JWT middleware and returns `{ \"error\": \"Token expired\" }` or `{ \"error\": \"Token malformed\" }` instead.",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/errors"
                },
                {
                  "$ref": "#/components/schemas/token_error_response"
                }
              ]
            },
            "example": {
              "errors": [
                {
                  "type": "AuthenticationError",
                  "message": "Unauthorized access"
                }
              ]
            }
          }
        }
      },
      "404": {
        "description": "NotFoundError - The requested resource does not exist.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/errors"
            },
            "example": {
              "errors": [
                {
                  "type": "NotFoundError",
                  "message": "job not found"
                }
              ]
            }
          }
        }
      },
      "500": {
        "description": "UnknownSystemError - A unknown system error occurred.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/errors"
            },
            "example": {
              "errors": [
                {
                  "type": "UnknownSystemError",
                  "message": "Oops, we encountered a problem"
                }
              ]
            }
          }
        }
      }
    }
  },
  "x-tagGroups": [
    {
      "name": "APIs",
      "tags": [
        "jobs",
        "invites",
        "crosscheck",
        "aml",
        "ssn",
        "tin",
        "dob",
        "documents"
      ]
    },
    {
      "name": "Internal",
      "tags": [
        "client",
        "digital-id",
        "admin",
        "webhooks"
      ]
    }
  ]
}
```