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

# Search using Identity

> Enables searching for politically exposed persons (PEP) and sanctioned entities using identity numbers, phone numbers, or company registration numbers. Supports an optional 'advancedSearch' object (firstName, lastName, position, keyword, gender, country, education) to streamline the search, as described on the Advanced Filters sub-page for this endpoint.



## OpenAPI

````yaml /api-reference/specs/quickcheck.json post /v2/api/verifications/advanced/identity/aml-checks
openapi: 3.0.3
info:
  title: Youverify Quick Check API
  version: 2.0.0
  description: >-
    All Quick Check endpoints (KYC identity verification by country, KYB
    business verification by country, and AML/watchlist screening). Assembled
    from doc.youverify.co/api-reference-sdk/api-reference/quick-check, endpoints
    kept in the exact order they appear in the GitBook navigation. Some
    endpoints (address-verification "create a candidate" / "get states" /
    "retrieve" / "history") are documented twice in the source docs — once for
    individuals under KYC, once for businesses under KYB — and are the exact
    same request/response shape. They appear ONCE here (at their first, KYC,
    position) tagged with both sections so the file stays valid OpenAPI.


    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: KYC - Global
    description: Identity data-matching endpoints that work across countries.
  - name: KYC - South Africa
    description: South Africa-specific identity, phone and bank verification.
  - name: KYC - Kenya
    description: Kenya-specific identity, phone, bank, credit and employment verification.
  - name: KYC - Ghana
    description: Ghana-specific identity verification (passport, SSNIT, voter's card).
  - name: KYC - Nigeria
    description: >-
      Nigeria-specific identity, phone, bank and credit verification (BVN, NIN,
      etc).
  - name: KYC - Cote D'Ivoire
    description: Cote D'Ivoire-specific national ID and residence card verification.
  - name: KYC - General
    description: >-
      Identity retrieval, history and facial comparison, not tied to one
      country.
  - name: KYC - Address Verification (Individuals)
    description: >-
      Physical and digital address verification workflows for individuals. Note:
      these same endpoints are also documented under KYB for businesses — see
      merge notes.
  - name: KYB - Global
    description: >-
      Business search, bulk-upload and premium company-search endpoints not tied
      to one country.
  - name: KYB - Nigeria
    description: Nigeria-specific business address verification and tax ID checks.
  - name: KYB - South Africa
    description: South Africa-specific business account and address verification.
  - name: KYB - Cote D'Ivoire
    description: Cote D'Ivoire-specific company filings lookup.
  - name: AML Screening
    description: PEP, sanctions, adverse-media and crypto AML screening.
  - name: AML Watchlist
    description: Manage your own custom AML watchlist.
paths:
  /v2/api/verifications/advanced/identity/aml-checks:
    post:
      tags:
        - AML Screening
      summary: Search using Identity
      description: >-
        Enables searching for politically exposed persons (PEP) and sanctioned
        entities using identity numbers, phone numbers, or company registration
        numbers. Supports an optional 'advancedSearch' object (firstName,
        lastName, position, keyword, gender, country, education) to streamline
        the search, as described on the Advanced Filters sub-page for this
        endpoint.
      operationId: searchUsingIdentity
      parameters:
        - name: token
          in: header
          required: true
          schema:
            type: string
          description: API secret token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                  description: >-
                    Identity identifier to search with (e.g. phone number, ID
                    number, registration number)
                isSubjectConsent:
                  type: boolean
                  description: Confirm subject consent given. Must be true
                type:
                  type: string
                  description: Entity classification
                  enum:
                    - all
                    - individual
                    - business
                advancedSearch:
                  type: object
                  description: Contains features that can streamline your search
                  properties:
                    firstName:
                      type: string
                      description: First name of subject
                    lastName:
                      type: string
                      description: Last name of subject
                    position:
                      type: string
                      description: Position of subject
                    keyword:
                      type: string
                      description: Keywords related to the subject
                    gender:
                      type: string
                      description: Gender of subject
                    country:
                      type: string
                      description: Country of subject
                    education:
                      type: string
                      description: Subject's education
              required:
                - query
                - isSubjectConsent
                - type
            example:
              type: individual
              query: '+2347037730852'
              isSubjectConsent: 'true'
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                success: true
                statusCode: 200
                message: success
                data:
                  status: review_required
                  parentId: null
                  isSubjectConsent: true
                  type: individual
                  sanctions: []
                  pep:
                    - title:
                        - MUHAMMED GUDAJI
                      entityType: Person
                      datasets:
                        - wd_peps
                        - wikidata
                        - everypolitician
                      gender:
                        - male
                      position:
                        - member of the House of Representatives of Nigeria
                        - >-
                          member of the House of Representatives of Nigeria
                          (2019-)
                        - House of Representatives (member, 2015-)
                      topics:
                        - role.pep
                      birthDate:
                        - '1972-01-01T00:00:00.000Z'
                      alias:
                        - Muhammed Gudaji
                        - Muhammad Aliyu Gudaji
                        - MUHAMMED KAZAURE GUDAJI
                        - Muhammed Kazaure Gudaji
                        - Muhammed Gudaji Kazaure
                      keywords:
                        - National government
                      country:
                        - ng
                      nationality:
                        - ng
                      notes:
                        - Nigerian politician
                      name:
                        - Muhammed Gudaji
                        - MUHAMMED GUDAJI
                      phone:
                        - '+2347037730852'
                      positionOccupancies:
                        - post:
                            - country:
                                - ng
                              name:
                                - >-
                                  member of the House of Representatives of
                                  Nigeria
                          status:
                            - ended
                          startDate:
                            - '2019-06-11T00:00:00.000Z'
                          endDate:
                            - '2023-06-11T00:00:00.000Z'
                        - post:
                            - country:
                                - ng
                              name:
                                - >-
                                  member of the House of Representatives of
                                  Nigeria
                          status:
                            - ended
                          endDate:
                            - '2019-06-09T00:00:00.000Z'
                          startDate:
                            - '2015-06-09T00:00:00.000Z'
                  crime: []
                  debarment: []
                  financial_services: []
                  government: []
                  role: []
                  religion: []
                  military: []
                  frozen_asset: []
                  personOfInterest: []
                  totalEntity: 1
                  categoryCount:
                    sanctions: 0
                    pep: 1
                    crime: 0
                    debarment: 0
                    financial_services: 0
                    government: 0
                    role: 0
                    religion: 0
                    military: 0
                    frozen_asset: 0
                    personOfInterest: 0
                  queriedWith: Identity Number
                  query: '+2347037730852'
                  businessId: 6222a5ed3e7a41c29c031ecc
                  requestedAt: '2023-09-21T07:18:47.482Z'
                  requestedById: 6222a5ed3e7a41c29c031ece
                  createdAt: '2023-09-21T07:18:47.572Z'
                  lastModifiedAt: '2023-09-21T07:18:47.572Z'
                  id: 650bee57b5646f3c2c54a979
                  requestedBy:
                    firstName: API
                    lastName: User
                    middleName: ''
                    id: 6222a5ed3e7a41c29c031ece
                links: []
        '401':
          $ref: '#/components/responses/Error401Unauthorized'
        '402':
          $ref: '#/components/responses/Error402PaymentRequired'
        '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.

````