From fa62dc652a490f3221b894ab3f06fd95825ae187 Mon Sep 17 00:00:00 2001 From: VarunSonava Date: Tue, 11 Mar 2025 23:48:14 +0200 Subject: [PATCH] docs(DGSUP-69): remove OKYC from docs --- api-playground/products.json | 8 - content/data/okyc/aadhaar-redundancy.mdx | 6 - .../aadhaar-redundancy/api-integration.mdx | 237 ----- content/data/okyc/api-reference.mdx | 6 - .../data/okyc/auto-okyc-api-integration.mdx | 741 -------------- content/data/okyc/okyc-api-integration.mdx | 900 ------------------ content/data/okyc/overview.mdx | 42 - content/data/okyc/pre-built-screens.mdx | 408 -------- content/data/okyc/quickstart.mdx | 57 -- content/endpoints.json | 6 - content/menuItems.json | 2 +- 11 files changed, 1 insertion(+), 2412 deletions(-) delete mode 100644 content/data/okyc/aadhaar-redundancy.mdx delete mode 100644 content/data/okyc/aadhaar-redundancy/api-integration.mdx delete mode 100644 content/data/okyc/api-reference.mdx delete mode 100644 content/data/okyc/auto-okyc-api-integration.mdx delete mode 100644 content/data/okyc/okyc-api-integration.mdx delete mode 100644 content/data/okyc/overview.mdx delete mode 100644 content/data/okyc/pre-built-screens.mdx delete mode 100644 content/data/okyc/quickstart.mdx diff --git a/api-playground/products.json b/api-playground/products.json index 93ab8886..b2df3a5f 100644 --- a/api-playground/products.json +++ b/api-playground/products.json @@ -30,10 +30,6 @@ "name": "PAN verification", "path": "data/pan" }, - { - "name": "Aadhaar KYC", - "path": "data/okyc" - }, { "name": "BAV Reverse Penny Drop", "path": "data/bav/reverse-penny-drop" @@ -63,10 +59,6 @@ { "name": "Insights", "path": "data/insights" - }, - { - "name": "Auto OKYC", - "path": "data/auto-okyc" } ] } diff --git a/content/data/okyc/aadhaar-redundancy.mdx b/content/data/okyc/aadhaar-redundancy.mdx deleted file mode 100644 index 865c5b45..00000000 --- a/content/data/okyc/aadhaar-redundancy.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -sidebar_title: Aadhaar Redundancy -page_title: Redundancy for Aadhaar OKYC -order: 5 -visible_in_sidebar: false ---- diff --git a/content/data/okyc/aadhaar-redundancy/api-integration.mdx b/content/data/okyc/aadhaar-redundancy/api-integration.mdx deleted file mode 100644 index 9665954c..00000000 --- a/content/data/okyc/aadhaar-redundancy/api-integration.mdx +++ /dev/null @@ -1,237 +0,0 @@ ---- -sidebar_title: API Integration -page_title: Aadhaar OKYC Redundancy API Integration -order: 1 -visible_in_sidebar: false ---- - -## Aadhaar OKYC Redundancy API Integration - -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 -API, which uses either supply partner to perform Aadhaar Verification and fetch a user's Aadhaar details, depending on uptimes. -You will need the following 2 APIs— - -- **Create Aadhaar Verification Request**—This lets you initiate a verification request. -- **GET Aadhaar Verification Details**—This lets you check the status associated with the verification request, and if complete, fetch the verification details. - -Here are the URLs you would need for this integration— - -- Sandbox—`https://dg-sandbox.setu.co` -- Production—`https://dg.setu.co` -- Headers—Contact Setu for providing the credentials required to successfully call Setu APIs. This contains: - - `x-client-id` - - `x-client-secret` - - `x-product-instance-id` - -
- -### Create Aadhaar verification request - -Call this API to initiate Aadhaar Verification for your end customer. A quick explanation of the request params— - -- `redirectUrl` Endpoint to which your end customer will be redirected to, post completion of verification flow. - -
- - - - -

- SUCCESS Your Aadhaar Verification - request was created successfully -

-
-
Request
- - {`POST /api/aadhaar/verify - -{ - "redirectUrl": "https://setu.co" -} `} - -
-
Response
-

- You get an id associated with the Aadhaar - verification request, which you can use to check verification - status in the Get Aadhaar Verification Details API. -

- - {`{ - "id": "be896113-6ad1-4741-80e3-56e67e794959", - "status": "pending", - "url": "https://dg.setu.co/digilocker/login/be896113-6ad1-4741-80e3-56e67e794959?path=L2Y3ZDdjOTk2LWEzNmQtNDQ0Mi1iMTliLTY3MDQ5NTE5Mjc0Yy8=", - "validUpto": "2023-11-15T06:52:01+05:30", - "traceId": "1-6540a411-48c3a26c1442b1580f6e6bf9" -}`} - - - ), - }, - ]} - > - - - -### Get Aadhaar Verification Details - -Call this API to fetch the details and status of the Aadhaar Verification request. A quick explanation of the query params— - -- `request_id` The `id` returned in the `Create Aadhaar Verification request` response - -
- - - - -
-
Request
- - {`GET /api/aadhaar/verify/:request_id`} - -
-
Response
-

- If status is pending. -

- - {`{ - "id": "be896113-6ad1-4741-80e3-56e67e794959", - "status": "pending", - "url": "https://dg.setu.co/digilocker/login/be896113-6ad1-4741-80e3-56e67e794959?path=L2Y3ZDdjOTk2LWEzNmQtNDQ0Mi1iMTliLTY3MDQ5NTE5Mjc0Yy8=", - "validUpto": "2023-11-15T06:52:01+05:30", - "traceId": "1-6540a411-48c3a26c1442b1580f6e6bf9" -}`} - - - ), - }, - { - key: "2", - label: "200", - content: ( - <> -
-
Request
- - {`GET /api/aadhaar/verify/:request_id`} - -
-
Response
-

- If status is complete. -

- - {` -{ - "aadhaar_data": { - "address": { - "careOf": "S/O: Rakesh Sharma", - "country": "India", - "district": "Bangalore", - "house": "# 90 1 Cross", - "landmark": "Near Talkies", - "locality": "Nagarabhavi", - "pin": "560072", - "postOffice": "Nagarbhavi", - "state": "Karnataka", - "street": "Nagarbhavi 1st Main Road", - "subDistrict": "Bangalore North", - "vtc": "Bangalore North" - }, - "dateOfBirth": "23-05-1990", - "email": "550fa5fd91eee3f29f6361a8c89aa9713d4d38811d1a5", - "gender": "M", - "generatedAt": "20210419145604802", - "maskedNumber": "xxxx-xxxx-8832", - "name": "Suresh Sharma", - "phone": "09c91184c1d610282d661dd63d257e3b44446853fb1388c9d5b", - "photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD==", - "verified": { - "email": false, - "phone": false, - "signature": true - }, - "xml": { - "fileUrl": "https://dg-esign-uat.s3.amazonaws.com/testFolder/sample.zip", - "shareCode": "1111", // will be null value in case of digilocker verification - "validUntil": "Tue, 27 Jul 2021 12:16:27 GMT" - }, - }, - "traceId": "1-6540a411-48c3a26c1442b1580f6e6bf9" - "status": "complete", - "id": "be896113-6ad1-4741-80e3-56e67e794959" -} -`} - - - ), - }, - { - key: "3", - label: "500", - content: ( - <> -
-
Request
- - {`GET /api/aadhaar/verify/:request_id`} - -
-
Response
-

Internal Server Error.

- - {`{ - "error": - { - "code": "internal_server_error", - "detail": "Something went wrong, please try again.", - "traceId": "1-6540b2f5-7576e9986b0b59ac02f4f831" - } -}`} - - - ), - }, - { - key: "4", - label: "500", - content: ( - <> -
-
Request
- - {`GET /api/aadhaar/verify/:request_id`} - -
-
Response
-

Upstream Service Error.

- - {`{ - "error": - { - "code": "upstream_server_error", - "detail": "Upstream service failure", - "traceId": "1-6540b2f5-7576e9986b0b59ac02f4f831" - } -}`} - - - ), - }, - ]} - > - - diff --git a/content/data/okyc/api-reference.mdx b/content/data/okyc/api-reference.mdx deleted file mode 100644 index 31c91018..00000000 --- a/content/data/okyc/api-reference.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -sidebar_title: API reference -page_title: Offline Aadhar API reference -order: 6 -visible_in_sidebar: false ---- diff --git a/content/data/okyc/auto-okyc-api-integration.mdx b/content/data/okyc/auto-okyc-api-integration.mdx deleted file mode 100644 index ec5513fa..00000000 --- a/content/data/okyc/auto-okyc-api-integration.mdx +++ /dev/null @@ -1,741 +0,0 @@ ---- -sidebar_title: Auto OKYC -page_title: Auto OKYC API integration -order: 4 -visible_in_sidebar: false ---- - -## AUTO-OKYC API integration - -Setu’s API solution can be used to complete a customer’s KYC with offline Aadhaar in real-time—with your own screens on your app or website. With this, you will get a downloadable, locked XML file with Aadhaar information from your customers. - -The following APIs are required for enabling this flow— - -- **Create AUTO-OKYC request**—Create AUTO-OKYC request for your customer. You will get a unique `id` in the response which can be used to track this particular request. -- **Verify AUTO-OKYC Request**—Share the `aadhaarNumber`, collected from your customer, with Setu. Next, redirect your customer to a screen to collect OTP sent to your customer’s Aadhaar linked mobile number. -- **Complete OKYC Request**—Share the collected `otp` to complete verification process. Next, you can call the **Get AUTO-OKYC request status** API. Once the AUTO-OKYC request has been processed successfully you will get customer details from the Aadhaar and the XML file link. -- **Get AUTO-OKYC request status**—Get status of customer verification by providing the request `id` - -Additionally, here is the information you would need for calling these APIs— - -- Sandbox URL—`https://dg-sandbox.setu.co` -- Production URL—`https://dg.setu.co` -- Headers—Contact Setu for providing the credentials required to successfully call Setu APIs. This contains: - - `x-client-id` - - `x-client-secret` - - `x-product-instance-id` - -
- -### Create AUTO-OKYC request - -Call this API to create a unique request to get your customer started on the AUTO-OKYC journey. - - - - -

- SUCCESS Your request has been - processed successfully and a new AUTO-OKYC request has been - created. -

-
-
Request
- - {`POST /api/auto-okyc/ `} - -
-
Response
-

- Use the request id in this response for all - subsequent API calls. -

