> ## Documentation Index
> Fetch the complete documentation index at: https://docs.idmetagroup.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Watchlist and AML Screening

> Screen an individual against AML and watchlist datasets through the passthrough endpoint.



## OpenAPI

````yaml stateless-verification-api/compliance/watchlist-aml.openapi.json POST /api/v3/verifications/watchlist-aml-passthrough
openapi: 3.0.3
info:
  title: Watchlist and AML Passthrough API
  version: 1.0.0
servers:
  - url: https://{environment-subdomain}.idmetagroup.com
    description: Your environment (replace `{environment-subdomain}`)
    variables:
      environment-subdomain:
        default: integrate
        description: IDmeta environment subdomain
security:
  - bearerAuth: []
paths:
  /api/v3/verifications/watchlist-aml-passthrough:
    post:
      tags:
        - Compliance Verification
      summary: Watchlist and AML Screening
      description: >-
        Screen an individual against AML and watchlist datasets. Screening
        settings are optional and use the documented defaults when omitted. A
        completed match is HTTP 200 with REVIEW_NEEDED by default, or REJECTED
        when `amlMatchDefaultAction` is `rejected`. An exact name and
        date-of-birth match is always REJECTED. AML monitoring worklist
        enrollment is not available through this stateless endpoint.
      operationId: watchlistAmlPassthrough
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: Bearer {your_api_token}
        - name: Accept
          in: header
          required: false
          schema:
            type: string
            default: application/json
        - name: Content-Type
          in: header
          required: false
          schema:
            type: string
            default: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WatchlistAmlRequest'
            examples:
              defaultSettings:
                summary: Screen using default settings
                value:
                  name: Example Person
                  dob: '1980-01-02'
                  metadata:
                    yourRef: case-1001
              customSettings:
                summary: Screen using request-specific settings
                value:
                  name: Example Person
                  dob: '1980-01-02'
                  datasets:
                    - PEP
                    - SAN
                  countries:
                    - PH
                    - SG
                  pepTiers:
                    - PEP Tier 1
                    - PEP Tier 2
                  threshold: 90
                  matchingPolicy: strict
                  gender: any
                  amlMatchDefaultAction: manual
                  metadata:
                    yourRef: case-1002
      responses:
        '200':
          description: >-
            Screening completed. No match, review-needed match, and rejected
            match outcomes all use HTTP 200.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WatchlistAmlSuccessResponse'
              examples:
                noMatches:
                  summary: No matches
                  value:
                    success: true
                    message: Watchlist AML screening processed successfully
                    data:
                      matchCount: 0
                      matches: []
                    verificationStatus: VERIFIED
                    verificationStatusCode: 3
                    transactionId: 79b6f81c-fc48-42ce-b907-763129b0957e
                    verificationType: aml
                    metadata:
                      yourRef: case-1001
                    createdAt: 2026-09-03 08:00:00+0000
                reviewNeeded:
                  summary: Match found for manual review
                  value:
                    success: true
                    message: Watchlist AML screening processed successfully
                    data:
                      matchCount: 1
                      matches:
                        - name: Example Person
                          score: 91
                          countries:
                            - PH
                          datesOfBirth:
                            - '1980-01-02'
                          datasets:
                            - PEP
                    verificationStatus: REVIEW_NEEDED
                    verificationStatusCode: 2
                    transactionId: 79b6f81c-fc48-42ce-b907-763129b0957e
                    verificationType: aml
                    metadata:
                      yourRef: case-1002
                    createdAt: 2026-09-03 08:00:00+0000
                rejected:
                  summary: Match handled as rejected
                  value:
                    success: true
                    message: Watchlist AML screening processed successfully
                    data:
                      matchCount: 1
                      matches:
                        - name: Example Person
                          score: 91
                          countries:
                            - PH
                          datesOfBirth:
                            - '1980-01-02'
                          datasets:
                            - PEP
                    verificationStatus: REJECTED
                    verificationStatusCode: 1
                    transactionId: 79b6f81c-fc48-42ce-b907-763129b0957e
                    verificationType: aml
                    metadata:
                      yourRef: case-1003
                    createdAt: 2026-09-03 08:00:00+0000
        '400':
          description: >-
            Validation failed. No source screening is performed and
            `transactionId` is null.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WatchlistAmlValidationErrorResponse'
              examples:
                invalidRequest:
                  summary: Validation failed
                  value:
                    success: false
                    code: VALIDATION_FAILED
                    message: >-
                      The request could not be validated. Please check the
                      submitted fields.
                    errors:
                      name:
                        - The name field is required.
                    transactionId: null
                    verificationType: aml
                    createdAt: 2026-09-03 08:00:00+0000
        '500':
          description: Internal error or screening source unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WatchlistAmlErrorResponse'
              examples:
                sourceUnavailable:
                  summary: Screening source unavailable
                  value:
                    success: false
                    code: SOURCE_UNAVAILABLE
                    message: >-
                      The verification source is currently unavailable. Please
                      try again later.
                    verificationStatus: FAILED
                    verificationStatusCode: 6
                    transactionId: f43156f1-c11c-4a38-92d9-c2d3221eba5b
                    verificationType: aml
                    metadata:
                      yourRef: case-1001
                    createdAt: 2026-09-03 08:00:00+0000
                internalError:
                  summary: Internal error
                  value:
                    success: false
                    code: INTERNAL_ERROR
                    message: >-
                      An internal error has occurred while processing your
                      request. Please try again later.
                    verificationStatus: FAILED
                    verificationStatusCode: 6
                    transactionId: f43156f1-c11c-4a38-92d9-c2d3221eba5b
                    verificationType: aml
                    metadata:
                      yourRef: case-1001
                    createdAt: 2026-09-03 08:00:00+0000
