> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.driver.olycab.in/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.driver.olycab.in/_mcp/server.

# Get Driver KYC Verification Checklist & Status

GET https://driver/#get11

# Get Driver KYC Verification Checklist & Status

Returns a structured status summary for all document onboarding requirements, indicating whether each document is submitted, its verification status (`PENDING`, `APPROVED`, `REJECTED`), any admin rejection feedback, and overall onboarding completion metrics.

***

### Endpoint Overview

* **Method:** `GET`

* **Route:** `/api/v1/driver/documents/status`

* **Authentication:** `Bearer Token (Driver JWT)`

* **Content-Type:** `N/A`

***

### Request Headers

| Header          | Type     | Required | Description      |
| --------------- | -------- | -------- | ---------------- |
| `Authorization` | `string` | **Yes**  | Format: `Bearer` |

***

### Request Body Schema

*None (GET request)*

***

### Response Body Schema (`200 OK`)

| Top-Level Key | Data Type | Description                                                         |
| ------------- | --------- | ------------------------------------------------------------------- |
| `documents`   | `object`  | Map of each document type to its submission and verification status |
| `summary`     | `object`  | Aggregate onboarding progress calculation                           |

#### `documents` Object Values (for each document type key)

| Field                 | Data Type | Nullable | Allowed Values / Constraints        | Description                                            |
| --------------------- | --------- | -------- | ----------------------------------- | ------------------------------------------------------ |
| `submitted`           | `boolean` | No       | `true`, `false`                     | Whether driver has submitted this document             |
| `verification_status` | `enum`    | Yes      | `"PENDING""APPROVED""REJECTED"null` | Administrative review status (`null` if not submitted) |
| `rejection_reason`    | `string`  | Yes      | String or `null`                    | Reason if status is `REJECTED`                         |
| `document_number`     | `string`  | Yes      | String or `null`                    | Document number recorded in DB                         |
| `name_on_doc`         | `string`  | Yes      | String or `null`                    | Name printed on document                               |

#### `summary` Object Fields

| Field                | Data Type | Description                                                      |
| -------------------- | --------- | ---------------------------------------------------------------- |
| `total_submitted`    | `integer` | Number of documents uploaded by the driver                       |
| `total_required`     | `integer` | Total adjusted requirements (Aadhaar/PAN are mutually exclusive) |
| `identity_submitted` | `boolean` | `true` if driver submitted either Aadhaar or PAN                 |
| `all_submitted`      | `boolean` | `true` if all required onboarding documents are submitted        |

***

### Response Example (`200 OK`)

```json
{
  "documents": {
    "DRIVING_LICENCE": {
      "submitted": true,
      "verification_status": "APPROVED",
      "rejection_reason": null,
      "document_number": "KA0120200012345",
      "name_on_doc": null
    },
    "AADHAAR": {
      "submitted": true,
      "verification_status": "PENDING",
      "rejection_reason": null,
      "document_number": "123456789012",
      "name_on_doc": null
    },
    "PAN": {
      "submitted": false,
      "verification_status": null,
      "rejection_reason": null,
      "document_number": null,
      "name_on_doc": null
    },
    "VEHICLE_RC": {
      "submitted": true,
      "verification_status": "REJECTED",
      "rejection_reason": "Image is blurry, please re-upload clear photo of RC",
      "document_number": "KA-01-AB-1234",
      "name_on_doc": null
    },
    "VEHICLE_MODEL_NUMBER": {
      "submitted": false,
      "verification_status": null,
      "rejection_reason": null,
      "document_number": null,
      "name_on_doc": null
    },
    "PERMIT": {
      "submitted": false,
      "verification_status": null,
      "rejection_reason": null,
      "document_number": null,
      "name_on_doc": null
    },
    "INSURANCE": {
      "submitted": false,
      "verification_status": null,
      "rejection_reason": null,
      "document_number": null,
      "name_on_doc": null
    },
    "FITNESS_CERTIFICATE": {
      "submitted": false,
      "verification_status": null,
      "rejection_reason": null,
      "document_number": null,
      "name_on_doc": null
    }
  },
  "summary": {
    "total_submitted": 3,
    "total_required": 7,
    "identity_submitted": true,
    "all_submitted": false
  }
}

```

***

### Error Responses

#### 1. `401 Unauthorized` — Missing / Expired Token / Session Revoked

```json
{
  "error": "Unauthorized",
  "message": "Invalid or expired driver access token."
}

```

#### 2. `403 Forbidden` — Account Blocked / Deactivated

```json
{
  "error": "Forbidden",
  "message": "Driver account is blocked or deactivated."
}

```

#### 3. `500 Internal Server Error`

```json
{
  "error": "Failed to fetch document status"
}

```

***

### Status Codes Reference

| HTTP Status Code                | Condition                                                               |
| ------------------------------- | ----------------------------------------------------------------------- |
| **`200 OK`**                    | Document checklist and status map successfully calculated and returned. |
| **`401 Unauthorized`**          | Missing, invalid, expired token or session revoked.                     |
| **`403 Forbidden`**             | Driver account is deactivated or blocked.                               |
| **`500 Internal Server Error`** | Server or database query error.                                         |

Reference: https://docs.driver.olycab.in/oly-driver/document/get-driver-kyc-verification-checklist-status

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Examples

**SDK Code**

```python
import requests

url = "https://driver/#get11"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://driver/#get11';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://driver/#get11"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://driver/#get11")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://driver/#get11")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://driver/#get11', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://driver/#get11");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://driver/#get11")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```