Get a customer by your own id 🔒
curl --request GET \
--url https://api.usenumero.com/numeroaccount/api/v1/customers/by-external-id/{externalId} \
--header 'X-Numero-Api-Key: <api-key>' \
--header 'X-Numero-Signature: <api-key>'import requests
url = "https://api.usenumero.com/numeroaccount/api/v1/customers/by-external-id/{externalId}"
headers = {
"X-Numero-Api-Key": "<api-key>",
"X-Numero-Signature": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Numero-Api-Key': '<api-key>', 'X-Numero-Signature': '<api-key>'}
};
fetch('https://api.usenumero.com/numeroaccount/api/v1/customers/by-external-id/{externalId}', 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/customers/by-external-id/{externalId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.usenumero.com/numeroaccount/api/v1/customers/by-external-id/{externalId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Numero-Api-Key", "<api-key>")
req.Header.Add("X-Numero-Signature", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.usenumero.com/numeroaccount/api/v1/customers/by-external-id/{externalId}")
.header("X-Numero-Api-Key", "<api-key>")
.header("X-Numero-Signature", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usenumero.com/numeroaccount/api/v1/customers/by-external-id/{externalId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Numero-Api-Key"] = '<api-key>'
request["X-Numero-Signature"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"businessCode": "<string>",
"externalId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"dateOfBirth": "2023-11-07T05:31:56Z",
"kycTier": 123,
"kycStatus": "<string>",
"kycVerifiedAt": "2023-11-07T05:31:56Z",
"capabilities": [
"<string>"
],
"status": "<string>",
"isTest": true,
"metadataJson": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"cardProfile": {
"cardCustomerId": "<string>",
"status": "<string>",
"activeCardCount": 123
},
"billingProfile": {
"id": 123,
"name": "<string>",
"type": "<string>",
"address": "<string>"
}
},
"error": {
"message": "<string>",
"param": "<string>"
},
"meta": {
"request_id": "<string>",
"pagination": {
"page": 123,
"page_size": 123,
"total": 123,
"has_more": true
}
}
}Customers
Get a customer by your own id 🔒
Look a customer up by the externalId you supplied on create.
GET
/
customers
/
by-external-id
/
{externalId}
Get a customer by your own id 🔒
curl --request GET \
--url https://api.usenumero.com/numeroaccount/api/v1/customers/by-external-id/{externalId} \
--header 'X-Numero-Api-Key: <api-key>' \
--header 'X-Numero-Signature: <api-key>'import requests
url = "https://api.usenumero.com/numeroaccount/api/v1/customers/by-external-id/{externalId}"
headers = {
"X-Numero-Api-Key": "<api-key>",
"X-Numero-Signature": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Numero-Api-Key': '<api-key>', 'X-Numero-Signature': '<api-key>'}
};
fetch('https://api.usenumero.com/numeroaccount/api/v1/customers/by-external-id/{externalId}', 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/customers/by-external-id/{externalId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.usenumero.com/numeroaccount/api/v1/customers/by-external-id/{externalId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Numero-Api-Key", "<api-key>")
req.Header.Add("X-Numero-Signature", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.usenumero.com/numeroaccount/api/v1/customers/by-external-id/{externalId}")
.header("X-Numero-Api-Key", "<api-key>")
.header("X-Numero-Signature", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usenumero.com/numeroaccount/api/v1/customers/by-external-id/{externalId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Numero-Api-Key"] = '<api-key>'
request["X-Numero-Signature"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"businessCode": "<string>",
"externalId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"dateOfBirth": "2023-11-07T05:31:56Z",
"kycTier": 123,
"kycStatus": "<string>",
"kycVerifiedAt": "2023-11-07T05:31:56Z",
"capabilities": [
"<string>"
],
"status": "<string>",
"isTest": true,
"metadataJson": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"cardProfile": {
"cardCustomerId": "<string>",
"status": "<string>",
"activeCardCount": 123
},
"billingProfile": {
"id": 123,
"name": "<string>",
"type": "<string>",
"address": "<string>"
}
},
"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.
Path Parameters
Your own stable identifier for the customer.
⌘I