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

# PIN KRA

> Vérifiez le PIN de l'Kenya Revenue Authority d'un client et récupérez ses détails de contribuable.

L'endpoint PIN KRA valide un numéro d'identification personnel de la Kenya Revenue Authority (KRA) et renvoie les détails du contribuable associés incluant le nom, le statut du PIN, le statut iTax et les informations d'obligation fiscale.

## Endpoint

```
POST /api/onboarding/kenya_kyc/kra_pin/
```

## 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                                  |
| --------- | ------ | ------ | -------------------------------------------- |
| `pin`     | string | Oui    | Le PIN KRA du client (par ex. `A123456789B`) |

### Exemple

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

## Réponse

### 200 OK

| Champ                     | Type   | Description                                                  |
| ------------------------- | ------ | ------------------------------------------------------------ |
| `data.pin`                | string | PIN KRA                                                      |
| `data.taxpayer_name`      | string | Nom du contribuable enregistré                               |
| `data.pin_status`         | string | Statut du PIN (par ex. `"Active"`)                           |
| `data.itax_status`        | string | Statut du système iTax                                       |
| `data.obligation_details` | string | Description de l'obligation fiscale et date d'enregistrement |

```json theme={null}
{
  "status": "success",
  "data": {
    "pin": "A123456789B",
    "taxpayer_name": "ABB APP Limited",
    "pin_status": "Active",
    "itax_status": "iPage Updated",
    "obligation_details": "Income Tax - Company Registered 29/01/2013"
  },
  "message": "Pin details retrieved successfully"
}
```

### 400 Bad Request

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

### 401 Unauthorized

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


## OpenAPI

````yaml POST /api/onboarding/kenya_kyc/kra_pin/
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/kenya_kyc/kra_pin/:
    post:
      tags:
        - Kenya KYC
      summary: KRA PIN Verification
      operationId: kraPin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - pin
              properties:
                pin:
                  type: string
                  description: Kenya Revenue Authority PIN
                  example: A000000000Z
      responses:
        '200':
          description: KRA PIN verified
        '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

````