Sign in

v1

latestOpenAPI 3.1.02026-07-2656114159.7 KB
Risk

Credit Score Query

Query customer credit score information using mobile number, ID number, and optional extended info.

post/api/v1/merchant/risk/credit-score/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

mobile_nostring required
id_numberstring required
extend_infoobject required

Example request

{
  "mobile_no": "08012345678",
  "id_number": "22123456789",
  "extend_info": {
    "channel": "web",
    "product": "consumer-loan"
  }
}

Response

Credit score query response

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "Credit score query completed successfully",
  "data": {
    "credit_score": "742",
    "version": "v1.0",
    "request_id": "CSQ-20260402-0001"
  },
  "charges": {
    "charged_amount": "0.00"
  }
}