Skip to main content
POST
/
api
/
v3
/
name-lookup
Validate a phone number against a customer name before payout
curl --request POST \
  --url https://sandbox-api.kotanipay.com/api/v3/name-lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "walletId": "5f9b2c7b9c9d6b0017b4e6b1",
  "customer_key": "customer-key-123"
}
'
import requests

url = "https://sandbox-api.kotanipay.com/api/v3/name-lookup"

payload = {
"walletId": "5f9b2c7b9c9d6b0017b4e6b1",
"customer_key": "customer-key-123"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({walletId: '5f9b2c7b9c9d6b0017b4e6b1', customer_key: 'customer-key-123'})
};

fetch('https://sandbox-api.kotanipay.com/api/v3/name-lookup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.kotanipay.com/api/v3/name-lookup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'walletId' => '5f9b2c7b9c9d6b0017b4e6b1',
'customer_key' => 'customer-key-123'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sandbox-api.kotanipay.com/api/v3/name-lookup"

payload := strings.NewReader("{\n \"walletId\": \"5f9b2c7b9c9d6b0017b4e6b1\",\n \"customer_key\": \"customer-key-123\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://sandbox-api.kotanipay.com/api/v3/name-lookup")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"walletId\": \"5f9b2c7b9c9d6b0017b4e6b1\",\n \"customer_key\": \"customer-key-123\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox-api.kotanipay.com/api/v3/name-lookup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"walletId\": \"5f9b2c7b9c9d6b0017b4e6b1\",\n \"customer_key\": \"customer-key-123\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "Name lookup completed.",
  "data": {}
}
{
"success": false,
"message": "Bad Request",
"data": {}
}
{
"success": false,
"message": "Invalid API Key",
"data": {}
}
Validate the mobile money account name on file for a customer before sending a payout to them, reducing the risk of sending funds to the wrong recipient. The phone number and network checked are always the ones already on file for the given customer_key — you cannot pass arbitrary values. Currently supported for corridors handled by pawaPay or Onafriq; unsupported corridors return status: "UNSUPPORTED" rather than an error.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
walletId
string
required

The fiat wallet the payout would be debited from — used to resolve which provider would actually handle it.

Example:

"5f9b2c7b9c9d6b0017b4e6b1"

customer_key
string
required

Customer key of an existing mobile-money customer. The phone number, network, and name validated are always the ones already on file for this customer — not arbitrary values — so the result reflects who would actually receive this payout.

Example:

"customer-key-123"

Response

success
boolean
Example:

true

message
string
Example:

"Name lookup completed."

data
object