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

# KRA PIN

> Verify a customer's Kenya Revenue Authority PIN and retrieve their taxpayer details.

The KRA PIN endpoint validates a Kenya Revenue Authority (KRA) Personal Identification Number and returns the associated taxpayer details including name, PIN status, iTax status, and tax obligation information.

## Endpoint

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

## Request

### Headers

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

### Body Parameters

| Parameter | Type   | Required | Description                                 |
| --------- | ------ | -------- | ------------------------------------------- |
| `pin`     | string | Yes      | The customer's KRA PIN (e.g. `A123456789B`) |

### Example

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

## Response

### 200 OK

| Field                     | Type   | Description                                      |
| ------------------------- | ------ | ------------------------------------------------ |
| `data.pin`                | string | KRA PIN                                          |
| `data.taxpayer_name`      | string | Registered taxpayer name                         |
| `data.pin_status`         | string | PIN status (e.g. `"Active"`)                     |
| `data.itax_status`        | string | iTax system status                               |
| `data.obligation_details` | string | Tax obligation description and registration date |

```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: 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

````