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

# Verify Entity (AML)

> Runs Anti-Money Laundering (AML) checks such as PEP and sanctions screening against an entity, including its Ultimate Beneficial Owners.



## OpenAPI

````yaml /api-reference/specs/cowork.json post /v2/api/entities/{entityId}/amlChecks
openapi: 3.0.3
info:
  title: Youverify Cowork API
  version: 2.0.0
  description: >-
    Entity, Activity, Signal and Case Management endpoints — the core Cowork
    platform object model. Assembled from doc.youverify.co/api-reference-sdk,
    endpoints kept in the exact order they appear in the GitBook navigation.


    Account-wide error responses (401, 429, 500 on every endpoint; 402 on paid
    verification calls; 404 on lookup-by-ID calls) are sourced verbatim from
    Youverify's own "Youverify OS Error Codes" and "Response Codes" pages
    (doc.youverify.co/youverify-os-error-codes, /get-started/response-codes) and
    attached via components.responses, since those pages document them
    account-wide rather than per endpoint. Any error example that a specific
    endpoint's own page actually showed is kept exactly as documented there
    instead of being replaced by these.
  contact:
    name: Youverify Support
    email: support@youverify.co
servers:
  - url: https://api.youverify.co
    description: Production (live, billed)
  - url: https://api.sandbox.youverify.co
    description: Sandbox (test data, not billed)
security:
  - ApiKeyAuth: []
tags:
  - name: Entity Management
    description: >-
      Create, retrieve and verify entities (individuals or businesses) — the
      core object every check attaches to.
  - name: Activity Management
    description: Inspect the verification activities run against your account.
  - name: Signal Management
    description: Retrieve monitoring signals and their events, by entity or business.
  - name: Case Management
    description: Create and manage compliance cases, including AI-generated case summaries.
paths:
  /v2/api/entities/{entityId}/amlChecks:
    post:
      tags:
        - Entity Management
      summary: Verify Entity (AML)
      description: >-
        Runs Anti-Money Laundering (AML) checks such as PEP and sanctions
        screening against an entity, including its Ultimate Beneficial Owners.
      operationId: verifyEntityAml
      parameters:
        - name: token
          in: header
          required: true
          schema:
            type: string
          description: API secret token
        - name: entityId
          in: path
          required: true
          schema:
            type: string
          description: Id of the entity being checked
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                entityType:
                  type: string
                  description: Type of entity
                  enum:
                    - individual
                    - business
                isSubjectConsent:
                  type: boolean
                  description: Must be true
                incorporationNumber:
                  type: string
                  description: Required if amlCheckType is "id_number"
                incorporationName:
                  type: string
                  description: Business registered name
                incorporationCountry:
                  type: string
                  description: ISO 3166-1 alpha-2 code
                incorporationDate:
                  type: string
                  description: 'Format: YYYY-MM-DD'
                amlCheckType:
                  type: string
                  description: AML check strategy
                  enum:
                    - name
                    - id_number
                amlChecks:
                  type: array
                  items:
                    type: string
                  description: Additional AML checks, e.g. pep, sanctions
                ubos:
                  type: object
                  description: >-
                    Ultimate Beneficial Owners info, containing uboList and
                    amlChecks
                uboList:
                  type: array
                  items:
                    type: object
                  description: List of UBOs
                category:
                  type: string
                  description: UBO category
                  enum:
                    - individual
                    - business
                firstName:
                  type: string
                  description: Required for individual UBOs
                lastName:
                  type: string
                  description: Required for individual UBOs
                dateOfBirth:
                  type: string
                  description: 'Format: YYYY-MM-DD'
                nationality:
                  type: string
                  description: 2-character code
              required:
                - entityType
                - isSubjectConsent
            example:
              entityType: business
              isSubjectConsent: true
              incorporationName: Acme Corp
              incorporationCountry: NG
              incorporationDate: '2010-01-01'
              amlCheckType: name
              amlChecks:
                - pep
              ubos:
                uboList:
                  - category: individual
                    firstName: Jon
                    lastName: Snow
                amlChecks:
                  - pep
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                success: true
                status_code: 200
                message: AML checks performed successfully!
                data:
                  id: ent_6834f77bc55aea948b907391
                  entityType: business
                  amlProcessedChecks:
                    sanctions:
                      status: not_cleared
                      reportId: 68364960534488d5449f0784
                      data: []
                  uboChecks:
                    - ubo: Jon Snow
                      pep:
                        status: cleared
                        reportId: 68364962534488d5449f0787
                        data: []
                links: []
        '401':
          $ref: '#/components/responses/Error401Unauthorized'
        '402':
          $ref: '#/components/responses/Error402PaymentRequired'
        '404':
          description: Not Found
          content:
            application/json:
              example:
                success: false
                statusCode: 404
                message: You have attempted to get a resource that does not exist.
                name: ResourceNotFoundError
                data: {}
        '429':
          $ref: '#/components/responses/Error429TooManyRequests'
        '500':
          $ref: '#/components/responses/Error500ServerError'
components:
  responses:
    Error401Unauthorized:
      description: Unauthorized — the token header is missing or invalid.
      content:
        application/json:
          example:
            success: false
            statusCode: 401
            message: Permission denied
            name: UnauthorizedError
            data: {}
    Error402PaymentRequired:
      description: Payment Required — your account balance is too low to run this check.
      content:
        application/json:
          example:
            success: false
            statusCode: 402
            message: Insufficient fund
            name: PaymentRequiredError
            data: {}
    Error429TooManyRequests:
      description: Too Many Requests — you have exceeded the rate limit; wait and retry.
      content:
        application/json:
          example:
            success: false
            statusCode: 429
            message: Too many requests
            name: RateLimitError
            data: {}
    Error500ServerError:
      description: >-
        Internal Server Error — a rare, unexpected failure on Youverify's side.
        Contact support@youverify.co if it persists.
      content:
        application/json:
          example:
            success: false
            statusCode: 500
            message: Internal Server Error
            name: Error
            data: {}
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: token
      description: Your Youverify API secret key. Never expose client-side.

````