Skip to content

Commit 2515885

Browse files
aditya-67aditya-67
committed
Hide OKYC product
1 parent 511d79b commit 2515885

9 files changed

+166
-171
lines changed

‎content/data/okyc/aadhaar-redundancy.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
sidebar_title: Aadhaar Redundancy
33
page_title: Redundancy for Aadhaar OKYC
44
order: 5
5-
visible_in_sidebar: true
5+
visible_in_sidebar: false
66
---

‎content/data/okyc/aadhaar-redundancy/api-integration.mdx

+132-137
Original file line numberDiff line numberDiff line change
@@ -2,140 +2,139 @@
22
sidebar_title: API Integration
33
page_title: Aadhaar OKYC Redundancy API Integration
44
order: 1
5-
visible_in_sidebar: true
5+
visible_in_sidebar: false
66
---
77

88
## Aadhaar OKYC Redundancy API Integration
99

10-
The following guide describes the redundancy implementation of our Aadhaar OKYC APIs. Due to intermittent issues on our supply partner's end, we have introduced an Aadhaar Redundancy
11-
API, which uses either supply partner to perform Aadhaar Verification and fetch a user's Aadhaar details, depending on uptimes.
10+
The following guide describes the redundancy implementation of our Aadhaar OKYC APIs. Due to intermittent issues on our supply partner's end, we have introduced an Aadhaar Redundancy
11+
API, which uses either supply partner to perform Aadhaar Verification and fetch a user's Aadhaar details, depending on uptimes.
1212
You will need the following 2 APIs—
1313

14-
- **Create Aadhaar Verification Request**—This lets you initiate a verification request.
15-
- **GET Aadhaar Verification Details**—This lets you check the status associated with the verification request, and if complete, fetch the verification details.
14+
- **Create Aadhaar Verification Request**—This lets you initiate a verification request.
15+
- **GET Aadhaar Verification Details**—This lets you check the status associated with the verification request, and if complete, fetch the verification details.
1616

1717
Here are the URLs you would need for this integration—
1818

19-
- Sandbox—`https://dg-sandbox.setu.co`
20-
- Production—`https://dg.setu.co`
21-
- Headers—Contact Setu for providing the credentials required to successfully call Setu APIs. This contains:
22-
- `x-client-id`
23-
- `x-client-secret`
24-
- `x-product-instance-id`
19+
- Sandbox—`https://dg-sandbox.setu.co`
20+
- Production—`https://dg.setu.co`
21+
- Headers—Contact Setu for providing the credentials required to successfully call Setu APIs. This contains:
22+
- `x-client-id`
23+
- `x-client-secret`
24+
- `x-product-instance-id`
2525

2626
<hr class="primary" />
2727

2828
### Create Aadhaar verification request
2929

3030
Call this API to initiate Aadhaar Verification for your end customer. A quick explanation of the request params—
3131

32-
- `redirectUrl` Endpoint to which your end customer will be redirected to, post completion of verification flow.
32+
- `redirectUrl` Endpoint to which your end customer will be redirected to, post completion of verification flow.
3333

3434
<br />
3535

3636
<Row>
37-
<Portion desktopSpan="whole">
38-
<Tabs
39-
tabs={[
40-
{
41-
key: "1",
42-
label: "200",
43-
content: (
44-
<>
45-
<p>
46-
<Badge type="success">SUCCESS</Badge> Your
47-
Aadhaar Verification request was created successfully
48-
</p>
49-
<hr className="tertiary" />
50-
<h5>Request</h5>
51-
<CodeBlockWithCopy language="json">
52-
{`POST /api/aadhaar/verify
37+
<Portion desktopSpan="whole">
38+
<Tabs
39+
tabs={[
40+
{
41+
key: "1",
42+
label: "200",
43+
content: (
44+
<>
45+
<p>
46+
<Badge type="success">SUCCESS</Badge> Your Aadhaar Verification
47+
request was created successfully
48+
</p>
49+
<hr className="tertiary" />
50+
<h5>Request</h5>
51+
<CodeBlockWithCopy language="json">
52+
{`POST /api/aadhaar/verify
5353
5454
{
5555
"redirectUrl": "https://setu.co"
5656
} `}
57-
</CodeBlockWithCopy>
58-
<hr className="tertiary" />
59-
<h5>Response</h5>
60-
<p>
61-
You get an <code>id</code> associated with the
62-
Aadhaar verification request, which you can use to check
63-
verification status in the <code>Get Aadhaar Verification Details</code> API.
64-
</p>
65-
<CodeBlockWithCopy language="json">
66-
{`{
57+
</CodeBlockWithCopy>
58+
<hr className="tertiary" />
59+
<h5>Response</h5>
60+
<p>
61+
You get an <code>id</code> associated with the Aadhaar
62+
verification request, which you can use to check verification
63+
status in the <code>Get Aadhaar Verification Details</code> API.
64+
</p>
65+
<CodeBlockWithCopy language="json">
66+
{`{
6767
"id": "be896113-6ad1-4741-80e3-56e67e794959",
6868
"status": "pending",
6969
"url": "https://dg.setu.co/digilocker/login/be896113-6ad1-4741-80e3-56e67e794959?path=L2Y3ZDdjOTk2LWEzNmQtNDQ0Mi1iMTliLTY3MDQ5NTE5Mjc0Yy8=",
7070
"validUpto": "2023-11-15T06:52:01+05:30",
7171
"traceId": "1-6540a411-48c3a26c1442b1580f6e6bf9"
7272
}`}
73-
</CodeBlockWithCopy>
74-
</>
75-
),
76-
},
77-
]}
78-
></Tabs>
79-
</Portion>
73+
</CodeBlockWithCopy>
74+
</>
75+
),
76+
},
77+
]}
78+
></Tabs>
79+
</Portion>
8080
</Row>
8181

