> ## Documentation Index
> Fetch the complete documentation index at: https://docs.konnectnxt.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Driving Licence Verification v2
> Verify Driving Licence details with comprehensive information including address and class of vehicle.
## Overview
The Driving Licence Verification v2 API validates Driving Licence details using Driving Licence number, full name, and date of birth. It returns comprehensive information including personal details, registered address, current status, and class of vehicle.
### Key Features
* **Complete Verification**: Validates Driving Licence number, name, and date of birth
* **Comprehensive Details**: Returns full name, address, contact information
* **Real-time Validation**: Instant verification in under 2 seconds
* **Masked Data**: Secure display of sensitive information
### What's New in v2
* **Enhanced Data**: More comprehensive personal and address details
* **Better Validation**: Full name and DOB matching for accuracy
* **Vehicle Response**: Optimized for quicker verification
* **Consistent Format**: Unified response structure across all v2 APIs
**Data Availability**: Driving Licence status and cardholder name are always returned.
Additional details such as address, contact information, and vehicle class
status are provided when available in the records.
## OpenAPI
````yaml POST /v2/verification/driving-licence
openapi: 3.0.0
info:
title: KonnectNXT API Store
description: >-
A sample API that uses a plant store as an example to demonstrate features
in the OpenAPI specification
license:
name: MIT
version: 1.0.0
servers:
- url: https://bgv.konnectnxt.com/api
description: Production
- url: https://testbgv.konnectnxt.com/api
description: QA
security:
- bearerAuth: []
paths:
/v2/verification/driving-licence:
post:
tags:
- Identity Verification
- Driving Licence
summary: Verify Driving Licence (v2)
description: Verifies a driving licence using licence number and date of birth.
operationId: verifyDrivingLicenceV2
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
dl_number:
type: string
maxLength: 16
example: MH0920220028511
description: >-
DL Number must be in the format AA00XXXXXXXXXXX and not
contain all identical digits in the numeric part. (Max
Length: 16)
dob:
type: string
pattern: ^\d{2}-\d{2}-\d{4}$
example: 05-05-2000
description: Date of Birth in DD-MM-YYYY format.
required:
- dl_number
- dob
responses:
'200':
description: Successful response with Driving Licence details.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/APIBaseResponse'
- type: object
required:
- data
properties:
data:
type: object
required:
- state
- status
- user_dob
- dl_number
- user_image
- expiry_date
- issued_date
- endorse_date
- user_address
- endorse_number
- status_details
- user_full_name
- name_match_score
- user_blood_group
- father_or_husband
- transport_validity
- non_transport_validity
properties:
state:
type: string
example: Maharashtra
status:
type: string
example: id_found
user_dob:
type: string
example: 05-05-2000
dl_number:
type: string
example: MH0920220018811
user_image:
type: string
example: ''
expiry_date:
type: string
example: 04-05-2040
issued_date:
type: string
example: ''
endorse_date:
type: string
example: NA
user_address:
type: object
properties:
pin:
type: string
example: '700091'
type:
type: string
example: Permanent
state:
type: string
example: West Bengal
country:
type: string
example: India
district:
type: string
example: Kolkata
addressLine1:
type: string
example: Flat 4B, Salt Lake Sector V
completeAddress:
type: string
example: >-
Flat 4B, Salt Lake Sector V, Kolkata, West
Bengal, 700091
endorse_number:
type: string
example: NA
status_details:
type: object
properties:
to:
type: string
example: ''
from:
type: string
example: ''
remarks:
type: string
example: ''
user_full_name:
type: string
example: RAHUL S MEHRA
name_match_score:
type: string
example: '92.00'
user_blood_group:
type: string
example: AB-
father_or_husband:
type: string
example: NARAYAN K MEHRA
transport_validity:
type: object
properties:
to:
type: string
example: NA
from:
type: string
example: NA
non_transport_validity:
type: object
properties:
to:
type: string
example: 04-05-2040
from:
type: string
example: 10-06-2022
vehicle_category_details:
type: array
items:
type: object
properties:
cov:
type: string
example: LMV-NT
covType:
type: string
example: non-transport
issueDate:
type: string
example: 22-08-2024
expiryDate:
type: string
example: 19-02-2042
- $ref: '#/components/schemas/Credits'
examples:
Success:
summary: Successful response with driving licence details.
value:
status: success
code: 200
message: Operation completed successfully
data:
state: West Bengal
status: id_found
user_dob: 19-02-2002
dl_number: WB0120240098453
user_image: ''
expiry_date: 19-02-2042
issued_date: 22-08-2024
endorse_date: NA
user_address:
pin: '700091'
type: Permanent
state: West Bengal
country: India
district: Kolkata
addressLine1: Flat 4B, Salt Lake Sector V
completeAddress: >-
Flat 4B, Salt Lake Sector V, Kolkata, West Bengal,
700091
endorse_number: NA
status_details:
to: ''
from: ''
remarks: ''
user_full_name: ARJUN DEV ROY
name_match_score: '88.50'
user_blood_group: O+
father_or_husband: BISWAJIT ROY
transport_validity:
to: NA
from: NA
non_transport_validity:
to: 19-02-2042
from: 22-08-2024
vehicle_category_details:
- cov: LMV-NT
covType: non-transport
issueDate: 22-08-2024
expiryDate: 19-02-2042
- cov: MCWG
covType: non-transport
issueDate: 22-08-2024
expiryDate: 19-02-2042
credits_used: 7
credits_remaining: 492
'400':
$ref: '#/components/responses/400_WithCredits'
description: Bad request due to invalid input data.
content:
application/json:
examples:
Incorrect DL Format:
summary: DL Number must be in the format AA00XXXXXXXXXXX.
value:
status: error
code: 400
message: DL Number must be in the format AA00XXXXXXXXXXX.
data: null
credits_used: 0
credits_remaining: 8858
All Identical Digits in DL:
summary: All Identical Digits in DL
value:
status: error
code: 400
message: >-
DL Number cannot have all identical digits in the numeric
part.
data: null
credits_used: 0
credits_remaining: 8858
Missing DL Number:
summary: DL Number missing
value:
status: error
code: 400
message: '`dl_number` is required.'
data: null
credits_used: 0
credits_remaining: 8858
Invalid DL:
summary: Invalid DL
value:
status: error
code: 400
message: '`dl_number` is invalid.'
data: null
credits_used: 0
credits_remaining: 8858
Invalid DOB Format:
summary: Invalid DOB Format (DD-MM-YYYY)
value:
status: error
code: 400
message: Date of Birth must be in the format dd-mm-yyyy.
data: null
credits_used: 0
credits_remaining: 8858
Missing DOB:
summary: DOB is required.
value:
status: error
code: 400
message: '`dob` is required.'
data: null
credits_used: 0
credits_remaining: 8858
Invalid DOB Value:
summary: DOB is invalid.
value:
status: error
code: 400
message: '`dob` is invalid.'
data: null
credits_used: 0
credits_remaining: 8858
Null DOB:
summary: DOB must be a string.
value:
status: error
code: 400
message: '`dob` must be a string.'
data: null
credits_used: 0
credits_remaining: 8858
Missing payload:
summary: Payload is missing.
value:
status: error
code: 400
message: Payload is missing.
data: null
credits_used: 0
credits_remaining: 8858
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
description: No Records Found
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/APIBaseResponse'
- type: object
required:
- data
properties:
data:
type: object
required:
- case_id
properties:
case_id:
$ref: '#/components/schemas/CaseId'
- $ref: '#/components/schemas/Credits'
examples:
No records found:
summary: No records Found
value:
status: error
code: 404
message: No records found.
data:
case_id: 8a3b2d79e91c4ff1b2e97b9f2b36c123
credits_used: 0
credits_remaining: 499
'500':
$ref: '#/components/responses/500_WithCredits'
description: Internal server error.
components:
schemas:
APIBaseResponse:
type: object
required:
- status
- code
- message
properties:
status:
$ref: '#/components/schemas/APIStatus'
code:
$ref: '#/components/schemas/HTTPCode'
message:
$ref: '#/components/schemas/APIMessage'
Credits:
type: object
properties:
credits_used:
$ref: '#/components/schemas/CreditsUsed'
credits_left:
$ref: '#/components/schemas/CreditsLeft'
required:
- credits_used
- credits_left
CaseId:
required:
- case_id
type: string
description: Unique Case Id for BGV
APIStatus:
type: string
enum:
- success
- error
description: Overall status of the API
HTTPCode:
type: integer
description: HTTP status code
example: 400
APIMessage:
type: string
description: Description of the response or error
example: Invalid request parameters
CreditsUsed:
type: integer
description: Represents the total number of credits used in this request.
example: 3
CreditsLeft:
type: integer
description: 'Represents the remaining credits available for use. '
example: 4040
Error:
allOf:
- $ref: '#/components/schemas/APIBaseResponse'
APIErrorData:
type: object
properties:
data:
type: object
nullable: true
example: null
responses:
'401':
description: Unauthorized
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- $ref: '#/components/schemas/APIErrorData'
examples:
Missing Token:
summary: Bearer token is missing or invalid.
value:
status: error
code: 401
message: Bearer token is missing or invalid.
data: null
Incorrect Token Format:
summary: Token format is incorrect
value:
status: error
code: 401
message: Token format is incorrect
data: null
No Admin Found:
summary: No admin found for this request
value:
status: error
code: 401
message: No admin user found for this organization
data: null
Invalid API Key:
summary: Invalid API Key
value:
status: error
code: 401
message: Invalid API key (organization ID)
data: null
User not Found:
summary: User not found
value:
status: error
code: 401
message: User not found.
data: null
'402':
description: Payment Required
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- $ref: '#/components/schemas/APIErrorData'
examples:
Credit Limit Exceed:
summary: Credit Limit Exceeded.
value:
status: error
code: 402
message: Credit Limit Exceeded.
data: null
Insufficient Credits:
summary: Insufficient credits
value:
status: error
code: 402
message: 'Insufficient credits: 2 required, 1 remaining.'
data: null
'403':
description: Forbidden
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- $ref: '#/components/schemas/APIErrorData'
examples:
Token Revoked:
summary: Token access has been Revoked, Contact Support.
value:
status: error
code: 403
message: Token access has been Revoked, Contact Support.
data: null
Token Inactive:
summary: Token is Inactive, Contact Support.
value:
status: error
code: 403
message: Token is Inactive, Contact Support.
data: null
400_WithCredits:
description: Bad Request
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- $ref: '#/components/schemas/APIErrorData'
- $ref: '#/components/schemas/Credits'
500_WithCredits:
description: Internal Server Error
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- $ref: '#/components/schemas/APIErrorData'
- $ref: '#/components/schemas/Credits'
examples:
Internal Server Error:
summary: Internal Server Error.
value:
status: error
code: 500
message: Internal Server Error.
data: null
credits_used: 3
credits_remaining: 178
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
API key issued by KonnectNXT. Pass as `Authorization: Bearer
`.
````