diff --git a/api-playground/json/data/aadhaar-lite/aadhaar-lite.json b/api-playground/json/data/aadhaar-lite/aadhaar-lite.json new file mode 100644 index 00000000..524feb23 --- /dev/null +++ b/api-playground/json/data/aadhaar-lite/aadhaar-lite.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "header": [ + { + "x-client-id": "292c6e76-dabf-49c4-8e48-90fba2916673" + }, + { + "x-client-secret": "7IZMe9zvoBBuBukLiCP7n4KLwSOy11oP" + }, + { + "x-product-instance-id": "69e23f7f-4f71-412e-aec6-b1da3fb77c6f" + } + ] + }, + "body": { + "aadhaar_number": "999999990001" + } + } + \ No newline at end of file diff --git a/api-playground/products.json b/api-playground/products.json index b2df3a5f..2e5e5186 100644 --- a/api-playground/products.json +++ b/api-playground/products.json @@ -59,6 +59,10 @@ { "name": "Insights", "path": "data/insights" + }, + { + "name": "Aadhaar Lite", + "path": "data/aadhaar-lite" } ] } diff --git a/api-references/data/aadhar-lite.json b/api-references/data/aadhar-lite.json new file mode 100644 index 00000000..11c4e230 --- /dev/null +++ b/api-references/data/aadhar-lite.json @@ -0,0 +1,281 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Data Gateway - GST verification", + "description": "pull just the key facts from an Aadhaar record without any extra OTPs or hoops for your users.\n\n[See on Setu docs](https://docs.setu.co/data)", + "contact": {}, + "version": "1.0" + }, + "servers": [ + { + "url": "https://dg-sandbox.setu.co", + "description": "Sandbox" + }, + { + "url": "https://dg.setu.co", + "description": "Production" + } + ], + "paths": { + "/api/aadhaar-lite": { + "post": { + "tags": ["Aadhaar Lite"], + "summary": "Aadhaar Lite", + "operationId": "AadhaarLite", + "parameters": [ + { + "name": "x-client-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{client_id}}" + } + }, + { + "name": "x-client-secret", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{secret}}" + } + }, + { + "name": "x-product-instance-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{x-product-instance-id}}" + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/AadhaarLiteRequest" + }, + { + "example": { + "aadhaar_number": "999999990001" + } + } + ] + }, + "example": { + "aadhaar_number": "999999990001" + } + } + }, + "required": true + }, + "responses": { + "404": { + "description": "Not Found", + "headers": {}, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/AadhaarNotFound" + }, + { + "example": { + "message": "Aadhaar not found", + "id": "fa239bc1-b0ec-4484-be42-cfc4031c6be5", + "traceId": "1-68187a91-2067df594a94c6047b65043a", + "status": "FAILED" + } + } + ] + }, + "example": { + "message": "Aadhaar not found", + "id": "fa239bc1-b0ec-4484-be42-cfc4031c6be5", + "traceId": "1-68187a91-2067df594a94c6047b65043a", + "status": "FAILED" + } + } + } + }, + "200": { + "description": "OK", + "headers": {}, + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ValidAadhaarLite" + }, + { + "example": { + "status": "SUCCESS", + "id": "3ae8518d-99d3-4cd0-9315-b12a4936e1bc", + "message": "Aadhaar found", + "data": { + "address": "Delhi", + "ageBand": "20-30", + "gender": "M", + "maskedMobileNumber": "XXXXXX1234" + }, + "traceId": "1-681871c5-2c10e99906394e4055ef962a" + } + } + ] + }, + "example":{ + "status": "SUCCESS", + "id": "3ae8518d-99d3-4cd0-9315-b12a4936e1bc", + "message": "Aadhaar found", + "data": { + "address": "Delhi", + "ageBand": "20-30", + "gender": "M", + "maskedMobileNumber": "XXXXXX1234" + }, + "traceId": "1-681871c5-2c10e99906394e4055ef962a" + } + } + } + } + }, + "deprecated": false, + "security": [] + } + } + }, + "components": { + "schemas": { + "AadhaarLiteRequest": { + "title": "AadhaarLiteRequest", + "required": ["aadhaar_number"], + "type": "object", + "properties": { + "aadhaar_number": { + "type": "string" + } + }, + "example": { + "aadhaar_number": "999999990001" + } + }, + "ValidAadhaarLite": { + "title": "ValidAadhaarLite", + "required": [ + "status", + "id", + "message", + "data", + "traceId" + ], + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "data": { + "$ref": "#/components/schemas/Data" + }, + "traceId": { + "type": "string" + } + }, + "example": { + "status": "SUCCESS", + "id": "3ae8518d-99d3-4cd0-9315-b12a4936e1bc", + "message": "Aadhaar found", + "data": { + "address": "Delhi", + "ageBand": "20-30", + "gender": "M", + "maskedMobileNumber": "XXXXXX1234" + }, + "traceId": "1-681871c5-2c10e99906394e4055ef962a" + } + }, + "Data": { + "title": "Data", + "required": ["address", "ageBand", "gender", "maskedMobileNumber"], + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "ageBand": { + "type": "string" + }, + "gender": { + "type": "string" + }, + "maskedMobileNumber": { + "type": "string" + } + } + }, + "AadhaarNotFound": { + "title": "AadhaarNotFound", + "required": ["message", "id", "traceId","status"], + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "id": { + "type": "string" + }, + "traceId": { + "type": "string" + }, + "status": { + "type": "string" + } + }, + "example": { + "status": "FAILED", + "id": "fa239bc1-b0ec-4484-be42-cfc4031c6be5", + "message": "Aadhaar not found", + "traceId": "1-68187a91-2067df594a94c6047b65043a" + } + } + }, + "securitySchemes": { + "bearer": { + "type": "http", + "scheme": "bearer" + } + } + }, + "security": [ + { + "bearer": [] + } + ], + "tags": [ + { + "name": "Aadhaar Lite" + }, + { + "name": "Misc", + "description": "" + } + ] +} diff --git a/content/data/aadhaar-lite/api-reference.mdx b/content/data/aadhaar-lite/api-reference.mdx new file mode 100644 index 00000000..18201ce4 --- /dev/null +++ b/content/data/aadhaar-lite/api-reference.mdx @@ -0,0 +1,6 @@ +--- +sidebar_title: API reference +page_title: Aadhaar lite API reference +order: 1 +visible_in_sidebar: true +--- diff --git a/content/data/aadhaar-lite/quickstart.mdx b/content/data/aadhaar-lite/quickstart.mdx new file mode 100644 index 00000000..3914ecbf --- /dev/null +++ b/content/data/aadhaar-lite/quickstart.mdx @@ -0,0 +1,225 @@ +--- +sidebar_title: Quickstart +page_title: Aadhaar-lite API quickstart +order: 0 +visible_in_sidebar: true +--- + +## Aadhaar Lite API Quickstart + +### What is Setu Aadhaar-lite? + +Aadhaar Lite lets you pull just the key facts from an Aadhaar record—age bracket, gender, masked mobile number, issuing state and card status—without any extra OTPs or hoops for your users. + +Built for plug-and-play integration, it delivers lightning-fast identity checks while keeping sensitive data locked down. You get only what you need, so your workflows stay lean, your users stay private, and your operations stay rock-solid. + +### What can I do with this product? + +**Verify Age Eligibility:** +Ensure users meet minimum age requirements for your service. + +**Enforce Regional Restrictions:** +Automatically block or flag requests from locations where your offering isn't permitted. + +**Streamline Onboarding:** +Accelerate user registration by instantly validating key identity attributes. + +**Meet Regulatory KYC Requirements:** +Stay compliant with local and industry-specific identity verification standards. + +**Reduce Fraud and Risk:** +Detect and deter fraudulent or duplicate applications by confirming genuine Aadhaar data. + +Here's a quick overview of the Aadhaar Lite API. Additionally, here are the URLs you would need for this API— + +- 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` + +
+ +### aadhaar-lite + +Call this API to verify a user's summarised aadhaar data. A quick explanation of the request param— + +- `aadhaar_number` is the 12- digit aadhaar of the user. + +
+ +While testing on Sandbox, you may use the following sample values— + +- Use 999999990001 for a valid Aadhaar number +- Use 999999990000 for an aadhaar number that has not been found in the UIDAI database. +- If you use any other values for `aadhaar_number`, you will get a 404 aadhaar not found message. + + +

+ SUCCESS Your request has a valid{" "} + aadhaar number and Setu has processed your request successfully. +

+
+
Request
+ + {`POST /api/aadhaar-lite + +{ + "aadhaar_number": "999999990001" +} `} + +
+
Response
+ + {`{ + "status": "SUCCESS", + "id": "68449359-8db7-4b89-b662-f402a22b9672", + "message": "Aadhaar found", + "data": { + "address": "Delhi", + "ageBand": "20-30", + "gender": "M", + "maskedMobileNumber": "XXXXXX1234" + }, + "traceId": "1-68186a92-6a10e37431de832b2616c53d" +} `} + + + ), + }, + { + key: "2", + label: "404", + content: ( + <> +

+ SUCCESS Setu has processed your + request successfully, but the provided{" "} + aadhaar number could not be found +

+
+
Request
+ + {`POST /api/aadhaar-lite + +{ + "aadhaar_number": "999999990001" +} `} + +
+
Response
+ + {`{ + "status": "FAILED", + "id": "95d970cf-e3f9-474f-95a2-1694307b9bb6", + "message": "Aadhaar not found", + "traceId": "1-68186bd7-5c07a0a97ca37b2f589950d4" +} `} + + + ), + }, + { + key: "3", + label: "400", + content: ( + <> +

+ BAD REQUEST Your request does not have a valid{" "} + aadhaar number. +

+
+
Request
+ + {`POST /api/aadhaar-lite + +{ + "aadhaar_number": "99990001" +} `} + +
+
Response
+ + {`{ + "status": "FAILED", + "id": "1bcc51c2-71b2-4db0-9df7-ba9a98c5845f", + "message": "Invalid Aadhaar number. It must be 12 digits.", + "traceId": "1-68186c75-5585419254477c03060e573c" +} `} + + + ), + }, + { + key: "4", + label: "400", + content: ( + <> +

+ BAD REQUEST The aadhaar number{" "} + field is empty +

+
+
Request
+ + {`POST /api/aadhaar-lite + +{ + "aadhaar_number": "" +} `} + +
+
Response
+ + {`{ + "status": "FAILED", + "id": "d54a49b5-6776-442b-b353-5c9a28c3de2d", + "message": "Aadhaar number cannot be empty", + "traceId": "1-68186cf5-4342e3c74addefc75e7dc10c" +} `} + + + ), + }, + { + key: "5", + label: "400", + content: ( + <> +

+ FAILURE Field aadhaar_number is not passed correctly in the request. +

+
+
Request
+ + {`POST /api/aadhaar-lite + +{ + "aadhaar": "999999990001" +} `} + +
+
Response
+ + {`{ + "status": "FAILED", + "id": "7da8cf24-4f48-4f62-a8e6-7c0daa0c1733", + "message": "Invalid request body. Field 'aadhaar_number' is required.", + "traceId": "1-68186d54-362bc66046204db412ed1f94" +} `} + + + ), + }, + ]} +/> + +
+ diff --git a/content/data/digilocker/pulldrivinglicense.mdx b/content/data/digilocker/pulldrivinglicense.mdx index 051bce6b..f0ffdffa 100644 --- a/content/data/digilocker/pulldrivinglicense.mdx +++ b/content/data/digilocker/pulldrivinglicense.mdx @@ -1,12 +1,12 @@ --- sidebar_title: Pull Driving Licence page_title: Digilocker Quickstart -order: 1 +order: 2 visible_in_sidebar: true --- -## Pull Driving Licence via Digilocker +## Pull Driving Licence Use this flow to fetch a user's Driving Licence from Digilocker via Setu APIs. This involves two steps: