> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.haloinvest.ng/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.haloinvest.ng/_mcp/server.

# Get customer details

POST https://api.haloinvest.ng/api/banking/customer/get-details
Content-Type: application/json

Returns the full bank record of a customer your business opened an account for.

Reference: https://docs.haloinvest.ng/api-reference/customers/get-customer-details

## Authentication

- `Authorization` header (bearer token, required) — Your Halo partner API key, sent as `Authorization: Bearer <key>`.

## Request

### Body (application/json)

This endpoint expects an object.

- `account_number` (string, optional) — An account number your business opened. Required when email is not sent.
- `email` (string, optional) — The customer email. Required when account_number is not sent.

## Response

### 200

Success.

- `status` (boolean, optional)
- `message` (string, optional)
- `data` (ApiBankingCustomerGetDetailsPostResponsesContentApplicationJsonSchemaData, optional)
- `status_code` (integer, optional)

## Errors

### 400 Bad Request Error

No account your business opened was found, or the bank returned an error.

- `status` (boolean, required) — True on success, false otherwise.
- `message` (EnvelopeMessage, required) — A short message. On a 422 validation failure it is an object of field names to error lists.
- `status_code` (integer, required) — The HTTP status code.
- `data` (any, optional) — The result. Left out on most errors.

### 401 Unauthorized Error

The API key is missing or not recognised, or your business is switched off.

- `error` (UnauthorizedErrorError, optional)

### 422 Unprocessable Entity Error

The request failed validation. `message` lists the errors by field.

- `status` (boolean, required) — True on success, false otherwise.
- `message` (EnvelopeMessage, required) — A short message. On a 422 validation failure it is an object of field names to error lists.
- `status_code` (integer, required) — The HTTP status code.
- `data` (any, optional) — The result. Left out on most errors.

### 429 Too Many Requests Error

Too many requests. Wait and try again.

- `status` (boolean, required) — True on success, false otherwise.
- `message` (EnvelopeMessage, required) — A short message. On a 422 validation failure it is an object of field names to error lists.
- `status_code` (integer, required) — The HTTP status code.
- `data` (any, optional) — The result. Left out on most errors.

## Types

### ApiBankingCustomerGetDetailsPostResponsesContentApplicationJsonSchemaData

- `Id` (integer, optional)
- `customerID` (string, optional)
- `LastName` (string, optional)
- `Gender` (string, optional)
- `OtherNames` (string, optional)
- `Address` (string, optional)
- `Email` (string, optional)
- `Landmark` (string, optional)
- `PhoneNumber` (string, optional)
- `NickName` (string, optional)
- `BankVerificationNumber` (string, optional)
- `EmailNotification` (boolean, optional)
- `PhoneNotification` (string, optional)
- `DistrictOfResidence` (string, optional)
- `DistrictOfBusiness` (string, optional)
- `IdentificationNumber` (string, optional)
- `DateOfBirth` (string, optional)
- `HomeTown` (string, optional)
- `LocalGovernment` (string, optional)
- `MothersMaidenName` (string, optional)
- `Nationale` (string, optional)
- `TestQuestion` (string, optional)
- `TestAnswer` (string, optional)
- `State` (string, optional)
- `WorkAddress` (string, optional)
- `WorkAnnualIncome` (integer, optional)
- `WorkEmployerName` (string, optional)
- `WorkNextOfKin` (string, optional)
- `WorkNextOfKinAddress` (string, optional)
- `WorkNextOfKinPhoneNo` (string, optional)
- `WorkNextOfKinRelationship` (string, optional)
- `WorkOccupation` (string, optional)
- `WorkPhoneNo` (string, optional)
- `NameOnUtilityBill` (string, optional)
- `AddressOnUtilityBill` (string, optional)
- `DateOnUtilityBill` (string, optional)
- `CommentsForUtilityBill` (string, optional)
- `IsUtilityBillInfoComplete` (boolean, optional)
- `NextOfKinEmailAddress` (string, optional)
- `CustomerPhoto` (string, optional)
- `CustomerSignature` (string, optional)
- `Accounts` (list of any, optional)
- `Name` (string, optional)
- `PostalAddress` (string, optional)
- `BusinessPhoneNo` (string, optional)
- `TaxIDNo` (string, optional)
- `BusinessName` (string, optional)
- `TradeName` (string, optional)
- `IndustrialSector` (string, optional)
- `CompanyRegDate` (string, optional)
- `ContactPersonName` (string, optional)
- `BusinessType` (string, optional)
- `BusinessNature` (string, optional)
- `WebAddress` (string, optional)
- `DateIncorporated` (string, optional)
- `BusinessCommencementDate` (string, optional)
- `RegistrationNumber` (string, optional)
- `CustomerMembers` (string, optional)
- `TheDirectors` (string, optional)

### EnvelopeMessage

A short message. On a 422 validation failure it is an object of field names to error lists.

- string
- map from string to list of string

### UnauthorizedErrorError

- `message` (string, optional)

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "status": true,
  "message": "Retrieved Successfully",
  "data": {
    "Id": 0,
    "customerID": "003658",
    "LastName": "Ada Example",
    "OtherNames": "Example",
    "Email": "ada@example.com",
    "PhoneNumber": "08000000001",
    "BankVerificationNumber": "22200000001",
    "EmailNotification": false,
    "PhoneNotification": "true",
    "IdentificationNumber": "12345678901",
    "WorkAnnualIncome": 0,
    "IsUtilityBillInfoComplete": false,
    "Accounts": []
  },
  "status_code": 200
}
```

**SDK Code**

```python
import requests

url = "https://api.haloinvest.ng/api/banking/customer/get-details"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.haloinvest.ng/api/banking/customer/get-details';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.haloinvest.ng/api/banking/customer/get-details"

	payload := strings.NewReader("{}")

	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(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.haloinvest.ng/api/banking/customer/get-details")

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 = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.haloinvest.ng/api/banking/customer/get-details")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.haloinvest.ng/api/banking/customer/get-details', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.haloinvest.ng/api/banking/customer/get-details");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.haloinvest.ng/api/banking/customer/get-details")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```