Sign in

v1

latestOpenAPI 3.1.02026-07-2656114159.7 KB
Risk

Blacklist Query

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

post/api/v1/merchant/risk/blacklist/query

Headers

api-keystring required

Your Payvessel public API key

api-secretstring required

Your Payvessel secret

Content-Type'application/json' required

Request content type

Request body

phone_numberstring required

Customer phone number

bvn_nostring required

Customer BVN

ninstring required

Customer NIN

Example request

{
  "phone_number": "08012345678",
  "bvn_no": "22123456789",
  "nin": "12345678901"
}

Response

Blacklist query response

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "Blacklist query completed successfully",
  "data": {
    "result": "NO_HIT",
    "request_id": "BLQ-20260402-0001"
  },
  "charges": {
    "charged_amount": "0.00"
  }
}