Skip to main content
POST
/
api
/
v1
/
merchant
/
risk
/
blacklist
/
query
Blacklist Query
curl --request POST \
  --url https://api.payvessel.com/kyc/api/v1/merchant/risk/blacklist/query \
  --header 'Content-Type: <content-type>' \
  --header 'api-key: <api-key>' \
  --header 'api-secret: <api-secret>' \
  --data '
{
  "phone_number": "08012345678",
  "bvn_no": "22123456789",
  "nin": "12345678901"
}
'
{
  "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"
  }
}

Headers

api-key
string
required

Your PayVessel API key

api-secret
string
required

Your PayVessel API secret

Content-Type
enum<string>
required

Request content type

Available options:
application/json

Body

application/json
phone_number
string
required

Customer phone number

Example:

"08012345678"

bvn_no
string
required

Customer BVN

Example:

"22123456789"

nin
string
required

Customer NIN

Example:

"12345678901"

Response

Blacklist query response

success
boolean
required
Example:

true

message
string
required
Example:

"Blacklist query completed successfully"

data
object
required
charges
object
required