- - {`{ - "id": "7097e53a-ba29-48a2-983d-878433b4f33e", - "validUpto": "2024-07-22T10:02:33+05:30", - "status": "incomplete" -} `} - - - ), - }, - { - key: "2", - label: "500", - content: ( - <> -

- INTERNAL SERVER ERROR Setu has - failed to process your request due to some error in code or an - unreachable database; or because authentication services are - down. -

-
-
Request
- - {`POST /api/auto-okyc/ `} - -
-
Response
- - {`{ - "code": "internal_server_error", - "detail": "Internal Server Error", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - ]} - > - - - -
- -### Verify AUTO-OKYC request - -Call this API once you have collected the following details from your customer— - -- `aadhaarNumber` —This is not saved/stored by Setu, but is passed on to UIDAI to initiate sending an OTP to your customer’s Aadhaar linked mobile number. - - - For testing this API on Sandbox, use 999999990019 as the Aadhaar number for - success. Any other value for Aadhaar will be considered invalid. - - - - - -

- OTP SENT The request has a valid AUTO-OKYC request id. Your customer has successfully received an OTP. -

-
-
Request
- - {`POST /api/auto-okyc/:requestId/verify/ - -{ - "aadhaarNumber": "aadhaarNumber" -} `} - -
-
Response
- - {`{ - "code": "otp_sent", - "message": "OTP sent to your registered mobile number." -} `} - - - ), - }, - { - key: "2", - label: "400", - content: ( - <> -

- INVALID AADHAAR NUMBER The captcha entered by your user in invalid. -

-
-
Request
- - {`POST /api/auto-okyc/:requestId/verify/ - -{ - "aadhaarNumber": "aadhaarNumber" -} `} - -
-
Response
- - {`{ - "code": "invalid_aadhaar_number", - "detail": "Invalid Aadhaar entered", - "traceId": "" // unique identifier for this error -} `} - -

If an incorrect aadhaar number is filled in by your customer, they would need to call the verify AUTO-OKYC request API again.

- - ), - }, - { - key: "3", - label: "400", - content: ( - <> -

- INVALID SEQUENCE This API has been called in incorrect sequence, either— -

  • After the status associated with request id is failed.
  • Or after the status associated with request id is complete, i.e, this request has already been completed. This also means that the Aadhaar number provided with this request id is already processed and is confirmed as either verified or incorrect. You should instead call the Get AUTO-OKYC request status API to proceed.
-

-
-
Request
- - {`POST /api/auto-okyc/:requestId/verify/ - -{ - "aadhaarNumber": "aadhaarNumber" -} `} - -
-
Response
- - {`{ - "code": "invalid_sequence", - "detail": "Invalid request order", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "4", - label: "400", - content: ( - <> -

- AADHAAR LOCKED user's UID/aadhaar is locked in UIDAI portal -

-
-
Request
- - {`POST /api/auto-okyc/:requestId/verify/ - -{ - "aadhaarNumber": "aadhaarNumber" -} `} - -
-
Response
- - {`{ - "code": "aadhaar_locked_by_holder", - "detail": "Aadhaar locked by Aadhaar number holder.", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "5", - label: "404", - content: ( - <> -

- REQUEST NOT FOUND The request id provided by you was not found—it is either incorrect or has expired, i.e, is past the time of the validUpto time in the Create AUTO-OKYC request API’s response. Create a fresh request to do KYC for the same customer. -

-
-
Request
- - {`POST /api/auto-okyc/:requestId/verify/ - -{ - "aadhaarNumber": "aadhaarNumber" -} `} - -
-
Response
- - {`{{ - "code": "request_not_found", - "detail": "Request not found", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "6", - label: "500", - content: ( - <> -

- INTERNAL SERVER ERROR Setu’s system has failed to process your request due to some error in code or an unreachable database; or because authentication services are down. -

-
-
Request
- - {`POST /api/auto-okyc/:requestId/verify/ - -{ - "aadhaarNumber": "aadhaarNumber" -} `} - -
-
Response
- - {`{ - "code": "internal_server_error", - "detail": "Internal Server Error", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "7", - label: "500", - content: ( - <> -

- CAPTCHA NOT MATCHED ERROR Setu’s system has failed to detect UIDAI captcha code. -

-
-
Request
- - {`POST /api/auto-okyc/:requestId/verify/ - -{ - "aadhaarNumber": "aadhaarNumber" -} `} - -
-
Response
- - {`{ - "code": "captcha_not_matched", - "detail": "Captcha value doesn't match", - "traceId": "" // unique identifier for this error -} `} - - - ), -} -]} > - - - - -
- -### Complete AUTO-OKYC request - -Call this API once you have collected the following details from your customer— - -- `otp` —This should be filled in by the customer, who would have received an OTP from UIDAI, on their Aadhaar linked mobile number. -- `aadhaarNumber` —This is not saved/stored by Setu, but is passed on to UIDAI to verify OTP. - -
- -This API returns the unwrapped Aadhaar response, as well as a link to the XML, if the `otp` is correct. If `otp` is incorrect, the AUTO-OKYC `status` remains `incomplete`. To test for different scenarios, use the following `otp` values on Sandbox— - -- Use 123456 for a valid OTP. -- Use 123457 for OTP to mimic 1st failed attempt. -- Use 123458 for OTP to mimic 2nd failed attempt. -- Use 123459 for OTP to mimic failed attempts limit exceeded. -- Anything aside from these values returns an error description as a generic “error”, if the upstream service returns an error. - - - - -

- SUCCESS Your request has a valid AUTO-OKYC request id and correct otp as per UIDAI. -

- In the event that the otp is incorrect, you would need to redirect your customer to the screen you use to collect OTP. Your customer can retry entering the same OTP up to 3 times. -

-You may also let your customer receive a new OTP by calling the Verify AUTO-OKYC request API again. The old OTP will be void after new OTP is generated. -
-
Request
-

If the status of the AUTO-OKYC request is complete, Setu will respond with details from your customer’s Aadhaar XML file.

- - {`POST /api/auto-okyc/:requestId/complete/ - -{ - "otp": "132347", - "aadhaarNumber": "999999990019" -} - `} - -
-
Response
-

If the unmasked phone and email of the user are available from UIDAI, we return it in the userProfile field of the response. userProfile contains - two fields, unmaskedPhone and unmaskedEmail.

- - Note: userProfile data will be purged after 24 hours. - -
- - {`{ - "aadhaar": { - "address": { - "careOf": "S/O: Gurjar Pradeep", - "country": "India", - "district": "Bangalore", - "house": "# 90 1 Cross", - "landmark": "Near Talkies", - "locality": "Nagarabhavi", - "pin": "560072", - "postOffice": "Nagarbhavi", - "state": "Karnataka", - "street": "Nagarbhavi 1st Main Road", - "subDistrict": "Bangalore North", - "vtc": "Bangalore North" - }, - "dateOfBirth": "23-05-1990", - "email": "550fa5fd91eee3f29f6361a8c89aa9713d4d38811d1a5", - "gender": "M", - "generatedAt": "20210419145604802", - "maskedNumber": "xxxx-xxxx-8832", - "name": "Jignesh Gurjar", - "phone": "09c91184c1d610282d661dd63d257e3b44446853fb1388c9d5b", - "photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD==", - "userProfile": { - "unmaskedEmail": "abc@def.com", - "unmaskedPhone": "9999999999" - }, - "verified": { - "email": false, - "phone": false, - "signature": true - }, - "xml": { - "fileUrl": "https://setus3linkgoeshere.com/", - "validUntil": "2024-07-22T10:02:33+05:30", - "shareCode": "1234" - } - }, - "status": "complete", - "id": "7097e53a-ba29-48a2-983d-878433b4f33e" -} `} - - - ), - }, - { - key: "2", - label: "400", - content: ( - <> -

- INVALID SEQUENCE This API has been called in incorrect sequence, either— -

  • after the status associated with request id is complete, i.e, this request has already been completed. This also means that the Aadhaar number provided with this request id is already processed and is confirmed as either verified or incorrect. You should instead call the Get AUTO-OKYC request status API to proceed.
-

-
-
Request
- - {`POST /api/auto-okyc/:requestId/complete/ -{ - "otp": "132347", - "aadhaarNumber": "999999990019" -} `} - -
-
Response
- - {`{ - "code": "invalid_sequence", - "detail": "Invalid request order", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "3", - label: "404", - content: ( - <> -

- REQUEST NOT FOUND The request id provided by you was not found—it is either incorrect or has expired, i.e, is past the time of the validUpto time in the Create AUTO-OKYC request API’s response. Create a fresh request to do KYC for the same customer. -

-
-
Request
- - {`POST /api/auto-okyc/:requestId/complete/ -{ - "otp": "132347", - "aadhaarNumber": "999999990019" -} `} - -
-
Response
- - {`{{ - "code": "request_not_found", - "detail": "Request not found", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "4", - label: "500", - content: ( - <> -

- INTERNAL SERVER ERROR Setu’s system has failed to process your request due to some error in code or an unreachable database; or because authentication services are down. -

-
-
Request
- - {`POST /api/auto-okyc/:requestId/complete/ -{ - "otp": "132347", - "aadhaarNumber": "999999990019" -} `} - -
-
Response
- - {`{ - "code": "internal_server_error", - "detail": "Internal Server Error", - "traceId": "" // unique identifier for this error -} `} - - - ), -} -]} > - - - - -
- -### Get AUTO-OKYC request status - -Call this API to view status of an AUTO-OKYC journey that you initiated with a customer. - -When the `status` of the AUTO-OKYC request `id` is `complete`, this API returns— - -- Aadhaar details in json -- A link to the zip/xml aadhaar details, if no `shareCode` is passed. - - - If the request status is incomplete, call the{" "} - Complete AUTO-OKYC request API with a correct{" "} - otp input to mark request status as{" "} - complete. - - -
- - - You can call this API whenever you need to check for the status{" "} - associated with a particular request id. - - -
- -Possible values for `status`, received as part of the response— - -- When `complete`, KYC is complete for a customer, you will get all customer details from the Aadhaar XML file. -- When `incomplete`, you can check for KYC completion after some time. -- In case the request has `expired`, your will get a `404` error code. - - - - -

- COMPLETE Your request has been processed successfuly with the status associated with this AUTO-OKYC request id is complete. -

-
-
Request
- - {`GET /api/auto-okyc/:requestId `} - -
-
Response
-

- When status is complete, you will get - all customer KYC details included in the XML, and the URL for - the zip file. -

-

If the unmasked phone and email of the user are available from UIDAI, we return it in the userProfile field of the response. userProfile contains - two fields, unmaskedPhone and unmaskedEmail. If both are not available, userProfile will be an empty dictionary.

- - Note: userProfile data will be purged after 24 hours. - -
- - {`{ - "aadhaar": { - "address": { - "careOf": "S/O: Gurjar Pradeep", - "country": "India", - "district": "Bangalore", - "house": "# 90 1 Cross", - "landmark": "Near Talkies", - "locality": "Nagarabhavi", - "pin": "560072", - "postOffice": "Nagarbhavi", - "state": "Karnataka", - "street": "Nagarbhavi 1st Main Road", - "subDistrict": "Bangalore North", - "vtc": "Bangalore North" - }, - "dateOfBirth": "23-05-1990", - "email": "550fa5fd91eee3f29f6361a8c89aa9713d4d38811d1a5", - "gender": "M", - "generatedAt": "20210419145604802", - "maskedNumber": "xxxx-xxxx-8832", - "name": "Jignesh Gurjar", - "phone": "09c91184c1d610282d661dd63d257e3b44446853fb1388c9d5b", - "photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD==", - "userProfile": { - "unmaskedEmail": "abc@def.com", - "unmaskedPhone": "9999999999" - }, - "verified": { - "email": false, - "phone": false, - "signature": true - }, - "xml": { - "fileUrl": "https://dg-esign-uat.s3.amazonaws.com/testFolder/sample.zip", - "shareCode": "1234", - "validUntil": "2024-07-22T10:02:33+05:30" - } - }, - "status": "complete", - "id": "7097e53a-ba29-48a2-983d-878433b4f33e" -} `} - - - ), - }, - { - key: "2", - label: "200", - content: ( - <> -

- INCOMPLETE Your request has been processed successfuly, but the status associated with this AUTO-OKYC request id is incomplete. -

-
-
Request
- - {`GET /api/auto-okyc/:requestId/ `} - -
-
Response
- - {`{ - "id": "7097e53a-ba29-48a2-983d-878433b4f33e", - "status": "incomplete", - "validUpto": "2024-07-22T10:02:33+05:30" -} `} - - - ), - }, - { - key: "3", - label: "400", - content: ( - <> -

- UPSTREAM SERVICE DOWN Setu partners with other companies to provide data blocks to you. If you get this error, it means that our partner’s service is down. Please retry in some time. -

-
-
Request
- - {`GET /api/auto-okyc/:requestId/ `} - -
-
Response
- - {`{ - "error": { - "code": "upstream_service_down", - "detail": "Upstream service is down", - "traceID": "" // unique identifier for this error - }, - "id": "7097e53a-ba29-48a2-983d-878433b4f33e" -} `} - - - ), - }, - { - key: "4", - label: "404", - content: ( - <> -

- EXPIRED REQEUST ID Setu has processed your request successfully. However, the status of the provided request id is expired, ie, is past the time of the provided validUpto time. You would need to create a fresh request to do KYC for the same customer. -

-
-
Request
- - {`GET /api/auto-okyc/:requestId/ `} - -
-
Response
-

You will get status as expired.

- - {`{{ - "code": "request_not_found", - "detail": "Request not found.", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "5", - label: "500", - content: ( - <> -

- INTERNAL SERVER ERROR Setu’s system has failed to process your request due to some error in code or an unreachable database; or because authentication services are down. -

-
-
Request
- - {`GET /api/auto-okyc/:requestId/ `} - -
-
Response
- - {`{ - "code": "internal_server_error", - "detail": "Internal Server Error", - "traceId": "" // unique identifier for this error -} `} - - - ), -} -]} > - - - - - diff --git a/content/data/okyc/okyc-api-integration.mdx b/content/data/okyc/okyc-api-integration.mdx deleted file mode 100644 index c13fc616..00000000 --- a/content/data/okyc/okyc-api-integration.mdx +++ /dev/null @@ -1,900 +0,0 @@ ---- -sidebar_title: OKYC -page_title: OKYC API integration -order: 3 -visible_in_sidebar: false ---- - -## OKYC API integration - -Setu’s API solution can be used to complete a customer’s KYC with offline Aadhaar in real-time—with your own screens on your app or website. With this, you will get a downloadable, locked XML file with Aadhaar information from your customers. - -The following APIs are required for enabling this flow— - -- **Create OKYC request**—Create OKYC request for your customer. You will get a unique `id` in the response which can be used to track this particular request. -- **Initiate OKYC Request**—Initialise the OKYC request for your customer with the previously returned request `id` and receive a `base64` encoded `captchaImage` from Setu. Once you have called this API, you can redirect your customer to your OKYC screens, to collect Aadhaar number and captcha from your customer. -- **Verify OKYC Request**—Share the `aadhaarNumber` and `captchaCode`, collected from your customer, with Setu. Next, redirect your customer to a screen to collect OTP sent to your customer’s Aadhaar linked mobile number. Also request your customer to enter a 4 digit share code—this is the code that will be used to unlock you customer’s fetch Aadhaar XML file. -- **Complete OKYC Request**—Share the collected `otp` and `shareCode` to complete verification process. Next, you can call the **Get OKYC request status** API. Once the OKYC request has been processed successfully you will get customer details from the Aadhaar and the XML file link in the response. -- **Get OKYC request status**—Get status of customer verification by providing the request `id` and optionally, the `shareCode`. - -Additionally, here is the information you would need for calling these APIs— - -- Sandbox URL—`https://dg-sandbox.setu.co` -- Production URL—`https://dg.setu.co` -- Headers—Contact Setu for providing the credentials required to successfully call Setu APIs. This contains: - - `x-client-id` - - `x-client-secret` - - `x-product-instance-id` - -
- -### Create OKYC request - -Call this API to create a unique request to get your customer started on the OKYC journey. - - - - -

- SUCCESS Your request has been - processed successfully and a new OKYC request has been created. -

-
-
Request
- - {`POST /api/okyc/ `} - -
-
Response
-

- Use the request id in this response for all - subsequent API calls. -

- - {`{ - "id": "7097e53a-ba29-48a2-983d-878433b4f33e", - "validUpto": "2024-07-22T10:02:33+05:30", - "status": "incomplete" -} `} - - - ), - }, - { - key: "2", - label: "500", - content: ( - <> -

- INTERNAL SERVER ERROR Setu has - failed to process your request due to some error in code or an - unreachable database; or because authentication services are - down. -

-
-
Request
- - {`POST /api/okyc/ `} - -
-
Response
- - {`{ - "code": "internal_server_error", - "detail": "Internal Server Error", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - ]} - > - - - -
- -### Initiate OKYC request - -Call this API to initiate your customer’s OKYC journey. Pass the previously shared request `id` in the API call. - - - - -

- SUCCESS Your request has been processed successfully. -

-
-
Request
- - {`GET /api/okyc/:requestId/initiate/ `} - -
-
Response
-

- As part of the response, you will receive a captchaImage that is base-64 encoded. This image data is passed on to you by Setu, after we receive it from UIDAI. You would need to convert this to an image and display it on subsequent screens to let your customer enter text from the captcha. -

- - {`{ - "captchaImage": "base 64 Image data", - "id": "7097e53a-ba29-48a2-983d-878433b4f33e", - "captchaRetriesRemaining": 4 -} `} - -

captchaRetriesRemaining indicates the number of times you can call this API with the same request id to generate a new captcha.

- - ), - }, - { - key: "2", - label: "400", - content: ( - <> -

- INVALID SEQUENCE This API has been called after the status associated with request id is complete, i.e, this request has already been completed. -

-This also means that the Aadhaar number provided with this request id is already processed and is confirmed as either verified or incorrect. You should instead call the Get OKYC request status API to proceed. -

-
-
Request
- - {`GET /api/okyc/:requestId/initiate/ `} - -
-
Response
- - {`{ - "code": "invalid_sequence", - "detail": "Invalid request order", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "3", - label: "429", - content: ( - <> -

- EXCEEDED CAPTCHA REQUESTS There have been too many captcha requests for a particular request id. - -

- - This API is called to get a new captcha, in case a customer enters an incorrect one. By default, you are allowed to fetch captcha for a request id upto 5 times, including the first captcha fetched. - -
-
Request
- - {`GET /api/okyc/:requestId/initiate/ `} - -
-
Response
- - {`{ - "code": "exceeded_captcha_requests", - "detail": "Exceeded captcha requests", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "4", - label: "404", - content: ( - <> -

- REQUEST NOT FOUND The request id provided by you was not found—it is either incorrect or has expired, i.e, is past the time of the validUpto time in the Create OKYC request API’s response. Create a fresh request to do KYC for the same customer. -

-
-
Request
- - {`GET /api/okyc/:requestId/ `} - -
-
Response
- - {`{ - "code": "request_not_found", - "detail": "Request not found", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "5", - label: "500", - content: ( - <> -

- INTERNAL SERVER ERROR Setu’s system has failed to process your request due to some error in code or an unreachable database; or because authentication services are down. -

-
-
Request
- - {`GET /api/okyc/:requestId/initiate/ `} - -
-
Response
- - {`{ - "code": "internal_server_error", - "detail": "Internal Server Error", - "traceId": "" // unique identifier for this error -} `} - - - ), -} -]} > - - - - -
- -### Verify OKYC request - -Call this API once you have collected the following details from your customer— - -- `aadhaarNumber` —This is not saved/stored by Setu, but is passed on to UIDAI to initiate sending an OTP to your customer’s Aadhaar linked mobile number. -- `captchaCode`—An encoded captcha image is provided to you by Setu, as received from UIDAI, in the **_Initiate OKYC request_** API response. You would need to convert this to an image and display it to your customer, wherein they would enter the text associated with the captcha. A correct captcha response is expected to proceed to the next API call. - - - For testing this API on Sandbox, use 999999990019 as the Aadhaar number for - success. Any other value for Aadhaar will be considered invalid. Use 2GAD0 for - valid captcha and any other value for invalid. - - - - - -

- OTP SENT The request has a valid OKYC request id and correct captchaCode. Your customer has successfully received an OTP. -

-
-
Request
- - {`POST /api/okyc/:requestId/verify/ - -{ - "aadhaarNumber": "aadhaarNumber", - "captchaCode": "captchaCode" -} `} - -
-
Response
- - {`{ - "code": "otp_sent", - "message": "OTP sent to your registered mobile number." -} `} - - - ), - }, - { - key: "2", - label: "400", - content: ( - <> -

- INVALID CAPTCHA The captcha entered by your user in invalid. -

-
-
Request
- - {`POST /api/okyc/:requestId/verify/ - -{ - "aadhaarNumber": "aadhaarNumber", - "captchaCode": "captchaCode" -} `} - -
-
Response
- - {`{ - "code": "invalid_captcha_entered", - "detail": "Invalid captcha entered", - "traceId": "" // unique identifier for this error -} `} - -

If an incorrect captcha text is filled in by your customer, they would need to get a new captcha and try again. You would need to call the Initiate OKYC request API again to get a fresh captcha image to display it to your customer.

- - By default, you are allowed to fetch captcha for a request id upto 5 times, including the first captcha that was fetched. - - - ), - }, - { - key: "3", - label: "400", - content: ( - <> -

- INVALID SEQUENCE This API has been called in incorrect sequence, either— -

  • Before calling the Initiate OKYC request API with this request id . Call the Initiate OKYC request API to proceed.
  • Or after the status associated with request id is complete, i.e, this request has already been completed. This also means that the Aadhaar number provided with this request id is already processed and is confirmed as either verified or incorrect. You should instead call the Get OKYC request status API to proceed.
-

-
-
Request
- - {`POST /api/okyc/:requestId/verify/ - -{ - "aadhaarNumber": "aadhaarNumber", - "captchaCode": "captchaCode" -} `} - -
-
Response
- - {`{ - "code": "invalid_sequence", - "detail": "Invalid request order", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "4", - label: "404", - content: ( - <> -

- REQUEST NOT FOUND The request id provided by you was not found—it is either incorrect or has expired, i.e, is past the time of the validUpto time in the Create OKYC request API’s response. Create a fresh request to do KYC for the same customer. -

-
-
Request
- - {`POST /api/okyc/:requestId/verify/ - -{ - "aadhaarNumber": "aadhaarNumber", - "captchaCode": "captchaCode" -} `} - -
-
Response
- - {`{{ - "code": "request_not_found", - "detail": "Request not found", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "5", - label: "500", - content: ( - <> -

- INTERNAL SERVER ERROR Setu’s system has failed to process your request due to some error in code or an unreachable database; or because authentication services are down. -

-
-
Request
- - {`POST /api/okyc/:requestId/verify/ - -{ - "aadhaarNumber": "aadhaarNumber", - "captchaCode": "captchaCode" -} `} - -
-
Response
- - {`{ - "code": "internal_server_error", - "detail": "Internal Server Error", - "traceId": "" // unique identifier for this error -} `} - - - ), -} -]} > - - - - -
- -### Complete OKYC request - -Call this API once you have collected the following details from your customer— - -- `otp` —This should be filled in by the customer, who would have received an OTP from UIDAI, on their Aadhaar linked mobile number. -- `shareCode` is a 4 digit pin set by the customer and serves as the password to unlock the contents of the XML file at a later stage. -- `aadhaarNumber` —This is not saved/stored by Setu, but is passed on to UIDAI to verify OTP. - - - Before calling the API, you may want to save the shareCode on - your end, as Setu will not store it and will simply pass on the value you - provide to UIDAI. - - -
- -This API returns the unwrapped Aadhaar response, as well as a link to the XML, if the `otp` is correct. If `otp` is incorrect, the OKYC `status` remains `incomplete`. To test for different scenarios, use the following `otp` values on Sandbox— - -- Use 123456 for a valid OTP. -- Use 123457 for OTP to mimic 1st failed attempt. -- Use 123458 for OTP to mimic 2nd failed attempt. -- Use 123459 for OTP to mimic failed attempts limit exceeded. -- Anything aside from these values returns an error description as a generic “error”, if the upstream service returns an error. - -You may use any 4 digit value for the `shareCode`, when testing on Sandbox. - - - Note that the error description will always be “Invalid OTP”. We are working - on more appropriate descriptions, and will release them soon. - - - - - -

- SUCCESS Your request has a valid OKYC request id and correct otp as per UIDAI. Additionally, it has the correct shareCode that was previously set by your customer. -

- In the event that the otp is incorrect, you would need to redirect your customer to the screen you use to collect OTP. Your customer can retry entering the same OTP up to 3 times. -

-You may also let your customer receive a new OTP by calling the Verify OKYC request API again. The old OTP will be void after new OTP is generated. Captcha, since already verified, will be honoured still and you needn’t fetch a fresh captcha from Setu to display to your customer. -
-
Request
-

If you pass the correct value of the shareCode to Setu, and if the status of the OKYC request is complete, Setu will respond with details from your customer’s Aadhaar XML file.

- - {`POST /api/okyc/:requestId/complete/ - -{ - "otp": "132347", - "shareCode": "1234", - "aadhaarNumber": "999999990019" -} - `} - -
-
Response
-

If the value of the shareCode is incorrect, the status associated with this OKYC request id will remain in incomplete state. Please retry the API to move the status to complete.

-

If the unmasked phone and email of the user are available from UIDAI, we return it in the userProfile field of the response. userProfile contains - two fields, unmaskedPhone and unmaskedEmail.

- - Note: userProfile data will be purged after 24 hours. - -
- - {`{ - "aadhaar": { - "address": { - "careOf": "S/O: Gurjar Pradeep", - "country": "India", - "district": "Bangalore", - "house": "# 90 1 Cross", - "landmark": "Near Talkies", - "locality": "Nagarabhavi", - "pin": "560072", - "postOffice": "Nagarbhavi", - "state": "Karnataka", - "street": "Nagarbhavi 1st Main Road", - "subDistrict": "Bangalore North", - "vtc": "Bangalore North" - }, - "dateOfBirth": "23-05-1990", - "email": "550fa5fd91eee3f29f6361a8c89aa9713d4d38811d1a5", - "gender": "M", - "generatedAt": "20210419145604802", - "maskedNumber": "xxxx-xxxx-8832", - "name": "Jignesh Gurjar", - "phone": "09c91184c1d610282d661dd63d257e3b44446853fb1388c9d5b", - "photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD==", - "userProfile": { - "unmaskedEmail": "abc@def.com", - "unmaskedPhone": "9999999999" - }, - "verified": { - "email": false, - "phone": false, - "signature": true - }, - "xml": { - "fileUrl": "https://setus3linkgoeshere.com/", - "validUntil": "2024-07-22T10:02:33+05:30", - "shareCode": "1234" - } - }, - "status": "complete", - "id": "7097e53a-ba29-48a2-983d-878433b4f33e" -} `} - - - ), - }, - { - key: "2", - label: "400", - content: ( - <> -

- INVALID SEQUENCE This API has been called in incorrect sequence, either— -

  • Before calling the Initiate OKYC request API with this request id . Call the Initiate OKYC request API to proceed.
  • Or after the status associated with request id is complete, i.e, this request has already been completed. This also means that the Aadhaar number provided with this request id is already processed and is confirmed as either verified or incorrect. You should instead call the Get OKYC request status API to proceed.
-

-
-
Request
- - {`POST /api/okyc/:requestId/complete/ -{ - "otp": "132347", - "shareCode": "1234", - "aadhaarNumber": "999999990019" -} `} - -
-
Response
- - {`{ - "code": "invalid_sequence", - "detail": "Invalid request order", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "3", - label: "404", - content: ( - <> -

- REQUEST NOT FOUND The request id provided by you was not found—it is either incorrect or has expired, i.e, is past the time of the validUpto time in the Create OKYC request API’s response. Create a fresh request to do KYC for the same customer. -

-
-
Request
- - {`POST /api/okyc/:requestId/complete/ -{ - "otp": "132347", - "shareCode": "1234", - "aadhaarNumber": "999999990019" -} `} - -
-
Response
- - {`{{ - "code": "request_not_found", - "detail": "Request not found", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "4", - label: "500", - content: ( - <> -

- INTERNAL SERVER ERROR Setu’s system has failed to process your request due to some error in code or an unreachable database; or because authentication services are down. -

-
-
Request
- - {`POST /api/okyc/:requestId/complete/ -{ - "otp": "132347", - "shareCode": "1234", - "aadhaarNumber": "999999990019" -} `} - -
-
Response
- - {`{ - "code": "internal_server_error", - "detail": "Internal Server Error", - "traceId": "" // unique identifier for this error -} `} - - - ), -} -]} > - - - - -
- -### Get OKYC request status - -Call this API to view status of an OKYC journey that you initiated with a customer. - -When the `status` of the OKYC request `id` is `complete`, this API returns— - -- Aadhaar details in json, if a correct `shareCode` is passed. -- An error, if an incorrect `shareCode` is passed. -- A link to the zip/xml aadhaar details, if no `shareCode` is passed. - - - If the request status is incomplete, call the{" "} - Complete OKYC request API with a correct otp{" "} - input to mark request status as complete. - - -
- - - You can call this API whenever you need to check for the status{" "} - associated with a particular request id. - - -
- -Possible values for `status`, received as part of the response— - -- When `complete`, KYC is complete for a customer. If you provide a `shareCode` in the API request, you will get all customer details from the Aadhaar XML file. -- When `incomplete`, you can check for KYC completion after some time. -- In case the request has `expired`, your will get a `404` error code. - - - - -

- WITH SHARE CODE Your request has a - valid OKYC request id and 4-digit{" "} - shareCode. -

-
-
Request
- - {`GET /api/okyc/:requestId/:shareCode/ `} - -
-
Response
-

- When status is complete, you will get - all customer KYC details included in the XML, and the URL for - the zip file. -

-

If the unmasked phone and email of the user are available from UIDAI, we return it in the userProfile field of the response. userProfile contains - two fields, unmaskedPhone and unmaskedEmail. If both are not available, userProfile will be an empty dictionary.

- - Note: userProfile data will be purged after 24 hours. - -
- - {`{ - "aadhaar": { - "address": { - "careOf": "S/O: Gurjar Pradeep", - "country": "India", - "district": "Bangalore", - "house": "# 90 1 Cross", - "landmark": "Near Talkies", - "locality": "Nagarabhavi", - "pin": "560072", - "postOffice": "Nagarbhavi", - "state": "Karnataka", - "street": "Nagarbhavi 1st Main Road", - "subDistrict": "Bangalore North", - "vtc": "Bangalore North" - }, - "dateOfBirth": "23-05-1990", - "email": "550fa5fd91eee3f29f6361a8c89aa9713d4d38811d1a5", - "gender": "M", - "generatedAt": "20210419145604802", - "maskedNumber": "xxxx-xxxx-8832", - "name": "Jignesh Gurjar", - "phone": "09c91184c1d610282d661dd63d257e3b44446853fb1388c9d5b", - "photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD==", - "userProfile": { - "unmaskedEmail": "abc@def.com", - "unmaskedPhone": "9999999999" - }, - "verified": { - "email": false, - "phone": false, - "signature": true - }, - "xml": { - "fileUrl": "https://dg-esign-uat.s3.amazonaws.com/testFolder/sample.zip", - "shareCode": "1111", - "validUntil": "2024-07-22T10:02:33+05:30" - } - }, - "status": "complete", - "id": "7097e53a-ba29-48a2-983d-878433b4f33e" -} `} - - - ), - }, - { - key: "2", - label: "200", - content: ( - <> -

- WITHOUT SHARE CODE Your request - has a valid OKYC request id -

-
-
Request
- - {`GET /api/okyc/:requestId/ `} - -
-
Response
-

- When status is complete, you will get - the URL for the zip file. You can use the share code to decrypt - the zip file and access the Aadhaar XML file. -

- - {`{ - "aadhaar": { - "xml": { - "fileUrl": "https://setus3linkgoeshere.com/", - "validUntil": "2024-07-22T10:02:33+05:30" - } - }, - "status": "complete", - "id": "7097e53a-ba29-48a2-983d-878433b4f33e" -} `} - - - ), - }, - { - key: "3", - label: "200", - content: ( - <> -

- INCOMPLETE Your request has been processed successfuly, but the status associated with this OKYC request id is incomplete. -

-
-
Request
- - {`GET /api/okyc/:requestId/ `} - -
-
Response
- - {`{ - "id": "7097e53a-ba29-48a2-983d-878433b4f33e", - "status": "incomplete", - "validUpto": "2024-07-22T10:02:33+05:30" -} `} - - - ), - }, - { - key: "4", - label: "400", - content: ( - <> -

- UPSTREAM SERVICE DOWN Setu partners with other companies to provide data blocks to you. If you get this error, it means that our partner’s service is down. Please retry in some time. -

-
-
Request
- - {`GET /api/okyc/:requestId/ `} - -
-
Response
- - {`{ - "error": { - "code": "upstream_service_down", - "detail": "Upstream service is down", - "traceID": "" // unique identifier for this error - }, - "id": "7097e53a-ba29-48a2-983d-878433b4f33e" -} `} - - - ), - }, - { - key: "4", - label: "404", - content: ( - <> -

- EXPIRED REQEUST ID Setu has processed your request successfully. However, the status of the provided request id is expired, ie, is past the time of the provided validUpto time. You would need to create a fresh request to do KYC for the same customer. -

-
-
Request
- - {`GET /api/okyc/:requestId/ `} - -
-
Response
-

You will get status as expired.

- - {`{{ - "code": "request_not_found", - "detail": "Request not found.", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - { - key: "5", - label: "500", - content: ( - <> -

- INTERNAL SERVER ERROR Setu’s system has failed to process your request due to some error in code or an unreachable database; or because authentication services are down. -

-
-
Request
- - {`GET /api/okyc/:requestId/ `} - -
-
Response
- - {`{ - "code": "internal_server_error", - "detail": "Internal Server Error", - "traceId": "" // unique identifier for this error -} `} - - - ), -} -]} > - - - - - diff --git a/content/data/okyc/overview.mdx b/content/data/okyc/overview.mdx deleted file mode 100644 index d8ffbd06..00000000 --- a/content/data/okyc/overview.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_title: Overview -page_title: Offline Aadhar KYC overview -order: 0 -visible_in_sidebar: true ---- - -## Offline Aadhaar KYC - - - 🚨This service has been discontinued right now, due to technical changes - implemented by UIDAI, that affect all service providers. In the meantime, we - recommend DigiLocker ↗ as an - alternative, and are exploring ways to bring back an easier Aadhaar - verification UX for you. - - -
- -### What is offline Aadhaar KYC? - -Offline Aadhaar KYC, or OKYC, is a legally compliant KYC method as per UIDAI guidelines. Your customers can provide their Aadhaar number and verify with an OTP sent to their Aadhaar-linked mobile number, to access a downloadable XML file with their Aadhaar details. - -This file has all details that can be derived from an Aadhaar card—like name, gender, DOB, address—and is locked by default. Your customer sets up a 4-digit access code that can be used to unlock the contents of this file. - -
- -### What is Setu’s OKYC solution? - -Our OKYC APIs let you fetch Aadhaar XML for your users in real-time—on your app/website—and is fully privacy compliant. We provide ready-to-use screens for your customers to get their Aadhaar XML in a shareable format, and to set up a share code. The share code is made available to you for accessing the contents of the file. - -Our pre-built screens can be easily themed as per your brand colours and logo—and you can load these inside your app as a webview, or redirect your customers to the provided link via your website. - -
- -### What can I do with this product? - -Offer your customers a smooth experience for OKYC. Extract verified details of your customers with confidence. - -Whichever industry you belong to—insurance, finance, gaming, or even transportation and logistics—you can ease the onboarding and verification processes for your customers. - - diff --git a/content/data/okyc/pre-built-screens.mdx b/content/data/okyc/pre-built-screens.mdx deleted file mode 100644 index c9a148fb..00000000 --- a/content/data/okyc/pre-built-screens.mdx +++ /dev/null @@ -1,408 +0,0 @@ ---- -sidebar_title: Pre-built screens -page_title: Offline Aadhar pre-built screens -order: 2 -visible_in_sidebar: false ---- - -## Offline Aadhaar KYC integration - -Setu’s web based solution can be used to complete a customer’s KYC with offline Aadhaar—within your own app or website, in real-time. Offline Aadhaar involves getting a downloadable, locked XML file with Aadhaar information from your customers. - -Essentially, only 2 APIs are required for enabling this flow— - -- **Create OKYC request**—Create OKYC request for your customer. You will get a unique `id` in the response which can be used to track this particular request. - - Post this, the customer should be redirected to Setu’s UI for collection of details like Aadhaar number and share code for the locked XML file. -- **Get OKYC request status**—Get status of customer verification by providing the request `id`. - -Additionally, here are the URLs you would need for these APIs— - -- Sandbox—`https://dg-sandbox.setu.co` -- Production—`https://dg.setu.co` -- Headers—Contact Setu for providing the credentials required to successfully call Setu APIs. This contains: - - `x-client-id` - - `x-client-secret` - - `x-product-instance-id` - -### Create OKYC request - -Call this API to create a unique request to get your customer started on the OKYC journey. - -Setu’s pre-built screens will handle the OKYC completion flow, but you need to give Setu a `redirectURL`—this is where we will redirect your customer, once the OKYC journey is complete. This is the only param needed to create a new OKYC request. - - - - - - - -

- SUCCESS Your request has a valid{" "} - redirectURL and Setu has processed your request - successfully. -

- - The button shown in the screen should have{" "} - response.url as the link. - -
-
Request
-

- Share a redirectURL to send your customers to, - after the OKYC journey is completed by your customer, on Setu - screens. -

- - {`POST /api/okyc/ -Content-Length: 46 - -{ - "redirectURL": "https://setu.co/anything?anyotherkeys=cangohere" -} `} - -
-
Response
-

- You will get a unique URL from Setu—OKYC details will be - collected here—where you will have to redirect your customer. -

- - {`{ - "id": "7097e53a-ba29-48a2-983d-878433b4f33e", //unique request id for the OKYC request - "url": "https://dg-sandbox.setu.co/okyc/initiate/uuid", //this is where you will redirect your customers - "validUpto": "Wed, 23 Jun 2021 19:33:55 GMT", //the time till when the request id is valid - "status": "incomplete" //status against the request id -} `} - -

- url is a Setu generated URL, that is unique to a - particular request id. This is where you should - redirect the customer to, to complete their KYC. You can - generate a new url as many times as you want without additional - charges. -

- - ), - }, - { - key: "2", - label: "400", - content: ( - <> -

- BAD REQUEST Your request has an - invalid redirectURL -

-
-
Request
- - {`POST /api/okyc/ -Content-Length: 46 - -{ - "redirectURL": "https://redirecturl" -} `} - -
-
Response
- - {`{ - "error": { - "code": "invalid_redirect_url", - "detail": "Please enter a valid redirect URL.", - "traceID": "" // unique identifier for this error - } -} `} - - - ), - }, - { - key: "3", - label: "500", - content: ( - <> -

- INTERNAL SERVER ERROR Setu has - failed to process your request due to some error in code or an - unreachable database; or because authentication services are - down. -

-
-
Request
- - {`POST /api/okyc/ -Content-Length: 46 - -{ - "redirectURL": "https://redirecturl" -} `} - -
-
Response
- - {`{ - "code": "internal_server_error", - "detail": "Internal Server Error", - "traceId": "" // unique identifier for this error -} `} - - - ), - }, - ]} - > - - - -
- -### Completion of OKYC by customer - -

- SETU SCREENS are used to collect OKYC details from - your customer. The following details are collected, as shown in the sample - screen flow below— -

- -- **Aadhaar number** —not saved/stored by Setu—which is used to fetch the corresponding XML file for the customer, _after_ an OTP verification is done with Aadhaar linked mobile number. -- **Share code** is a 4 digit pin set by the customer and serves as the password to unlock the contents of the XML file. - - - - - - -

- The screen on the left shows Setu’s UI. This is what your customers see - when filling in details to complete their OKYC. -

- - When OKYC is completed, Setu will redirect the customer to the{" "} - redirectURL that you provided in the Create OKYC request API. - Setu will append the share code provided by the customer, and the - request id to the provided URL. You should store both these - values on your system to access the XML file at a later stage. - - - - -
- -### Get OKYC request status - -Call this API to view status of an OKYC journey that you initiated with a customer. - - - You can call this API whenever you need to check for the status{" "} - associated with a particular request id. - - -
- -Possible values for `status`, received as part of the response— - -- When `complete`, KYC is complete for a customer. If you provide a `shareCode` in the API request, you will get all customer details from the Aadhaar XML file. -- When `incomplete`, you can check for KYC completion after some time. -- In case the request has `expired`, your will get a `404` error code. - - - - -

- WITH SHARE CODE Your request has a - valid OKYC request id and 4-digit{" "} - shareCode. -

-
-
Request
- - {`GET /api/okyc/:requestId/:shareCode/ `} - -
-
Response
-

- When status is complete, you will get - all customer KYC details included in the XML, and the URL for - the zip file. -

- - {`{ - "aadhaar": { - "address": { - "careOf": "S/O: Gurjar Pradeep", - "country": "India", - "district": "Bangalore", - "house": "# 90 1 Cross", - "landmark": "Near Talkies", - "locality": "Nagarabhavi", - "pin": "560072", - "postOffice": "Nagarbhavi", - "state": "Karnataka", - "street": "Nagarbhavi 1st Main Road", - "subDistrict": "Bangalore North", - "vtc": "Bangalore North" - }, - "dateOfBirth": "23-05-1990", - "email": "550fa5fd91eee3f29f6361a8c89aa9713d4d38811d1a5", - "gender": "M", - "generatedAt": "20210419145604802", - "maskedNumber": "xxxx-xxxx-8832", - "name": "Jignesh Gurjar", - "phone": "09c91184c1d610282d661dd63d257e3b44446853fb1388c9d5b", - "photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD==", - "verified": { - "email": false, - "phone": false, - "signature": true - }, - "xml": { - "fileUrl": "https://dg-esign-uat.s3.amazonaws.com/testFolder/sample.zip", - "shareCode": "1111", - "validUntil": "Tue, 27 Jul 2021 12:16:27 GMT" - } - }, - "status": "complete", - "id": "7097e53a-ba29-48a2-983d-878433b4f33e" -} `} - - - ), - }, - { - key: "2", - label: "200", - content: ( - <> -

- WITHOUT SHARE CODE Your request - has a valid OKYC request id -

-
-
Request
- - {`GET /api/okyc/:requestId/ `} - -
-
Response
-

- When status is complete, you will get - the URL for the zip file. You can use the share code to decrypt - the zip file and access the Aadhaar XML file. -

- - {`{ - "aadhaar": { - "xml": { - "fileUrl": "https://setus3linkgoeshere.com/", - "validUntil": "Wed, 23 Jun 2021 19:33:55 GMT" - } - }, - "status": "complete", - "id": "7097e53a-ba29-48a2-983d-878433b4f33e" -} `} - - - ), - }, - { - key: "3", - label: "400", - content: ( - <> -

- UPSTREAM SERVICE DOWN Setu partners with other companies to provide data blocks to you. If you get this error, it means that our partner’s service is down. Please retry in some time. -

-
-
Request
- - {`GET /api/okyc/:requestId/ `} - -
-
Response
- - {`{ - "error": { - "code": "upstream_service_down", - "detail": "Upstream service is down", - "traceID": "" // unique identifier for this error - }, - "id": "7097e53a-ba29-48a2-983d-878433b4f33e" -} `} - - - ), - }, - { - key: "4", - label: "404", - content: ( - <> -

- EXPIRED REQEUST ID Setu has processed your request successfully. However, the status of the provided request id is expired, ie, is past the time of the provided validUpto time. You would need to create a fresh request to do KYC for the same customer. -

-
-
Request
- - {`GET /api/okyc/:requestId/ `} - -
-
Response
-

You will get status as expired.

- - {`{ - "url": "https://setuOKYCURL.co/foobar&someId=uuid", - "id": "7097e53a-ba29-48a2-983d-878433b4f33e", - "validUpto": "Wed, 23 Jun 2021 19:33:55 GMT", - "status": "expired" -} `} - - - ), - }, - { - key: "5", - label: "500", - content: ( - <> -

- INTERNAL SERVER ERROR Setu’s system has failed to process your request due to some error in code or an unreachable database; or because authentication services are down. -

-
-
Request
- - {`GET /api/okyc/:requestId/ `} - -
-
Response
- - {`{ - "code": "internal_server_error", - "detail": "Internal Server Error", - "traceId": "" // unique identifier for this error -} `} - - - ), -} -]} > - - - - - diff --git a/content/data/okyc/quickstart.mdx b/content/data/okyc/quickstart.mdx deleted file mode 100644 index 75804cc0..00000000 --- a/content/data/okyc/quickstart.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_title: Quickstart -page_title: Offline Aadhar Quickstart -order: 1 -visible_in_sidebar: false ---- - -## Offline Aadhaar KYC integration - -### Step 1 — Start KYC and business documentation - -This is started once Setu’s Sales team has interacted with you and confirmed integration. You will need to add a few KYC details and review some agreements. - -
- -### Step 2 — Get API credentials - -Contact Setu to receive `x-client-id`, `x-client-secret` and `x-product-instance-id`. These credentials are required to make API calls on Sandbox or Prodution. - -
- -### Step 3 — Choose integration method - -Setu’s OKYC product allows you to choose between two integration methods. - -
- - - -

Pre-built screens

-

- Simply redirect your customer to pre-built screens with carefully designed - UX, and collect Aadhaar details. Theme screens to match your brand. Look - at the{" "} - - pre-built screens guide - {" "} - to proceed. -

- - - -

API integration

-

- Integrate directly with our APIs and build your own UI. Look at the{" "} - - API integration guide - {" "} - to proceed. -

- - - - diff --git a/content/endpoints.json b/content/endpoints.json index 434a5551..d5d3ba5b 100644 --- a/content/endpoints.json +++ b/content/endpoints.json @@ -59,12 +59,6 @@ "order": 0, "visible_in_sidebar": false }, - { - "name": "Aadhaar KYC", - "path": "okyc", - "order": 1, - "visible_in_sidebar": false - }, { "name": "Aadhaar eSign", "path": "esign", diff --git a/content/menuItems.json b/content/menuItems.json index 4f694609..c94ba451 100644 --- a/content/menuItems.json +++ b/content/menuItems.json @@ -1 +1 @@ -{"home":[{"name":"Payments","path":"payments","order":0,"visible_in_sidebar":true,"api_reference":true,"children":[{"name":"BBPS BillCollect","path":"bbps","order":0,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS API reference","path":"api-reference","order":9},{"name":"Axis BBPS","visible_in_sidebar":false,"page_title":"Axis BBPS API Approach Document","path":"axis","order":10},{"name":"Bill Structure","visible_in_sidebar":true,"page_title":"BBPS - Bill Structure","path":"bill-structure","order":5,"children":[{"name":"Special cases","visible_in_sidebar":true,"page_title":"BBPS - Bill Structure special cases","path":"special-cases","order":1}]},{"name":"Go live","visible_in_sidebar":true,"page_title":"BBPS - Go live","path":"go-live","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"BBPS - Notifications","path":"notifications","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS - Overview","path":"overview","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS - Quickstart","path":"quickstart","order":2,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS - API integration","path":"api-integration","order":2},{"name":"No-code CSV","visible_in_sidebar":true,"page_title":"BBPS - No-code CSV","path":"no-code-integration","order":1},{"name":"Share bills","visible_in_sidebar":false,"page_title":"BBPS - Share bills","path":"share-biils","order":1}]},{"name":"Reports API","visible_in_sidebar":true,"page_title":"BBPS - Reports API","path":"reports","order":6},{"name":"Additional resources","visible_in_sidebar":true,"page_title":"BBPS - Additional Resources","path":"resources","order":8,"children":[{"name":"Errors","visible_in_sidebar":true,"page_title":"BBPS error codes","path":"errors","order":4},{"name":"JWT authentication","visible_in_sidebar":true,"page_title":"UPI Deeplinks JWT authentication","path":"jwt","order":2},{"name":"OAuth 2.0","visible_in_sidebar":true,"page_title":"BBPS OAuth 2.0","path":"oauth","order":1},{"name":"Settlement object","visible_in_sidebar":true,"page_title":"UPI Deeplinks settlement object","path":"settlement-object","order":3}]}]},{"name":"BBPS BillPay","path":"billpay","order":1,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS Billpay API integration","path":"api-integration","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"COU Direct Connectivity API reference","path":"api-reference","order":6},{"name":"List of APIs","visible_in_sidebar":true,"page_title":"BBPS COU - List of APIs","path":"apis","order":2},{"name":"Deprecated APIs","visible_in_sidebar":false,"page_title":"BBPS COU - API integration (deprecated)","path":"deprecated","order":4,"children":[{"name":"Mock environment","visible_in_sidebar":false,"page_title":"BBPS Billpay Mock environment","path":"mock-environment","order":2},{"name":"Polling","visible_in_sidebar":false,"page_title":"BBPS Billpay polling","path":"polling","order":2}]},{"name":"Objects","visible_in_sidebar":true,"page_title":"BBPS COU - Objects","path":"objects","order":3},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS COU - API integration","path":"quickstart","order":1},{"name":"Migration Guide to v2","visible_in_sidebar":true,"page_title":"BBPS COU - Migration Guide to v2","path":"v2-migration","order":5},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS COU - Webhooks","path":"webhooks","order":4}]},{"name":"API reference","visible_in_sidebar":false,"page_title":"BillPay API reference","path":"api-reference","order":5},{"name":"Prepaid Recharge","visible_in_sidebar":true,"page_title":"BBPS Billpay Prepaid Recharge APIs","path":"mobile-prepaid-recharge","order":3,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Mobile Prepaid Recharge API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Mobile Prepaid Recharge quickstart","path":"quickstart","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS Billpay Overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":true,"page_title":"BBPS Billpay pre-built screens","path":"pre-built-screens","order":2,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"BBPS Billpay API reference","path":"api-reference-wl","order":4},{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS Billpay API reference","path":"api-reference","order":4},{"name":"Custom payment","visible_in_sidebar":true,"page_title":"BBPS Billpay custom payment","path":"custom-payment","order":2,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay android integration for custom payment","path":"android","order":3},{"name":"Required APIs","visible_in_sidebar":true,"page_title":"BBPS Billpay APIs for custom payment","path":"apis","order":1},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross-platform integration for custom payment","path":"cross-platform","order":3},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration for custom payment","path":"iOS","order":4},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website integration for custom payment","path":"website","order":2}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS Billpay Quickstart","path":"quickstart","order":1,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay Android integration","path":"android","order":2},{"name":"API","visible_in_sidebar":true,"page_title":"BBPS Billpay API","path":"api","order":2},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross platform integration","path":"cross-platform","order":4},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration","path":"iOS","order":3},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website","path":"website","order":1}]},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS Billpay webhooks","path":"webhooks","order":2}]},{"path":"v1","children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS Billpay API integration","path":"api-integration","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"COU Direct Connectivity API reference","path":"api-reference","order":5},{"name":"List of APIs","visible_in_sidebar":true,"page_title":"BBPS COU - List of APIs","path":"apis","order":2},{"name":"Deprecated APIs","visible_in_sidebar":false,"page_title":"BBPS COU - API integration (deprecated)","path":"deprecated","order":4,"children":[{"name":"Mock environment","visible_in_sidebar":false,"page_title":"BBPS Billpay Mock environment","path":"mock-environment","order":2},{"name":"Polling","visible_in_sidebar":false,"page_title":"BBPS Billpay polling","path":"polling","order":2}]},{"name":"Objects","visible_in_sidebar":true,"page_title":"BBPS COU - Objects","path":"objects","order":3},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS COU - API integration","path":"quickstart","order":1},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS COU - Webhooks","path":"webhooks","order":4}]},{"name":"API reference","visible_in_sidebar":false,"page_title":"BillPay API reference","path":"api-reference","order":5},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS Billpay Overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":true,"page_title":"BBPS Billpay pre-built screens","path":"pre-built-screens","order":2,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"BBPS Billpay API reference","path":"api-reference-wl","order":4},{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS Billpay API reference","path":"api-reference","order":4},{"name":"Custom payment","visible_in_sidebar":true,"page_title":"BBPS Billpay custom payment","path":"custom-payment","order":2,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay android integration for custom payment","path":"android","order":3},{"name":"Required APIs","visible_in_sidebar":true,"page_title":"BBPS Billpay APIs for custom payment","path":"apis","order":1},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross-platform integration for custom payment","path":"cross-platform","order":3},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration for custom payment","path":"iOS","order":4},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website integration for custom payment","path":"website","order":2}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS Billpay Quickstart","path":"quickstart","order":1,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay Android integration","path":"android","order":2},{"name":"API","visible_in_sidebar":true,"page_title":"BBPS Billpay API","path":"api","order":2},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross platform integration","path":"cross-platform","order":4},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration","path":"iOS","order":3},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website","path":"website","order":1}]},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS Billpay webhooks","path":"webhooks","order":2}]}]}]},{"name":"WhatsApp Collect","path":"whatsapp-collect","order":3,"visible_in_sidebar":true,"children":[{"name":"API Integration","visible_in_sidebar":true,"page_title":"WhatsApp Collect API Integration","path":"api-integration","order":3},{"name":"API reference","visible_in_sidebar":true,"page_title":"WhatsApp Collect API reference","path":"api-reference","order":5},{"name":"Error codes","visible_in_sidebar":true,"page_title":"WhatsApp Collect error codes","path":"errors","order":4},{"name":"Collection journey","visible_in_sidebar":true,"page_title":"WhatsApp Collect Journey","path":"journey","order":1},{"name":"Overview","visible_in_sidebar":true,"page_title":"WhatsApp Collect Overview","path":"overview","order":0},{"name":"Collection reminders","visible_in_sidebar":true,"page_title":"WhatsApp Collect reminders","path":"reminders","order":2}]},{"name":"UPI DeepLinks","path":"upi-deeplinks","order":4,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"UPI Deeplinks API reference","path":"api-reference","order":8},{"name":"Notifications","visible_in_sidebar":true,"page_title":"UPI Deeplinks Notifications","path":"notifications","order":6},{"name":"Overview","visible_in_sidebar":true,"page_title":"UPI Deeplinks Overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"UPI Deeplinks quickstart","path":"quickstart","order":1,"children":[{"name":"Go Live","visible_in_sidebar":true,"page_title":"UPI Deeplinks go live","path":"go-live","order":1}]},{"name":"Refunds","visible_in_sidebar":true,"page_title":"UPI Deeplinks Refunds","path":"refunds","order":4},{"name":"Reports API","visible_in_sidebar":true,"page_title":"UPI Deeplinks Reports API","path":"reports","order":5},{"name":"Additional resources","visible_in_sidebar":true,"page_title":"UPI Deeplinks additonal resources","path":"resources","order":6,"children":[{"name":"JWT authentication","visible_in_sidebar":true,"page_title":"UPI Deeplinks JWT authentication","path":"jwt","order":2},{"name":"OAuth 2.0","visible_in_sidebar":true,"page_title":"UPI Deeplinks OAuth 2.0","path":"oauth","order":1},{"name":"Settlement object","visible_in_sidebar":true,"page_title":"UPI Deeplinks settlement object","path":"settlement-object","order":3}]},{"name":"SDKs","visible_in_sidebar":true,"page_title":"UPI Deeplinks SDKs","path":"sdks","order":3},{"name":"Third party verification","visible_in_sidebar":true,"page_title":"UPI Deeplinks third party verification","path":"third-party-verification","order":3}]},{"name":"UPI Setu","path":"umap","order":7,"visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"UPI Setu - API integration","path":"api-integration","order":2,"children":[{"name":"Aggregators","visible_in_sidebar":true,"page_title":"UPI Setu - API integration for aggregators","path":"aggregators","order":1},{"name":"Merchants","visible_in_sidebar":true,"page_title":"UPI Setu - API integration for merchants","path":"merchants","order":2}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"UPI Setu - API reference","path":"api-reference","order":8},{"name":"UPI mandates","visible_in_sidebar":true,"page_title":"UPI mandates","path":"mandates","order":4,"children":[{"name":"Mandate operations","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Mandate operations","path":"generic","order":5,"children":[{"name":"Pause","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Pause","path":"pause","order":3},{"name":"Revoke","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Revoke","path":"revoke","order":2},{"name":"Unpause","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Unpause","path":"unpause","order":4},{"name":"Update","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Update","path":"update","order":1}]},{"name":"OneShot","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - OneShot","path":"one-shot","order":1,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create One Time Mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute One Time Mandate","path":"execute","order":3},{"name":"Pre Debit Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Send One Time Mandate Pre Debit Notification","path":"pre-debit-notify","order":2}]},{"name":"Recur","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Recur","path":"recur","order":3,"children":[{"name":"Check payment status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create recurring mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute mandate","path":"execute","order":3},{"name":"Pre Debit Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Send Recurring Mandate Pre Debit Notification","path":"pre-debit-notify","order":2}]},{"name":"Reserve","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Reserve","path":"reserve","order":2,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create Reserve Mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute Reserve Mandate","path":"execute","order":3}]},{"name":"ReservePlus","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - ReservePlus","path":"reserve-plus","order":4,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":3},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create single block multi-debit","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute single block multi-debit","path":"execute","order":2}]}]},{"name":"Merchant on-boarding","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant onboarding","path":"merchant-onboarding","order":2,"children":[{"name":"Check VPA availability","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Check VPA availability","path":"check-vpa-availability-api","order":2},{"name":"Setup a merchant","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Setup merchant","path":"create-merchant-api","order":1},{"name":"Registering VPA","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Registering a VPA","path":"create-vpa-api","order":3}]},{"name":"Notifications and alerts","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts","path":"notifications","order":7,"children":[{"name":"VPA verification","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Customer VPA verification","path":"customer-vpa-verification","order":6},{"name":"Disputes","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Disputes","path":"disputes","order":5},{"name":"Mandates","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandates","path":"mandates","order":3,"children":[{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Creation of mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandate execution","path":"execute","order":7},{"name":"Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandate pre-debit notifications","path":"notify","order":6},{"name":"Pause","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Pausing mandate","path":"pause","order":4},{"name":"Revoke","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Revoking mandate","path":"revoke","order":3},{"name":"Unpause","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Unpausing mandate","path":"unpause","order":5},{"name":"Update","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Updating mandate","path":"update","order":2}]},{"name":"Payments","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Payments","path":"payments","order":2},{"name":"Refunds","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Refunds","path":"refunds","order":4},{"name":"Verify signature","visible_in_sidebar":true,"page_title":"UMAP - Events and notifications","path":"verify-signature","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"UPI Setu - Overview","path":"overview","order":0},{"name":"UPI payments","visible_in_sidebar":true,"page_title":"UPI payments","path":"payments","order":3,"children":[{"name":"Collect","visible_in_sidebar":true,"page_title":"UPI payments - Collect","path":"collect","order":2,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu payments - Collect request - Check payment status","path":"check-status","order":3},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create collect request","path":"create-collect-request","order":2},{"name":"Verify customer VPA","visible_in_sidebar":true,"page_title":"UPI Setu payments - Verify customer VPA","path":"verify-customer-vpa-api","order":1}]},{"name":"Flash","visible_in_sidebar":true,"page_title":"UPI payments - Flash","path":"flash","order":1,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu payments - Intent/QR - Check payment status","path":"check-status","order":2},{"name":"Dynamic QR","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create Dynamic QR","path":"create-dqr","order":1},{"name":"Static QR","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create Static QR","path":"create-sqr","order":1}]},{"name":"TPV","visible_in_sidebar":true,"page_title":"UPI payments - TPV","path":"tpv","order":3,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Payments - TPV - Check payment status","path":"check-status","order":2},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Payments - Create TPV API","path":"create-tpv","order":1},{"name":"Payments","visible_in_sidebar":true,"page_title":"UMAP - Notifications and alerts - Payments","path":"life-cycle","order":1}]}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart","path":"quickstart","order":1,"children":[{"name":"Aggregators","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart for aggregators","path":"aggregators","order":1},{"name":"Merchants","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart for merchants","path":"merchants","order":2}]},{"name":"Refunds and disputes","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes","path":"refunds-disputes","order":6,"children":[{"name":"Check refund status","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Check refund status API","path":"check-refund-status-api","order":2},{"name":"Create refund","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Create refund API","path":"create-refund-api","order":1},{"name":"Fetch dispute","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Fetch dispute API","path":"fetch-dispute-api","order":3}]},{"name":"Transaction Monitoring","visible_in_sidebar":false,"page_title":"UPI Setu - Transaction Monitoring","path":"transaction-monitoring","order":5,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Check status API","path":"check-status-api","order":1},{"name":"Check status history","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Check status sistory API","path":"check-status-history-api","order":2},{"name":"Fetch payment","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Fetch payment API","path":"fetch-payment-api","order":3}]}]}]},{"name":"Data","path":"data","order":1,"visible_in_sidebar":true,"children":[{"name":"KYC","path":"kyc","order":0,"visible_in_sidebar":true,"children":[{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu KYC Overview","path":"overview","order":1}]},{"name":"PAN verification","path":"pan","order":0,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"PAN verification API reference","path":"api-reference","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"PAN verification quickstart","path":"quickstart","order":0}]},{"name":"Aadhaar KYC","path":"okyc","order":1,"visible_in_sidebar":false,"children":[{"name":"Aadhaar Redundancy","visible_in_sidebar":false,"page_title":"Redundancy for Aadhaar OKYC","path":"aadhaar-redundancy","order":5,"children":[{"name":"API Integration","visible_in_sidebar":false,"page_title":"Aadhaar OKYC Redundancy API Integration","path":"api-integration","order":1}]},{"name":"API reference","visible_in_sidebar":false,"page_title":"Offline Aadhar API reference","path":"api-reference","order":6},{"name":"Auto OKYC","visible_in_sidebar":false,"page_title":"Auto OKYC API integration","path":"auto-okyc-api-integration","order":4},{"name":"OKYC","visible_in_sidebar":false,"page_title":"OKYC API integration","path":"okyc-api-integration","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Offline Aadhar KYC overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":false,"page_title":"Offline Aadhar pre-built screens","path":"pre-built-screens","order":2},{"name":"Quickstart","visible_in_sidebar":false,"page_title":"Offline Aadhar Quickstart","path":"quickstart","order":1}]},{"name":"Aadhaar eSign","path":"esign","order":2,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Aadhaar eSign API reference","path":"api-reference","order":8},{"name":"Error codes","visible_in_sidebar":true,"page_title":"Aadhaar eSign error codes","path":"error-codes","order":7},{"name":"eStamp overview","visible_in_sidebar":true,"page_title":"eStamp overview","path":"estamp","order":2},{"name":"Flexible eSign guide","visible_in_sidebar":true,"page_title":"Integration guide with flexible signature coordinates","path":"flexi-esign","order":4},{"name":"eSign Name Match","visible_in_sidebar":true,"page_title":"Aadhaar eSign Name Match","path":"name-match","order":6},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Aadhaar eSign Notifications","path":"notifications","order":5},{"name":"Overview","visible_in_sidebar":true,"page_title":"Aadhaar eSign overview","path":"overview","order":1},{"name":"Integration guide","visible_in_sidebar":true,"page_title":"Aadhaar eSign integration guide","path":"quickstart","order":3}]},{"name":"DigiLocker","path":"digilocker","order":3,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Digilocker API reference","path":"api-reference","order":3},{"name":"Error codes","visible_in_sidebar":true,"page_title":"DigiLocker error codes","path":"error-codes","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"Digilocker overview","path":"overview","order":0},{"name":"Integration guide","visible_in_sidebar":true,"page_title":"Digilocker quickstart","path":"quickstart","order":1}]},{"name":"AA Gateway","path":"account-aggregator","order":4,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Account Aggregator API integration","path":"api-integration","order":3,"children":[{"name":"Account Availability","visible_in_sidebar":true,"page_title":"Account Aggregator Account Availability","path":"account-availability-apis","order":5},{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-apis","order":2},{"name":"Active FIPs","visible_in_sidebar":true,"page_title":"Account Aggregator Active FIPs","path":"fip-apis","order":4},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Account Aggregator API reference","path":"api-reference","order":10},{"name":"Consent object","visible_in_sidebar":true,"page_title":"Account Aggregator consent object","path":"consent-object","order":4},{"name":"Embed Setu screens","visible_in_sidebar":true,"page_title":"Account Aggregator Embed Setu screens","path":"embed-setu-aa","order":7},{"name":"FI data types","visible_in_sidebar":true,"page_title":"Account Aggregator FI data types","path":"fi-data-types","order":5},{"name":"Licenses and go live","visible_in_sidebar":true,"page_title":"Account Aggregator license and go live process","path":"licenses-and-go-live","order":8,"children":[{"name":"Go live","visible_in_sidebar":true,"page_title":"FIU go live process","path":"go-live","order":2},{"name":"Licenses","visible_in_sidebar":true,"page_title":"Licenses required to participate in AA","path":"licenses","order":1},{"name":"Participants in AA","visible_in_sidebar":true,"page_title":"Participants in AA","path":"participants-in-aa","order":0}]},{"name":"Multi AA gateway","visible_in_sidebar":true,"page_title":"Account Aggregator multi-AA gateway","path":"multi-aa-gateway","order":2},{"name":"Overview","visible_in_sidebar":true,"page_title":"Account Aggregator overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Account Aggregator quickstart","path":"quickstart","order":1},{"path":"v1","children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Account Aggregator API integration","path":"api-integration","order":3,"children":[{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-apis","order":2},{"name":"Active FIPs","visible_in_sidebar":true,"page_title":"Account Aggregator Active FIPs","path":"fip-apis","order":4},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Account Aggregator API reference","path":"api-reference","order":10},{"name":"Consent object","visible_in_sidebar":true,"page_title":"Account Aggregator Consent object","path":"consent-object","order":4},{"name":"Embed Setu screens","visible_in_sidebar":true,"page_title":"Account Aggregator Embed Setu screens","path":"embed-setu-aa","order":7},{"name":"End-to-end encryption","visible_in_sidebar":false,"page_title":"Account Aggregator End-to-end encryption","path":"encryption","order":1},{"name":"FI data types","visible_in_sidebar":true,"page_title":"Account Aggregator FI data types","path":"fi-data-types","order":5},{"name":"Get started","visible_in_sidebar":false,"page_title":"Account Aggregator getting started","path":"get-started","order":0},{"name":"Licenses and go live","visible_in_sidebar":true,"page_title":"Account Aggregator license and go live process","path":"licenses-and-go-live","order":8,"children":[{"name":"Go live","visible_in_sidebar":true,"page_title":"FIU go live process","path":"go-live","order":2},{"name":"Licenses","visible_in_sidebar":true,"page_title":"Licenses required to participate in AA","path":"licenses","order":1},{"name":"Participants in AA","visible_in_sidebar":true,"page_title":"Participants in AA","path":"participants-in-aa","order":0}]},{"name":"Migration guide","visible_in_sidebar":true,"page_title":"Account Aggregator Migration Guide","path":"migration-guide","order":6,"children":[{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-flow","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Account Aggregator overview","path":"overview","order":0},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Account Aggregator Postman integration","path":"postman","order":2},{"name":"Quickstart","visible_in_sidebar":false,"page_title":"Account Aggregator quickstart","path":"quickstart-v1","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Account Aggregator quickstart","path":"quickstart","order":1},{"name":"Request signing","visible_in_sidebar":false,"page_title":"Account Aggregator Request signing","path":"request-signing","order":1}]}]},{"name":"Bank account verification","path":"bav","order":5,"visible_in_sidebar":false,"children":[{"name":"Penny drop","visible_in_sidebar":true,"page_title":"BAV using penny drop","path":"penny-drop","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BAV API integration","path":"api-integration","order":1,"children":[{"name":"Async API","visible_in_sidebar":true,"page_title":"BAV Async API integration","path":"async","order":2},{"path":"bav-codes"},{"name":"Sync API","visible_in_sidebar":true,"page_title":"BAV Sync API integration","path":"sync","order":1}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV API reference","path":"api-reference","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"BAV Async Penny drop Notifications","path":"notifications","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BAV quickstart","path":"quickstart","order":0}]},{"name":"Penny drop + PennyLess","visible_in_sidebar":true,"page_title":"Bank account verification using Penny drop + PennyLess","path":"pennydrop-pennyless","order":2,"children":[{"name":"API Integration","visible_in_sidebar":true,"page_title":"Penny drop + PennyLess API Integration","path":"api-integration","order":1},{"name":"API reference","visible_in_sidebar":true,"page_title":"Pennydrop-pennyless API reference","path":"api-reference","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Penny drop + PennyLess Notifications","path":"notifications","order":2}]},{"name":"PennyLess Drop","visible_in_sidebar":true,"page_title":"BAV using PennyLess Drop API","path":"pennyless-drop","order":4,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV Pennyless API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Quickstart for PennyLess drop API","path":"quickstart","order":1}]},{"name":"Reverse Penny drop","visible_in_sidebar":true,"page_title":"BAV using reverse penny drop","path":"reverse-penny-drop","order":3,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"RPD API integration","path":"api-integration","order":2},{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV RPD API reference","path":"api-reference","order":4},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Quickstart for reverse penny drop","path":"quickstart","order":1},{"name":"Webhook Auth","visible_in_sidebar":true,"page_title":"Webhook Authentication","path":"webhook-authentication","order":3}]}]},{"name":"Insights","path":"insights","order":5,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Setu Insights API reference","path":"api-reference","order":4},{"name":"List of insights","visible_in_sidebar":true,"page_title":"All Setu insights","path":"insights","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Setu Insights notifications","path":"notifications","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu Insights overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Setu Insights quickstart","path":"quickstart","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"api-integration","order":1},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"postman","order":0}]},{"path":"v1","children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Setu Insights API reference","path":"api-reference","order":4},{"name":"List of insights","visible_in_sidebar":true,"page_title":"All Setu insights","path":"insights","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Setu Insights notifications","path":"notifications","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu Insights overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Setu Insights quickstart","path":"quickstart","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"api-integration","order":1},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"postman","order":0}]}]}]},{"name":"ULI","path":"uli","order":6,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"GSTIN verification API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"GST Verification quickstart","path":"quickstart","order":1}]},{"name":"GST verification","path":"gst","order":6,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"GSTIN verification API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"GST Verification quickstart","path":"quickstart","order":1}]},{"name":"Match APIs","path":"match-apis","order":7,"visible_in_sidebar":false,"children":[{"name":"Name match","visible_in_sidebar":true,"page_title":"Name match APIs","path":"name-match","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Name Match API reference","path":"api-reference","order":4},{"name":"Examples","visible_in_sidebar":true,"page_title":"Name Match API response examples","path":"examples","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Name Match API overview","path":"overview","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Name Match API quickstart","path":"quickstart","order":2}]}]},{"name":"eKYC","path":"ekyc","order":8,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"eKYC API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"PAN verification quickstart","path":"quickstart","order":1}]}]},{"name":"Dev tools","path":"dev-tools","order":2,"visible_in_sidebar":true,"children":[{"name":"The Bridge","path":"bridge","order":0,"visible_in_sidebar":true,"children":[{"name":"Bridge configuration","visible_in_sidebar":false,"page_title":"Bridge configuration","path":"configure","order":6},{"name":"Generate Token","visible_in_sidebar":false,"page_title":"Bridge generate token","path":"generate-token","order":4},{"name":"Org settings","visible_in_sidebar":true,"page_title":"Bridge org settings","path":"org-settings","order":3,"children":[{"name":"API keys","visible_in_sidebar":true,"page_title":"API keys","path":"api-keys","order":2,"children":[{"name":"JWT Auth","visible_in_sidebar":false,"page_title":"JWT Auth","path":"jwt-auth","order":3},{"name":"JWT","visible_in_sidebar":true,"page_title":"JWT","path":"jwt","order":1},{"name":"OAuth","visible_in_sidebar":true,"page_title":"OAuth","path":"oauth","order":2}]},{"name":"People","visible_in_sidebar":true,"page_title":"People","path":"people","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Bridge overview","path":"overview","order":0},{"name":"Reports","visible_in_sidebar":true,"page_title":"Bridge reports","path":"reports","order":1,"children":[{"name":"Types","visible_in_sidebar":false,"page_title":"Report types","path":"types","order":1}]},{"name":"Reports API","visible_in_sidebar":false,"page_title":"Reports API","path":"reports-api","order":5}]}]},{"name":"Sample Category","path":"sample-category","order":3,"visible_in_sidebar":false,"children":[{"name":"Sample Product","path":"sample-product","order":0,"visible_in_sidebar":false,"children":[{"name":"Sample Page","visible_in_sidebar":false,"page_title":"Docs sample page","path":"sample-page","order":0}]}]}]} \ No newline at end of file +{"home":[{"name":"Payments","path":"payments","order":0,"visible_in_sidebar":true,"api_reference":true,"children":[{"name":"BBPS BillCollect","path":"bbps","order":0,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS API reference","path":"api-reference","order":9},{"name":"Axis BBPS","visible_in_sidebar":false,"page_title":"Axis BBPS API Approach Document","path":"axis","order":10},{"name":"Bill Structure","visible_in_sidebar":true,"page_title":"BBPS - Bill Structure","path":"bill-structure","order":5,"children":[{"name":"Special cases","visible_in_sidebar":true,"page_title":"BBPS - Bill Structure special cases","path":"special-cases","order":1}]},{"name":"Go live","visible_in_sidebar":true,"page_title":"BBPS - Go live","path":"go-live","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"BBPS - Notifications","path":"notifications","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS - Overview","path":"overview","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS - Quickstart","path":"quickstart","order":2,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS - API integration","path":"api-integration","order":2},{"name":"No-code CSV","visible_in_sidebar":true,"page_title":"BBPS - No-code CSV","path":"no-code-integration","order":1},{"name":"Share bills","visible_in_sidebar":false,"page_title":"BBPS - Share bills","path":"share-biils","order":1}]},{"name":"Reports API","visible_in_sidebar":true,"page_title":"BBPS - Reports API","path":"reports","order":6},{"name":"Additional resources","visible_in_sidebar":true,"page_title":"BBPS - Additional Resources","path":"resources","order":8,"children":[{"name":"Errors","visible_in_sidebar":true,"page_title":"BBPS error codes","path":"errors","order":4},{"name":"JWT authentication","visible_in_sidebar":true,"page_title":"UPI Deeplinks JWT authentication","path":"jwt","order":2},{"name":"OAuth 2.0","visible_in_sidebar":true,"page_title":"BBPS OAuth 2.0","path":"oauth","order":1},{"name":"Settlement object","visible_in_sidebar":true,"page_title":"UPI Deeplinks settlement object","path":"settlement-object","order":3}]}]},{"name":"BBPS BillPay","path":"billpay","order":1,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS Billpay API integration","path":"api-integration","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"COU Direct Connectivity API reference","path":"api-reference","order":6},{"name":"List of APIs","visible_in_sidebar":true,"page_title":"BBPS COU - List of APIs","path":"apis","order":2},{"name":"Deprecated APIs","visible_in_sidebar":false,"page_title":"BBPS COU - API integration (deprecated)","path":"deprecated","order":4,"children":[{"name":"Mock environment","visible_in_sidebar":false,"page_title":"BBPS Billpay Mock environment","path":"mock-environment","order":2},{"name":"Polling","visible_in_sidebar":false,"page_title":"BBPS Billpay polling","path":"polling","order":2}]},{"name":"Objects","visible_in_sidebar":true,"page_title":"BBPS COU - Objects","path":"objects","order":3},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS COU - API integration","path":"quickstart","order":1},{"name":"Migration Guide to v2","visible_in_sidebar":true,"page_title":"BBPS COU - Migration Guide to v2","path":"v2-migration","order":5},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS COU - Webhooks","path":"webhooks","order":4}]},{"name":"API reference","visible_in_sidebar":false,"page_title":"BillPay API reference","path":"api-reference","order":5},{"name":"Prepaid Recharge","visible_in_sidebar":true,"page_title":"BBPS Billpay Prepaid Recharge APIs","path":"mobile-prepaid-recharge","order":3,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Mobile Prepaid Recharge API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Mobile Prepaid Recharge quickstart","path":"quickstart","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS Billpay Overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":true,"page_title":"BBPS Billpay pre-built screens","path":"pre-built-screens","order":2,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"BBPS Billpay API reference","path":"api-reference-wl","order":4},{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS Billpay API reference","path":"api-reference","order":4},{"name":"Custom payment","visible_in_sidebar":true,"page_title":"BBPS Billpay custom payment","path":"custom-payment","order":2,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay android integration for custom payment","path":"android","order":3},{"name":"Required APIs","visible_in_sidebar":true,"page_title":"BBPS Billpay APIs for custom payment","path":"apis","order":1},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross-platform integration for custom payment","path":"cross-platform","order":3},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration for custom payment","path":"iOS","order":4},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website integration for custom payment","path":"website","order":2}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS Billpay Quickstart","path":"quickstart","order":1,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay Android integration","path":"android","order":2},{"name":"API","visible_in_sidebar":true,"page_title":"BBPS Billpay API","path":"api","order":2},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross platform integration","path":"cross-platform","order":4},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration","path":"iOS","order":3},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website","path":"website","order":1}]},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS Billpay webhooks","path":"webhooks","order":2}]},{"path":"v1","children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BBPS Billpay API integration","path":"api-integration","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"COU Direct Connectivity API reference","path":"api-reference","order":5},{"name":"List of APIs","visible_in_sidebar":true,"page_title":"BBPS COU - List of APIs","path":"apis","order":2},{"name":"Deprecated APIs","visible_in_sidebar":false,"page_title":"BBPS COU - API integration (deprecated)","path":"deprecated","order":4,"children":[{"name":"Mock environment","visible_in_sidebar":false,"page_title":"BBPS Billpay Mock environment","path":"mock-environment","order":2},{"name":"Polling","visible_in_sidebar":false,"page_title":"BBPS Billpay polling","path":"polling","order":2}]},{"name":"Objects","visible_in_sidebar":true,"page_title":"BBPS COU - Objects","path":"objects","order":3},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS COU - API integration","path":"quickstart","order":1},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS COU - Webhooks","path":"webhooks","order":4}]},{"name":"API reference","visible_in_sidebar":false,"page_title":"BillPay API reference","path":"api-reference","order":5},{"name":"Overview","visible_in_sidebar":true,"page_title":"BBPS Billpay Overview","path":"overview","order":0},{"name":"Pre-built screens","visible_in_sidebar":true,"page_title":"BBPS Billpay pre-built screens","path":"pre-built-screens","order":2,"children":[{"name":"API reference","visible_in_sidebar":false,"page_title":"BBPS Billpay API reference","path":"api-reference-wl","order":4},{"name":"API reference","visible_in_sidebar":true,"page_title":"BBPS Billpay API reference","path":"api-reference","order":4},{"name":"Custom payment","visible_in_sidebar":true,"page_title":"BBPS Billpay custom payment","path":"custom-payment","order":2,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay android integration for custom payment","path":"android","order":3},{"name":"Required APIs","visible_in_sidebar":true,"page_title":"BBPS Billpay APIs for custom payment","path":"apis","order":1},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross-platform integration for custom payment","path":"cross-platform","order":3},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration for custom payment","path":"iOS","order":4},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website integration for custom payment","path":"website","order":2}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BBPS Billpay Quickstart","path":"quickstart","order":1,"children":[{"name":"Android","visible_in_sidebar":true,"page_title":"BBPS Billpay Android integration","path":"android","order":2},{"name":"API","visible_in_sidebar":true,"page_title":"BBPS Billpay API","path":"api","order":2},{"name":"Cross platform","visible_in_sidebar":true,"page_title":"BBPS Billpay cross platform integration","path":"cross-platform","order":4},{"name":"iOS","visible_in_sidebar":true,"page_title":"BBPS Billpay iOS integration","path":"iOS","order":3},{"name":"Website","visible_in_sidebar":true,"page_title":"BBPS Billpay website","path":"website","order":1}]},{"name":"Webhooks","visible_in_sidebar":true,"page_title":"BBPS Billpay webhooks","path":"webhooks","order":2}]}]}]},{"name":"WhatsApp Collect","path":"whatsapp-collect","order":3,"visible_in_sidebar":true,"children":[{"name":"API Integration","visible_in_sidebar":true,"page_title":"WhatsApp Collect API Integration","path":"api-integration","order":3},{"name":"API reference","visible_in_sidebar":true,"page_title":"WhatsApp Collect API reference","path":"api-reference","order":5},{"name":"Error codes","visible_in_sidebar":true,"page_title":"WhatsApp Collect error codes","path":"errors","order":4},{"name":"Collection journey","visible_in_sidebar":true,"page_title":"WhatsApp Collect Journey","path":"journey","order":1},{"name":"Overview","visible_in_sidebar":true,"page_title":"WhatsApp Collect Overview","path":"overview","order":0},{"name":"Collection reminders","visible_in_sidebar":true,"page_title":"WhatsApp Collect reminders","path":"reminders","order":2}]},{"name":"UPI DeepLinks","path":"upi-deeplinks","order":4,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"UPI Deeplinks API reference","path":"api-reference","order":8},{"name":"Notifications","visible_in_sidebar":true,"page_title":"UPI Deeplinks Notifications","path":"notifications","order":6},{"name":"Overview","visible_in_sidebar":true,"page_title":"UPI Deeplinks Overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"UPI Deeplinks quickstart","path":"quickstart","order":1,"children":[{"name":"Go Live","visible_in_sidebar":true,"page_title":"UPI Deeplinks go live","path":"go-live","order":1}]},{"name":"Refunds","visible_in_sidebar":true,"page_title":"UPI Deeplinks Refunds","path":"refunds","order":4},{"name":"Reports API","visible_in_sidebar":true,"page_title":"UPI Deeplinks Reports API","path":"reports","order":5},{"name":"Additional resources","visible_in_sidebar":true,"page_title":"UPI Deeplinks additonal resources","path":"resources","order":6,"children":[{"name":"JWT authentication","visible_in_sidebar":true,"page_title":"UPI Deeplinks JWT authentication","path":"jwt","order":2},{"name":"OAuth 2.0","visible_in_sidebar":true,"page_title":"UPI Deeplinks OAuth 2.0","path":"oauth","order":1},{"name":"Settlement object","visible_in_sidebar":true,"page_title":"UPI Deeplinks settlement object","path":"settlement-object","order":3}]},{"name":"SDKs","visible_in_sidebar":true,"page_title":"UPI Deeplinks SDKs","path":"sdks","order":3},{"name":"Third party verification","visible_in_sidebar":true,"page_title":"UPI Deeplinks third party verification","path":"third-party-verification","order":3}]},{"name":"UPI Setu","path":"umap","order":7,"visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"UPI Setu - API integration","path":"api-integration","order":2,"children":[{"name":"Aggregators","visible_in_sidebar":true,"page_title":"UPI Setu - API integration for aggregators","path":"aggregators","order":1},{"name":"Merchants","visible_in_sidebar":true,"page_title":"UPI Setu - API integration for merchants","path":"merchants","order":2}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"UPI Setu - API reference","path":"api-reference","order":8},{"name":"UPI mandates","visible_in_sidebar":true,"page_title":"UPI mandates","path":"mandates","order":4,"children":[{"name":"Mandate operations","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Mandate operations","path":"generic","order":5,"children":[{"name":"Pause","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Pause","path":"pause","order":3},{"name":"Revoke","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Revoke","path":"revoke","order":2},{"name":"Unpause","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Unpause","path":"unpause","order":4},{"name":"Update","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Update","path":"update","order":1}]},{"name":"OneShot","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - OneShot","path":"one-shot","order":1,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create One Time Mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute One Time Mandate","path":"execute","order":3},{"name":"Pre Debit Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Send One Time Mandate Pre Debit Notification","path":"pre-debit-notify","order":2}]},{"name":"Recur","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Recur","path":"recur","order":3,"children":[{"name":"Check payment status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create recurring mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute mandate","path":"execute","order":3},{"name":"Pre Debit Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Send Recurring Mandate Pre Debit Notification","path":"pre-debit-notify","order":2}]},{"name":"Reserve","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Reserve","path":"reserve","order":2,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":4},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create Reserve Mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute Reserve Mandate","path":"execute","order":3}]},{"name":"ReservePlus","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - ReservePlus","path":"reserve-plus","order":4,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Check payment status","path":"check-status","order":3},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Create single block multi-debit","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Mandates - Execute single block multi-debit","path":"execute","order":2}]}]},{"name":"Merchant on-boarding","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant onboarding","path":"merchant-onboarding","order":2,"children":[{"name":"Check VPA availability","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Check VPA availability","path":"check-vpa-availability-api","order":2},{"name":"Setup a merchant","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Setup merchant","path":"create-merchant-api","order":1},{"name":"Registering VPA","visible_in_sidebar":true,"page_title":"UPI Setu - Merchant on-boarding - Registering a VPA","path":"create-vpa-api","order":3}]},{"name":"Notifications and alerts","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts","path":"notifications","order":7,"children":[{"name":"VPA verification","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Customer VPA verification","path":"customer-vpa-verification","order":6},{"name":"Disputes","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Disputes","path":"disputes","order":5},{"name":"Mandates","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandates","path":"mandates","order":3,"children":[{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Creation of mandate","path":"create","order":1},{"name":"Execute","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandate execution","path":"execute","order":7},{"name":"Notify","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Mandate pre-debit notifications","path":"notify","order":6},{"name":"Pause","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Pausing mandate","path":"pause","order":4},{"name":"Revoke","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Revoking mandate","path":"revoke","order":3},{"name":"Unpause","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Unpausing mandate","path":"unpause","order":5},{"name":"Update","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Updating mandate","path":"update","order":2}]},{"name":"Payments","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Payments","path":"payments","order":2},{"name":"Refunds","visible_in_sidebar":true,"page_title":"UPI Setu - Notifications and alerts - Refunds","path":"refunds","order":4},{"name":"Verify signature","visible_in_sidebar":true,"page_title":"UMAP - Events and notifications","path":"verify-signature","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"UPI Setu - Overview","path":"overview","order":0},{"name":"UPI payments","visible_in_sidebar":true,"page_title":"UPI payments","path":"payments","order":3,"children":[{"name":"Collect","visible_in_sidebar":true,"page_title":"UPI payments - Collect","path":"collect","order":2,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu payments - Collect request - Check payment status","path":"check-status","order":3},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create collect request","path":"create-collect-request","order":2},{"name":"Verify customer VPA","visible_in_sidebar":true,"page_title":"UPI Setu payments - Verify customer VPA","path":"verify-customer-vpa-api","order":1}]},{"name":"Flash","visible_in_sidebar":true,"page_title":"UPI payments - Flash","path":"flash","order":1,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu payments - Intent/QR - Check payment status","path":"check-status","order":2},{"name":"Dynamic QR","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create Dynamic QR","path":"create-dqr","order":1},{"name":"Static QR","visible_in_sidebar":true,"page_title":"UPI Setu payments - Create Static QR","path":"create-sqr","order":1}]},{"name":"TPV","visible_in_sidebar":true,"page_title":"UPI payments - TPV","path":"tpv","order":3,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Payments - TPV - Check payment status","path":"check-status","order":2},{"name":"Create","visible_in_sidebar":true,"page_title":"UPI Setu - Payments - Create TPV API","path":"create-tpv","order":1},{"name":"Payments","visible_in_sidebar":true,"page_title":"UMAP - Notifications and alerts - Payments","path":"life-cycle","order":1}]}]},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart","path":"quickstart","order":1,"children":[{"name":"Aggregators","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart for aggregators","path":"aggregators","order":1},{"name":"Merchants","visible_in_sidebar":true,"page_title":"UPI Setu - Quickstart for merchants","path":"merchants","order":2}]},{"name":"Refunds and disputes","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes","path":"refunds-disputes","order":6,"children":[{"name":"Check refund status","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Check refund status API","path":"check-refund-status-api","order":2},{"name":"Create refund","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Create refund API","path":"create-refund-api","order":1},{"name":"Fetch dispute","visible_in_sidebar":true,"page_title":"UPI Setu - Refunds and disputes - Fetch dispute API","path":"fetch-dispute-api","order":3}]},{"name":"Transaction Monitoring","visible_in_sidebar":false,"page_title":"UPI Setu - Transaction Monitoring","path":"transaction-monitoring","order":5,"children":[{"name":"Check status","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Check status API","path":"check-status-api","order":1},{"name":"Check status history","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Check status sistory API","path":"check-status-history-api","order":2},{"name":"Fetch payment","visible_in_sidebar":true,"page_title":"UPI Setu - Transaction monitoring - Fetch payment API","path":"fetch-payment-api","order":3}]}]}]},{"name":"Data","path":"data","order":1,"visible_in_sidebar":true,"children":[{"name":"KYC","path":"kyc","order":0,"visible_in_sidebar":true,"children":[{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu KYC Overview","path":"overview","order":1}]},{"name":"PAN verification","path":"pan","order":0,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"PAN verification API reference","path":"api-reference","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"PAN verification quickstart","path":"quickstart","order":0}]},{"name":"Aadhaar eSign","path":"esign","order":1,"visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Aadhaar eSign API reference","path":"api-reference","order":8},{"name":"Error codes","visible_in_sidebar":true,"page_title":"Aadhaar eSign error codes","path":"error-codes","order":7},{"name":"eStamp overview","visible_in_sidebar":true,"page_title":"eStamp overview","path":"estamp","order":2},{"name":"Flexible eSign guide","visible_in_sidebar":true,"page_title":"Integration guide with flexible signature coordinates","path":"flexi-esign","order":4},{"name":"eSign Name Match","visible_in_sidebar":true,"page_title":"Aadhaar eSign Name Match","path":"name-match","order":6},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Aadhaar eSign Notifications","path":"notifications","order":5},{"name":"Overview","visible_in_sidebar":true,"page_title":"Aadhaar eSign overview","path":"overview","order":1},{"name":"Integration guide","visible_in_sidebar":true,"page_title":"Aadhaar eSign integration guide","path":"quickstart","order":3}]},{"name":"DigiLocker","path":"digilocker","order":3,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Digilocker API reference","path":"api-reference","order":3},{"name":"Error codes","visible_in_sidebar":true,"page_title":"DigiLocker error codes","path":"error-codes","order":4},{"name":"Overview","visible_in_sidebar":true,"page_title":"Digilocker overview","path":"overview","order":0},{"name":"Integration guide","visible_in_sidebar":true,"page_title":"Digilocker quickstart","path":"quickstart","order":1}]},{"name":"AA Gateway","path":"account-aggregator","order":4,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Account Aggregator API integration","path":"api-integration","order":3,"children":[{"name":"Account Availability","visible_in_sidebar":true,"page_title":"Account Aggregator Account Availability","path":"account-availability-apis","order":5},{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-apis","order":2},{"name":"Active FIPs","visible_in_sidebar":true,"page_title":"Account Aggregator Active FIPs","path":"fip-apis","order":4},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Account Aggregator API reference","path":"api-reference","order":10},{"name":"Consent object","visible_in_sidebar":true,"page_title":"Account Aggregator consent object","path":"consent-object","order":4},{"name":"Embed Setu screens","visible_in_sidebar":true,"page_title":"Account Aggregator Embed Setu screens","path":"embed-setu-aa","order":7},{"name":"FI data types","visible_in_sidebar":true,"page_title":"Account Aggregator FI data types","path":"fi-data-types","order":5},{"name":"Licenses and go live","visible_in_sidebar":true,"page_title":"Account Aggregator license and go live process","path":"licenses-and-go-live","order":8,"children":[{"name":"Go live","visible_in_sidebar":true,"page_title":"FIU go live process","path":"go-live","order":2},{"name":"Licenses","visible_in_sidebar":true,"page_title":"Licenses required to participate in AA","path":"licenses","order":1},{"name":"Participants in AA","visible_in_sidebar":true,"page_title":"Participants in AA","path":"participants-in-aa","order":0}]},{"name":"Multi AA gateway","visible_in_sidebar":true,"page_title":"Account Aggregator multi-AA gateway","path":"multi-aa-gateway","order":2},{"name":"Overview","visible_in_sidebar":true,"page_title":"Account Aggregator overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Account Aggregator quickstart","path":"quickstart","order":1},{"path":"v1","children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Account Aggregator API integration","path":"api-integration","order":3,"children":[{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-apis","order":2},{"name":"Active FIPs","visible_in_sidebar":true,"page_title":"Account Aggregator Active FIPs","path":"fip-apis","order":4},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"Account Aggregator API reference","path":"api-reference","order":10},{"name":"Consent object","visible_in_sidebar":true,"page_title":"Account Aggregator Consent object","path":"consent-object","order":4},{"name":"Embed Setu screens","visible_in_sidebar":true,"page_title":"Account Aggregator Embed Setu screens","path":"embed-setu-aa","order":7},{"name":"End-to-end encryption","visible_in_sidebar":false,"page_title":"Account Aggregator End-to-end encryption","path":"encryption","order":1},{"name":"FI data types","visible_in_sidebar":true,"page_title":"Account Aggregator FI data types","path":"fi-data-types","order":5},{"name":"Get started","visible_in_sidebar":false,"page_title":"Account Aggregator getting started","path":"get-started","order":0},{"name":"Licenses and go live","visible_in_sidebar":true,"page_title":"Account Aggregator license and go live process","path":"licenses-and-go-live","order":8,"children":[{"name":"Go live","visible_in_sidebar":true,"page_title":"FIU go live process","path":"go-live","order":2},{"name":"Licenses","visible_in_sidebar":true,"page_title":"Licenses required to participate in AA","path":"licenses","order":1},{"name":"Participants in AA","visible_in_sidebar":true,"page_title":"Participants in AA","path":"participants-in-aa","order":0}]},{"name":"Migration guide","visible_in_sidebar":true,"page_title":"Account Aggregator Migration Guide","path":"migration-guide","order":6,"children":[{"name":"Consent flow","visible_in_sidebar":true,"page_title":"Account Aggregator Consent flow","path":"consent-flow","order":1},{"name":"Data flow","visible_in_sidebar":true,"page_title":"Account Aggregator Data flow","path":"data-flow","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Account Aggregator Notifications","path":"notifications","order":3}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Account Aggregator overview","path":"overview","order":0},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Account Aggregator Postman integration","path":"postman","order":2},{"name":"Quickstart","visible_in_sidebar":false,"page_title":"Account Aggregator quickstart","path":"quickstart-v1","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Account Aggregator quickstart","path":"quickstart","order":1},{"name":"Request signing","visible_in_sidebar":false,"page_title":"Account Aggregator Request signing","path":"request-signing","order":1}]}]},{"name":"Bank account verification","path":"bav","order":5,"visible_in_sidebar":false,"children":[{"name":"Penny drop","visible_in_sidebar":true,"page_title":"BAV using penny drop","path":"penny-drop","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"BAV API integration","path":"api-integration","order":1,"children":[{"name":"Async API","visible_in_sidebar":true,"page_title":"BAV Async API integration","path":"async","order":2},{"path":"bav-codes"},{"name":"Sync API","visible_in_sidebar":true,"page_title":"BAV Sync API integration","path":"sync","order":1}]},{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV API reference","path":"api-reference","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"BAV Async Penny drop Notifications","path":"notifications","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"BAV quickstart","path":"quickstart","order":0}]},{"name":"Penny drop + PennyLess","visible_in_sidebar":true,"page_title":"Bank account verification using Penny drop + PennyLess","path":"pennydrop-pennyless","order":2,"children":[{"name":"API Integration","visible_in_sidebar":true,"page_title":"Penny drop + PennyLess API Integration","path":"api-integration","order":1},{"name":"API reference","visible_in_sidebar":true,"page_title":"Pennydrop-pennyless API reference","path":"api-reference","order":3},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Penny drop + PennyLess Notifications","path":"notifications","order":2}]},{"name":"PennyLess Drop","visible_in_sidebar":true,"page_title":"BAV using PennyLess Drop API","path":"pennyless-drop","order":4,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV Pennyless API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Quickstart for PennyLess drop API","path":"quickstart","order":1}]},{"name":"Reverse Penny drop","visible_in_sidebar":true,"page_title":"BAV using reverse penny drop","path":"reverse-penny-drop","order":3,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"RPD API integration","path":"api-integration","order":2},{"name":"API reference","visible_in_sidebar":true,"page_title":"BAV RPD API reference","path":"api-reference","order":4},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Quickstart for reverse penny drop","path":"quickstart","order":1},{"name":"Webhook Auth","visible_in_sidebar":true,"page_title":"Webhook Authentication","path":"webhook-authentication","order":3}]}]},{"name":"Insights","path":"insights","order":5,"versions":["v1","v2"],"default_version":"v2","visible_in_sidebar":true,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Setu Insights API reference","path":"api-reference","order":4},{"name":"List of insights","visible_in_sidebar":true,"page_title":"All Setu insights","path":"insights","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Setu Insights notifications","path":"notifications","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu Insights overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Setu Insights quickstart","path":"quickstart","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"api-integration","order":1},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"postman","order":0}]},{"path":"v1","children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Setu Insights API reference","path":"api-reference","order":4},{"name":"List of insights","visible_in_sidebar":true,"page_title":"All Setu insights","path":"insights","order":2},{"name":"Notifications","visible_in_sidebar":true,"page_title":"Setu Insights notifications","path":"notifications","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Setu Insights overview","path":"overview","order":0},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Setu Insights quickstart","path":"quickstart","order":1,"children":[{"name":"API integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"api-integration","order":1},{"name":"Postman integration","visible_in_sidebar":true,"page_title":"Setu Insights Postman integration","path":"postman","order":0}]}]}]},{"name":"ULI","path":"uli","order":6,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"GSTIN verification API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"GST Verification quickstart","path":"quickstart","order":1}]},{"name":"GST verification","path":"gst","order":6,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"GSTIN verification API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"GST Verification quickstart","path":"quickstart","order":1}]},{"name":"Match APIs","path":"match-apis","order":7,"visible_in_sidebar":false,"children":[{"name":"Name match","visible_in_sidebar":true,"page_title":"Name match APIs","path":"name-match","order":1,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"Name Match API reference","path":"api-reference","order":4},{"name":"Examples","visible_in_sidebar":true,"page_title":"Name Match API response examples","path":"examples","order":3},{"name":"Overview","visible_in_sidebar":true,"page_title":"Name Match API overview","path":"overview","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"Name Match API quickstart","path":"quickstart","order":2}]}]},{"name":"eKYC","path":"ekyc","order":8,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"eKYC API reference","path":"api-reference","order":2},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"PAN verification quickstart","path":"quickstart","order":1}]}]},{"name":"Dev tools","path":"dev-tools","order":2,"visible_in_sidebar":true,"children":[{"name":"The Bridge","path":"bridge","order":0,"visible_in_sidebar":true,"children":[{"name":"Bridge configuration","visible_in_sidebar":false,"page_title":"Bridge configuration","path":"configure","order":6},{"name":"Generate Token","visible_in_sidebar":false,"page_title":"Bridge generate token","path":"generate-token","order":4},{"name":"Org settings","visible_in_sidebar":true,"page_title":"Bridge org settings","path":"org-settings","order":3,"children":[{"name":"API keys","visible_in_sidebar":true,"page_title":"API keys","path":"api-keys","order":2,"children":[{"name":"JWT Auth","visible_in_sidebar":false,"page_title":"JWT Auth","path":"jwt-auth","order":3},{"name":"JWT","visible_in_sidebar":true,"page_title":"JWT","path":"jwt","order":1},{"name":"OAuth","visible_in_sidebar":true,"page_title":"OAuth","path":"oauth","order":2}]},{"name":"People","visible_in_sidebar":true,"page_title":"People","path":"people","order":1}]},{"name":"Overview","visible_in_sidebar":true,"page_title":"Bridge overview","path":"overview","order":0},{"name":"Reports","visible_in_sidebar":true,"page_title":"Bridge reports","path":"reports","order":1,"children":[{"name":"Types","visible_in_sidebar":false,"page_title":"Report types","path":"types","order":1}]},{"name":"Reports API","visible_in_sidebar":false,"page_title":"Reports API","path":"reports-api","order":5}]}]},{"name":"Sample Category","path":"sample-category","order":3,"visible_in_sidebar":false,"children":[{"name":"Sample Product","path":"sample-product","order":0,"visible_in_sidebar":false,"children":[{"name":"Sample Page","visible_in_sidebar":false,"page_title":"Docs sample page","path":"sample-page","order":0}]}]}]} \ No newline at end of file