> ## 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.

# Score de crédit First Central

> Récupérez le score de crédit d'un individu auprès du bureau First Central à l'aide de son BVN.

L'endpoint Score de crédit First Central renvoie le score de crédit à la consommation d'un individu auprès du bureau First Central, accompagné de résumés d'état des comptes, des totaux de dettes impayées et des métriques de décomposition du score.

## Endpoint

```
POST /api/onboarding/individual/credit_scores_first_central/
```

## Requête

### En-têtes

| En-tête          | Valeur                | Requis |
| ---------------- | --------------------- | ------ |
| `x-access-token` | Votre clé secrète API | Oui    |
| `Content-Type`   | `application/json`    | Oui    |

### Paramètres de corps

| Paramètre | Type   | Requis | Description                                                     |
| --------- | ------ | ------ | --------------------------------------------------------------- |
| `bvn`     | string | Oui    | Le numéro d'identification bancaire à 11 chiffres de l'individu |

### Exemple

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

## Réponse

### 200 OK

| Champ                                    | Type   | Description                                               |
| ---------------------------------------- | ------ | --------------------------------------------------------- |
| `data.score.totalConsumerScore`          | string | Score de crédit global du consommateur                    |
| `data.score.description`                 | string | Évaluation du risque (p. ex. `"LOW RISK"`, `"HIGH RISK"`) |
| `data.score.totalAccounts`               | string | Comptes totaux au dossier                                 |
| `data.score.totalaccountinGoodcondition` | string | Comptes en bonne situation                                |
| `data.score.totalaccountinBadcondition`  | string | Comptes en mauvaise situation                             |
| `data.score.totalOutstandingDebt`        | string | Dette impayée totale                                      |
| `data.score.totalAmountOverdue`          | string | Montant total en retard                                   |
| `data.score.repaymentHistoryScore`       | string | Composante du score d'historique de remboursement         |
| `data.score.firstCentralEnquiryResultID` | string | Identifiant du résultat de demande First Central          |

```json theme={null}
{
  "status": "success",
  "data": {
    "_id": "64f600608aaf9386c646de32",
    "bvn": "22244545518",
    "name": "ADELEKE EMMANUEL AYORINDE",
    "score": {
      "totalConsumerScore": "835",
      "description": "LOW RISK",
      "totalAccounts": "23",
      "scoreDate": "11/23/2023",
      "noOfAcctScore": "55/55",
      "totalaccountinGoodcondition": "23",
      "totalaccountinBadcondition": "0",
      "totalOutstandingDebt": "30,719.00",
      "totalAccountarrear": "0",
      "totalAmountOverdue": "0.00",
      "repaymentHistoryScore": "192/192",
      "totalAmountOwedScore": "165/165",
      "firstCentralEnquiryResultID": "37181617"
    },
    "searchedDate": "2023-11-23T14:37:04.152Z"
  },
  "message": "Credit Scores individual first central report details retrieved successfully"
}
```

### 400 Bad Request

```json theme={null}
{
  "status": "failed",
  "data": [],
  "message": "Sorry, your check cannot be processed at the moment. Please try again in a few minutes"
}
```

### 401 Unauthorized

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


## OpenAPI

````yaml POST /api/onboarding/individual/credit_scores_first_central/
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: Document Verification
  - 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/individual/credit_scores_first_central/:
    post:
      tags:
        - Individual Credit
      summary: First Central Credit Score
      operationId: creditScoresFirstCentral
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - bvn
              properties:
                bvn:
                  type: string
                  example: '22244545518'
      responses:
        '200':
          description: First Central credit score 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

````