Skip to content

Commit a1d20bf

Browse files
biprakantabiprakanta
authored
Merge pull request #259 from SetuHQ/DATA-1974
docs(DATA-1974): added aadhaar-lite documentation
2 parents 461d28b + 7ff3dcd commit a1d20bf

File tree

6 files changed

+537
-2
lines changed

6 files changed

+537
-2
lines changed

‎api-playground/json/data/aadhaar-lite/aadhaar-lite.json

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"parameters": {
3+
"header": [
4+
{
5+
"x-client-id": "292c6e76-dabf-49c4-8e48-90fba2916673"
6+
},
7+
{
8+
"x-client-secret": "7IZMe9zvoBBuBukLiCP7n4KLwSOy11oP"
9+
},
10+
{
11+
"x-product-instance-id": "69e23f7f-4f71-412e-aec6-b1da3fb77c6f"
12+
}
13+
]
14+
},
15+
"body": {
16+
"aadhaar_number": "999999990001"
17+
}
18+
}
19+

‎api-playground/products.json

+4
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@
5959
{
6060
"name": "Insights",
6161
"path": "data/insights"
62+
},
63+
{
64+
"name": "Aadhaar Lite",
65+
"path": "data/aadhaar-lite"
6266
}
6367
]
6468
}

‎api-references/data/aadhar-lite.json

