Create a cardholder
curl --request POST \
--url https://api.usenumero.com/numeroaccount/api/v1/business/cardholders \
--header 'Content-Type: application/json' \
--header 'X-Numero-Api-Key: <api-key>' \
--header 'X-Numero-Signature: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"dateOfBirth": "2023-12-25",
"address1": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": "<string>",
"country": "NG",
"idType": "PASSPORT",
"idNumber": "<string>",
"bvn": "<string>",
"idDocumentFrontUrl": "<string>"
}
'import requests
url = "https://api.usenumero.com/numeroaccount/api/v1/business/cardholders"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"dateOfBirth": "2023-12-25",
"address1": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": "<string>",
"country": "NG",
"idType": "PASSPORT",
"idNumber": "<string>",
"bvn": "<string>",
"idDocumentFrontUrl": "<string>"
}
headers = {
"X-Numero-Api-Key": "<api-key>",
"X-Numero-Signature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Numero-Api-Key': '<api-key>',
'X-Numero-Signature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
email: '<string>',
phone: '<string>',
dateOfBirth: '2023-12-25',
address1: '<string>',
city: '<string>',
state: '<string>',
zipcode: '<string>',
country: 'NG',
idType: 'PASSPORT',
idNumber: '<string>',
bvn: '<string>',
idDocumentFrontUrl: '<string>'
})
};
fetch('https://api.usenumero.com/numeroaccount/api/v1/business/cardholders', 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://api.usenumero.com/numeroaccount/api/v1/business/cardholders",
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([
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'dateOfBirth' => '2023-12-25',
'address1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipcode' => '<string>',
'country' => 'NG',
'idType' => 'PASSPORT',
'idNumber' => '<string>',
'bvn' => '<string>',
'idDocumentFrontUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Numero-Api-Key: <api-key>",
"X-Numero-Signature: <api-key>"
],
]);
$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://api.usenumero.com/numeroaccount/api/v1/business/cardholders"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"country\": \"NG\",\n \"idType\": \"PASSPORT\",\n \"idNumber\": \"<string>\",\n \"bvn\": \"<string>\",\n \"idDocumentFrontUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Numero-Api-Key", "<api-key>")
req.Header.Add("X-Numero-Signature", "<api-key>")
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://api.usenumero.com/numeroaccount/api/v1/business/cardholders")
.header("X-Numero-Api-Key", "<api-key>")
.header("X-Numero-Signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"country\": \"NG\",\n \"idType\": \"PASSPORT\",\n \"idNumber\": \"<string>\",\n \"bvn\": \"<string>\",\n \"idDocumentFrontUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usenumero.com/numeroaccount/api/v1/business/cardholders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Numero-Api-Key"] = '<api-key>'
request["X-Numero-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"country\": \"NG\",\n \"idType\": \"PASSPORT\",\n \"idNumber\": \"<string>\",\n \"bvn\": \"<string>\",\n \"idDocumentFrontUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"customerId": "NCUS9953596C2B7F45",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"status": "<string>",
"activeCardCount": 123,
"createdAt": "2023-11-07T05:31:56Z"
},
"error": {
"message": "<string>",
"param": "<string>"
},
"meta": {
"request_id": "<string>",
"pagination": {
"page": 123,
"page_size": 123,
"total": 123,
"has_more": true
}
}
}Cardholders
Create a cardholder
Create one of your customers as a cardholder. You attest their KYC (required by the issuer).
POST
/
business
/
cardholders
Create a cardholder
curl --request POST \
--url https://api.usenumero.com/numeroaccount/api/v1/business/cardholders \
--header 'Content-Type: application/json' \
--header 'X-Numero-Api-Key: <api-key>' \
--header 'X-Numero-Signature: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"dateOfBirth": "2023-12-25",
"address1": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": "<string>",
"country": "NG",
"idType": "PASSPORT",
"idNumber": "<string>",
"bvn": "<string>",
"idDocumentFrontUrl": "<string>"
}
'import requests
url = "https://api.usenumero.com/numeroaccount/api/v1/business/cardholders"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"dateOfBirth": "2023-12-25",
"address1": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": "<string>",
"country": "NG",
"idType": "PASSPORT",
"idNumber": "<string>",
"bvn": "<string>",
"idDocumentFrontUrl": "<string>"
}
headers = {
"X-Numero-Api-Key": "<api-key>",
"X-Numero-Signature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Numero-Api-Key': '<api-key>',
'X-Numero-Signature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
email: '<string>',
phone: '<string>',
dateOfBirth: '2023-12-25',
address1: '<string>',
city: '<string>',
state: '<string>',
zipcode: '<string>',
country: 'NG',
idType: 'PASSPORT',
idNumber: '<string>',
bvn: '<string>',
idDocumentFrontUrl: '<string>'
})
};
fetch('https://api.usenumero.com/numeroaccount/api/v1/business/cardholders', 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://api.usenumero.com/numeroaccount/api/v1/business/cardholders",
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([
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'dateOfBirth' => '2023-12-25',
'address1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipcode' => '<string>',
'country' => 'NG',
'idType' => 'PASSPORT',
'idNumber' => '<string>',
'bvn' => '<string>',
'idDocumentFrontUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Numero-Api-Key: <api-key>",
"X-Numero-Signature: <api-key>"
],
]);
$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://api.usenumero.com/numeroaccount/api/v1/business/cardholders"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"country\": \"NG\",\n \"idType\": \"PASSPORT\",\n \"idNumber\": \"<string>\",\n \"bvn\": \"<string>\",\n \"idDocumentFrontUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Numero-Api-Key", "<api-key>")
req.Header.Add("X-Numero-Signature", "<api-key>")
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://api.usenumero.com/numeroaccount/api/v1/business/cardholders")
.header("X-Numero-Api-Key", "<api-key>")
.header("X-Numero-Signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"country\": \"NG\",\n \"idType\": \"PASSPORT\",\n \"idNumber\": \"<string>\",\n \"bvn\": \"<string>\",\n \"idDocumentFrontUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usenumero.com/numeroaccount/api/v1/business/cardholders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Numero-Api-Key"] = '<api-key>'
request["X-Numero-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"country\": \"NG\",\n \"idType\": \"PASSPORT\",\n \"idNumber\": \"<string>\",\n \"bvn\": \"<string>\",\n \"idDocumentFrontUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"customerId": "NCUS9953596C2B7F45",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"status": "<string>",
"activeCardCount": 123,
"createdAt": "2023-11-07T05:31:56Z"
},
"error": {
"message": "<string>",
"param": "<string>"
},
"meta": {
"request_id": "<string>",
"pagination": {
"page": 123,
"page_size": 123,
"total": 123,
"has_more": true
}
}
}Authorizations
Your business API key (live_key_...). Issued on approval; managed in Dashboard → Settings → Developer.
Base64(HMAC-SHA256(publicApiKey, input)) over the raw request body (POST) or canonicalized
query string (signed GET). Also send X-Numero-Signature-Version: v2. Required on
money-movement / state-changing endpoints (marked 🔒).
The HMAC key is your Public Key as raw UTF-8 bytes — a SECRET despite the name, and a
different value from the X-Numero-Api-Key authentication header. Signing with the API key
will never produce a valid signature.
Body
application/json
Example:
"NG"
Example:
"PASSPORT"
⌘I