DIN from PAN API

This document highlights the DIN from PAN API details.

API Description

Objective

The DIN from PAN API facilitates the retrieval of a Director Identification Number (DIN) from a Permanent Account Number (PAN).

Input	Output
The 10-digit PAN of the user	The details corresponding to the user such as name, address, tax status, and more.

API URL

https://ind-engine.thomas.hyperverge.co/v1/dinFromPan

API Endpoint

dinFromPan

Overview

The API is RESTful and uses standard HTTP verbs and status codes. The responses are in JSON format and you should upload all images and files as form-data through a POST request.

Authentication

You need a unique pair of application ID ( appId ) and application key (appKey) from HyperVerge to verify your identity for accessing the API.

Parameter	Mandatory or Optional	Description	Allowed Values
content-type	Mandatory	This parameter defines the media type for the request payload	application/json
appId	Mandatory	The application identifier shared by HyperVerge. You can find the details in the dashboard's credentials tab.	This should be a unique value.
appKey	Mandatory	The application key shared by HyperVerge. You can find the details in the dashboard's credentials tab.	This should be a unique value.
transactionId	Mandatory	A unique identifier for tracking a user journey	This should be both unique and easily associated with the user's journey in your application(s)

Input

The following table outlines the parameter required in the API's request body:

Parameter	Description	Mandatory or Optional	Allowed Values	Default Value
`panNumber`	The PAN of the user, which is a unique identifier for taxpayers in India	Mandatory	Format: 'CCCCCDDDDC' format, where 'C' represents a character and 'D' represents a digit	Not Applicable

Request

The following code snippet demonstrates a standard curl request for the API:

curl --location --request POST 'https://ind.thomas.hyperverge.co/v1/dinFromPan' \
--header 'Content-Type: application/json' \
--header 'appId: <Enter_the_HyperVerge_appId>' \
--header 'appKey: <Enter_the_HyperVerge_appKey>' \
--header 'transactionId: <Enter_the_HyperVerge_transactionID>' \
--data '{
    "panNumber": "<Enter_the_PAN>"
}'

Success Response

The following code snippet demonstrates a success response from the API:

{
  "status": "success",
  "statusCode": "200",
  "result": {
    "message": "<Message_About_The_Result>",
    "details": {
      "panNumber": "<Masked_PAN_Number>",
      "dinNumber": "<Masked_DIN_Number>",
      "dinStatus": "<DIN_Status>",
      "firstName": "<First_Name_Of_The_user>",
      "middleName": "<Middle_Name_Of_The_user_If_Available>",
      "lastName": "<Last_Name_Of_The_user>",
      "dateOfBirth": "<Date_Of_Birth_in_DD-MMM-YYYY_Format>",
      "fatherFirstName": "<Father's_First_Name>",
      "fatherMiddleName": "<Father's_Middle_Name_If_Available>",
      "fatherLastName": "<Father's_Last_Name>",
      "residentOfIndia": "<Is_Resident_Of_India_Y/N>",
      "membershipNumber": "<Membership_Number_If_Available>"
    }
  },
  "metaData": {
    "requestId": "<Unique_Request_Identifier>",
    "transactionId": "<Unique_Transaction_Identifier>"
  }
}

Success Response Details

Parameter	Type	Description
status	string	The status of the request
statusCode	integer	The HTTP status code of the response
message	string	The result message of the request
panNumber	string	The PAN of the user
dinNumber	string	The DIN of the user
dinStatus	string	The status of the DIN
firstName	string	The first name of the user
middleName	string	The middle name of the user
lastName	string	The last name of the user
dateOfBirth	string	The date of birth of the user in DD-MMM-YYYY format (the first three letters of the month's name are returned, e.g., NOV)
fatherFirstName	string	The first name of the user's father
fatherMiddleName	string	The middle name of the user's father
fatherLastName	string	The last name of the user's father
residentOfIndia	string	Indicates whether the user is a resident of India (Y/N)
membershipNumber	string	The membership number of the user
requestId	string	The unique identifier for the request
transactionId	string	The transaction ID associated with the request

Failure Response

The following is a failure response from the API:

{
    "status": "failure",
    "statusCode": 404,
    "result": {
        "message": "Din Not Found"
    },
    "metaData": {
         "requestId": "<Request_ID>",
        "transactionId": "<Transaction_ID>"
    }
}

Error Responses

The following are the error responses from the API:

Invalid PAN
Input Validation Error: Missing Parameter
Incorrect Data Type
Missing/Invalid Credentials
Internal Server Error
External Downtime

{
    "message": "Invalid Pan format",
    "statusCode": 400,
    "status": "failure",
    "metaData": {
        "requestId": "<Request_ID>",
        "transactionId": "<Transaction_ID>"
    }
}

{
    "message": "Input Validation Error: requires property \"panNumber\"",
    "statusCode": 400,
    "status": "failure"
}

{
    "message": "Input Validation Error: is not of a type(s) string",
    "statusCode": 400,
    "status": "failure"
}

{
    "message": "Missing/Invalid credentials",
    "statusCode": 401,
    "status": "failure"
}

{
    "message": "Internal Server Error",
    "statusCode": 500,
    "status": "failure"
}

{
          "message": "External vendor downtime",
          "statusCode": 503,
          "status": "failure",
          "error": "EXTERNAL_DOWNTIME"
          "metaData": {
             "requestId": "<Request_ID>",
        "transactionId": "<Transaction_ID>"
    }
}

Failure and Error Response Details

A failure or error response from the module contains a failure status, with a relevant status code and error message. The following table lists all error responses:

Status Code	Error Message	Error Description
400	Missing required request parameters	Some mandatory request parameters are missing in the API request made.
400	Invalid Pan format	The 10-digit PAN is not in the CCCCCDDDDC format
401	Missing/Invalid credentials	The request is either missing the mandatory `appId` and `appKey` combination or has invalid values
403	Access Denied	Please contact the HyperVerge team for resolution
404	Din Not Found	The request has an invalid DIN that yielded no match in the database
500	Internal Server Error	Please check the request headers or contact the HyperVerge team for resolution
503	External Downtime	Please contact the HyperVerge team for resolution

API Description​

Objective​

API URL​

API Endpoint​

Overview​

Authentication​

Input​

Request​

Success Response​

Success Response Details​

Failure Response​

Error Responses​

Failure and Error Response Details​