Skip to content
This repository was archived by the owner on Aug 3, 2022. It is now read-only.

Commit c543f65

Browse files
arnav1991arnav1991
committed
first commit
0 parents  commit c543f65

File tree

91 files changed

+20010
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+20010
-0
lines changed

‎docs/Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SPHINXPROJ = BitGuard
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/build/doctrees/environment.pickle

14.7 KB
Binary file not shown.

‎docs/build/doctrees/gettingStarted/Apendix.doctree

8.11 KB
Binary file not shown.

‎docs/build/doctrees/gettingStarted/appendex.doctree

32.8 KB
Binary file not shown.

‎docs/build/doctrees/gettingStarted/authentication.doctree

56.1 KB
Binary file not shown.

‎docs/build/doctrees/gettingStarted/introduction.doctree

10.5 KB
Binary file not shown.

‎docs/build/doctrees/index.doctree

3.87 KB
Binary file not shown.

‎docs/build/html/.buildinfo

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 8294db59e178c0cbf981f31c76b51a52
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/build/html/_sources/gettingStarted/Apendix.rst.txt

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
Appendex
2+
========
3+
4+
Appendex 1
5+
----------
6+
7+
Driving License:
8+
****************
9+
10+
**success Response**
11+
12+
.. code::
13+
14+
{
15+
"result": "id_found",
16+
"message": "Id was found in the source",
17+
"success": true,
18+
"ocr": {
19+
"address": "M-150, BLK-I NAGAR, PASCHIM VIHAR,DELHI GURUHARKISHAN",
20+
"date_of_birth": "1991-08-24",
21+
"date_of_validity": null,
22+
"fathers_name": "SANJAY AHUJADOB",
23+
"id_number": "DL-0420150346015",
24+
"is_scanned": "false",
25+
"issue_dates": {
26+
"LMV": null,
27+
"MCWG": null,
28+
"TRANS": null
29+
},
30+
"name_on_card": "KARAN AHUJA",
31+
"pincode": "110087",
32+
"state": "Delhi",
33+
"street_address": "BLK-I NAGAR, PASCHIM VIHAR, GURUHARKISHAN",
34+
"type": [
35+
"LMV-NT",
36+
"MCWG"
37+
],
38+
"validity": {
39+
"NT": "2035-01-30",
40+
"T": null
41+
}
42+
},
43+
"matched_information": {
44+
"message": "OCR Data has been verified with government source",
45+
"source": "SARATHI",
46+
"dl_status": "Active",
47+
"status": "id_found",
48+
"name_match": 98.33333333333333,
49+
"dob_match": true,
50+
"ocr_id_match": true
51+
}
52+
}

‎docs/build/html/_sources/gettingStarted/appendex.rst.txt

