> For the complete documentation index, see [llms.txt](https://developer.fraudcheck.co.za/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.fraudcheck.co.za/commercial-service/identity/principal-details.md).

# Business Principal Details

Business Principal Details retrieves the current and historical directors of a business, together with an archive of previous principals. It returns structured director records covering personal details, appointment dates, and status. Use it to build a complete picture of who controls or has controlled a company.

## When to use this

* Retrieving the full director list for a business during KYB (Know Your Business) checks
* Auditing changes in directorship over time via the principal archive
* Cross-referencing directors against watchlists or adverse databases

## How it works

| Property              | Value                                                        |
| --------------------- | ------------------------------------------------------------ |
| Response type         | `Synchronous`                                                |
| Typical response time | < 5s                                                         |
| Result retrieval      | `GET /commercial-service/principal-details/{transaction_id}` |
| Consent required      | `Yes`                                                        |
| Region                | South Africa                                                 |

## Authentication

```http
Authorization: Bearer {your_access_token}
```

## Endpoints

```http
POST /commercial-service/principal-details
GET  /commercial-service/principal-details/{transaction_id}
```

## Request

### Headers

| Header          | Required | Value              |
| --------------- | -------- | ------------------ |
| `Authorization` | Yes      | `Bearer {token}`   |
| `Content-Type`  | Yes      | `application/json` |

### Body parameters

| Field                          | Type    | Required | Description                                                |
| ------------------------------ | ------- | -------- | ---------------------------------------------------------- |
| `CompanyName`                  | string  | Yes\*    | Registered company name. Required if no `CompanyRegNo`.    |
| `CompanyRegNo`                 | string  | Yes\*    | Company registration number. Required if no `CompanyName`. |
| `EnquiryReason`                | string  | Yes      | Reason code for the enquiry.                               |
| `ConsentObtainedByDataSubject` | boolean | Yes      | Must be `true`. Confirms POPIA consent.                    |
| `ReferenceNo`                  | string  | No       | Your own reference.                                        |

### Example request

```json
{
  "CompanyName": "Example Company (Pty) Ltd",
  "CompanyRegNo": "2021/123456/07",
  "EnquiryReason": "CreditInformationQuery",
  "ConsentObtainedByDataSubject": true
}
```

## Response

### Response fields

| Field                      | Type    | Description                                              |
| -------------------------- | ------- | -------------------------------------------------------- |
| `success`                  | boolean | `true` if the API call succeeded.                        |
| `transaction_id`           | string  | Unique identifier for this request.                      |
| `searched_name`            | string  | Company name that was searched.                          |
| `searched_registration_no` | string  | Registration number that was searched.                   |
| `enquiry_reason`           | string  | Enquiry reason code used.                                |
| `principals_count`         | integer | Number of current director records returned.             |
| `principal_archives_count` | integer | Number of archived (previous) director records returned. |
| `first_response`           | object  | Raw first-response data from the bureau.                 |
| `principals`               | array   | Current director/principal records.                      |
| `principal_archives`       | array   | Historical director/principal records.                   |

### `principals[]` key fields

Each record in the `principals` array contains director details. Key fields include:

| Field              | Description                                           |
| ------------------ | ----------------------------------------------------- |
| `surname`          | Director's surname.                                   |
| `forename1`        | Director's first name.                                |
| `forename2`        | Director's second name.                               |
| `id_number`        | South African identity number.                        |
| `date_of_birth`    | Date of birth.                                        |
| `appointment_date` | Date appointed as director.                           |
| `director_type`    | Type of directorship (e.g. Executive, Non-executive). |
| `director_status`  | Current status.                                       |
| `address`          | Residential address on record.                        |

### `principal_archives[]` key fields

Each record in the `principal_archives` array mirrors the structure of `principals[]` but represents past directors who are no longer active.

### Example response

```json
{
  "success": true,
  "transaction_id": "d0e1f2a3-b4c5-6789-defa-890123456789",
  "searched_name": "Example Company (Pty) Ltd",
  "searched_registration_no": "2021/123456/07",
  "enquiry_reason": "01",
  "principals_count": 2,
  "principal_archives_count": 1,
  "first_response": {},
  "principals": [
    {
      "surname": "Smith",
      "forename1": "John",
      "id_number": "8601015800086",
      "date_of_birth": "1986-01-01",
      "appointment_date": "2021-01-15",
      "director_type": "Executive",
      "director_status": "Active"
    },
    {
      "surname": "Dlamini",
      "forename1": "Sipho",
      "id_number": "9203025800080",
      "date_of_birth": "1992-03-02",
      "appointment_date": "2021-01-15",
      "director_type": "Executive",
      "director_status": "Active"
    }
  ],
  "principal_archives": [
    {
      "surname": "Johnson",
      "forename1": "David",
      "id_number": "7505055800083",
      "appointment_date": "2021-01-15",
      "director_status": "Resigned"
    }
  ]
}
```

## Retrieving results later

```http
GET /commercial-service/principal-details/{transaction_id}
```

Use the `transaction_id` from the POST response to retrieve the result again at any time.

## Errors

| HTTP | Code            | Meaning                              | Action                               |
| ---- | --------------- | ------------------------------------ | ------------------------------------ |
| 401  | `unauthorized`  | Token missing or expired             | Refresh your access token            |
| 403  | `forbidden`     | Account lacks access to this service | Contact your account manager         |
| 422  | `invalid_input` | Required field missing or invalid    | See `details.field`                  |
| 500  | `server_error`  | Unexpected error                     | Retry; contact support if persistent |

## Code examples

{% tabs %}
{% tab title="cURL" %}

```bash
BASE_URL="https://commercial-service-api.fraudcheckonline.co.za/commercial-service"

curl -X POST "$BASE_URL/principal-details" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CompanyName": "Example Company (Pty) Ltd",
    "CompanyRegNo": "2021/123456/07",
    "EnquiryReason": "01",
    "ConsentObtainedByDataSubject": true
  }'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

BASE_URL = "https://commercial-service-api.fraudcheckonline.co.za/commercial-service"

response = requests.post(
    f"{BASE_URL}/principal-details",
    headers={
        "Authorization": f"Bearer {access_token}",
        "Content-Type": "application/json",
    },
    json={
        "CompanyName": "Example Company (Pty) Ltd",
        "CompanyRegNo": "2021/123456/07",
        "EnquiryReason": "01",
        "ConsentObtainedByDataSubject": True,
    },
)
data = response.json()
```

{% endtab %}

{% tab title="JavaScript (Node.js)" %}

```javascript
const BASE_URL = "https://commercial-service-api.fraudcheckonline.co.za/commercial-service";

const response = await fetch(`${BASE_URL}/principal-details`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    CompanyName: "Example Company (Pty) Ltd",
    CompanyRegNo: "2021/123456/07",
    EnquiryReason: "01",
    ConsentObtainedByDataSubject: true,
  }),
});
const data = await response.json();
```

{% endtab %}
{% endtabs %}

## Compliance & consent

* Obtain explicit consent from the data subject before submitting a request.
* Set `ConsentObtainedByDataSubject` to `true` to confirm consent has been captured.
* Director details include personal identity information - ensure you have a permissible purpose under POPIA.
* Retain proof of consent in line with POPIA requirements.

## FAQ

<details>

<summary>What client timeout should I configure?</summary>

Up to 30 seconds.

</details>

<details>

<summary>What is the difference between `principals` and `principal_archives`?</summary>

`principals` contains currently active directors. `principal_archives` contains historical records for directors who have resigned, been removed, or whose status has changed. Reviewing the archive helps identify individuals who previously controlled the company.

</details>

## Changelog

| Date       | Version | Change           |
| ---------- | ------- | ---------------- |
| 2026-04-21 | v1.0    | Initial release. |