> ## 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

> Check individuals against global watchlists and anti‐money laundering databases.



## OpenAPI

````yaml api-reference-legacy/openapi.json POST /api/v1/verification/aml
openapi: 3.0.3
info:
  title: IDmeta API
  description: IDmeta verification and integration API.
  license:
    name: MIT
  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: []
tags:
  - name: Processes
    description: Verification process endpoints
  - name: Compliance
    description: Compliance verification endpoints
  - name: Government Data
    description: Government data verification endpoints
paths:
  /api/v1/verification/aml:
    post:
      tags:
        - Compliance
      summary: Watchlist and AML screening
      description: >-
        Checks watchlists and AML data using identity details and verification
        context.
      operationId: watchlistAmlScreening
      parameters:
        - 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:
              default:
                summary: AML screening request
                value:
                  name: <string>
                  dob: '1990-05-15'
                  gender: <string>
                  template_id: '{your_trust_flow_id}'
                  verification_id: '{your_created_verification_id}'
      responses:
        '200':
          description: AML screening completed successfully
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WatchlistAmlResponse'
              example:
                status: true
                message: OK
                result:
                  results:
                    matchCount: 39
                    matches:
                      - qrCode: '3360148'
                        resourceId: 96e3b2e2...
                        score: 98
                        match: John Doe
                        name: John Doe
                        countries:
                          - GB
                        addresses:
                          - geography: GB
                            city: Slough
                        datasets:
                          - REL
                        gender: Male
                        resourceUri: /individuals/96e3b2e2...
                      - qrCode: '10262301'
                        resourceId: 4d3dd373...
                        score: 85
                        match: John Deo
                        name: John Deo
                        countries:
                          - FJ
                        addresses:
                          - geography: FJ
                        datasets:
                          - POI
                        gender: Male
                        profileImage: https://.../qe__8tn3.PNG
                        resourceUri: /individuals/4d3dd373...
                      - qrCode: '5868428'
                        resourceId: f1cf2dc6...
                        score: 81
                        match: John
                        name: John Ryan
                        countries:
                          - NZ
                        addresses:
                          - geography: NZ
                            city: Wellington
                        datasets:
                          - PEP-FORMER
                        pepTier: PEP Tier 1
                        gender: Male
                        profileImage: https://.../XYWVJMbKmfJ7aOiJ1n_NC.jpeg
                        resourceUri: /individuals/f1cf2dc6...
components:
  schemas:
    WatchlistAmlRequest:
      type: object
      required:
        - name
        - template_id
        - verification_id
      properties:
        name:
          type: string
          description: Full name of the individual to be screened.
        dob:
          type: string
          description: Date of birth of the individual.
        gender:
          type: string
          description: Gender of the individual.
        template_id:
          type: string
          description: Identifier for categorizing or tracking verification templates.
        verification_id:
          type: string
          description: Unique ID to track the specific verification session or request.
    WatchlistAmlResponse:
      type: object
      properties:
        status:
          type: boolean
        message:
          type: string
        result:
          type: object
          additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use `Bearer {your_api_token}` in the Authorization header.

````