Appendix¶
Caste Certificate¶
A description:
<CertificateData>
<Caste name="" category="SC/ST/OBC/GC" subCategory="" description="" />
</CertificateData>
Element: Caste The element contains the caste details of an individual. |
||
---|---|---|
Attribute |
Mandatory (M)/ Optional (O) |
Description |
name |
M |
The descriptive name of the caste. |
category |
M |
The category of the caste. It contains one of the following value: SC – Scheduled Caste ST – Scheduled Tribe OBC – Other Backward Caste GC – General Category |
subcategory |
O |
The issuer may add the details of issuer specific caste category in this attribute. |
description |
O |
The descriptive details of the caste may be added in this field. |
Example¶
A description:
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<PullDocResponse xmlns:ns2="http://tempuri.org/">
<ResponseStatus status="1" ts="YYYY-MM-DDThh:mm:ss+/-nn:nn" txn="">
//1-Success //0-Failure </ResponseStatus>
<DocDetails>
<DocContent>//Base64 encoded PDF content</DocContent>
<DataContent>
<?xml version="1.0" encoding="utf-8"?>
//Certificate metadata in XML format
<Certificate language="99" name="Caste Certificate" type="CTCER" number="C012345" issuedAt="" issueDate="01-01-1980" validFromDate="01-01-1980" expiryDate="" status="A/E/R/S">
<IssuedBy>
<Organization name="" code="" tin="" uid="" type="CG/SG/NG" >
<Address type="present/permanent/mailing/official" line1="" line2="" house="" landmark="" locality="" vtc="" district="" pin="" state="" country="" />
</Organization>
</IssuedBy>
<IssuedTo>
<Person uid="" title="" name="" dob="" swd="" swdIndicator="S/W/D" gender="M/F/T" maritalStatus="" religion="" phone="" email="">
<Address type="present/permanent/mailing/official" line1="" line2="" house="" landmark="" locality="" vtc="" district="" pin="" state="" country="" />
<Photo format="RAW/PNG/JPG/JPEG">Base 64 encoded image content</Photo>
</Person>
</IssuedTo>
<CertificateData>
<Caste name="" category="SC/ST/OBC/GC" subCategory="" description="" />
</CertificateData>
<Signature/>
</Certificate>
</DataContent>
</DocDetails>
</PullDocResponse>
Driving License¶
A description:
<CertificateData>
<DrivingLicense>
<Categories>
<Category code="" abbreviation="" description="" issueDate="" endorseDate=""/>
<Category code="" abbreviation="" description="" issueDate="" endorseDate=""/>
</Categories>
</DrivingLicense>
</CertificateData>
Element: DrivingLicense The element contains the driving license details. |
||
---|---|---|
Element: Categories The element contains list of categories of vehicles that the individual is authorized to drive. |
||
Element: Category The element contains the details of the category of vehicles that the individual is authorized to drive. |
||
Attribute |
Mandatory (M)/ Optional (O) |
Description |
code |
M |
The category code of the vehicle. |
abbreviation |
M |
The category abbreviation of the vehicle such as MCWG or LMV. |
description |
O |
The descriptive details of the vehicle category. |
issueDate |
O |
The license issue date for this category of vehicle. |
endorseDate |
O |
The endorsement date for this category of vehicle. |
Example¶
The content of DataContent element will be in Base64 encoded format in actual response. It has been shown in clear text here only for demonstration.
A description:
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<PullDocResponse xmlns:ns2="http://tempuri.org/">
<ResponseStatus status="1" ts="YYYY-MM-DDThh:mm:ss+/-nn:nn" txn="">
//1-Success //0-Failure </ResponseStatus>
<DocDetails>
<DocContent>//Base64 encoded PDF content</DocContent>
<DataContent>
<?xml version="1.0" encoding="utf-8"?>
//Certificate metadata in XML format
<Certificate language="99" name="Driving License" type="DRVLC" number="DL012345678" prevNumber="1234/9876" issuedAt="New Delhi" issueDate="01-01-1990" validFromDate="01-01-1990" expiryDate="31-12-2010" status="A">
<IssuedBy>
<Organization name="" code="" tin="" uid="" type="CG/SG/NG" >
<Address type="present/permanent/mailing/official" line1="" line2="" house="" landmark="" locality="" vtc="" district="" pin="" state="" country="" />
</Organization>
</IssuedBy>
<IssuedTo>
<Person uid="" title="" name="" dob="" swd="" swdIndicator="S/W/D" gender="M/F/T" maritalStatus="" religion="" phone="" email="">
<Address type="present/permanent/mailing/official" line1="" line2="" house="" landmark="" locality="" vtc="" district="" pin="" state="" country="" />
<Photo format="RAW/PNG/JPG/JPEG">Base 64 encoded image content</Photo>
</Person>
</IssuedTo>
<CertificateData>
<DrivingLicense>
<Categories>
<Category code="NT" abbreviation="MCWG" description="Motor Cycle with Gear(Non Transport)" issueDate="01-01-1990" endorseDate="01-01-1990"/>
<Category code="NT" abbreviation="LMV" description="Light Motor Vehicle" issueDate="01-01-1990" endorseDate="01-01-1990"/>
<Categories>
</DrivingLicense>
</CertificateData>
<Signature/>
</Certificate>
</DataContent>
</DocDetails>
</PullDocResponse>
Vehicle Registration¶
A description:
<CertificateData>
<VehicleRegistration statusDate="" financer="" normsDesc="" ownerSerialNo="" taxUpto="" blacklistStatus="" nocDetails="">
<Insurance policyNo="" validTill="" companyName=""/>
<PUCCertificate certificateNo="" validTill=""/>
<Vehicle engineNo="" chasisNo="" make="" model="" mfgDate="" class="" category="" bodyType="" color="" seatCapacity="" standingCapacity="" sleeperCapacity="" fuelDesc="" cylinder="" cubicCapacity="" grossWeight="" unladenWeight="" wheelbase="" fitTill="" />
</VehicleRegistration>
</CertificateData>
Element: VehicleRegistration The element contains the vehicle registration details. |
||
---|---|---|
statusDate |
M |
This will be the date on which the status of vehicle registration is retrieved from VAHAN application in DD-MM-YYYY format. |
financer |
O |
The name financer of the vehicle if any. |
normsDesc |
O |
The norms description as returned by VAHAN application. |
ownerSerialNo |
O |
This is the serial number of the owner in case the vehicle has been sold multiple times. |
taxUpto |
O |
The date till which tax is paid in DD-MM-YYYY format. |
blacklistStatus |
O |
The vehicle black list status. |
nocDetails |
O |
Vehicle NOC details. |
Element: Insurance The element contains the details of the insurance of the vehicle. |
||
Attribute |
Mandatory (M)/ Optional (O) |
Description |
policyNo |
M |
The insurance policy number. |
validTilll |
M |
The date till the insurance is valid in DD-MM-YYYY format. |
companyName |
M |
The name of the insurance company. |
Element: PUCCertificate The element contains the details of the PUC certificate. |
||
Attribute |
Mandatory (M)/ Optional (O) |
Description |
certificateNo |
M |
The PUC certificate number. |
validTilll |
M |
The date till the PUC certificate is valid in DD-MM-YYYY format. |
Element: Vehicle The element contains the details of the vehicle. |
||
Attribute |
Mandatory (M)/ Optional (O) |
Description |
engineNo |
M |
Engine number |
chasisNo |
M |
Chasis number |
make |
M |
Vehicle make |
model |
M |
Vehicle model |
mfgDate |
M |
Manufacturing month and year in MM/YYYY format |
class |
M |
Class of vehicle |
category |
M |
Vehicle Category |
bodyType |
Vehicle body type |
|
color |
M |
Color |
seatCapacity |
M |
Seating capacity |
standingCapacity |
M |
Standing capacity |
sleeperCapacity |
M |
Sleeping capacity |
fuelDesc |
M |
Fuel description |
cylinder |
M |
Number of cylinders |
cubicCapacity |
M |
Cubic capacity of vehicle |
grossWeight |
M |
Gross weight |
unladenWeight |
M |
Unladen weight |
wheelbase |
M |
Wheel base siz. |
fitTill |
M |
Validity of the fitness certificate in DD-MM-YYYY format |
Example¶
The content of DataContent element will be in Base64 encoded format in actual response. It has been shown in clear text here only for demonstration.
A description:
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<PullDocResponse xmlns:ns2="http://tempuri.org/">
<ResponseStatus status="1" ts="YYYY-MM-DDThh:mm:ss+/-nn:nn" txn="">
//1-Success //0-Failure </ResponseStatus>
<DocDetails>
<DocContent>//Base64 encoded PDF content</DocContent>
<DataContent>
<?xml version="1.0" encoding="utf-8"?>
//Certificate metadata in XML format
<Certificate language="99" name="Vehicle Registration" type="RVCER" number="DL01AB1234" issuedAt="New Delhi" issueDate="01-01-1980" validFromDate="" expiryDate="" status="A/E/R/S">
<IssuedBy>
<Organization name="" code="" tin="" uid="" type="CG/SG/NG" >
<Address type="present/permanent/mailing/official" line1="" line2="" house="" landmark="" locality="" vtc="" district="" pin="" state="" country="" />
</Organization>
</IssuedBy>
<IssuedTo>
<Person uid="" title="" name="" dob="" swd="" swdIndicator="S/W/D" gender="M/F/T" maritalStatus="" religion="" phone="" email="">
<Address type="present/permanent/mailing/official" line1="" line2="" house="" landmark="" locality="" vtc="" district="" pin="" state="" country="" />
<Photo format="RAW/PNG/JPG/JPEG">Base 64 encoded image content</Photo>
</Person>
</IssuedTo>
<CertificateData>
<VehicleRegistration statusDate="" financer="" normsDesc="" ownerSerialNo="1" taxUpto="" blacklistStatus="" nocDetails="">
<Isurance policyNo="" validTill="" companyName=""/>
<PUCCertificate certificateNo="" validTill=""/>
<Vehicle engineNo="" chasisNo="" make="" model="" mfgDate="" class="" category="" bodyType="" color="" seatCapacity="" standingCapacity="" sleeperCapacity="" fuelDesc="" cylinder="" cubicCapacity="" grossWeight="" unladenWeight="" wheelbase="" fitTill="" />
</VehicleRegistration>
</CertificateData>
<Signature/>
</Certificate>
</DataContent>
</DocDetails>
</PullDocResponse>
PAN Verification Record¶
A description:
<CertificateData>
<PAN verifiedOn="12-12-2018 12:53:57"/>
</CertificateData>
Element: PAN |
||
---|---|---|
The element contains additional details of the PAN record. |
||
Attribute |
Mandatory (M)/ |
Description |
Optional (O) |
||
verifiedOn |
M |
The date in DD-MM-YYYY HH:MM:SS format on which the PAN information was verified. |
Example¶
The content of DataContent element will be in Base64 encoded format in actual response. It has been shown in clear text here only for demonstration. .. highlight:: none A description:
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<PullDocResponse xmlns:ns2="http://tempuri.org/">
<ResponseStatus status="1" ts="YYYY-MM-DDThh:mm:ss+/-nn:nn" txn="">
//1-Success //0-Failure </ResponseStatus>
<DocDetails>
<DocContent>//Base64 encoded PDF content</DocContent>
<DataContent>
<?xml version="1.0" encoding="utf-8"?>
//Certificate metadata in XML format
<Certificate language="99" name="PAN Card" type="PANCR" number="BBXPK2797M" issuedAt="Digilocker" issueDate="" validFromDate="" status="A">
<IssuedBy>
<Organization name="Income Tax Department" code="" tin="" uid="" type="CG">
<Address type="" line1="" line2="" house="" landmark="" locality="" vtc="" district="" pin="" state="" country="IN"/>
</Organization>
</IssuedBy>
<IssuedTo>
<Person uid="215051602786" title="" name="ANAND KUMAR" dob="01-10-1988" swd="" swdIndicator="" gender="M" maritalStatus="" religion="" phone="" email="">
<Address type="permanent" line1="" line2="" house="" landmark="" locality="" vtc="" district="" pin="" state="" country="IN"/>
<Photo format=""/>
</Person>
</IssuedTo>
<CertificateData>
<PAN num="BBXPK2797M" verifiedOn="12-12-2018 12:53:57"/>
</CertificateData>
<Signature/>
</Certificate>
</DataContent>
</DocDetails>
</PullDocResponse>
Academic Certificate (Mark Sheet, Passing Certificate)¶
A description:
<CertificateData>
<School name="" code=""/>
<Examination name="" month="" year=""/>
<Performance result="" marksTotal="" marksMax="" percentage="" cgpa="" cgpaMax="" grade="" resultDate="" updateDate="">
<Subjects>
<Subject name="" code="" marksTheory="" marksMaxTheory="" marksPractical="" marksMaxPractical="" marksOther="" marksMaxOther="" marksTotal="" marksMax="" gp="" gpMax="" grade=""/>
<Subject name="" code="" marksTheory="" marksMaxTheory="" marksPractical="" marksMaxPractical="" marksTotal="" marksMax="" gp="" gpMax="" grade=""/>
</Subjects>
</Performance>
</CertificateData>
Element: School The element contains the school/institution details. |
||
---|---|---|
name |
M |
Name of the school or institution. |
code |
O |
The code of the school or institution. |
Element: Examination The element contains the details of the examination. |
||
Attribute |
Mandatory (M)/ Optional (O) |
Description |
name |
M |
The name of the examination such as the Secondary School Examination or Higher Secondary School Examination. |
month |
M |
The month in which the examination was conducted. |
year |
M |
The year in which the examination was conducted. |
Element: Performance The element contains the details of the academic performance or result of the candidate. |
||
Attribute |
Mandatory (M)/ Optional (O) |
Description |
result |
M |
Descriptive text of the overall result such as PASS/QUALIFIED etc. |
marksTotal |
O |
Total marks obtained by the candidate in the examination if the issuer uses marking system for evaluation. |
marksMax |
O |
Maximum possible marks for the examination if the issuer uses marking system for evaluation. |
percentage |
O |
The overall percentage marks obtained by the candidate in the examination if the issuer uses marking system for evaluation. |
cgpa |
O |
Cumulative grading point average of the candidate in the examination if the issuer uses grading point system for evaluation. |
cgpaMax |
O |
Maximum cumulative grading point average possible if the issuer uses grading point system for evaluation. Some CGPA are based on 10 points while others are based on 4 points. |
grade |
O |
Textual overall grade of the candidate such as A/B/C/D if the issuer uses letter grading system. |
resultDate |
O |
The date of declaration of result. |
updateDate |
O |
The date of update of result record if any. |
Element: Subjects The element contains a list of Subject elements containing the subject-wise performance details. |
||
Element: Subject The element contains the performance details for a subject. |
||
name |
M |
Name of the school or institution. |
code |
O |
The code of the school or institution. |
marksTheory |
O |
Marks obtained by the candidate in theory for the subject. |
marksMaxTheory |
O |
Maximum marks possible in theory for the subject. |
marksPractical |
O |
Marks obtained by the candidate in practical for the subject. |
marksMaxPractical |
O |
Maximum marks possible in practical for the subject. |
marksOther |
O |
This field can be used for any other category than Theory and Practical. It contains marks obtained by the candidate in this category. |
marksMaxOther |
O |
This field can be used for any other category than Theory and Practical. It contains maximum marks possible in this category. |
marksTotal |
O |
Total marks obtained by the candidate in the subject including theory, practical or grace marks if any. |
marksMax |
O |
Maximum marks possible for the subject. |
gp |
O |
Grade point obtained in the subject. |
gpMax |
O |
Maximum grade point possible in the subject. |
grade |
O |
Grade in text obtained in the subject such as A/B/C/D. |
Example¶
The content of DataContent element will be in Base64 encoded format in actual response. It has been shown in clear text here only for demonstration.
A description:
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<PullDocResponse xmlns:ns2="http://tempuri.org/">
<ResponseStatus status="1" ts="YYYY-MM-DDThh:mm:ss+/-nn:nn" txn="">
//1-Success //0-Failure </ResponseStatus>
<DocDetails>
<DocContent>//Base64 encoded PDF content</DocContent>
<DataContent>
<?xml version="1.0" encoding="utf-8"?>
//Certificate metadata in XML format
<Certificate language="99" name="Higher Secondary School Certificate" type="HSCER" number="1100044" issuedAt="" issueDate="" validFromDate="" status="A">
<IssuedBy>
<Organization name="Central Board of Secondary Education" code="" tin="" uid="" type="CG">
<Address type="" line1="" line2="" house="" landmark="" locality="" vtc="" district="" pin="" state="" country="IN"/>
</Organization>
</IssuedBy>
<IssuedTo>
<Person uid="" title="" name="ANAND KUMAR" dob="01-10-1988" swd="PRAMOD KUMAR" swdIndicator="S" motherName="SUNITA DEVI" gender=" " maritalStatus="" disabilityStatus="" category="SC" religion="" phone="" email="">
<Address type="permanent" line1="" line2="" house="" landmark="" locality="" vtc="" district="" pin="" state="" country="IN"/>
<Photo format=""/>
</Person>
</IssuedTo>
<CertificateData>
<School name="DELHI PUBLIC SCHOOL GURGAON" code="20020"/>
<Examination name="SENION SCHOOL CERTIFICATE EXAMINATION" month="MARCH" year="2019"/>
<Performance result="PASS" marksTotal="" marksMax="" percentage="" cgpa="" cgpaMax="" grade="" resultDate="02-05-2019" updateDate="">
<Subjects>
<Subject name="ENGLISH CORE" code="301" marksTheory="95" marksMaxTheory="" marksPractical="" marksMaxPractical="" marksOther="95" marksMaxOther="" marksTotal="95" marksMax="" gp="" gpMax="" grade="A1"/>
<Subject name="ECONOMICS" code="030" marksTheory="70" marksMaxTheory="" marksPractical="17" marksMaxPractical="" marksOther="95" marksMaxOther="" marksTotal="87" marksMax="" gp="" gpMax="" grade="A2"/>
</Subjects>
</Performance>
</CertificateData>
</DataContent>
</DocDetails>
</PullDocResponse>
Ration Card¶
A description:
<CertificateData>
<RationCard>
<FairPriceShop number="" name="" address=""/>
<GasConnection number="" type="" companyName="" agencyName=""/>
</RationCard>
</CertificateData>
Element: RationCard The element contains the ration card details. |
||
---|---|---|
Element: FairPriceShop The element contains the details of the fair price shop for the ration card. |
||
Attribute |
Mandatory (M)/ Optional (O) |
Description |
number |
M |
The number of the fair price shop. |
name |
M |
The name of the fair price shop. |
address |
M |
The address of the fair price shop. |
Element: GasConnection The element contains the details of gas (LPG) connection owned by the family. |
||
Attribute |
Mandatory (M)/ Optional (O) |
Description |
number |
M |
The subscription number of the gas connection. |
type |
M |
The connection type. |
companyName |
M |
The name of the gas company such as BPCL or HPCL providing the connection. |
agencyName |
M |
The name of the agency or dealer providing the connection. |
Example¶
The content of DataContent element will be in Base64 encoded format in actual response. It has been shown in clear text here only for demonstration.
A description:
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<PullDocResponse xmlns:ns2="http://tempuri.org/">
<ResponseStatus status="1" ts="YYYY-MM-DDThh:mm:ss+/-nn:nn" txn="">
//1-Success //0-Failure </ResponseStatus>
<DocDetails>
<DocContent>//Base64 encoded PDF content</DocContent>
<DataContent>
<?xml version="1.0" encoding="utf-8"?>
//Certificate metadata in XML format
<Certificate language="99" name="Ration Card" type="RATCR" number=" 119001907994" issuedAt="Jaipur" issueDate="01-01-1980" validFromDate="" expiryDate="31-12-2020" status="A/E/R/S">
<IssuedBy>
<Organization name="Food and Civil Supplies Department, Govt of Rajasthan" code="" tin="" uid="" type="CG/SG/NG" >
<Address type="present/permanent/mailing/official" line1="" line2="" house="" landmark="" locality="" vtc="" district="Jaipur" pin="" state="Rajasthan" country="" />
</Organization>
</IssuedBy>
<IssuedTo>
<Person uid="" title="" name="Sunil Kumar" dob="" age="50" swd="" swdIndicator="S/W/D" gender="M" maritalStatus="" relationWithHof="I/M/F/H/W/S/D/O" religion="" phone="" email="">
<Address type="present/permanent/mailing/official" line1="" line2="" house="" landmark="" locality="" vtc="" district="" pin="" state="" country="" />
<Photo format="RAW/PNG/JPG/JPEG">Base 64 encoded image content</Photo>
</Person>
<Person uid="" title="" name="Sunita Devi" dob="" age="47" swd="" swdIndicator="S/W/D" gender="F" maritalStatus="" relationWithHof="W" religion="" phone="" email="">
<Address type="present/permanent/mailing/official" line1="" line2="" house="" landmark="" locality="" vtc="" district="" pin="" state="" country="" />
<Photo format="RAW/PNG/JPG/JPEG">Base 64 encoded image content</Photo>
</Person>
</IssuedTo>
<CertificateData>
<RationCard>
<FairPriceShop number="368" name="Kumawat Shop" address="1, Khatipura, Jaipur, Rajasthan"/>
<GasConnection number="30512" type="DOUBLE" companyName="BPCL" agencyName="Ms Tulip Gas Agency"/>
</RationCard>
</CertificateData>
<Signature/>
</Certificate>
</DataContent>
</DocDetails>
</PullDocResponse>