EPAN extraction
Introduction
The EPAN extraction API provided by Signzy Technologies Private Limited allows you to extract the Electronic PAN (EPAN) details of an individual from a valid password-protected PDF or zip file or an XML file. This API endpoint can be integrated with your existing systems to automate the process of EPAN extraction, reducing manual effort and increasing efficiency.
The API accepts a direct URL to the file and the associated password (for PDF and zip files), and returns a JSON response containing the extracted EPAN details, including the name, father's name, date of birth, gender, photo, PAN number, and validity of the PAN. Additionally, the API also returns the X509 data of the digital signature certificate (DSC) associated with the file.
API details
Endpoint
POST https://api.signzy.app/api/v3/epan/extractionPOST https://api-preproduction.signzy.app/api/v3/epan/extractionRequest body Parameters
Property | Data Type | Description | Required |
|---|---|---|---|
file | string | Publicly accessible URL of the file to be processed. Must be a direct link to a zip, XML or PDF file. | Mandatory |
password | string | Required only for ZIP and PDF files. The password to decrypt the file. | Conditionally mandatory |
type | string | The type of the file being processed. Must be one of "individualPan". | Mandatory |
{
"file": "<file url>",
"password": "<file password>",
"type": "<type of file>"
}Request Headers
Name | Value | Required | Description |
|---|---|---|---|
Content-Type | application/json | Mandatory | The type of content that the request body contains. |
Authorization | XXXXXXXXXXXXXXX | Mandatory | An authentication token to authorize the request. Reach out to the Signzy support team to get one created. |
Code Samples
curl --location 'https://api.signzy.app/api/v3/epan/extraction' \
--header 'Content-Type: application/json' \
--header 'Authorization: <TOKEN>' \
--data '{
"file": "<File public url>",
"password": "<File password>",
"type": "<type of file>"
}'Response Body Parameters
Parameter | Data Type | Description |
|---|---|---|
result | Object | The main container for the result data. |
result.name | String | Name of the person. |
result.fatherName | String | Name of the father. |
result.dob | String | Date of birth of the person. |
result.number | String | PAN number of the person. |
result.gender | String | Gender of the person. |
result.photo | String | Direct URL to the photo of the person. |
result.timestamp | String | A timestamp (currently empty) associated with the data. |
result.x509Data | Object | Container for X.509 certificate-related data. |
result.x509Data.version | Number | Version of the X.509 certificate. |
result.x509Data.subject | Object | Information about the subject (entity) of the certificate. |
result.x509Data.issuer | Object | Information about the issuer (entity) of the certificate. |
result.x509Data.serial | String | Serial number of the certificate. |
result.x509Data.notBefore | String | The date and time before which the certificate is not valid. |
result.x509Data.notAfter | String | The date and time after which the certificate is not valid. |
result.x509Data.subjectHash | String | Hash of the subject information in the certificate. |
result.x509Data.signatureAlgorithm | String | The algorithm used for the signature of the certificate. |
result.x509Data.fingerPrint | String | Fingerprint of the certificate. |
result.x509Data.publicKey | Object | Information about the public key in the certificate. |
result.x509Data.publicKey.algorithm | String | Algorithm used for the public key. |
result.x509Data.altNames | Array | Alternative names associated with the certificate. |
result.x509Data.extensions | Object | Various extensions present in the certificate. |
result.x509Data.extensions.authorityKeyIdentifier | String | Identifier for the public key of the certificate authority. |
result.x509Data.extensions.subjectKeyIdentifier | String | Identifier for the public key of the subject. |
result.x509Data.extensions.basicConstraints | String | Basic constraints information of the certificate. |
result.x509Data.extensions.keyUsage | String | Usage of the public key in the certificate. |
result.x509Data.extensions.subjectAlternativeName | String | Alternative names for the subject. |
result.x509Data.extensions.extendedKeyUsage | String | Extended key usage information in the certificate. |
result.x509Data.extensions.certificatePolicies | String | Policies associated with the certificate. |
result.x509Data.extensions.authorityInformationAccess | String | Information about how to access the authority's information. |
result.x509Data.extensions.cRLDistributionPoints | String | Distribution points for certificate revocation lists (CRLs). |
result.isValidEPANDSC | Boolean | Indicates whether the certificate is valid for EP (Employee Provident Fund) and DSC (Digital Signature Certificate) purposes. |
{
"result": {
"name": "..name..",
"fatherName": "..fatherName..",
"dob": "..dob..",
"number": "..pan number.."
"gender": "..gender..",
"photo": "..directURL to photo..",
"timestamp": "",
"x509Data": {
"version": 2,
"subject": {
"countryName": "..countryName..",
"organizationName": "..organizationName..",
"organizationalUnitName": "..organizationalUnitName..",
"postalCode": "..postalCode..",
"stateOrProvinceName": "..stateOrProvinceName..",
"streetAddress": "..streetAddress..",
"houseIdentifier": "..houseIdentifier..",
"commonName": "..commonName.."
},
"issuer": {
"countryName": "..countryName..",
"organizationName": "..organizationName..",
"organizationalUnitName": "..organizationalUnitName..",
"commonName": "..commonName.."
},
"serial": "..serial..",
"notBefore": "..notBefore..",
"notAfter": "..notAfter..",
"subjectHash": "..subjectHash..",
"signatureAlgorithm": "..signatureAlgorithm..",
"fingerPrint": "..fingerPrint..",
"publicKey": {
"algorithm": "..algorithm.."
},
"altNames": [],
"extensions": {
"authorityKeyIdentifier": "..authorityKeyIdentifier..",
"subjectKeyIdentifier": "..subjectKeyIdentifier..",
"basicConstraints": "..basicConstraints..",
"keyUsage": "..keyUsage..",
"subjectAlternativeName": "..subjectAlternativeName..",
"extendedKeyUsage": "..extendedKeyUsage..",
"certificatePolicies": "..certificatePolicies..",
"authorityInformationAccess": "..authorityInformationAccess..",
"cRLDistributionPoints": "..cRLDistributionPoints.."
}
},
"isValidEPANDSC": "..true/false.."
}
}Contact Us for Any Assistance
If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!