Get Customer Details
curl --request GET \
--url https://sandbox-api.axisfi.net/api/customers/detail \
--header 'Api-Version: <api-version>' \
--header 'X-API-Key: <api-key>' \
--header 'X-API-Secret: <api-key>'import requests
url = "https://sandbox-api.axisfi.net/api/customers/detail"
headers = {
"Api-Version": "<api-version>",
"X-API-Key": "<api-key>",
"X-API-Secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'Api-Version': '<api-version>',
'X-API-Key': '<api-key>',
'X-API-Secret': '<api-key>'
}
};
fetch('https://sandbox-api.axisfi.net/api/customers/detail', 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.axisfi.net/api/customers/detail",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Api-Version: <api-version>",
"X-API-Key: <api-key>",
"X-API-Secret: <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://sandbox-api.axisfi.net/api/customers/detail"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Api-Version", "<api-version>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("X-API-Secret", "<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://sandbox-api.axisfi.net/api/customers/detail")
.header("Api-Version", "<api-version>")
.header("X-API-Key", "<api-key>")
.header("X-API-Secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.axisfi.net/api/customers/detail")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Api-Version"] = '<api-version>'
request["X-API-Key"] = '<api-key>'
request["X-API-Secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"partner_customer_id": "<string>",
"business_details": {
"business_name_english": "<string>",
"business_type": "Limited Liability Company",
"business_identifier_type": "Business Registration",
"business_identifier_number": "<string>",
"business_identifier_country_code": "US",
"business_identifier_document_list": [
"<string>"
],
"business_name": "<string>",
"website": "https://www.example.com",
"business_identifier_start_date": "2023-11-07T05:31:56Z",
"business_identifier_expiry_date": "2023-11-07T05:31:56Z"
},
"registration_address": {
"registration_address_line1": "<string>",
"registration_address_city": "<string>",
"registration_address_state": "<string>",
"registration_address_postcode": "<string>",
"registration_address_country_code": "US"
},
"customer_id": "cus_79fb361a05074629bf1ecf0d14cd244e",
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"account_usage": {
"operating_country": "US",
"goods_service_description": "<string>",
"industry_category_code": "<string>",
"account_usage_product_reference": "Financial Services",
"estimated_monthly_revenue_currency": "USD",
"estimated_monthly_revenue_amount": 99.99
},
"primary_contact": {
"contact_phone": "+8613800138000",
"contact_email": "service@gemini.com"
},
"business_person_list": [
{
"basic_info": {
"first_name_english": "<string>",
"last_name_english": "<string>",
"birth_date": "2023-11-07T05:31:56Z",
"nationality": "US",
"role_type": "Director",
"first_name": "<string>",
"last_name": "<string>"
},
"residential_address": {
"residential_address_line1": "<string>",
"residential_address_city": "<string>",
"residential_address_country_code": "US",
"residential_address_state": "<string>",
"residential_address_postcode": "<string>"
},
"identification": {
"id_type": "National ID",
"id_number": "<string>",
"id_issuing_country_code": "US",
"id_expiration_date": "2023-11-07T05:31:56Z",
"id_issue_date": "2023-11-07T05:31:56Z",
"id_document_front_file_id": "<string>",
"id_document_back_file_id": "<string>"
}
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "Invalid organizationId",
"code": "ORG_ID_INVALID"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}Customers
Get Customer Details
Get a specific customer by specifying the (Id).
GET
/
api
/
customers
/
detail
Get Customer Details
curl --request GET \
--url https://sandbox-api.axisfi.net/api/customers/detail \
--header 'Api-Version: <api-version>' \
--header 'X-API-Key: <api-key>' \
--header 'X-API-Secret: <api-key>'import requests
url = "https://sandbox-api.axisfi.net/api/customers/detail"
headers = {
"Api-Version": "<api-version>",
"X-API-Key": "<api-key>",
"X-API-Secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'Api-Version': '<api-version>',
'X-API-Key': '<api-key>',
'X-API-Secret': '<api-key>'
}
};
fetch('https://sandbox-api.axisfi.net/api/customers/detail', 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.axisfi.net/api/customers/detail",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Api-Version: <api-version>",
"X-API-Key: <api-key>",
"X-API-Secret: <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://sandbox-api.axisfi.net/api/customers/detail"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Api-Version", "<api-version>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("X-API-Secret", "<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://sandbox-api.axisfi.net/api/customers/detail")
.header("Api-Version", "<api-version>")
.header("X-API-Key", "<api-key>")
.header("X-API-Secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.axisfi.net/api/customers/detail")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Api-Version"] = '<api-version>'
request["X-API-Key"] = '<api-key>'
request["X-API-Secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"partner_customer_id": "<string>",
"business_details": {
"business_name_english": "<string>",
"business_type": "Limited Liability Company",
"business_identifier_type": "Business Registration",
"business_identifier_number": "<string>",
"business_identifier_country_code": "US",
"business_identifier_document_list": [
"<string>"
],
"business_name": "<string>",
"website": "https://www.example.com",
"business_identifier_start_date": "2023-11-07T05:31:56Z",
"business_identifier_expiry_date": "2023-11-07T05:31:56Z"
},
"registration_address": {
"registration_address_line1": "<string>",
"registration_address_city": "<string>",
"registration_address_state": "<string>",
"registration_address_postcode": "<string>",
"registration_address_country_code": "US"
},
"customer_id": "cus_79fb361a05074629bf1ecf0d14cd244e",
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"account_usage": {
"operating_country": "US",
"goods_service_description": "<string>",
"industry_category_code": "<string>",
"account_usage_product_reference": "Financial Services",
"estimated_monthly_revenue_currency": "USD",
"estimated_monthly_revenue_amount": 99.99
},
"primary_contact": {
"contact_phone": "+8613800138000",
"contact_email": "service@gemini.com"
},
"business_person_list": [
{
"basic_info": {
"first_name_english": "<string>",
"last_name_english": "<string>",
"birth_date": "2023-11-07T05:31:56Z",
"nationality": "US",
"role_type": "Director",
"first_name": "<string>",
"last_name": "<string>"
},
"residential_address": {
"residential_address_line1": "<string>",
"residential_address_city": "<string>",
"residential_address_country_code": "US",
"residential_address_state": "<string>",
"residential_address_postcode": "<string>"
},
"identification": {
"id_type": "National ID",
"id_number": "<string>",
"id_issuing_country_code": "US",
"id_expiration_date": "2023-11-07T05:31:56Z",
"id_issue_date": "2023-11-07T05:31:56Z",
"id_document_front_file_id": "<string>",
"id_document_back_file_id": "<string>"
}
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "Invalid organizationId",
"code": "ORG_ID_INVALID"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}Authorizations
Includes an API key in the HTTP headers to authenticate the client.
Includes an API secret in the HTTP headers to authenticate the client.
Headers
AxisFi API contract version
Available options:
2026-08-31 Response
Operation Successful
Customer Details Response Information
Partner Assigned Customer ID
Required string length:
20 - 64Company Details Section
Show child attributes
Show child attributes
Registration Address Section
Show child attributes
Show child attributes
Unique Customer ID
Example:
"cus_79fb361a05074629bf1ecf0d14cd244e"
Customer status
Available options:
pending, active, rejected, suspended Example:
"active"
Customer created time
Business Details Section
Show child attributes
Show child attributes
Primary Contact Section
Show child attributes
Show child attributes
List of Legal Representatives
Show child attributes
Show child attributes

