> ## Documentation Index
> Fetch the complete documentation index at: https://docs.smartcomply.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Premium Business Credit History

> Retrieve a consolidated business credit report from both CRC and First Central bureaus.

The Premium Business Credit History endpoint aggregates credit data from both the CRC and First Central bureaus, providing a unified view of a business's credit standing including loan history, performance summaries, director details, and credit enquiries.

## Endpoint

```
POST /api/onboarding/business/premium/
```

## Request

### Headers

| Header           | Value               | Required |
| ---------------- | ------------------- | -------- |
| `x-access-token` | Your API secret key | Yes      |
| `Content-Type`   | `application/json`  | Yes      |

### Body Parameters

| Parameter             | Type   | Required | Description                            |
| --------------------- | ------ | -------- | -------------------------------------- |
| `registration_number` | string | Yes      | The business RC or registration number |

### Example

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/business/premium/" \
    -H "x-access-token: YOUR_SECRET_KEY" \
    -H "Content-Type: application/json" \
    -d '{"registration_number": "RC123456"}'
  ```
</CodeGroup>

## Response

### 200 OK

Each field in `data.score` is an array of objects with `source` (`"CRC"` or `"FIRST_CENTRAL"`) and `value` keys, providing per-bureau breakdowns.

| Field                         | Type   | Description                            |
| ----------------------------- | ------ | -------------------------------------- |
| `data.name`                   | string | Business name                          |
| `data.businessType`           | string | Business type                          |
| `data.score.directors`        | array  | Directors per bureau                   |
| `data.score.totalNoOfLoans`   | array  | Total loans per bureau                 |
| `data.score.totalBorrowed`    | array  | Total borrowed per bureau              |
| `data.score.totalOutstanding` | array  | Outstanding balance per bureau         |
| `data.score.totalOverdue`     | array  | Overdue amount per bureau              |
| `data.score.loanHistory`      | array  | Loan history per bureau                |
| `data.score.creditEnquiries`  | array  | Credit enquiries per bureau            |
| `data.score.loanPerformance`  | array  | Loan performance per bureau            |
| `data.score.bureauStatus`     | object | Success/failure status for each bureau |

```json theme={null}
{
  "status": "success",
  "data": {
    "_id": "636e768d8215a2e2fb06cfde",
    "business_reg_no": "RC123456",
    "name": "CAPITALFIELD ASSET MGT LTD",
    "businessType": "SMALLANDMEDIUMSCALEENTERPRISE",
    "score": {
      "totalNoOfLoans": [
        {"source": "CRC", "value": 24},
        {"source": "FIRST_CENTRAL", "value": 9}
      ],
      "totalBorrowed": [
        {"source": "CRC", "value": 567401372},
        {"source": "FIRST_CENTRAL", "value": 1004525869.55}
      ],
      "totalNoOfDelinquentFacilities": [
        {"source": "CRC", "value": 1},
        {"source": "FIRST_CENTRAL", "value": 0}
      ],
      "bureauStatus": {
        "crc": "success",
        "firstCentral": "success"
      }
    },
    "searchedDate": "2023-11-23T16:17:36.391Z"
  },
  "message": "Premium check successful"
}
```

### 400 Bad Request

```json theme={null}
{
  "status": "failed",
  "data": [],
  "message": "Missing required fields"
}
```

### 401 Unauthorized

```json theme={null}
{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}
```


## OpenAPI

````yaml POST /api/onboarding/business/premium/
openapi: 3.0.3
info:
  title: Adhere API
  description: >-
    Identity verification, credit checks, transaction monitoring, and loan fraud
    detection across Africa.
  version: 3.0.0
servers:
  - url: https://adhere-api.smartcomply.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Nigeria KYC
  - name: Kenya KYC
  - name: Ghana KYC
  - name: Rwanda KYC
  - name: Uganda KYC
  - name: Biometrics
  - name: Individual Credit
  - name: Business Credit
  - name: Transaction Monitoring
  - name: Transaction Screening
  - name: Transaction KYC
  - name: Loan Fraud
  - name: User Journey
paths:
  /api/onboarding/business/premium/:
    post:
      tags:
        - Business Credit
      summary: Premium Business Credit History
      operationId: premiumBusiness
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - registration_number
              properties:
                registration_number:
                  type: string
                  example: RC-123456
      responses:
        '200':
          description: Premium business credit report retrieved
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: failed
              data:
                type: array
                items: {}
              message:
                type: string
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: failed
              message:
                type: string
                example: Authentication credentials were not provided.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-access-token
      description: Your Adhere API secret key

````