Skip to main content
GET
/
v1
/
account-name-validation
Validate account name
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fingopay.io/v1/account-name-validation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "status": "success",
  "message": "Account validated",
  "data": {
    "found": true,
    "accountId": "0112345678900",
    "accountName": "Jane Wambui",
    "accountType": "pesalink",
    "freezeStatus": "0",
    "restrictStatus": "0",
    "errorMessage": "Account does not exist."
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. Example: Authorization: Bearer sk_live_...

Query Parameters

​
country
enum<string>
required

Country code (ISO 3166-1 alpha-2). Currently only KE (Kenya) is supported.

Available options:
KE
Example:

"KE"

​
accountId
string
required

The account identifier to validate. For M-Pesa this is the phone number (e.g. 254712345678), for bank accounts this is the account number, for tills/paybills this is the business number.

Example:

"0112345678900"

​
accountType
enum<string>
required

The type of account to validate.

Available options:
choice_bank,
mpesa_paybill,
mpesa_till,
mpesa_mobile,
pesalink
​
bankCode
string

Bank code from the /v1/local-bank-codes endpoint. Required when accountType is pesalink.

Example:

"07000"

Response

Validation result returned. Check the found field to determine whether the account exists.

​
status
string
required
Example:

"success"

​
message
string
required
Example:

"Account validated"

​
data
object
required

Result of account name validation. When found is false, the account does not exist or could not be validated.