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

# AML Check Individual Service

> AML Check Individual Service API Documentation

For a usage description of the AML Check Individual Service, please refer to the [AML](/essentials/aml) page.

## Endpoint

**POST** `/aml/checkIndividual`

## Swagger

<a href="/public/downloads/swagger/AML/AML.postman_collection.json" download="AML.postman_collection.json">
  <button>⬇️ Download OpenAPI YAML</button>
</a>


## OpenAPI

````yaml POST /aml/checkIndividual
openapi: 3.1.0
info:
  title: Umbrella API
  version: 1.0.0
  description: >-
    API documentation for Umbrella services including KYB, KYC, AML, payments,
    phone intelligence, onboarding, and address verification.
servers:
  - url: https://api-umbrella.io/api/services
    description: Production
  - url: https://sandbox-umbrella-api.azurewebsites.net/api/services
    description: Sandbox
security:
  - bearerAuth: []
paths:
  /aml/checkIndividual:
    post:
      summary: Check Individual
      description: >-
        Checks an individual in the AML system to see if there are any matches
        for the provided details.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AMLIndividualCheckRequest'
      responses:
        '200':
          description: A JSON array of matching individuals.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AMLIndividualCheckResponse'
        '400':
          description: Bad request due to missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: API key is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
components:
  schemas:
    AMLIndividualCheckRequest:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          description: Search string checked against name fields.
          example: Boris Johnson
        dob:
          type: string
          description: Date of birth in the format yyyy/mm/dd.
          example: 1964/06/19
    AMLIndividualCheckResponse:
      type: object
      properties:
        timestamp:
          type: string
          description: The timestamp of the response (ISO 8601 date time).
          example: 2024/09/24T19:16:00Z
        totalHits:
          type: number
          description: The total number of hits for the searched parameters.
          example: 1
        foundRecords:
          type: array
          description: Array with attributes of type Individual.
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier for the record.
                example: c438b18a93cd3c13
              sourceType:
                type: string
                description: 'Possible values: SANCTION, PEP, CRIMINAL.'
                enum:
                  - SANCTION
                  - PEP
                  - CRIMINAL
                example: PEP
              pepType:
                type: string
                description: >-
                  Type of PEP (e.g., POLITICIAN, JUDGE,
                  BOARD_MEMBER_OF_CENTRAL_BANK).
                example: POLITICIAN
              sourceId:
                type: string
                description: The source ID of the list.
                example: dilisense_pep
              entityType:
                type: string
                description: 'Enumeration: INDIVIDUAL, UNKNOWN.'
                enum:
                  - INDIVIDUAL
                  - UNKNOWN
                example: INDIVIDUAL
              gender:
                type: string
                description: 'Enumeration: FEMALE, MALE, UNKNOWN.'
                enum:
                  - FEMALE
                  - MALE
                  - UNKNOWN
                example: MALE
              name:
                type: string
                description: Name of the individual.
                example: Boris Johnson
              lastNames:
                type: array
                description: A list of last names of this individual.
                items:
                  type: string
                example:
                  - Johnson
                  - Pfeffel
              aliasNames:
                type: array
                description: A list of alias names of this individual.
                items:
                  type: string
                example:
                  - Alexander Boris de Pfeffel Johnson
                  - Boris
                  - BoJo
              givenNames:
                type: array
                description: A list of given names of this individual.
                items:
                  type: string
                example:
                  - Alexander
                  - Boris
              dateOfBirth:
                type: array
                description: A list of dates of birth for this individual.
                items:
                  type: string
                example:
                  - 1964/06/19
              placeOfBirth:
                type: array
                description: A list of places of birth for this individual.
                items:
                  type: string
                example:
                  - New York City
              citizenship:
                type: array
                description: >-
                  A list of citizenships for this individual in ISO 3166-1
                  alpha-2 format.
                items:
                  type: string
                example:
                  - GB
                  - US
              occupations:
                type: array
                description: A list of occupations for this individual.
                items:
                  type: string
                example:
                  - journalist
                  - politician
              positions:
                type: array
                description: A list of positions for this individual.
                items:
                  type: string
                example:
                  - >-
                    2001/06/07 - 2005/04/11 Member of the 53rd Parliament of the
                    United Kingdom
                  - Since 2019/07/24 Prime Minister of the United Kingdom
              politicalParties:
                type: array
                description: A list of political parties for this individual.
                items:
                  type: string
                example:
                  - Conservative Party
              links:
                type: array
                description: >-
                  A list of links for this individual (e.g., websites, email
                  addresses).
                items:
                  type: string
                example:
                  - https://www.gov.uk/government/people/boris-johnson
                  - 'Facebook: borisjohnson'
    Error400:
      required:
        - message
      type: object
      properties:
        message:
          type: string
          example: Invalid request payload
    Error401:
      required:
        - message
      type: object
      properties:
        message:
          type: string
          example: Unauthorized request
    Error403:
      required:
        - message
      type: object
      properties:
        message:
          type: string
          example: Forbidden
    Error500:
      required:
        - message
      type: object
      properties:
        message:
          type: string
          example: Internal Server Error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token obtained from POST /auth. Valid for 60 minutes.

````