components:
  schemas:
    WatchlistAmlRequest:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          maxLength: 255
          description: Full name of the individual to screen.
          example: Example Person
        dob:
          type: string
          format: date
          nullable: true
          description: Optional date of birth.
        datasets:
          type: array
          minItems: 1
          default:
            - PEP
            - SAN
            - RRE
            - INS
            - DD
            - POI
            - REL
          items:
            type: string
            enum:
              - PEP
              - SAN
              - RRE
              - INS
              - DD
              - POI
              - REL
        countries:
          type: array
          minItems: 1
          default:
            - ID
            - PL
            - MY
            - US
            - AU
            - SG
          description: Two-character country codes used to narrow the search.
          items:
            type: string
            minLength: 2
            maxLength: 2
        pepTiers:
          type: array
          minItems: 1
          default:
            - PEP Tier 1
            - PEP Tier 2
            - PEP Tier 3
          items:
            type: string
            enum:
              - PEP Tier 1
              - PEP Tier 2
              - PEP Tier 3
        threshold:
          type: integer
          minimum: 75
          maximum: 100
          default: 75
        matchingPolicy:
          type: string
          enum:
            - fuzzy
            - strict
          default: fuzzy
        gender:
          type: string
          enum:
            - any
            - male
            - female
          default: any
        amlMatchDefaultAction:
          type: string
          enum:
            - manual
            - rejected
          default: manual
          description: >-
            Status applied when matches exist but there is no exact name and
            date-of-birth match.
        metadata:
          type: object
          additionalProperties: true
          description: >-
            Optional client-defined values echoed in completed and source-error
            responses.
    WatchlistAmlSuccessResponse:
      type: object
      required:
        - success
        - message
        - data
        - verificationStatus
        - verificationStatusCode
        - transactionId
        - verificationType
        - createdAt
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
        data:
          type: object
          required:
            - matchCount
            - matches
          properties:
            matchCount:
              type: integer
              minimum: 0
            matches:
              type: array
              items:
                type: object
                additionalProperties: true
          additionalProperties: true
        verificationStatus:
          type: string
          enum:
            - VERIFIED
            - REVIEW_NEEDED
            - REJECTED
        verificationStatusCode:
          type: integer
          enum:
            - 3
            - 2
            - 1
          description: '`3` = Verified, `2` = Review Needed, `1` = Rejected.'
        transactionId:
          type: string
          format: uuid
        verificationType:
          type: string
          example: aml
        metadata:
          type: object
          additionalProperties: true
          nullable: true
        createdAt:
          type: string
          example: 2026-09-03 08:00:00+0000
    WatchlistAmlValidationErrorResponse:
      type: object
      required:
        - success
        - code
        - message
        - errors
        - transactionId
        - verificationType
        - createdAt
      properties:
        success:
          type: boolean
          example: false
        code:
          type: string
          enum:
            - VALIDATION_FAILED
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        transactionId:
          type: string
          format: uuid
          nullable: true
        verificationType:
          type: string
          example: aml
        createdAt:
          type: string
    WatchlistAmlErrorResponse:
      type: object
      required:
        - success
        - code
        - message
        - verificationStatus
        - verificationStatusCode
        - transactionId
        - verificationType
        - createdAt
      properties:
        success:
          type: boolean
          example: false
        code:
          type: string
          enum:
            - SOURCE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
        verificationStatus:
          type: string
          example: FAILED
        verificationStatusCode:
          type: integer
          example: 6
        transactionId:
          type: string
          format: uuid
        verificationType:
          type: string
          example: aml
        metadata:
          type: object
          additionalProperties: true
          nullable: true
        createdAt:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use your API token as a Bearer token in the `Authorization` header.

````