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

# Global DB Initiate Check API

> Initiate Global DB check for the given search term(Name of an individual.)



## OpenAPI

````yaml POST /v2/verification/global-db/initiate/
openapi: 3.0.0
info:
  title: KonnectNXT API Store
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://bgv.konnectnxt.com/api
    description: Production
  - url: https://testbgv.konnectnxt.com/api
    description: QA
security:
  - bearerAuth: []
paths:
  /v2/verification/global-db/initiate/:
    post:
      tags:
        - Global Database Check
      summary: Initiate global database screening
      description: >-
        Initiates an asynchronous global database (AML) screening request. The
        vendor processes the request in the background. Use the GET endpoint
        with the returned `request_id` to fetch the result.
      operationId: initiateGlobalDbCheck
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GlobalDBInitiateRequest'
      responses:
        '201':
          description: Screening initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalDBInitiateSuccessResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/InsufficientCredits'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          description: Vendor error
components:
  schemas:
    GlobalDBInitiateRequest:
      type: object
      required:
        - search_term
      properties:
        search_term:
          type: string
          example: John Doe
          description: Name or entity to be screened
        group_id:
          type: string
          example: grp_12345
          description: Optional group identifier
        version:
          type: string
          example: '2'
          description: Vendor API version
    GlobalDBInitiateSuccessResponse:
      type: object
      properties:
        status:
          type: string
          example: success
        code:
          type: integer
          example: 201
        message:
          type: string
          example: Operation completed successfully
        data:
          $ref: '#/components/schemas/GlobalDBInitiateData'
        credits_used:
          type: number
          example: 10
        credits_remaining:
          type: number
          example: 90
    GlobalDBInitiateData:
      type: object
      properties:
        task_id:
          type: string
          example: 550e8400-e29b-41d4-a716-446655440000
        group_id:
          type: string
          example: grp_12345
        request_id:
          type: string
          example: 1f07d2de-f113-43f5-9613-43d4897cb493
        status:
          type: string
          example: in_progress
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          example: error
        code:
          type: integer
          example: 400
        message:
          type: string
          example: Validation failed
        errors:
          type: object
          additionalProperties: true
  responses:
    BadRequest:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InsufficientCredits:
      description: Not enough credits
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Unexpected system error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key issued by KonnectNXT. Pass as `Authorization: Bearer
        <your_api_key>`.

````