+262
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,262 @@
1+
Appendex
2+
========
3+
4+
Appendex 1
5+
----------
6+
Understanding Government Responses
7+
8+
Driving License:
9+
****************
10+
11+
**success Response**
12+
13+
.. code::
14+
15+
{
16+
"result": "id_found",
17+
"message": "Id was found in the source",
18+
"success": true,
19+
"ocr": {
20+
"address": "M-150, BLK-I NAGAR, PASCHIM VIHAR,DELHI GURUHARKISHAN",
21+
"date_of_birth": "1991-08-24",
22+
"date_of_validity": null,
23+
"fathers_name": "SANJAY AHUJADOB",
24+
"id_number": "DL-0420150346015",
25+
"is_scanned": "false",
26+
"issue_dates": {
27+
"LMV": null,
28+
"MCWG": null,
29+
"TRANS": null
30+
},
31+
"name_on_card": "KARAN AHUJA",
32+
"pincode": "110087",
33+
"state": "Delhi",
34+
"street_address": "BLK-I NAGAR, PASCHIM VIHAR, GURUHARKISHAN",
35+
"type": [
36+
"LMV-NT",
37+
"MCWG"
38+
],
39+
"validity": {
40+
"NT": "2035-01-30",
41+
"T": null
42+
}
43+
},
44+
"matched_information": {
45+
"message": "OCR Data has been verified with government source",
46+
"source": "SARATHI",
47+
"dl_status": "Active",
48+
"status": "id_found",
49+
"name_match": 98.33333333333333,
50+
"dob_match": true,
51+
"ocr_id_match": true
52+
}
53+
}
54+
55+
**dl_status** is status of the Driving License found with source, look for Active/Inactive.
56+
57+
**ocr_id_match** will be true if OCR scanned ID and Government pulled ID were same.
58+
59+
**name_match** will be percentage match of scanned Name and government retrieved name.
60+
61+
**dob_match** will bebe true if OCR scanned date of birth and Government pulled date of birth were same.
62+
63+
PAN CARD
64+
********
65+
66+
**success response**
67+
68+
.. code::
69+
70+
{
71+
"result": "id_found",
72+
"message": "PAN is Active and the details are matching with PAN database.",
73+
"success": true,
74+
"ocr": {
75+
"age": 28,
76+
"date_of_birth": "1991-08-24",
77+
"date_of_issue": null,
78+
"fathers_name": "Sanjay Kumar Ahuja",
79+
"id_number": "BILPA4762R",
80+
"is_scanned": false,
81+
"minor": false,
82+
"name_on_card": "Karan Arilia",
83+
"pan_type": "Individual"
84+
},
85+
"matched_information": {
86+
"message": "PAN format is correct and PAN number is correct matching against DOB. However, Name is Incorrect.",
87+
"id_match": true,
88+
"name_match": false,
89+
"dob_match": true
90+
}
91+
}
92+
93+
**id_match** if id ocr and govt matched.
94+
95+
**name_match** if name ocr and govt matched.
96+
97+
**dob_match** if date of birth ocr and govt matched.
98+
99+
Voter ID
100+
********
101+
102+
**success response**
103+
104+
.. code::
105+
106+
{
107+
"result": "id_found",
108+
"message": "Id was found in the source",
109+
"success": true,
110+
"ocr": {
111+
"address": "150, BLOCK- M, GURU HAR KISHAN NAGAR PASCHIM VIHAR, DELHI",
112+
"age": null,
113+
"date_of_birth": null,
114+
"district": "DELHI",
115+
"fathers_name": "Sanjay Kumar Ahuja",
116+
"gender": "MALE",
117+
"house_number": "150",
118+
"id_number": "UBF2101764",
119+
"is_scanned": null,
120+
"name_on_card": "Karan Ahuja",
121+
"pincode": null,
122+
"state": "Delhi",
123+
"street_address": "Block- M, Guru Har Kishan Nagar Paschim Vihar, Delhi",
124+
"year_of_birth": null
125+
},
126+
"matched_information": {
127+
"message": "OCR Data has been verified with government source",
128+
"gender": "M",
129+
"source": "NVSP",
130+
"status": "id_found",
131+
"name_match": 100,
132+
"father_name_match": 100,
133+
"street_address_match": 64.57571524439514,
134+
"ocr_id_match": true
135+
}
136+
}
137+
138+
**gender** will be Government retrieved gender of person.
139+
140+
**name_match** will be percentage match of scanned Name and government retrieved name.
141+
142+
**father_name_match** will be percentage match of scanned Name (father/husband or guardian) and government retrieved name.
143+
144+
**street_address_match** will be percentage match of scanned address and government retrieved address. closer it is to 100, better result. Will rarely be 100.
145+
146+
Aadhaar
147+
*******
148+
149+
**success response**
150+
151+
.. code::
152+
153+
{
154+
"result": "id_found",
155+
"message": "found and verified by UIDAI portal",
156+
"success": true,
157+
"information": "{\"Gender\": \"MALE\", \"State\": \"Delhi\", \"Mobile Number\": \"xxxxxxx447\", \"Age Band\": \"20-30\"}",
158+
"ocr": {
159+
"address": "S/O Sanjay Ahuja, House No-M 150, Guru karkishan Nagar, Paschim Vihar, Jwala Puri, We st Delhi, Delhi - 110087",
160+
"date_of_birth": "1991-08-24",
161+
"district": "DELHI",
162+
"fathers_name": "Sanjay Ahuja",
163+
"gender": "MALE",
164+
"house_number": "M 150",
165+
"id_number": "319*4429*458",
166+
"is_scanned": "false",
167+
"name_on_card": "Karan Ahuja",
168+
"pincode": "110087",
169+
"state": "Delhi",
170+
"street_address": "Guru karkishan Nagar, Paschim Vihar, Jwala Puri, We st",
171+
"year_of_birth": "1991"
172+
},
173+
"matched_information": {
174+
"message": "OCR Data has been verified with government source",
175+
"gender_match": true,
176+
"state_match": true,
177+
"age_match": true
178+
}
179+
}
180+
181+
**gender_match** will be true if gender from ocr and goverment are same.
182+
183+
**state_match** will be true if state from ocr and goverment are same.
184+
185+
**age_match** will be true if age from ocr and goverment are same.
186+
187+
Appendex 2
188+
----------
189+
190+
**success response**
191+
192+
.. code::
193+
194+
{ "person":
195+
{
196+
"name": {
197+
"first": "Karan",
198+
"last": "Ahuja",
199+
"middle": "Ahuja"
200+
},
201+
"documents": {
202+
"ind_aadhaar": {
203+
"result": {
204+
"address": "S/O Sanjay Ahuja, House No-M 150, Guru karkishan Nagar, Paschim Vihar, Jwala Puri, We st Delhi, Delhi - 110087",
205+
"date_of_birth": "1991-08-24",
206+
"district": "DELHI",
207+
"fathers_name": "Sanjay Ahuja",
208+
"gender": "MALE",
209+
"house_number": "M 150",
210+
"id_number": "319644293458",
211+
"is_scanned": "false",
212+
"name_on_card": "Karan Ahuja",
213+
"pincode": "110087",
214+
"state": "Delhi",
215+
"street_address": "Guru karkishan Nagar, Paschim Vihar, Jwala Puri, We st",
216+
"year_of_birth": "1991"
217+
},
218+
"manualObj": null,
219+
"status": "completed",
220+
"faceMatched": false,
221+
"matchResult": null,
222+
"govResult": null,
223+
"request_id": "1b247fa9-df84-463e-aa3f-899758ab6019",
224+
"provider": "idfy",
225+
"_id": "5df9fdfb71b57d2c188ebc63",
226+
"docType": "ind_aadhaar",
227+
"document1": "https://pdf-reports-springrole.s3.amazonaws.com/adhaar.png",
228+
"belongsTo": "5df9fdf971b57d2c188ebc62",
229+
"createdAt": "2019-12-18T10:22:59.917Z",
230+
"updatedAt": "2019-12-18T10:23:01.167Z",
231+
"__v": 0
232+
},
233+
"ind_driving_license": null,
234+
"ind_pan": null,
235+
"ind_voter_id": null,
236+
"ind_passport": null
237+
},
238+
"selfie": {
239+
"url": "https://pdf-reports-springrole.s3.amazonaws.com/face_image_1573552012776.jpg"
240+
},
241+
"hasConsent": false,
242+
"phone": null,
243+
"city": null,
244+
"gender": null,
245+
"s3_paths": null,
246+
"_id": "5df9fdf971b57d2c188ebc62",
247+
"addedBy": "5df88fc19ef1c83484090fb0",
248+
"createdAt": "2019-12-18T10:22:49.563Z",
249+
"updatedAt": "2019-12-18T10:23:00.299Z",
250+
"__v": 0
251+
}
252+
}
253+
254+
**Person** object will contain name and document objects
255+
256+
**document** object will contain one of the 5 supported document type (table in beginning of this document.
257+
258+
**result** object inside ind_* object is the ==OCR result==
259+
260+
**govResult** is government result object, filled after government verification (5) api is called
261+
262+
**document1** is the link of document

0 commit comments

Comments
 (0)