Identity & KYC API

Verify the identity of recipients before initiating payouts or transfers to ensure security and reduce errors.

API Version

Overview

The Identity API allows you to programmatically verify the owner of a CashPay wallet or a Mobile Money account. This is a critical step in the "Verify-before-Pay" workflow to prevent fraudulent transfers and accidental payments to wrong numbers.

Security Requirement

We highly recommend performing a name lookup before any Payout or Airtime transaction. This ensures that the person you intend to pay matches the account holder's name.

Mobile Money Name Lookup

Interrogates the operator network (e.g., Airtel, M-Pesa) to retrieve the registered name for a specific phone number.

GET/api/v1/b2b/identity/lookup

Returns the full name associated with a mobile money phone number.

Request Example

cURL

curl -X GET 'https://api.cashpay-all.com/api/v1/b2b/identity/lookup?phone=243812345678&operator=AIRTEL' \
-H 'Authorization: Bearer <YOUR_API_KEY>'

Success Response

JSON

{
  "success": true,
  "data": {
    "fullName": "PATRICK KAMANDA",
    "phone": "243812345678",
    "operator": "AIRTEL",
    "status": "VERIFIED"
  }
}

CashPay Wallet Verification

Verifies if a CashPay Wallet ID (X-Wallet) exists and returns the holder's name.

GET/api/v1/b2b/identity/wallet/{walletId}

Retrieves the owner name for a native CashPay wallet.

Example Response

JSON

{
  "success": true,
  "data": {
    "fullName": "JEAN DUPONT",
    "walletId": "CD01-A1B2C3",
    "accountType": "Personal"
  }
}