82-
8382
### Get Aadhaar Verification Details
8483

8584
Call this API to fetch the details and status of the Aadhaar Verification request. A quick explanation of the query params—
8685

87-
- `request_id` The `id` returned in the `Create Aadhaar Verification request` response
86+
- `request_id` The `id` returned in the `Create Aadhaar Verification request` response
8887

8988
<br />
9089

9190
<Row>
92-
<Portion desktopSpan="whole">
93-
<Tabs
94-
tabs={[
95-
{
96-
key: "1",
97-
label: "200",
98-
content: (
99-
<>
100-
<hr className="tertiary" />
101-
<h5>Request</h5>
102-
<CodeBlockWithCopy language="json">
103-
{`GET /api/aadhaar/verify/:request_id`}
104-
</CodeBlockWithCopy>
105-
<hr className="tertiary" />
106-
<h5>Response</h5>
107-
<p>
108-
If <code>status</code> is pending.
109-
</p>
110-
<CodeBlockWithCopy language="json">
111-
{`{
91+
<Portion desktopSpan="whole">
92+
<Tabs
93+
tabs={[
94+
{
95+
key: "1",
96+
label: "200",
97+
content: (
98+
<>
99+
<hr className="tertiary" />
100+
<h5>Request</h5>
101+
<CodeBlockWithCopy language="json">
102+
{`GET /api/aadhaar/verify/:request_id`}
103+
</CodeBlockWithCopy>
104+
<hr className="tertiary" />
105+
<h5>Response</h5>
106+
<p>
107+
If <code>status</code> is pending.
108+
</p>
109+
<CodeBlockWithCopy language="json">
110+
{`{
112111
"id": "be896113-6ad1-4741-80e3-56e67e794959",
113112
"status": "pending",
114113
"url": "https://dg.setu.co/digilocker/login/be896113-6ad1-4741-80e3-56e67e794959?path=L2Y3ZDdjOTk2LWEzNmQtNDQ0Mi1iMTliLTY3MDQ5NTE5Mjc0Yy8=",
115114
"validUpto": "2023-11-15T06:52:01+05:30",
116115
"traceId": "1-6540a411-48c3a26c1442b1580f6e6bf9"
117116
}`}
118-
</CodeBlockWithCopy>
119-
</>
120-
),
121-
},
122-
{
123-
key: "2",
124-
label: "200",
125-
content: (
126-
<>
127-
<hr className="tertiary" />
128-
<h5>Request</h5>
129-
<CodeBlockWithCopy language="json">
130-
{`GET /api/aadhaar/verify/:request_id`}
131-
</CodeBlockWithCopy>
132-
<hr className="tertiary" />
133-
<h5>Response</h5>
134-
<p>
135-
If <code>status</code> is complete.
136-
</p>
137-
<CodeBlockWithCopy language="json">
138-
{`
117+
</CodeBlockWithCopy>
118+
</>
119+
),
120+
},
121+
{
122+
key: "2",
123+
label: "200",
124+
content: (
125+
<>
126+
<hr className="tertiary" />
127+
<h5>Request</h5>
128+
<CodeBlockWithCopy language="json">
129+
{`GET /api/aadhaar/verify/:request_id`}
130+
</CodeBlockWithCopy>
131+
<hr className="tertiary" />
132+
<h5>Response</h5>
133+
<p>
134+
If <code>status</code> is complete.
135+
</p>
136+
<CodeBlockWithCopy language="json">
137+
{`
139138
{
140139
"aadhaar_data": {
141140
"address": {
@@ -176,67 +175,63 @@ Call this API to fetch the details and status of the Aadhaar Verification reques
176175
"id": "be896113-6ad1-4741-80e3-56e67e794959"
177176
}
178177
`}
179-
</CodeBlockWithCopy>
180-
</>
181-
),
182-
},
183-
{
184-
key: "3",
185-
label: "500",
186-
content: (
187-
<>
188-
<hr className="tertiary" />
189-
<h5>Request</h5>
190-
<CodeBlockWithCopy language="json">
191-
{`GET /api/aadhaar/verify/:request_id`}
192-
</CodeBlockWithCopy>
193-
<hr className="tertiary" />
194-
<h5>Response</h5>
195-
<p>
196-
Internal Server Error.
197-
</p>
198-
<CodeBlockWithCopy language="json">
199-
{`{
178+
</CodeBlockWithCopy>
179+
</>
180+
),
181+
},
182+
{
183+
key: "3",
184+
label: "500",
185+
content: (
186+
<>
187+
<hr className="tertiary" />
188+
<h5>Request</h5>
189+
<CodeBlockWithCopy language="json">
190+
{`GET /api/aadhaar/verify/:request_id`}
191+
</CodeBlockWithCopy>
192+
<hr className="tertiary" />
193+
<h5>Response</h5>
194+
<p>Internal Server Error.</p>
195+
<CodeBlockWithCopy language="json">
196+
{`{
200197
"error":
201198
{
202199
"code": "internal_server_error",
203200
"detail": "Something went wrong, please try again.",
204201
"traceId": "1-6540b2f5-7576e9986b0b59ac02f4f831"
205202
}
206203
}`}
207-
</CodeBlockWithCopy>
208-
</>
209-
),
210-
},
211-
{
212-
key: "4",
213-
label: "500",
214-
content: (
215-
<>
216-
<hr className="tertiary" />
217-
<h5>Request</h5>
218-
<CodeBlockWithCopy language="json">
219-
{`GET /api/aadhaar/verify/:request_id`}
220-
</CodeBlockWithCopy>
221-
<hr className="tertiary" />
222-
<h5>Response</h5>
223-
<p>
224-
Upstream Service Error.
225-
</p>
226-
<CodeBlockWithCopy language="json">
227-
{`{
204+
</CodeBlockWithCopy>
205+
</>
206+
),
207+
},
208+
{
209+
key: "4",
210+
label: "500",
211+
content: (
212+
<>
213+
<hr className="tertiary" />
214+
<h5>Request</h5>
215+
<CodeBlockWithCopy language="json">
216+
{`GET /api/aadhaar/verify/:request_id`}
217+
</CodeBlockWithCopy>
218+
<hr className="tertiary" />
219+
<h5>Response</h5>
220+
<p>Upstream Service Error.</p>
221+
<CodeBlockWithCopy language="json">
222+
{`{
228223
"error":
229224
{
230225
"code": "upstream_server_error",
231226
"detail": "Upstream service failure",
232227
"traceId": "1-6540b2f5-7576e9986b0b59ac02f4f831"
233228
}
234229
}`}
235-
</CodeBlockWithCopy>
236-
</>
237-
),
238-
}
239-
]}
240-
></Tabs>
241-
</Portion>
230+
</CodeBlockWithCopy>
231+
</>
232+
),
233+
},
234+
]}
235+
></Tabs>
236+
</Portion>
242237
</Row>

