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

# Blacklist Query

> Query blacklist data using phone number, BVN, and NIN identifiers.



## OpenAPI

````yaml POST /api/v1/merchant/risk/blacklist/query
openapi: 3.1.0
info:
  title: PayVessel API
  description: >-
    PayVessel API for accepting payments, sending money, verifying identities,
    and managing wallets
  version: 1.0.0
servers:
  - url: https://api.payvessel.com
  - url: https://sandbox.payvessel.com
security:
  - {}
paths:
  /api/v1/merchant/risk/blacklist/query:
    post:
      tags:
        - Risk
      summary: Blacklist Query
      description: Query blacklist data using phone number, BVN, and NIN identifiers.
      parameters:
        - name: api-key
          in: header
          description: Your Payvessel public API key
          required: true
          schema:
            type: string
        - name: api-secret
          in: header
          description: Your Payvessel secret
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Request content type
          required: true
          schema:
            type: string
            enum:
              - application/json
          example: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlacklistQueryRequest'
            examples:
              default:
                summary: Blacklist query request
                value:
                  phone_number: '08012345678'
                  bvn_no: '22123456789'
                  nin: '12345678901'
      responses:
        '200':
          description: Blacklist query response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlacklistQueryResponse'
              examples:
                successfulQuery:
                  summary: Successful blacklist query
                  value:
                    success: true
                    message: Blacklist query completed successfully
                    data:
                      result: NO_HIT
                      hit_time: 0
                      request_id: BLQ-20260402-0001
                    charges:
                      charged: false
                      charged_amount: '0.00'
        '402':
          description: >-
            Query could not be processed because the wallet balance is
            insufficient
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationPaymentErrorResponse'
              examples:
                insufficientBalance:
                  summary: Insufficient wallet balance
                  value:
                    success: false
                    message: >-
                      Your wallet balance is insufficient for this request.
                      Required 25.00, available 0. Please fund your wallet and
                      try again.
                    details:
                      - >-
                        Your wallet balance is insufficient for this request.
                        Required 25.00, available 0. Please fund your wallet and
                        try again.
      servers:
        - url: https://api.payvessel.com/kyc
        - url: https://sandbox.payvessel.com/kyc
components:
  schemas:
    BlacklistQueryRequest:
      type: object
      required:
        - phone_number
        - bvn_no
        - nin
      properties:
        phone_number:
          type: string
          description: Customer phone number
          example: '08012345678'
        bvn_no:
          type: string
          description: Customer BVN
          example: '22123456789'
        nin:
          type: string
          description: Customer NIN
          example: '12345678901'
    BlacklistQueryResponse:
      type: object
      required:
        - success
        - message
        - data
        - charges
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Blacklist query completed successfully
        data:
          $ref: '#/components/schemas/BlacklistQueryData'
        charges:
          $ref: '#/components/schemas/VerificationCharges'
    VerificationPaymentErrorResponse:
      type: object
      required:
        - success
        - message
        - details
      properties:
        success:
          type: boolean
          description: Whether the request completed successfully
          example: false
        message:
          type: string
          description: Reason the request could not be processed
          example: >-
            Your wallet balance is insufficient for this request. Required
            25.00, available 0. Please fund your wallet and try again.
        details:
          type: array
          description: Detailed error messages returned by the API
          items:
            type: string
          example:
            - >-
              Your wallet balance is insufficient for this request. Required
              25.00, available 0. Please fund your wallet and try again.
    BlacklistQueryData:
      type: object
      required:
        - result
        - hit_time
        - request_id
      properties:
        result:
          type: string
          example: NO_HIT
        hit_time:
          type: integer
          example: 0
        request_id:
          type: string
          example: BLQ-20260402-0001
    VerificationCharges:
      type: object
      required:
        - charged
        - charged_amount
      properties:
        charged:
          type: boolean
          description: Whether the verification request was billed
        charged_amount:
          type: string
          description: Amount charged for the verification request
          example: '0.00'

````