Resolve account name

Look up the registered name on a mobile-money account before initiating a payment. Use this to let your customers confirm they are paying the right person, or to pre-fill customer names during checkout.

POST/v1/resolve

Request body

Parameters

phone

stringrequired

The mobile-money phone number to resolve. Accepts any Ghanaian format: 0244000000, +233244000000, or 233244000000. JKAPay normalises before dispatch.

network

string

The customer's network. One of MTN, VODAFONE (alias TELECEL), or AIRTELTIGO (alias AT). Optional but recommended — it improves accuracy and avoids ambiguity when a number has been ported.

Sample request

cURL

curl -X POST https://api.jkapay.com/v1/resolve \
  -H "Authorization: Bearer sk_test_YOUR_KEY" \
  -H "X-JKAPay-Merchant-Id: MCH_XXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "0244000000",
    "network": "MTN"
  }'

Response fields

Response

name

string | null

The registered account holder name. null when the number could not be resolved (e.g. unregistered number or network timeout).

verified

boolean

true when name was successfully resolved, false otherwise.

Response200

JSON

{
  "name": "KWAME ASANTE",
  "verified": true
}

Unresolved number

Response200

JSON

{
  "name": null,
  "verified": false
}

Errors

400 VALIDATION_ERROR — the request body failed validation. Check error.details.
401 UNAUTHENTICATED — missing, malformed, or revoked API key.
403 FORBIDDEN — your merchant account is suspended, or the request IP is not in your whitelist.
502 SERVICE_UNAVAILABLE — the name lookup service is temporarily unavailable. Safe to retry.