Skip to main content
Use these endpoints to augment your risk engine with blacklist checks, credit scores, and loan feature eligibility for customers. Base paths:
  • Sandbox: https://sandbox.payvessel.com/kyc
  • Production: https://api.payvessel.com/kyc
All paths below are relative to the base URL.

​
Blacklist query

POST /api/v1/merchant/risk/blacklist/query Check whether a customer appears on internal or external blacklists. Typical request body fields:
  • Identifiers such as BVN, NIN, phone number, or email
  • reference – unique query reference
Use the result to block high‑risk customers or route them to manual review.

​
Credit score query

POST /api/v1/merchant/risk/credit-score/query Retrieve a credit score or risk band for a customer. Typical request body fields:
  • Customer identifier(s) (e.g. BVN/NIN or other profile keys)
  • reference – unique query reference
Responses typically include:
  • A numeric score or risk grade
  • Additional fields that explain the score or segment

​
Loan feature query

POST /api/v1/merchant/risk/loan-feature/query Ask whether a customer is eligible for certain loan features (e.g. limits, tenor, or pricing bands). Typical request body fields:
  • Customer identifiers and basic loan parameters
  • reference – unique query reference
Use this to design loan offers and adjust pricing based on risk.

​
Example (blacklist)

curl -X POST "https://sandbox.payvessel.com/kyc/api/v1/merchant/risk/blacklist/query" \
  -H "Content-Type: application/json" \
  -d '{
    "bvn": "12345678901",
    "reference": "BL_2026_001"
  }'

​
Example (credit score)

curl -X POST "https://sandbox.payvessel.com/kyc/api/v1/merchant/risk/credit-score/query" \
  -H "Content-Type: application/json" \
  -d '{
    "bvn": "12345678901",
    "reference": "CS_2026_001"
  }'

​
Example (loan feature)

curl -X POST "https://sandbox.payvessel.com/kyc/api/v1/merchant/risk/loan-feature/query" \
  -H "Content-Type: application/json" \
  -d '{
    "bvn": "12345678901",
    "loan_amount": "500000.00",
    "tenor_months": 6,
    "reference": "LF_2026_001"
  }'