+281
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,281 @@
1+
{
2+
"openapi": "3.0.0",
3+
"info": {
4+
"title": "Data Gateway - GST verification",
5+
"description": "pull just the key facts from an Aadhaar record without any extra OTPs or hoops for your users.\n\n[See on Setu docs](https://docs.setu.co/data)",
6+
"contact": {},
7+
"version": "1.0"
8+
},
9+
"servers": [
10+
{
11+
"url": "https://dg-sandbox.setu.co",
12+
"description": "Sandbox"
13+
},
14+
{
15+
"url": "https://dg.setu.co",
16+
"description": "Production"
17+
}
18+
],
19+
"paths": {
20+
"/api/aadhaar-lite": {
21+
"post": {
22+
"tags": ["Aadhaar Lite"],
23+
"summary": "Aadhaar Lite",
24+
"operationId": "AadhaarLite",
25+
"parameters": [
26+
{
27+
"name": "x-client-id",
28+
"in": "header",
29+
"description": "",
30+
"required": true,
31+
"style": "simple",
32+
"schema": {
33+
"type": "string",
34+
"example": "{{client_id}}"
35+
}
36+
},
37+
{
38+
"name": "x-client-secret",
39+
"in": "header",
40+
"description": "",
41+
"required": true,
42+
"style": "simple",
43+
"schema": {
44+
"type": "string",
45+
"example": "{{secret}}"
46+
}
47+
},
48+
{
49+
"name": "x-product-instance-id",
50+
"in": "header",
51+
"description": "",
52+
"required": true,
53+
"style": "simple",
54+
"schema": {
55+
"type": "string",
56+
"example": "{{x-product-instance-id}}"
57+
}
58+
}
59+
],
60+
"requestBody": {
61+
"description": "",
62+
"content": {
63+
"application/json": {
64+
"schema": {
65+
"allOf": [
66+
{
67+
"$ref": "#/components/schemas/AadhaarLiteRequest"
68+
},
69+
{
70+
"example": {
71+
"aadhaar_number": "999999990001"
72+
}
73+
}
74+
]
75+
},
76+
"example": {
77+
"aadhaar_number": "999999990001"
78+
}
79+
}
80+
},
81+
"required": true
82+
},
83+
"responses": {
84+
"404": {
85+
"description": "Not Found",
86+
"headers": {},
87+
"content": {
88+
"application/json": {
89+
"schema": {
90+
"allOf": [
91+
{
92+
"$ref": "#/components/schemas/AadhaarNotFound"
93+
},
94+
{
95+
"example": {
96+
"message": "Aadhaar not found",
97+
"id": "fa239bc1-b0ec-4484-be42-cfc4031c6be5",
98+
"traceId": "1-68187a91-2067df594a94c6047b65043a",
99+
"status": "FAILED"
100+
}
101+
}
102+
]
103+
},
104+
"example": {
105+
"message": "Aadhaar not found",
106+
"id": "fa239bc1-b0ec-4484-be42-cfc4031c6be5",
107+
"traceId": "1-68187a91-2067df594a94c6047b65043a",
108+
"status": "FAILED"
109+
}
110+
}
111+
}
112+
},
113+
"200": {
114+
"description": "OK",
115+
"headers": {},
116+
"content": {
117+
"application/json": {
118+
"schema": {
119+
"allOf": [
120+
{
121+
"$ref": "#/components/schemas/ValidAadhaarLite"
122+
},
123+
{
124+
"example": {
125+
"status": "SUCCESS",
126+
"id": "3ae8518d-99d3-4cd0-9315-b12a4936e1bc",
127+
"message": "Aadhaar found",
128+
"data": {
129+
"address": "Delhi",
130+
"ageBand": "20-30",
131+
"gender": "M",
132+
"maskedMobileNumber": "XXXXXX1234"
133+
},
134+
"traceId": "1-681871c5-2c10e99906394e4055ef962a"
135+
}
136+
}
137+
]
138+
},
139+
"example":{
140+
"status": "SUCCESS",
141+
"id": "3ae8518d-99d3-4cd0-9315-b12a4936e1bc",
142+
"message": "Aadhaar found",
143+
"data": {
144+
"address": "Delhi",
145+
"ageBand": "20-30",
146+
"gender": "M",
147+
"maskedMobileNumber": "XXXXXX1234"
148+
},
149+
"traceId": "1-681871c5-2c10e99906394e4055ef962a"
150+
}
151+
}
152+
}
153+
}
154+
},
155+
"deprecated": false,
156+
"security": []
157+
}
158+
}
159+
},
160+
"components": {
161+
"schemas": {
162+
"AadhaarLiteRequest": {
163+
"title": "AadhaarLiteRequest",
164+
"required": ["aadhaar_number"],
165+
"type": "object",
166+
"properties": {
167+
"aadhaar_number": {
168+
"type": "string"
169+
}
170+
},
171+
"example": {
172+
"aadhaar_number": "999999990001"
173+
}
174+
},
175+
"ValidAadhaarLite": {
176+
"title": "ValidAadhaarLite",
177+
"required": [
178+
"status",
179+
"id",
180+
"message",
181+
"data",
182+
"traceId"
183+
],
184+
"type": "object",
185+
"properties": {
186+
"status": {
187+
"type": "string"
188+
},
189+
"id": {
190+
"type": "string"
191+
},
192+
"message": {
193+
"type": "string"
194+
},
195+
"data": {
196+
"$ref": "#/components/schemas/Data"
197+
},
198+
"traceId": {
199+
"type": "string"
200+
}
201+
},
202+
"example": {
203+
"status": "SUCCESS",
204+
"id": "3ae8518d-99d3-4cd0-9315-b12a4936e1bc",
205+
"message": "Aadhaar found",
206+
"data": {
207+
"address": "Delhi",
208+
"ageBand": "20-30",
209+
"gender": "M",
210+
"maskedMobileNumber": "XXXXXX1234"
211+
},
212+
"traceId": "1-681871c5-2c10e99906394e4055ef962a"
213+
}
214+
},
215+
"Data": {
216+
"title": "Data",
217+
"required": ["address", "ageBand", "gender", "maskedMobileNumber"],
218+
"type": "object",
219+
"properties": {
220+
"address": {
221+
"type": "string"
222+
},
223+
"ageBand": {
224+
"type": "string"
225+
},
226+
"gender": {
227+
"type": "string"
228+
},
229+
"maskedMobileNumber": {
230+
"type": "string"
231+
}
232+
}
233+
},
234+
"AadhaarNotFound": {
235+
"title": "AadhaarNotFound",
236+
"required": ["message", "id", "traceId","status"],
237+
"type": "object",
238+
"properties": {
239+
"message": {
240+
"type": "string"
241+
},
242+
"id": {
243+
"type": "string"
244+
},
245+
"traceId": {
246+
"type": "string"
247+
},
248+
"status": {
249+
"type": "string"
250+
}
251+
},
252+
"example": {
253+
"status": "FAILED",
254+
"id": "fa239bc1-b0ec-4484-be42-cfc4031c6be5",
255+
"message": "Aadhaar not found",
256+
"traceId": "1-68187a91-2067df594a94c6047b65043a"
257+
}
258+
}
259+
},
260+
"securitySchemes": {
261+
"bearer": {
262+
"type": "http",
263+
"scheme": "bearer"
264+
}
265+
}
266+
},
267+
"security": [
268+
{
269+
"bearer": []
270+
}
271+
],
272+
"tags": [
273+
{
274+
"name": "Aadhaar Lite"
275+
},
276+
{
277+
"name": "Misc",
278+
"description": ""
279+
}
280+
]
281+
}

‎content/data/aadhaar-lite/api-reference.mdx

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
sidebar_title: API reference
3+
page_title: Aadhaar lite API reference
4+
order: 1
5+
visible_in_sidebar: true
6+
---

0 commit comments

Comments
 (0)