‎content/data/okyc/api-reference.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
sidebar_title: API reference
33
page_title: Offline Aadhar API reference
44
order: 6
5-
visible_in_sidebar: true
5+
visible_in_sidebar: false
66
---

‎content/data/okyc/auto-okyc-api-integration.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_title: Auto OKYC
33
page_title: Auto OKYC API integration
44
order: 4
5-
visible_in_sidebar: true
5+
visible_in_sidebar: false
66
---
77

88
## AUTO-OKYC API integration

‎content/data/okyc/okyc-api-integration.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_title: OKYC
33
page_title: OKYC API integration
44
order: 3
5-
visible_in_sidebar: true
5+
visible_in_sidebar: false
66
---
77

88
## OKYC API integration

‎content/data/okyc/overview.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_title: Overview
33
page_title: Offline Aadhar KYC overview
44
order: 0
5-
visible_in_sidebar: false
5+
visible_in_sidebar: true
66
---
77

88
## Offline Aadhaar KYC

‎content/data/okyc/pre-built-screens.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_title: Pre-built screens
33
page_title: Offline Aadhar pre-built screens
44
order: 2
5-
visible_in_sidebar: true
5+
visible_in_sidebar: false
66
---
77

88
## Offline Aadhaar KYC integration

0 commit comments

Comments
 (0)