From 79f6b071b209cf7dc7e8d5b59f9f97739bdf6c8d Mon Sep 17 00:00:00 2001 From: VarunSonava Date: Mon, 3 Mar 2025 00:34:56 +0200 Subject: [PATCH 1/4] docs: add new EPFO documentation --- api-playground/json/data/epfo/UANDetails.json | 19 + api-playground/json/data/epfo/UANLookup.json | 19 + api-playground/products.json | 4 + api-references/data/epfo.json | 2879 +++++++++++++++++ content/data/epfo/api-reference.mdx | 6 + content/data/epfo/quickstart.mdx | 153 + 6 files changed, 3080 insertions(+) create mode 100644 api-playground/json/data/epfo/UANDetails.json create mode 100644 api-playground/json/data/epfo/UANLookup.json create mode 100644 api-references/data/epfo.json create mode 100644 content/data/epfo/api-reference.mdx create mode 100644 content/data/epfo/quickstart.mdx diff --git a/api-playground/json/data/epfo/UANDetails.json b/api-playground/json/data/epfo/UANDetails.json new file mode 100644 index 00000000..2deec2fa --- /dev/null +++ b/api-playground/json/data/epfo/UANDetails.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "header": [ + { + "x-client-id": "292c6e76-dabf-49c4-8e48-90fba2916673" + }, + { + "x-client-secret": "7IZMe9zvoBBuBukLiCP7n4KLwSOy11oP" + }, + { + "x-product-instance-id": "" + } + ] + }, + "body": { + "mobileNumber": "9555xxxxxx" + } + } + \ No newline at end of file diff --git a/api-playground/json/data/epfo/UANLookup.json b/api-playground/json/data/epfo/UANLookup.json new file mode 100644 index 00000000..30275bdc --- /dev/null +++ b/api-playground/json/data/epfo/UANLookup.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "header": [ + { + "x-client-id": "292c6e76-dabf-49c4-8e48-90fba2916673" + }, + { + "x-client-secret": "7IZMe9zvoBBuBukLiCP7n4KLwSOy11oP" + }, + { + "x-product-instance-id": "" + } + ] + }, + "body": { + "uan": "123456789012" + } + } + \ No newline at end of file diff --git a/api-playground/products.json b/api-playground/products.json index 93ab8886..9d578702 100644 --- a/api-playground/products.json +++ b/api-playground/products.json @@ -30,6 +30,10 @@ "name": "PAN verification", "path": "data/pan" }, + { + "name": "EPFO", + "path": "data/epfo" + }, { "name": "Aadhaar KYC", "path": "data/okyc" diff --git a/api-references/data/epfo.json b/api-references/data/epfo.json new file mode 100644 index 00000000..d34a2c71 --- /dev/null +++ b/api-references/data/epfo.json @@ -0,0 +1,2879 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Data Gateway - EPFO APIs", + "description": "Build the data flow you need for background verifications.\n\n[See on Setu docs](https://docs.setu.co/data)\n\n\n**EPF APIs**\nFetch UAN by user's mobile number and EPF details of the user by UAN", + "contact": {}, + "version": "1.0" + }, + "servers": [ + { + "url": "https://dg-sandbox.setu.co", + "description": "Sandbox" + }, + { + "url": "https://dg.setu.co", + "description": "Production" + } + ], + "paths": { + "/api/epf/uanLookup": { + "post": { + "summary": "UAN Lookup", + "operationId": "UANLookup", + "parameters": [ + { + "name": "x-client-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "test-client" + } + }, + { + "name": "x-client-secret", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "891707ee-d6cd-4744-a28d-058829e30f12" + } + }, + { + "name": "x-product-instance-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "891707ee-d6cd-4744-a28d-058829e30f10" + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UANLookup" + }, + "example": { + "mobileNumber": "9555xxxxxx" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SuccessLookup-ValidMobile" + }, + "example": { + "data": { + "uan":"123456789012" + }, + "requestId": "uuid", + "statusCode": 200, + "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Failure-InternalServerError1" + }, + "example": { + "error": { + "code": "internal_server_error", + "detail": "Internal Server Error. Please reach out to support along with the traceId.", + "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" + } + } + } + } + } + }, + "deprecated": false, + "security": [] + } + }, + "/api/epf/uanDetails":{ + "post": { + "summary": "UAN Details", + "operationId": "UANDetails", + "parameters": [ + { + "name": "x-client-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "test-client" + } + }, + { + "name": "x-client-secret", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "891707ee-d6cd-4744-a28d-058829e30f12" + } + }, + { + "name": "x-product-instance-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "891707ee-d6cd-4744-a28d-058829e30f10" + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UANDetails" + }, + "example": { + "uan": "123456789012" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SuccessDetails-ValidUAN" + }, + "example": { + "data": { + "uan": "123456789012", + "employers": [ + { + "startMonthYear": "12-JUN-2022", + "lastMonthYear": "", + "establishmentId": "", + "establishmentName": "", + "memberId": "" } + ], + "personalDetails": { + "name": "Walter White", + "fatherOrHusbandName": "", + "aadhaarVerificationStatus": "-1", + "contactNo": "" + }, + "summary": { + "minimumWorkExperienceInMonths": 33, + "lastEmployer": { + "employerName": "A1A PRIVATE LIMITED", + "startMonthYear": "12-JUN-2022", + "lastMonthYear": "12-JUN-2022", + "vintageInMonths": 33 + } + } + }, + "requestId": "uuid", + "statusCode": 200 + }, + "requestId": "uuid", + "statusCode": 200, + "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Failure-InternalServerError1" + }, + "example": { + "error": { + "code": "internal_server_error", + "detail": "Internal Server Error. Please reach out to support along with the traceId.", + "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" + } + } + } + } + } + }, + "deprecated": false, + "security": [] + } + }, + "components": { + "schemas": { + "parameters": { + "title": "parameters", + "required": [ + "name", + "fundraiser", + "beneficiaryName", + "beneficiaryRelationship", + "date", + "amount", + "account", + "accountHolderRelationship" + ], + "type": "object", + "properties": { + "name": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "" + }, + "fundraiser": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "" + }, + "beneficiaryName": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "" + }, + "beneficiaryRelationship": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "" + }, + "date": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "" + }, + "amount": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "" + }, + "account": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "" + }, + "accountHolderRelationship": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "" + } + }, + "example": { + "name": [100, 590], + "fundraiser": [100, 565], + "beneficiaryName": [210, 540], + "beneficiaryRelationship": [250, 515], + "date": [90, 487], + "amount": [350, 487], + "account": [410, 462], + "accountHolderRelationship": [270, 437] + } + }, + "UANLookup":{ + "title": "UANLookup", + "required": ["mobileNumber"], + "type": "object", + "properties": { + "mobileNumber": { + "type": "string" + } + }, + "example": { + "mobileNumber": "9555xxxxxx" + } + }, + "SuccessLookup-ValidMobile":{ + "title": "SuccessLookup-ValidMobile", + "required": ["data", "requestId", "statusCode", "traceId"], + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "uan": { + "type": "string" + } + }, + "required": ["uan"] + }, + "requestId": { + "type": "string" + }, + "statusCode": { + "type": "string" + }, + "traceId": { + "type": "string" + } + }, + "example": { + "data": { + "uan":"123456789012" + }, + "requestId": "uuid", + "statusCode": "200", + "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" + } + }, + "UANDetails":{ + "title": "UANDetails", + "required": ["uan"], + "type": "object", + "properties": { + "uan": { + "type": "string" + } + }, + "example": { + "uan": "123456789012" + } + }, + "SuccessDetails-ValidUAN":{ + "title": "SuccessDetails-ValidUAN", + "required": ["data", "requestId", "statusCode", "traceId"], + "type": "object", + "properties": { + "data": { + "$ref":"#/components/schemas/UANdata" + }, + "requestId": { + "type": "string" + }, + "statusCode": { + "type": "string" + }, + "traceId": { + "type": "string" + } + }, + "example": { + "data": { + "uan": "123456789012", + "employers": [ + { + "startMonthYear": "12-JUN-2022", + "lastMonthYear": "", + "establishmentId": "", + "establishmentName": "", + "memberId": "" } + ], + "personalDetails": { + "name": "Walter White", + "fatherOrHusbandName": "", + "aadhaarVerificationStatus": "-1", + "contactNo": "" + }, + "summary": { + "minimumWorkExperienceInMonths": 33, + "lastEmployer": { + "employerName": "A1A PRIVATE LIMITED", + "startMonthYear": "12-JUN-2022", + "lastMonthYear": "12-JUN-2022", + "vintageInMonths": 33 + } + } + }, + "requestId": "uuid", + "statusCode": "200", + "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" + } + }, + "UANdata": { + "title": "UANdata", + "type": "object", + "required": ["uan", "employers", "personalDetails", "summary"], + "properties": { + "uan": { + "type": "string" + }, + "employers": { + "type": "array", + "items": { + "type": "object", + "required": ["startMonthYear", "lastMonthYear", "establishmentId", "establishmentName", "memberId"], + "properties": { + "startMonthYear": { + "type": "string" + }, + "lastMonthYear": { + "type": "string" + }, + "establishmentId": { + "type": "string" + }, + "establishmentName": { + "type": "string" + }, + "memberId": { + "type": "string" + } + } + } + }, + "personalDetails": { + "type": "object", + "required": ["name", "fatherOrHusbandName", "aadhaarVerificationStatus", "contactNo"], + "properties": { + "name": { + "type": "string" + }, + "fatherOrHusbandName": { + "type": "string" + }, + "aadhaarVerificationStatus": { + "type": "string" + }, + "contactNo": { + "type": "string" + } + } + }, + "summary": { + "type": "object", + "required": ["minimumWorkExperienceInMonths", "lastEmployer"], + "properties": { + "minimumWorkExperienceInMonths": { + "type": "number" + }, + "lastEmployer": { + "type": "object", + "required": ["employerName", "startMonthYear", "lastMonthYear", "vintageInMonths"], + "properties": { + "employerName": { + "type": "string" + }, + "startMonthYear": { + "type": "string" + }, + "lastMonthYear": { + "type": "string" + }, + "vintageInMonths": { + "type": "number" + } + } + } + } + } + }, + "example": { + "uan": "123456789012", + "employers": [ + { + "startMonthYear": "12-JUN-2022", + "lastMonthYear": "", + "establishmentId": "", + "establishmentName": "", + "memberId": "" + } + ], + "personalDetails": { + "name": "Walter White", + "fatherOrHusbandName": "", + "aadhaarVerificationStatus": "-1", + "contactNo": "" + }, + "summary": { + "minimumWorkExperienceInMonths": 33, + "lastEmployer": { + "employerName": "A1A PRIVATE LIMITED", + "startMonthYear": "12-JUN-2022", + "lastMonthYear": "12-JUN-2022", + "vintageInMonths": 33 + } + } + } + }, + "UploadeSigndocumenttemplate": { + "title": "UploadeSigndocumenttemplate", + "required": ["downloadUrl", "id", "parameters"], + "type": "object", + "properties": { + "downloadUrl": { + "type": "string" + }, + "id": { + "type": "string" + }, + "parameters": { + "$ref": "#/components/schemas/parameters" + } + }, + "example": { + "downloadUrl": "https://s3-link-goes-here.com", + "id": "6ff6abc2-3306-4133-885a-245d5d9f69dc", + "parameters": { + "account": [410, 462], + "accountHolderRelationship": [270, 437], + "amount": [350, 487], + "beneficiaryName": [210, 540], + "beneficiaryRelationship": [250, 515], + "date": [90, 487], + "fundraiser": [100, 565], + "name": [100, 590] + } + } + }, + "RendereSigndocumenttemplateRequest": { + "title": "RendereSigndocumenttemplateRequest", + "required": ["name", "parameters"], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "parameters": { + "$ref": "#/components/schemas/Parameters2" + } + }, + "example": { + "name": "random name", + "parameters": { + "name": "your name", + "fundraiser": "fundraiser name", + "beneficiaryName": "beneficiary name", + "beneficiaryRelationship": "beneficiary relationship", + "date": "15/12/2021", + "amount": "25,000", + "account": "123456789", + "accountHolderRelationship": "account holder relationship" + } + } + }, + "Parameters2": { + "title": "Parameters2", + "required": [ + "name", + "fundraiser", + "beneficiaryName", + "beneficiaryRelationship", + "date", + "amount", + "account", + "accountHolderRelationship" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "fundraiser": { + "type": "string" + }, + "beneficiaryName": { + "type": "string" + }, + "beneficiaryRelationship": { + "type": "string" + }, + "date": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "account": { + "type": "string" + }, + "accountHolderRelationship": { + "type": "string" + } + }, + "example": { + "name": "your name", + "fundraiser": "fundraiser name", + "beneficiaryName": "beneficiary name", + "beneficiaryRelationship": "beneficiary relationship", + "date": "15/12/2021", + "amount": "25,000", + "account": "123456789", + "accountHolderRelationship": "account holder relationship" + } + }, + "RendereSigndocumenttemplate": { + "title": "RendereSigndocumenttemplate", + "required": ["documentType", "downloadUrl", "id", "name"], + "type": "object", + "properties": { + "documentType": { + "type": "string" + }, + "downloadUrl": { + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "example": { + "documentType": "application/pdf", + "downloadUrl": "https://s3-link-goes-here.com", + "id": "d784d36c-88c8-4670-b320-d164cad73d8c", + "name": "random name" + } + }, + "GetTemplate": { + "title": "GetTemplate", + "required": ["downloadUrl", "id", "parameters"], + "type": "object", + "properties": { + "downloadUrl": { + "type": "string" + }, + "id": { + "type": "string" + }, + "parameters": { + "$ref": "#/components/schemas/parameters" + } + }, + "example": { + "downloadUrl": "https://s3-link-goes-here.com", + "id": "6ff6abc2-3306-4133-885a-245d5d9f69dc", + "parameters": { + "account": [410, 462], + "accountHolderRelationship": [270, 437], + "amount": [350, 487], + "beneficiaryName": [210, 540], + "beneficiaryRelationship": [250, 515], + "date": [90, 487], + "fundraiser": [100, 565], + "name": [100, 590] + } + } + }, + "Thedocumentwassuccessfullyuploaded": { + "title": "Thedocumentwassuccessfullyuploaded", + "required": ["id", "name"], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "example": { + "id": "67e0ca30-49e4-4883-86f9-3762f0e6798c", + "name": "sample.pdf" + } + }, + "CreateSignatureRequestRequest": { + "title": "CreateSignatureRequestRequest", + "required": ["documentId", "redirectUrl", "signers"], + "type": "object", + "properties": { + "documentId": { + "type": "string" + }, + "redirectUrl": { + "type": "string" + }, + "signers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Signer" + }, + "description": "" + } + }, + "example": { + "documentId": "{{document_id}}", + "redirectUrl": "http://setu.co", + "signers": [ + { + "identifier": "9876543210", + "displayName": "Ian Fernandes", + "signature": { + "height": 60, + "onPages": ["1"], + "position": "bottom-left", + "width": 180 + } + } + ] + } + }, + "Signer": { + "title": "Signer", + "required": ["identifier", "displayName", "signature"], + "type": "object", + "properties": { + "identifier": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "signature": { + "$ref": "#/components/schemas/Signature" + } + }, + "example": { + "identifier": "9876543210", + "displayName": "Ian Fernandes", + "signature": { + "height": 60, + "onPages": ["1"], + "position": "bottom-left", + "width": 180 + } + } + }, + "Signature": { + "title": "Signature", + "required": ["height", "onPages", "position", "width"], + "type": "object", + "properties": { + "height": { + "type": "integer", + "format": "int32" + }, + "onPages": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "position": { + "type": "string" + }, + "width": { + "type": "integer", + "format": "int32" + } + }, + "example": { + "height": 60, + "onPages": ["1"], + "position": "bottom-left", + "width": 180 + } + }, + "Success": { + "title": "Success", + "required": [ + "documentId", + "id", + "redirectUrl", + "signers", + "status" + ], + "type": "object", + "properties": { + "documentId": { + "type": "string" + }, + "id": { + "type": "string" + }, + "redirectUrl": { + "type": "string" + }, + "signers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Signer1" + }, + "description": "" + }, + "status": { + "type": "string" + } + }, + "example": { + "documentId": "91fba655-95d3-4ffd-a47f-5e122024b00c", + "id": "6bae9d1f-0fa6-44e5-a801-3ad4a5f10a12", + "redirectUrl": "http://setu.co", + "signers": [ + { + "displayName": "Akshay P", + "id": "34f94af1-a8b9-4797-b287-c5ef7bff99a1", + "identifier": "9876543210", + "signatureDetails": null, + "status": "pending", + "url": "https://dg-uat.setu.co/signature/preview?requestId=6bae9d1f-0fa6-44e5-a801-3ad4a5f10a12&signerId=34f94af1-a8b9-4797-b287-c5ef7bff99a1" + } + ], + "status": "sign_initiated" + } + }, + "Signer1": { + "title": "Signer1", + "required": [ + "displayName", + "id", + "identifier", + "signatureDetails", + "status", + "url" + ], + "type": "object", + "properties": { + "displayName": { + "type": "string" + }, + "id": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "signatureDetails": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "example": { + "displayName": "Akshay P", + "id": "34f94af1-a8b9-4797-b287-c5ef7bff99a1", + "identifier": "9876543210", + "signatureDetails": null, + "status": "pending", + "url": "https://dg-uat.setu.co/signature/preview?requestId=6bae9d1f-0fa6-44e5-a801-3ad4a5f10a12&signerId=34f94af1-a8b9-4797-b287-c5ef7bff99a1" + } + }, + "Error": { + "title": "Error", + "required": ["code", "detail", "traceId"], + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "detail": { + "type": "string" + }, + "traceId": { + "type": "string" + } + }, + "example": { + "code": "invalid_document", + "detail": "The document Id is already being used in a signature", + "traceId": "" + } + }, + "Invaliddocument1": { + "title": "Invaliddocument1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "invalid_document", + "detail": "The document Id is already being used in a signature", + "traceId": "" + } + } + }, + "Invalidpayload1": { + "title": "Invalidpayload1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "invalid_payload", + "detail": "Invalid position value.", + "traceId": "" + } + } + }, + "Successpendingsign": { + "title": "Successpendingsign", + "required": [ + "documentId", + "id", + "redirectUrl", + "signers", + "status" + ], + "type": "object", + "properties": { + "documentId": { + "type": "string" + }, + "id": { + "type": "string" + }, + "redirectUrl": { + "type": "string" + }, + "signers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Signer1" + }, + "description": "" + }, + "status": { + "type": "string" + } + }, + "example": { + "documentId": "50ce4004-2133-4b39-8c5f-6522714ae2d0", + "id": "5f2eedb3-ef0e-4ae9-831b-8ae208a31b9b", + "redirectUrl": "http://setu.co", + "signers": [ + { + "displayName": "Akshay P", + "id": "9d9e47f7-9c24-4587-8775-f01b17e6fc4d", + "identifier": "9876543210", + "signatureDetails": null, + "status": "pending", + "url": "https://dg-uat.setu.co/signature/preview?requestId=5f2eedb3-ef0e-4ae9-831b-8ae208a31b9b&signerId=9d9e47f7-9c24-4587-8775-f01b17e6fc4d" + } + ], + "status": "sign_initiated" + } + }, + "Successdocumentsigned": { + "title": "Successdocumentsigned", + "required": [ + "documentId", + "id", + "redirectUrl", + "signers", + "status" + ], + "type": "object", + "properties": { + "documentId": { + "type": "string" + }, + "id": { + "type": "string" + }, + "redirectUrl": { + "type": "string" + }, + "signers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Signer3" + }, + "description": "" + }, + "status": { + "type": "string" + } + }, + "example": { + "documentId": "50ce4004-2133-4b39-8c5f-6522714ae2d0", + "id": "5f2eedb3-ef0e-4ae9-831b-8ae208a31b9b", + "redirectUrl": "http://setu.co", + "signers": [ + { + "displayName": "Akshay P", + "id": "9d9e47f7-9c24-4587-8775-f01b17e6fc4d", + "identifier": "9876543210", + "signatureDetails": { + "aadhaarName": "signer name as per aadhaar", + "aadhaarSuffix": "XXXX", + "birthYear": "1972", + "gender": "M", + "postalCode": "560001" + }, + "status": "signed", + "url": "https://dg-uat.setu.co/signature/preview?requestId=5f2eedb3-ef0e-4ae9-831b-8ae208a31b9b&signerId=9d9e47f7-9c24-4587-8775-f01b17e6fc4d" + } + ], + "status": "sign_complete" + } + }, + "Signer3": { + "title": "Signer3", + "required": [ + "displayName", + "id", + "identifier", + "signatureDetails", + "status", + "url" + ], + "type": "object", + "properties": { + "displayName": { + "type": "string" + }, + "id": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "signatureDetails": { + "$ref": "#/components/schemas/SignatureDetails" + }, + "status": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "example": { + "displayName": "Akshay P", + "id": "9d9e47f7-9c24-4587-8775-f01b17e6fc4d", + "identifier": "9876543210", + "signatureDetails": { + "aadhaarName": "signer name as per aadhaar", + "aadhaarSuffix": "XXXX", + "birthYear": "1972", + "gender": "M", + "postalCode": "560001" + }, + "status": "signed", + "url": "https://dg-uat.setu.co/signature/preview?requestId=5f2eedb3-ef0e-4ae9-831b-8ae208a31b9b&signerId=9d9e47f7-9c24-4587-8775-f01b17e6fc4d" + } + }, + "SignatureDetails": { + "title": "SignatureDetails", + "required": [ + "aadhaarName", + "aadhaarSuffix", + "birthYear", + "gender", + "postalCode" + ], + "type": "object", + "properties": { + "aadhaarName": { + "type": "string" + }, + "aadhaarSuffix": { + "type": "string" + }, + "birthYear": { + "type": "string" + }, + "gender": { + "type": "string" + }, + "postalCode": { + "type": "string" + } + }, + "example": { + "aadhaarName": "signer name as per aadhaar", + "aadhaarSuffix": "XXXX", + "birthYear": "1972", + "gender": "M", + "postalCode": "560001" + } + }, + "Signeddocumentdownloadurl": { + "title": "Signeddocumentdownloadurl", + "required": ["downloadUrl", "id", "validUpto"], + "type": "object", + "properties": { + "downloadUrl": { + "type": "string" + }, + "id": { + "type": "string" + }, + "validUpto": { + "type": "string" + } + }, + "example": { + "downloadUrl": "download_url_goes_here", + "id": "29e5a985-7d40-4b42-8260-9d9f4ef60aa1", + "validUpto": "2021-10-28T14:09:14+05:30" + } + }, + "SignatureRequestnotyetcompletedcancelleddeclined1": { + "title": "SignatureRequestnotyetcompletedcancelleddeclined1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "document_not_signed", + "detail": "Only signed documents can be downloaded.", + "traceId": "" + } + } + }, + "SignedDocumentdeletedDocumentnotfound1": { + "title": "SignedDocumentdeletedDocumentnotfound1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "signature_request_not_found", + "detail": "Signature Request Not Found.", + "traceId": "" + } + } + }, + "GetEsignAuditReport": { + "title": "GetEsignAuditReport", + "required": ["id", "document", "events"], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "document": { + "$ref": "#/components/schemas/Document" + }, + "events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Event" + }, + "description": "" + } + }, + "example": { + "id": "805b326f-e38c-4908-8592-0d3c7200a6b4", + "document": { + "id": "c3eaecdd-db27-4d9b-b9bb-ed7f7771b1c6", + "name": "vaccine" + }, + "events": [ + { + "createdAt": "2021-11-22 11:43:39.161115", + "activity": "uploaded", + "initator": { + "name": "Test client", + "type": "apiClient", + "userAgent": "PostmanRuntime/7.28.4", + "IP": "223.179.144.102, 172.31.28.227" + }, + "metaData": {} + }, + { + "createdAt": "2021-11-22 11:44:32.468027", + "activity": "notified", + "initator": { + "name": "Test client", + "type": "apiClient", + "userAgent": "PostmanRuntime/7.28.4", + "IP": "223.179.144.102, 172.31.28.227" + }, + "metaData": { + "signers": [ + { + "identifier": "9876543210", + "displayName": "Akshay P" + }, + { + "identifier": "7042484922", + "displayName": "Rahul" + } + ] + } + }, + { + "createdAt": "2021-11-22 11:44:55.497584", + "activity": "opened", + "initator": { + "name": "Akshay P", + "type": "signer", + "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.69 Safari/537.36", + "IP": "172.31.42.133" + }, + "metaData": {} + }, + { + "createdAt": "2021-11-22 11:46:41.198454", + "activity": "signed", + "initator": { + "name": "Akshay P", + "type": "signer", + "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.69 Safari/537.36", + "IP": "172.31.4.118" + }, + "metaData": { + "signatureDetails": { + "gender": "M", + "issuer": "NSDL e-Governance Infrastructure Limited", + "birthYear": "1993", + "validFrom": "2021-11-22 11:50:47", + "validUpto": "2021-11-22 12:20:46", + "postalCode": "201300", + "aadhaarName": "Rahul Roy", + "serialNumber": "1784230000", + "aadhaarSuffix": "5340" + } + } + } + ] + } + }, + "Document": { + "title": "Document", + "required": ["id", "name"], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "example": { + "id": "c3eaecdd-db27-4d9b-b9bb-ed7f7771b1c6", + "name": "vaccine" + } + }, + "Event": { + "title": "Event", + "required": ["createdAt", "activity", "initator", "metaData"], + "type": "object", + "properties": { + "createdAt": { + "type": "string" + }, + "activity": { + "type": "string" + }, + "initator": { + "$ref": "#/components/schemas/Initator" + }, + "metaData": { + "$ref": "#/components/schemas/MetaData" + } + }, + "example": { + "createdAt": "2021-11-22 11:43:39.161115", + "activity": "uploaded", + "initator": { + "name": "Test client", + "type": "apiClient", + "userAgent": "PostmanRuntime/7.28.4", + "IP": "223.179.144.102, 172.31.28.227" + }, + "metaData": {} + } + }, + "Initator": { + "title": "Initator", + "required": ["name", "type", "userAgent", "IP"], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "userAgent": { + "type": "string" + }, + "IP": { + "type": "string" + } + }, + "example": { + "name": "Test client", + "type": "apiClient", + "userAgent": "PostmanRuntime/7.28.4", + "IP": "223.179.144.102, 172.31.28.227" + } + }, + "MetaData": { + "title": "MetaData", + "type": "object", + "properties": { + "signers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Signer4" + }, + "description": "" + }, + "signatureDetails": { + "$ref": "#/components/schemas/SignatureDetails1" + } + }, + "example": {} + }, + "Signer4": { + "title": "Signer4", + "required": ["identifier", "displayName"], + "type": "object", + "properties": { + "identifier": { + "type": "string" + }, + "displayName": { + "type": "string" + } + }, + "example": { + "identifier": "9876543210", + "displayName": "Akshay P" + } + }, + "SignatureDetails1": { + "title": "SignatureDetails1", + "required": [ + "gender", + "issuer", + "birthYear", + "validFrom", + "validUpto", + "postalCode", + "aadhaarName", + "serialNumber", + "aadhaarSuffix" + ], + "type": "object", + "properties": { + "gender": { + "type": "string" + }, + "issuer": { + "type": "string" + }, + "birthYear": { + "type": "string" + }, + "validFrom": { + "type": "string" + }, + "validUpto": { + "type": "string" + }, + "postalCode": { + "type": "string" + }, + "aadhaarName": { + "type": "string" + }, + "serialNumber": { + "type": "string" + }, + "aadhaarSuffix": { + "type": "string" + } + }, + "example": { + "gender": "M", + "issuer": "NSDL e-Governance Infrastructure Limited", + "birthYear": "1993", + "validFrom": "2021-11-22 11:50:47", + "validUpto": "2021-11-22 12:20:46", + "postalCode": "201300", + "aadhaarName": "Rahul Roy", + "serialNumber": "1784230000", + "aadhaarSuffix": "5340" + } + }, + "Downloaddocument": { + "title": "Downloaddocument", + "required": ["documentType", "downloadUrl", "id", "name"], + "type": "object", + "properties": { + "documentType": { + "type": "string" + }, + "downloadUrl": { + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "example": { + "documentType": "application/pdf", + "downloadUrl": "https://s3-link-goes-here.com", + "id": "d784d36c-88c8-4670-b320-d164cad73d8c", + "name": "random name" + } + }, + "CreateanOKYCRequestRequest": { + "title": "CreateanOKYCRequestRequest", + "required": ["redirectURL"], + "type": "object", + "properties": { + "redirectURL": { + "type": "string" + } + }, + "example": { + "redirectURL": "https://setu.co" + } + }, + "Success1": { + "title": "Success1", + "required": ["id", "url", "validUpto", "status"], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "validUpto": { + "type": "string" + }, + "status": { + "type": "string" + } + }, + "example": { + "id": "7097e53a-ba29-48a2-983d-878433b4f33e", + "url": "https://setuOKYCURL.co/foobar&sessionId=uuid", + "validUpto": "Wed, 23 Jun 2021 19:33:55 GMT", + "status": "incomplete" + } + }, + "Failure-BadRequest1": { + "title": "Failure-BadRequest1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "invalid_redirect_url", + "detail": "Please enter a valid redirect URL.", + "traceId": "" + } + } + }, + "InternalServerError1": { + "title": "InternalServerError1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "internal_server_error", + "detail": "Internal Server Error", + "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" + } + } + }, + "InitiateOKYCRequest": { + "title": "InitiateOKYCRequest", + "required": ["captchaImage", "requestId"], + "type": "object", + "properties": { + "captchaImage": { + "type": "string" + }, + "requestId": { + "type": "string" + } + }, + "example": { + "captchaImage": "base64-Image-data", + "requestId": "7097e53a-ba29-48a2-983d-878433b4f33e" + } + }, + "Success2": { + "title": "Success2", + "required": ["captchaImage", "captchaRetriesRemaining", "id"], + "type": "object", + "properties": { + "captchaImage": { + "type": "string" + }, + "captchaRetriesRemaining": { + "type": "integer", + "format": "int32" + }, + "id": { + "type": "string" + } + }, + "example": { + "captchaImage": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAAyAK8DASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD3+iiigAooooAKKKKACiiigAooooAKKKKACiiigAqrfalY6XAs+oXttaRM2wSXEqxqWwTjJI5wD+VWq+efEj6h8Qviu+hm5+zww3MlrArncsSxg72AAGWbYT+QzgAhpXJk7Hq0PxS8FzzxwpraBpGCgvBKigk45YqAB7k4FdVaXlrf2yXNncw3Nu+dksLh1bBwcEcHkEVwt38HfCk2kPa21vNb3flhUvfOd2DD+IqTtOe4AHU4xxjhvhXqWoeHviBceFZpfNt5ZJoZER/3azRgnzFyM8hCvbIIJ+6BTsnsLmaep7zRRRUlhRRRQAUUUUAFFFFABWNrnizQfDewatqUNs742x8u5Bzg7FBbHynnGM8Vs189W1snib47zW+qHzo/7RmBXauGWENsQjGCMRqp45Ge5zTSuNGn8Z9X0/W7Lw7eaZeQ3Vu32j54mztOIjhh1U4IyDgjPNdrf+ILvwt8FbHWrGOGS5ttOs9izqSh3eWpyAQejHvXB/Gnw/pmj3ukXOnWkNp9ojljkigjWNPkKkNhQOTvIJ9APSum8af8m6x/9g6w/wDQ4arsVFXkkcvYfG7xXq1gLbS/DsN7rIlaSQW9tLJGtuAoHyKxbduJycgAbRgk8e0+HtQl1bwzpWpTqizXdnDPIsYIUM6BiBkk4yfWvN/2fYIl8FajOIkEz6iyNIFG5lWOMqCepALNgdtx9a9apSteyKq8qfKkfN/7QP8AyPlj/wBgyP8A9Gy1u/8ADOf/AFNX/lP/APttYX7QP/I+WP8A2DI//Rstbv8Awzn/ANTV/wCU/wD+20+hz21PVvB3hz/hEvCllof2v7V9m3/vvL8vdudn+7k4xux17Vu1zz6hpPgDwdYLrOpJFa2UENp57IcysqhRtQZJJwTgZwAT0BNcL/w0R4R/6B2t/wDfiL/47U2bKvY9br581+O7+H3xeGt3ELy2c929zHJ5fEkcmfMVfm+8odhyRyFJGCK900XWtP8AEOkQarpVx9osp93ly7GTdtYqeGAI5BHSpb7TbHVIFg1CytruJW3iO4iWRQ2CM4IPOCfzoTsKSucTd/GLwpDpD3VtcTXF35YZLLyXRix/hLEbRjuQT0OM8Z4b4V6bqHiH4gXHiqaLyreKSaaR0T9200gI8tcnPAct3wAAfvA16TD8LfBcE8cyaIhaNgwDzyupIOeVLEEexGDXVWlna2FsltZ20NtbpnZFCgRVycnAHA5JNO6WwuVt6k1FFFSWFFFFABRRRQAUUUUAFeYeLPhbd33iceIvDt/b2l6ZknMM8eEWRefMBAOSSFJBU5JYk84r0+imnYDyDxP8LPE/iL7FeXevWl7qSxmOd5k8lEXgqqBEO7DGTLHGQV4FegxeGLS88EWfhzWoUuYEtIIJ0SRlV2jC9GGGxuUHtW9RRdjuZPh/w1pHhawksdFtPsttJKZmTzHfLkAE5Yk9FH5VrUUUhN33PN/iB8KP+E616DVP7a+w+Varb+X9l83OGZs53r/e6Y7Vyn/DOf8A1NX/AJT/AP7bXudFO7FZHlviD4UXd78KdO8I2GqQPc6fdG5SeeIxpLlpMg4LFcCU88529s5HJ6Drfjn4R+FVj1bwVavo0TndNBcIsplduHlZGcEY+TJUfwDPQH1zxn4Sh8Y6PDZPf3VhPbXAura5tiA0cyqwRj3IBbOAQeBgivOtR+B+uaxbrb6n8RtRvYFfesdzA8ihsEZAaYjOCefc00+4rdjvfh54i0bxN4Rt7vQ7FNPt43aKSyjjCLBLwzKMAAj5g2QOd3ODkDqqxPCnhbTvB2gRaPpgcwI7O0ku3zJGY5yxUAE4wM46KB2rbqWUFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQB/", + "captchaRetriesRemaining": 4, + "id": "0d209de1-77d1-4069-ad71-3f2cddf261f9" + } + }, + "Exceededcaptcharequests1": { + "title": "Exceededcaptcharequests1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "exceeded_captcha_requests", + "detail": "Exceeded captcha requests", + "traceId": "" + } + } + }, + "Error14": { + "title": "Error14", + "required": ["code", "detail", "traceID"], + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "detail": { + "type": "string" + }, + "traceID": { + "type": "string" + } + }, + "example": { + "code": "internal_server_error", + "detail": "Internal Server Error.", + "traceID": "" + } + }, + "Internalservererror3": { + "title": "Internalservererror3", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error14" + } + }, + "example": { + "error": { + "code": "internal_server_error", + "detail": "Internal Server Error.", + "traceID": "" + } + } + }, + "UpstreamServicesDown1": { + "title": "UpstreamServicesDown1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error14" + } + }, + "example": { + "error": { + "code": "internal_server_error", + "detail": "Upstream services are down", + "traceID": "" + } + } + }, + "APIonlyVerifyOKYCRequestRequest": { + "title": "APIonlyVerifyOKYCRequestRequest", + "required": ["aadhaarNumber", "captchaCode"], + "type": "object", + "properties": { + "aadhaarNumber": { + "type": "string" + }, + "captchaCode": { + "type": "string" + } + }, + "example": { + "aadhaarNumber": "999999990019", + "captchaCode": "2GAD0" + } + }, + "Success3": { + "title": "Success3", + "required": ["code", "message"], + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "example": { + "code": "otp_sent", + "message": "OTP sent to your registered mobile number." + } + }, + "Invalidcaptchaentered1": { + "title": "Invalidcaptchaentered1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "invalid_captcha_entered", + "detail": "Invalid captcha entered", + "traceId": "" + } + } + }, + "Invalidrequestorder": { + "title": "Invalidrequestorder", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "invalid_sequence", + "detail": "Invalid request order.", + "traceId": "" + } + } + }, + "RequestNotFound1": { + "title": "RequestNotFound1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "request_not_found", + "detail": "Request not found.", + "traceId": "" + } + } + }, + "APIonlyCompleteOKYCRequestRequest": { + "title": "APIonlyCompleteOKYCRequestRequest", + "required": ["otp", "shareCode"], + "type": "object", + "properties": { + "otp": { + "type": "string" + }, + "shareCode": { + "type": "string" + } + }, + "example": { + "otp": "123456", + "shareCode": "1234" + } + }, + "CompleteOKYCRequest": { + "title": "CompleteOKYCRequest", + "required": ["aadhaar", "id"], + "type": "object", + "properties": { + "aadhaar": { + "$ref": "#/components/schemas/Aadhaar" + }, + "id": { + "type": "string" + } + }, + "example": { + "aadhaar": { + "address": { + "careOf": "S/O: Mohan", + "country": "India", + "district": "Bangalore", + "house": "# 90 1 Cross", + "landmark": "Near PO", + "locality": "M.G. Road", + "pin": "560072", + "postOffice": "M.G Road", + "state": "Karnataka", + "street": "M.G.Road 1st Main Road", + "subDistrict": "Bangalore North", + "vtc": "Bangalore North" + }, + "dateOfBirth": "22-01-1980", + "email": "550fa5fd91eee3f29f6361a8c89aa9713d4d38811d1a5", + "gender": "M", + "generatedAt": "20210419145604802", + "maskedNumber": "xxxx-xxxx-8112", + "name": "Aditya Mohan", + "phone": "09c91184c1d610282d661dd63d257e3b44446853fb1388c9d5b", + "photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD==", + "verified": { + "email": false, + "phone": false, + "signature": true + }, + "xml": { + "fileUrl": "https://setus3linkgoeshere.com/", + "validUntil": 12345678 + } + }, + "id": "7097e53a-ba29-48a2-983d-878433b4f33e" + } + }, + "Aadhaar": { + "title": "Aadhaar", + "required": [ + "address", + "dateOfBirth", + "email", + "gender", + "generatedAt", + "maskedNumber", + "name", + "phone", + "photo", + "verified", + "xml" + ], + "type": "object", + "properties": { + "address": { + "$ref": "#/components/schemas/Address" + }, + "dateOfBirth": { + "type": "string" + }, + "email": { + "type": "string" + }, + "gender": { + "type": "string" + }, + "generatedAt": { + "type": "string" + }, + "maskedNumber": { + "type": "string" + }, + "name": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "photo": { + "type": "string" + }, + "verified": { + "$ref": "#/components/schemas/Verified" + }, + "xml": { + "$ref": "#/components/schemas/Xml" + } + }, + "example": { + "address": { + "careOf": "S/O: Mohan", + "country": "India", + "district": "Bangalore", + "house": "# 90 1 Cross", + "landmark": "Near PO", + "locality": "M.G. Road", + "pin": "560072", + "postOffice": "M.G Road", + "state": "Karnataka", + "street": "M.G.Road 1st Main Road", + "subDistrict": "Bangalore North", + "vtc": "Bangalore North" + }, + "dateOfBirth": "22-01-1980", + "email": "550fa5fd91eee3f29f6361a8c89aa9713d4d38811d1a5", + "gender": "M", + "generatedAt": "20210419145604802", + "maskedNumber": "xxxx-xxxx-8112", + "name": "Aditya Mohan", + "phone": "09c91184c1d610282d661dd63d257e3b44446853fb1388c9d5b", + "photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD==", + "verified": { + "email": false, + "phone": false, + "signature": true + }, + "xml": { + "fileUrl": "https://setus3linkgoeshere.com/", + "validUntil": 12345678 + } + } + }, + "Address": { + "title": "Address", + "required": [ + "careOf", + "country", + "district", + "house", + "landmark", + "locality", + "pin", + "postOffice", + "state", + "street", + "subDistrict", + "vtc" + ], + "type": "object", + "properties": { + "careOf": { + "type": "string" + }, + "country": { + "type": "string" + }, + "district": { + "type": "string" + }, + "house": { + "type": "string" + }, + "landmark": { + "type": "string" + }, + "locality": { + "type": "string" + }, + "pin": { + "type": "string" + }, + "postOffice": { + "type": "string" + }, + "state": { + "type": "string" + }, + "street": { + "type": "string" + }, + "subDistrict": { + "type": "string" + }, + "vtc": { + "type": "string" + } + }, + "example": { + "careOf": "S/O: Mohan", + "country": "India", + "district": "Bangalore", + "house": "# 90 1 Cross", + "landmark": "Near PO", + "locality": "M.G. Road", + "pin": "560072", + "postOffice": "M.G Road", + "state": "Karnataka", + "street": "M.G.Road 1st Main Road", + "subDistrict": "Bangalore North", + "vtc": "Bangalore North" + } + }, + "Verified": { + "title": "Verified", + "required": ["email", "phone", "signature"], + "type": "object", + "properties": { + "email": { + "type": "boolean" + }, + "phone": { + "type": "boolean" + }, + "signature": { + "type": "boolean" + } + }, + "example": { + "email": false, + "phone": false, + "signature": true + } + }, + "Xml": { + "title": "Xml", + "required": ["fileUrl", "validUntil"], + "type": "object", + "properties": { + "fileUrl": { + "type": "string" + }, + "validUntil": { + "type": "integer", + "format": "int32" + } + }, + "example": { + "fileUrl": "https://setus3linkgoeshere.com/", + "validUntil": 12345678 + } + }, + "Withasharecode": { + "title": "Withasharecode", + "required": ["aadhaar", "status", "id"], + "type": "object", + "properties": { + "aadhaar": { + "$ref": "#/components/schemas/Aadhaar1" + }, + "status": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "example": { + "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://setus3linkgoeshere.com/", + "validUntil": "Wed, 23 Jun 2021 19:33:55 GMT", + "shareCode": "1234" + } + }, + "status": "complete", + "id": "7097e53a-ba29-48a2-983d-878433b4f33e" + } + }, + "Aadhaar1": { + "title": "Aadhaar1", + "required": [ + "address", + "dateOfBirth", + "email", + "gender", + "generatedAt", + "maskedNumber", + "name", + "phone", + "photo", + "verified", + "xml" + ], + "type": "object", + "properties": { + "address": { + "$ref": "#/components/schemas/Address" + }, + "dateOfBirth": { + "type": "string" + }, + "email": { + "type": "string" + }, + "gender": { + "type": "string" + }, + "generatedAt": { + "type": "string" + }, + "maskedNumber": { + "type": "string" + }, + "name": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "photo": { + "type": "string" + }, + "verified": { + "$ref": "#/components/schemas/Verified" + }, + "xml": { + "$ref": "#/components/schemas/Xml1" + } + }, + "example": { + "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://setus3linkgoeshere.com/", + "validUntil": "Wed, 23 Jun 2021 19:33:55 GMT", + "shareCode": "1234" + } + } + }, + "Xml1": { + "title": "Xml1", + "required": ["fileUrl", "validUntil", "shareCode"], + "type": "object", + "properties": { + "fileUrl": { + "type": "string" + }, + "validUntil": { + "type": "string" + }, + "shareCode": { + "type": "string" + } + }, + "example": { + "fileUrl": "https://setus3linkgoeshere.com/", + "validUntil": "Wed, 23 Jun 2021 19:33:55 GMT", + "shareCode": "1234" + } + }, + "Withoutasharecode": { + "title": "Withoutasharecode", + "required": ["aadhaar", "status", "id"], + "type": "object", + "properties": { + "aadhaar": { + "$ref": "#/components/schemas/Aadhaar2" + }, + "status": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "example": { + "aadhaar": { + "xml": { + "fileUrl": "https://setus3linkgoeshere.com/", + "validUntil": "Wed, 23 Jun 2021 19:33:55 GMT" + } + }, + "status": "complete", + "id": "7097e53a-ba29-48a2-983d-878433b4f33e" + } + }, + "Aadhaar2": { + "title": "Aadhaar2", + "required": ["xml"], + "type": "object", + "properties": { + "xml": { + "$ref": "#/components/schemas/Xml2" + } + }, + "example": { + "xml": { + "fileUrl": "https://setus3linkgoeshere.com/", + "validUntil": "Wed, 23 Jun 2021 19:33:55 GMT" + } + } + }, + "Xml2": { + "title": "Xml2", + "required": ["fileUrl", "validUntil"], + "type": "object", + "properties": { + "fileUrl": { + "type": "string" + }, + "validUntil": { + "type": "string" + } + }, + "example": { + "fileUrl": "https://setus3linkgoeshere.com/", + "validUntil": "Wed, 23 Jun 2021 19:33:55 GMT" + } + }, + "Incompleterequest": { + "title": "Incompleterequest", + "required": ["url", "id", "validUpto", "status"], + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "validUpto": { + "type": "string" + }, + "status": { + "type": "string" + } + }, + "example": { + "url": "https://setuOKYCURL.co/foobar&someId=uuid", + "id": "7097e53a-ba29-48a2-983d-878433b4f33e", + "validUpto": "Wed, 23 Jun 2021 19:33:55 GMT", + "status": "incomplete" + } + }, + "Upstreamservicedown1": { + "title": "Upstreamservicedown1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error14" + } + }, + "example": { + "error": { + "code": "internal_server_error", + "detail": "Upstream service error", + "traceID": "" + } + } + }, + "CreateaDigilockerRequestRequest": { + "title": "CreateaDigilockerRequestRequest", + "required": ["redirectUrl"], + "type": "object", + "properties": { + "redirectUrl": { + "type": "string" + } + }, + "example": { + "redirectUrl": "https://setu.co" + } + }, + "InvalidredirectURL1": { + "title": "InvalidredirectURL1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "invalid_redirect_url", + "detail": "Please enter a valid redirect URL.", + "traceId": "" + } + } + }, + "FetchadocumentRequest": { + "title": "FetchadocumentRequest", + "required": ["docType", "format", "consent"], + "type": "object", + "properties": { + "docType": { + "type": "string" + }, + "format": { + "type": "string" + }, + "consent": { + "type": "string" + } + }, + "example": { + "docType": "ADHAR", + "format": "pdf", + "consent": "Y" + } + }, + "Consentnotgiven1": { + "title": "Consentnotgiven1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "consent_not_given", + "detail": "Only accepted value for consent is 'Y'", + "traceId": "" + } + } + }, + "Successfetchadocument": { + "title": "Successfetchadocument", + "required": ["fileUrl", "validUpto"], + "type": "object", + "properties": { + "fileUrl": { + "type": "string" + }, + "validUpto": { + "type": "string" + } + }, + "example": { + "fileUrl": "s3_url of the file to be downloaded", + "validUpto": "2021-09-21T09:12:12+05:30" + } + }, + "Tokenrevoked1": { + "title": "Tokenrevoked1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "token_revoked", + "detail": "The user has revoked the token for the given request.", + "traceId": "" + } + } + }, + "Success5": { + "title": "Success5", + "required": ["aadhaar", "id", "status"], + "type": "object", + "properties": { + "aadhaar": { + "$ref": "#/components/schemas/Aadhaar1" + }, + "id": { + "type": "string" + }, + "status": { + "type": "string" + } + }, + "example": { + "aadhaar": { + "address": { + "careOf": "S/O John Doe", + "country": "India", + "district": "district", + "house": "house address", + "landmark": "", + "locality": "locality", + "pin": "123456", + "postOffice": "", + "state": "state", + "street": "", + "subDistrict": "", + "vtc": "vtc" + }, + "dateOfBirth": "01-01-1990", + "email": "", + "gender": "M", + "generatedAt": "2021-10-26T17:17:36.342+05:30", + "maskedNumber": "xxxx-xxxx-1234", + "name": "Jack Doe", + "phone": "", + "photo": "", + "verified": { + "email": false, + "phone": false, + "signature": true + }, + "xml": { + "fileUrl": "https://s3linkgoeshere.com", + "shareCode": "", + "validUntil": "2021-10-09T06:04:16+05:30" + } + }, + "id": "391a45be-d08d-4dd0-b8a8-06e53392d435", + "status": "complete" + } + }, + "Success6": { + "title": "Success6", + "required": ["documents"], + "type": "object", + "properties": { + "documents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document1" + }, + "description": "" + } + }, + "example": { + "documents": [ + { + "availableFormats": ["pdf"], + "description": "Pension Certificate", + "docType": "PECER", + "orgId": "002317", + "orgName": "Accountants General, Tripura", + "parameters": [ + { + "description": "Account No./PPO No.", + "name": "AC_NO" + } + ] + }, + { + "availableFormats": ["pdf"], + "description": "Provident Fund Member Passbook", + "docType": "PRFND", + "orgId": "002317", + "orgName": "Accountants General, Tripura", + "parameters": [ + { + "description": "Account No./PPO No.", + "name": "AC_NO" + } + ] + } + ] + } + }, + "Document1": { + "title": "Document1", + "required": [ + "availableFormats", + "description", + "docType", + "orgId", + "orgName", + "parameters" + ], + "type": "object", + "properties": { + "availableFormats": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "description": { + "type": "string" + }, + "docType": { + "type": "string" + }, + "orgId": { + "type": "string" + }, + "orgName": { + "type": "string" + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Parameters4" + }, + "description": "" + } + }, + "example": { + "availableFormats": ["pdf"], + "description": "Pension Certificate", + "docType": "PECER", + "orgId": "002317", + "orgName": "Accountants General, Tripura", + "parameters": [ + { + "description": "Account No./PPO No.", + "name": "AC_NO" + } + ] + } + }, + "Parameters4": { + "title": "Parameters4", + "required": ["description", "name"], + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "example": { + "description": "Account No./PPO No.", + "name": "AC_NO" + } + }, + "success7": { + "title": "success7", + "required": ["success"], + "type": "object", + "properties": { + "success": { + "type": "boolean" + } + }, + "example": { + "success": true + } + }, + "VerifyPANRequest": { + "title": "VerifyPANRequest", + "required": ["pan", "consent", "reason"], + "type": "object", + "properties": { + "pan": { + "type": "string" + }, + "consent": { + "type": "string" + }, + "reason": { + "type": "string" + } + }, + "example": { + "pan": "ABCDE1234A", + "consent": "Y", + "reason": "Reason for verifying PAN set by the developer" + } + }, + "Success-ValidPAN": { + "title": "Success-ValidPAN", + "required": ["data", "message", "verification", "traceID"], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Data" + }, + "message": { + "type": "string" + }, + "verification": { + "type": "string" + }, + "traceID": { + "type": "string" + } + }, + "example": { + "data": { + "aadhaar_seeding_status": "LINKED", + "category": "Individual", + "full_name": "John Doe" + }, + "message": "PAN is valid", + "verification": "SUCCESS", + "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" + } + }, + "Data": { + "title": "Data", + "required": ["category", "full_name"], + "type": "object", + "properties": { + "aadhaar_seeding_status": { + "type": "string" + }, + "category": { + "type": "string" + }, + "full_name": { + "type": "string" + } + }, + "example": { + "category": "Individual", + "full_name": "John Doe" + } + }, + "Success-InvalidPAN": { + "title": "Success-InvalidPAN", + "required": ["verification", "message"], + "type": "object", + "properties": { + "verification": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "example": { + "verification": "failed", + "message": "PAN is invalid" + } + }, + "Failure-ConsentNotGiven1": { + "title": "Failure-ConsentNotGiven1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "consent_not_given", + "detail": "Consent is required and should be Y/y.", + "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" + } + } + }, + "Failure-InsufficientReasonLength1": { + "title": "Failure-InsufficientReasonLength1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "insufficient_reason_length", + "detail": "Reason should be at least 20 characters in length.", + "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" + } + } + }, + "Failure-InternalServerError1": { + "title": "Failure-InternalServerError1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "internal_server_error", + "detail": "Internal Server Error. Please reach out to support along with the traceId.", + "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" + } + } + }, + "VerifyBANRequest": { + "title": "VerifyBANRequest", + "required": ["ifsc", "accountNumber"], + "type": "object", + "properties": { + "ifsc": { + "type": "string" + }, + "accountNumber": { + "type": "string" + } + }, + "example": { + "ifsc": "ABCD0123456", + "accountNumber": "1234567890" + } + }, + "Failedverification": { + "title": "Failedverification", + "required": ["verification", "message"], + "type": "object", + "properties": { + "verification": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "example": { + "verification": "failed", + "message": "This account does not exist or is invalid." + } + }, + "InvalidIFSCBANformat": { + "title": "InvalidIFSCBANformat", + "required": ["verification", "message"], + "type": "object", + "properties": { + "verification": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "example": { + "verification": "failed", + "message": "Either IFSC or bank account is invalid" + } + }, + "Successfulverification": { + "title": "Successfulverification", + "required": ["data", "message", "verification"], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Data1" + }, + "message": { + "type": "string" + }, + "verification": { + "type": "string" + } + }, + "example": { + "data": { + "aadhaar_seeding_status": "LINKED", + "name": "Kumar Gaurav Rathod", + "transactionReference": "120716373986" + }, + "message": "Account exists and is active.", + "verification": "SUCCESS", + "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" + } + }, + "Data1": { + "title": "Data1", + "required": ["name", "transactionReference"], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "transactionReference": { + "type": "string" + } + }, + "example": { + "name": "Kumar Gaurav Rathod", + "transactionReference": "120716373986" + } + }, + "VerifyBANAsyncRequest": { + "title": "VerifyBANAsyncRequest", + "required": ["ifsc", "accountNumber", "narration"], + "type": "object", + "properties": { + "ifsc": { + "type": "string" + }, + "accountNumber": { + "type": "string" + }, + "narration": { + "type": "string" + } + }, + "example": { + "ifsc": "ABCD0123456", + "accountNumber": "1234567890", + "narration": "test transaction for verification" + } + }, + "Requestcreatedsuccessfully": { + "title": "Requestcreatedsuccessfully", + "required": ["id"], + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "example": { + "id": "02c2dc4c-1015-4ea0-8ec4-987829fc70cc" + } + }, + "BAVrequestnotcomplete": { + "title": "BAVrequestnotcomplete", + "required": ["verification"], + "type": "object", + "properties": { + "verification": { + "type": "string" + } + }, + "example": { + "verification": "pending" + } + }, + "Invalidtransaction": { + "title": "Invalidtransaction", + "required": ["verification", "message"], + "type": "object", + "properties": { + "verification": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "example": { + "verification": "failed", + "message": "This transaction is not valid for this account." + } + }, + "Transactionlimit": { + "title": "Transactionlimit", + "required": ["verification", "message"], + "type": "object", + "properties": { + "verification": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "example": { + "verification": "failed", + "message": "The transaction limit for this account may have been reached." + } + } + }, + "securitySchemes": { + "bearer": { + "type": "http", + "scheme": "bearer" + } + } + }, + "security": [ + { + "bearer": [] + } + ] +} diff --git a/content/data/epfo/api-reference.mdx b/content/data/epfo/api-reference.mdx new file mode 100644 index 00000000..fc333657 --- /dev/null +++ b/content/data/epfo/api-reference.mdx @@ -0,0 +1,6 @@ +--- +sidebar_title: API reference +page_title: EPFO API reference +order: 1 +visible_in_sidebar: true +--- diff --git a/content/data/epfo/quickstart.mdx b/content/data/epfo/quickstart.mdx new file mode 100644 index 00000000..ae63b0be --- /dev/null +++ b/content/data/epfo/quickstart.mdx @@ -0,0 +1,153 @@ +--- +sidebar_title: Quickstart +page_title: EPFO quickstart +order: 0 +visible_in_sidebar: true +--- + +## EPFO + +### What is EPFO? + +The Employees’ Provident Fund Organisation (EPFO) is a statutory body under the Ministry of Labour and Employment, Government of India. It regulates and manages provident funds, pensions, and insurance schemes for employees across India. + +EPFO also oversees social security agreements with countries that have bilateral arrangements with India, ensuring international workers are covered under the EPFO plans. + +Read more about EPFO and the various documents supported here. + +
+ +### What can I do with this product? + +Fetch the Universal Account Number (UAN) of a user by providing their contact number. + +Fetch the user's personal and employment details by providing the UAN number. + +This API documentation provides details for integrating UAN-related functionalities into your application, enabling efficient management of employee provident fund details. + + +Here’s a quick overview of the EPFO 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` + +
+ +### UAN Lookup + +Call this API to fetch the user's UAN. Pass the below parameter in the request— + +- `mobileNumber` is the user's mobile number. This should be registered with the EPFO. + + + +

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

+
+
Request
+ + {`POST /api/epf/uanLookup +{ + "mobileNumber": "9555xxxxxx" +} `} + +
+
Response
+ + {`{ + "data": { + "uan":"123456789012" + }, + "requestId": "uuid", + "statusCode": 200, + "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" +} `} + + + ), + } + ]} +/> + +
+ + +### Fetch UAN Details + +Call this API to fetch the user's employment details using their UAN. Pass the below parameter in the request— + +- `uan` is the user's UAN. + + +

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

+
+
Request
+ + {`POST /api/epf/uanDetails +{ + "uan": "123456789012" +} `} + +
+
Response
+ + {`{ + "data":{ + "uan": "123456789012", + "employers": [ + { + "startMonthYear": "12-JUN-2022", + "lastMonthYear": "", + "establishmentId": "", + "establishmentName": "", + "memberId": "" } + ], + "personalDetails": { + "name": "Walter White", + "fatherOrHusbandName": "", + "aadhaarVerificationStatus": "-1", + "contactNo": "" + }, + "summary": { + "minimumWorkExperienceInMonths": 33, + "lastEmployer": { + "employerName": "A1A PRIVATE LIMITED", + "startMonthYear": "12-JUN-2022", + "lastMonthYear": "12-JUN-2022", + "vintageInMonths": 33 + } + } + }, + "requestId": "uuid", + "statusCode": 200, + "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" +} `} + + + ), + } + ]} +/> +
+ \ No newline at end of file From bc13fe1ec515061e7f39caf8329b13dfa65ce829 Mon Sep 17 00:00:00 2001 From: VarunSonava Date: Tue, 4 Mar 2025 10:02:33 +0200 Subject: [PATCH 2/4] New epfo doc: Removed unnecessary components from epfo.json --- api-references/data/epfo.json | 3380 +++++---------------------------- 1 file changed, 517 insertions(+), 2863 deletions(-) diff --git a/api-references/data/epfo.json b/api-references/data/epfo.json index d34a2c71..e15dad35 100644 --- a/api-references/data/epfo.json +++ b/api-references/data/epfo.json @@ -1,2879 +1,533 @@ { "openapi": "3.0.0", "info": { - "title": "Data Gateway - EPFO APIs", - "description": "Build the data flow you need for background verifications.\n\n[See on Setu docs](https://docs.setu.co/data)\n\n\n**EPF APIs**\nFetch UAN by user's mobile number and EPF details of the user by UAN", - "contact": {}, - "version": "1.0" - }, + "title": "Data Gateway - EPFO APIs", + "description": "Build the data flow you need for background verifications.\n\n[See on Setu docs](https://docs.setu.co/data)\n\n\n**EPF APIs**\nFetch UAN by user's mobile number and EPF details of the user by UAN", + "contact": {}, + "version": "1.0" + }, "servers": [ - { - "url": "https://dg-sandbox.setu.co", - "description": "Sandbox" - }, - { - "url": "https://dg.setu.co", - "description": "Production" - } + { + "url": "https://dg-sandbox.setu.co", + "description": "Sandbox" + }, + { + "url": "https://dg.setu.co", + "description": "Production" + } ], "paths": { - "/api/epf/uanLookup": { - "post": { - "summary": "UAN Lookup", - "operationId": "UANLookup", - "parameters": [ - { - "name": "x-client-id", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "test-client" - } - }, - { - "name": "x-client-secret", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "891707ee-d6cd-4744-a28d-058829e30f12" - } - }, - { - "name": "x-product-instance-id", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "891707ee-d6cd-4744-a28d-058829e30f10" - } - } + "/api/epf/uanLookup": { + "post": { + "tags": [ + "EPF" ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UANLookup" - }, - "example": { - "mobileNumber": "9555xxxxxx" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "headers": {}, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SuccessLookup-ValidMobile" - }, - "example": { - "data": { - "uan":"123456789012" - }, - "requestId": "uuid", - "statusCode": 200, - "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "headers": {}, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Failure-InternalServerError1" - }, - "example": { - "error": { - "code": "internal_server_error", - "detail": "Internal Server Error. Please reach out to support along with the traceId.", - "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" - } - } - } - } - } - }, - "deprecated": false, - "security": [] - } - }, - "/api/epf/uanDetails":{ - "post": { - "summary": "UAN Details", - "operationId": "UANDetails", - "parameters": [ - { - "name": "x-client-id", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "test-client" - } - }, - { - "name": "x-client-secret", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "891707ee-d6cd-4744-a28d-058829e30f12" - } - }, - { - "name": "x-product-instance-id", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "891707ee-d6cd-4744-a28d-058829e30f10" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UANDetails" - }, - "example": { - "uan": "123456789012" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "headers": {}, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SuccessDetails-ValidUAN" - }, - "example": { - "data": { - "uan": "123456789012", - "employers": [ - { - "startMonthYear": "12-JUN-2022", - "lastMonthYear": "", - "establishmentId": "", - "establishmentName": "", - "memberId": "" } - ], - "personalDetails": { - "name": "Walter White", - "fatherOrHusbandName": "", - "aadhaarVerificationStatus": "-1", - "contactNo": "" - }, - "summary": { - "minimumWorkExperienceInMonths": 33, - "lastEmployer": { - "employerName": "A1A PRIVATE LIMITED", - "startMonthYear": "12-JUN-2022", - "lastMonthYear": "12-JUN-2022", - "vintageInMonths": 33 - } - } + "summary": "UAN Lookup", + "operationId": "UANLookup", + "parameters": [ + { + "name": "x-client-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{x-client-id}}" + } + }, + { + "name": "x-client-secret", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{x-client-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": { + "$ref": "#/components/schemas/UANLookup" + }, + "example": { + "mobileNumber": "9555xxxxxx" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SuccessLookup-ValidMobile" + }, + "example": { + "data": { + "uan":"123456789012" + }, + "requestId": "e347e79b-dddc-49c1-b266-afb2c44843e8", + "statusCode": 200, + "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Failure-InternalServerError1" + }, + "example": { + "error": { + "code": "internal_server_error", + "detail": "Internal Server Error. Please reach out to support along with the traceId.", + "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" + } + } + } + } + } + }, + "deprecated": false, + "security": [] + } + }, + "/api/epf/uanDetails":{ + "post": { + "tags": [ + "EPF" + ], + "summary": "UAN Details", + "operationId": "UANDetails", + "parameters": [ + { + "name": "x-client-id", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{x-client-id}}" + } + }, + { + "name": "x-client-secret", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{{x-client-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": { + "$ref": "#/components/schemas/UANDetails" + }, + "example": { + "uan": "123456789012" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SuccessDetails-ValidUAN" + }, + "example": { + "data": { + "uan": "123456789012", + "employers": [ + { + "startMonthYear": "12-JUN-2022", + "lastMonthYear": "", + "establishmentId": "", + "establishmentName": "", + "memberId": "" } + ], + "personalDetails": { + "name": "Walter White", + "fatherOrHusbandName": "", + "aadhaarVerificationStatus": "-1", + "contactNo": "" }, - "requestId": "uuid", - "statusCode": 200 - }, - "requestId": "uuid", - "statusCode": 200, - "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "headers": {}, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Failure-InternalServerError1" - }, - "example": { - "error": { - "code": "internal_server_error", - "detail": "Internal Server Error. Please reach out to support along with the traceId.", - "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" - } - } - } - } - } - }, - "deprecated": false, - "security": [] - } - }, + "summary": { + "minimumWorkExperienceInMonths": 33, + "lastEmployer": { + "employerName": "A1A PRIVATE LIMITED", + "startMonthYear": "12-JUN-2022", + "lastMonthYear": "12-JUN-2022", + "vintageInMonths": 33 + } + } + }, + "requestId": "e347e79b-dddc-49c1-b266-afb2c44843e8", + "statusCode": 200 + }, + "requestId": "e347e79b-dddc-49c1-b266-afb2c44843e8", + "statusCode": 200, + "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" + } + } + } + }, + "500": { + "description": "Internal Server Error", + "headers": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Failure-InternalServerError1" + }, + "example": { + "error": { + "code": "internal_server_error", + "detail": "Internal Server Error. Please reach out to support along with the traceId.", + "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" + } + } + } + } + } + } + } + }, "components": { - "schemas": { - "parameters": { - "title": "parameters", - "required": [ - "name", - "fundraiser", - "beneficiaryName", - "beneficiaryRelationship", - "date", - "amount", - "account", - "accountHolderRelationship" - ], - "type": "object", - "properties": { - "name": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "" - }, - "fundraiser": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "" - }, - "beneficiaryName": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "" - }, - "beneficiaryRelationship": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "" - }, - "date": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "" - }, - "amount": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "" - }, - "account": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "" - }, - "accountHolderRelationship": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "" - } - }, - "example": { - "name": [100, 590], - "fundraiser": [100, 565], - "beneficiaryName": [210, 540], - "beneficiaryRelationship": [250, 515], - "date": [90, 487], - "amount": [350, 487], - "account": [410, 462], - "accountHolderRelationship": [270, 437] - } - }, - "UANLookup":{ - "title": "UANLookup", - "required": ["mobileNumber"], - "type": "object", - "properties": { - "mobileNumber": { - "type": "string" - } - }, - "example": { - "mobileNumber": "9555xxxxxx" - } - }, - "SuccessLookup-ValidMobile":{ - "title": "SuccessLookup-ValidMobile", - "required": ["data", "requestId", "statusCode", "traceId"], - "type": "object", - "properties": { - "data": { - "type": "object", - "properties": { - "uan": { - "type": "string" - } - }, - "required": ["uan"] - }, - "requestId": { - "type": "string" - }, - "statusCode": { - "type": "string" - }, - "traceId": { - "type": "string" - } - }, - "example": { - "data": { - "uan":"123456789012" - }, - "requestId": "uuid", - "statusCode": "200", - "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" - } - }, - "UANDetails":{ - "title": "UANDetails", - "required": ["uan"], - "type": "object", - "properties": { - "uan": { - "type": "string" - } - }, - "example": { - "uan": "123456789012" - } - }, - "SuccessDetails-ValidUAN":{ - "title": "SuccessDetails-ValidUAN", - "required": ["data", "requestId", "statusCode", "traceId"], - "type": "object", - "properties": { - "data": { - "$ref":"#/components/schemas/UANdata" - }, - "requestId": { - "type": "string" - }, - "statusCode": { - "type": "string" - }, - "traceId": { - "type": "string" - } - }, - "example": { - "data": { - "uan": "123456789012", - "employers": [ - { - "startMonthYear": "12-JUN-2022", - "lastMonthYear": "", - "establishmentId": "", - "establishmentName": "", - "memberId": "" } - ], - "personalDetails": { - "name": "Walter White", - "fatherOrHusbandName": "", - "aadhaarVerificationStatus": "-1", - "contactNo": "" - }, - "summary": { - "minimumWorkExperienceInMonths": 33, - "lastEmployer": { - "employerName": "A1A PRIVATE LIMITED", - "startMonthYear": "12-JUN-2022", - "lastMonthYear": "12-JUN-2022", - "vintageInMonths": 33 - } - } - }, - "requestId": "uuid", - "statusCode": "200", - "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" - } - }, - "UANdata": { - "title": "UANdata", - "type": "object", - "required": ["uan", "employers", "personalDetails", "summary"], - "properties": { - "uan": { - "type": "string" - }, - "employers": { - "type": "array", - "items": { - "type": "object", - "required": ["startMonthYear", "lastMonthYear", "establishmentId", "establishmentName", "memberId"], - "properties": { - "startMonthYear": { - "type": "string" - }, - "lastMonthYear": { - "type": "string" - }, - "establishmentId": { - "type": "string" - }, - "establishmentName": { - "type": "string" - }, - "memberId": { - "type": "string" - } - } - } - }, - "personalDetails": { - "type": "object", - "required": ["name", "fatherOrHusbandName", "aadhaarVerificationStatus", "contactNo"], - "properties": { - "name": { - "type": "string" - }, - "fatherOrHusbandName": { - "type": "string" - }, - "aadhaarVerificationStatus": { - "type": "string" - }, - "contactNo": { - "type": "string" - } - } - }, - "summary": { - "type": "object", - "required": ["minimumWorkExperienceInMonths", "lastEmployer"], - "properties": { - "minimumWorkExperienceInMonths": { - "type": "number" - }, - "lastEmployer": { - "type": "object", - "required": ["employerName", "startMonthYear", "lastMonthYear", "vintageInMonths"], - "properties": { - "employerName": { - "type": "string" - }, - "startMonthYear": { - "type": "string" - }, - "lastMonthYear": { - "type": "string" - }, - "vintageInMonths": { - "type": "number" - } - } - } - } - } - }, - "example": { - "uan": "123456789012", - "employers": [ - { - "startMonthYear": "12-JUN-2022", - "lastMonthYear": "", - "establishmentId": "", - "establishmentName": "", - "memberId": "" - } - ], - "personalDetails": { - "name": "Walter White", - "fatherOrHusbandName": "", - "aadhaarVerificationStatus": "-1", - "contactNo": "" - }, - "summary": { - "minimumWorkExperienceInMonths": 33, - "lastEmployer": { - "employerName": "A1A PRIVATE LIMITED", - "startMonthYear": "12-JUN-2022", - "lastMonthYear": "12-JUN-2022", - "vintageInMonths": 33 - } - } - } - }, - "UploadeSigndocumenttemplate": { - "title": "UploadeSigndocumenttemplate", - "required": ["downloadUrl", "id", "parameters"], - "type": "object", - "properties": { - "downloadUrl": { - "type": "string" - }, - "id": { - "type": "string" - }, - "parameters": { - "$ref": "#/components/schemas/parameters" - } - }, - "example": { - "downloadUrl": "https://s3-link-goes-here.com", - "id": "6ff6abc2-3306-4133-885a-245d5d9f69dc", - "parameters": { - "account": [410, 462], - "accountHolderRelationship": [270, 437], - "amount": [350, 487], - "beneficiaryName": [210, 540], - "beneficiaryRelationship": [250, 515], - "date": [90, 487], - "fundraiser": [100, 565], - "name": [100, 590] - } - } - }, - "RendereSigndocumenttemplateRequest": { - "title": "RendereSigndocumenttemplateRequest", - "required": ["name", "parameters"], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "parameters": { - "$ref": "#/components/schemas/Parameters2" - } - }, - "example": { - "name": "random name", - "parameters": { - "name": "your name", - "fundraiser": "fundraiser name", - "beneficiaryName": "beneficiary name", - "beneficiaryRelationship": "beneficiary relationship", - "date": "15/12/2021", - "amount": "25,000", - "account": "123456789", - "accountHolderRelationship": "account holder relationship" - } - } - }, - "Parameters2": { - "title": "Parameters2", - "required": [ - "name", - "fundraiser", - "beneficiaryName", - "beneficiaryRelationship", - "date", - "amount", - "account", - "accountHolderRelationship" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "fundraiser": { - "type": "string" - }, - "beneficiaryName": { - "type": "string" - }, - "beneficiaryRelationship": { - "type": "string" - }, - "date": { - "type": "string" - }, - "amount": { - "type": "string" - }, - "account": { - "type": "string" - }, - "accountHolderRelationship": { - "type": "string" - } - }, - "example": { - "name": "your name", - "fundraiser": "fundraiser name", - "beneficiaryName": "beneficiary name", - "beneficiaryRelationship": "beneficiary relationship", - "date": "15/12/2021", - "amount": "25,000", - "account": "123456789", - "accountHolderRelationship": "account holder relationship" - } - }, - "RendereSigndocumenttemplate": { - "title": "RendereSigndocumenttemplate", - "required": ["documentType", "downloadUrl", "id", "name"], - "type": "object", - "properties": { - "documentType": { - "type": "string" - }, - "downloadUrl": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "example": { - "documentType": "application/pdf", - "downloadUrl": "https://s3-link-goes-here.com", - "id": "d784d36c-88c8-4670-b320-d164cad73d8c", - "name": "random name" - } - }, - "GetTemplate": { - "title": "GetTemplate", - "required": ["downloadUrl", "id", "parameters"], - "type": "object", - "properties": { - "downloadUrl": { - "type": "string" - }, - "id": { - "type": "string" - }, - "parameters": { - "$ref": "#/components/schemas/parameters" - } - }, - "example": { - "downloadUrl": "https://s3-link-goes-here.com", - "id": "6ff6abc2-3306-4133-885a-245d5d9f69dc", - "parameters": { - "account": [410, 462], - "accountHolderRelationship": [270, 437], - "amount": [350, 487], - "beneficiaryName": [210, 540], - "beneficiaryRelationship": [250, 515], - "date": [90, 487], - "fundraiser": [100, 565], - "name": [100, 590] - } - } - }, - "Thedocumentwassuccessfullyuploaded": { - "title": "Thedocumentwassuccessfullyuploaded", - "required": ["id", "name"], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "example": { - "id": "67e0ca30-49e4-4883-86f9-3762f0e6798c", - "name": "sample.pdf" - } - }, - "CreateSignatureRequestRequest": { - "title": "CreateSignatureRequestRequest", - "required": ["documentId", "redirectUrl", "signers"], - "type": "object", - "properties": { - "documentId": { - "type": "string" - }, - "redirectUrl": { - "type": "string" - }, - "signers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Signer" - }, - "description": "" - } - }, - "example": { - "documentId": "{{document_id}}", - "redirectUrl": "http://setu.co", - "signers": [ - { - "identifier": "9876543210", - "displayName": "Ian Fernandes", - "signature": { - "height": 60, - "onPages": ["1"], - "position": "bottom-left", - "width": 180 - } - } - ] - } - }, - "Signer": { - "title": "Signer", - "required": ["identifier", "displayName", "signature"], - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - }, - "example": { - "identifier": "9876543210", - "displayName": "Ian Fernandes", - "signature": { - "height": 60, - "onPages": ["1"], - "position": "bottom-left", - "width": 180 - } - } - }, - "Signature": { - "title": "Signature", - "required": ["height", "onPages", "position", "width"], - "type": "object", - "properties": { - "height": { - "type": "integer", - "format": "int32" - }, - "onPages": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "position": { - "type": "string" - }, - "width": { - "type": "integer", - "format": "int32" - } - }, - "example": { - "height": 60, - "onPages": ["1"], - "position": "bottom-left", - "width": 180 - } - }, - "Success": { - "title": "Success", - "required": [ - "documentId", - "id", - "redirectUrl", - "signers", - "status" - ], - "type": "object", - "properties": { - "documentId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "redirectUrl": { - "type": "string" - }, - "signers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Signer1" - }, - "description": "" - }, - "status": { - "type": "string" - } - }, - "example": { - "documentId": "91fba655-95d3-4ffd-a47f-5e122024b00c", - "id": "6bae9d1f-0fa6-44e5-a801-3ad4a5f10a12", - "redirectUrl": "http://setu.co", - "signers": [ - { - "displayName": "Akshay P", - "id": "34f94af1-a8b9-4797-b287-c5ef7bff99a1", - "identifier": "9876543210", - "signatureDetails": null, - "status": "pending", - "url": "https://dg-uat.setu.co/signature/preview?requestId=6bae9d1f-0fa6-44e5-a801-3ad4a5f10a12&signerId=34f94af1-a8b9-4797-b287-c5ef7bff99a1" - } - ], - "status": "sign_initiated" - } - }, - "Signer1": { - "title": "Signer1", - "required": [ - "displayName", - "id", - "identifier", - "signatureDetails", - "status", - "url" - ], - "type": "object", - "properties": { - "displayName": { - "type": "string" - }, - "id": { - "type": "string" - }, - "identifier": { - "type": "string" - }, - "signatureDetails": { - "type": "string", - "nullable": true - }, - "status": { - "type": "string" - }, - "url": { - "type": "string" - } - }, - "example": { - "displayName": "Akshay P", - "id": "34f94af1-a8b9-4797-b287-c5ef7bff99a1", - "identifier": "9876543210", - "signatureDetails": null, - "status": "pending", - "url": "https://dg-uat.setu.co/signature/preview?requestId=6bae9d1f-0fa6-44e5-a801-3ad4a5f10a12&signerId=34f94af1-a8b9-4797-b287-c5ef7bff99a1" - } - }, - "Error": { - "title": "Error", - "required": ["code", "detail", "traceId"], - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "detail": { - "type": "string" - }, - "traceId": { - "type": "string" - } - }, - "example": { - "code": "invalid_document", - "detail": "The document Id is already being used in a signature", - "traceId": "" - } - }, - "Invaliddocument1": { - "title": "Invaliddocument1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "invalid_document", - "detail": "The document Id is already being used in a signature", - "traceId": "" - } - } - }, - "Invalidpayload1": { - "title": "Invalidpayload1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "invalid_payload", - "detail": "Invalid position value.", - "traceId": "" - } - } - }, - "Successpendingsign": { - "title": "Successpendingsign", - "required": [ - "documentId", - "id", - "redirectUrl", - "signers", - "status" - ], - "type": "object", - "properties": { - "documentId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "redirectUrl": { - "type": "string" - }, - "signers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Signer1" - }, - "description": "" - }, - "status": { - "type": "string" - } - }, - "example": { - "documentId": "50ce4004-2133-4b39-8c5f-6522714ae2d0", - "id": "5f2eedb3-ef0e-4ae9-831b-8ae208a31b9b", - "redirectUrl": "http://setu.co", - "signers": [ - { - "displayName": "Akshay P", - "id": "9d9e47f7-9c24-4587-8775-f01b17e6fc4d", - "identifier": "9876543210", - "signatureDetails": null, - "status": "pending", - "url": "https://dg-uat.setu.co/signature/preview?requestId=5f2eedb3-ef0e-4ae9-831b-8ae208a31b9b&signerId=9d9e47f7-9c24-4587-8775-f01b17e6fc4d" - } - ], - "status": "sign_initiated" - } - }, - "Successdocumentsigned": { - "title": "Successdocumentsigned", - "required": [ - "documentId", - "id", - "redirectUrl", - "signers", - "status" - ], - "type": "object", - "properties": { - "documentId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "redirectUrl": { - "type": "string" - }, - "signers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Signer3" - }, - "description": "" - }, - "status": { - "type": "string" - } - }, - "example": { - "documentId": "50ce4004-2133-4b39-8c5f-6522714ae2d0", - "id": "5f2eedb3-ef0e-4ae9-831b-8ae208a31b9b", - "redirectUrl": "http://setu.co", - "signers": [ - { - "displayName": "Akshay P", - "id": "9d9e47f7-9c24-4587-8775-f01b17e6fc4d", - "identifier": "9876543210", - "signatureDetails": { - "aadhaarName": "signer name as per aadhaar", - "aadhaarSuffix": "XXXX", - "birthYear": "1972", - "gender": "M", - "postalCode": "560001" - }, - "status": "signed", - "url": "https://dg-uat.setu.co/signature/preview?requestId=5f2eedb3-ef0e-4ae9-831b-8ae208a31b9b&signerId=9d9e47f7-9c24-4587-8775-f01b17e6fc4d" - } - ], - "status": "sign_complete" - } - }, - "Signer3": { - "title": "Signer3", - "required": [ - "displayName", - "id", - "identifier", - "signatureDetails", - "status", - "url" - ], - "type": "object", - "properties": { - "displayName": { - "type": "string" - }, - "id": { - "type": "string" - }, - "identifier": { - "type": "string" - }, - "signatureDetails": { - "$ref": "#/components/schemas/SignatureDetails" - }, - "status": { - "type": "string" - }, - "url": { - "type": "string" - } - }, - "example": { - "displayName": "Akshay P", - "id": "9d9e47f7-9c24-4587-8775-f01b17e6fc4d", - "identifier": "9876543210", - "signatureDetails": { - "aadhaarName": "signer name as per aadhaar", - "aadhaarSuffix": "XXXX", - "birthYear": "1972", - "gender": "M", - "postalCode": "560001" - }, - "status": "signed", - "url": "https://dg-uat.setu.co/signature/preview?requestId=5f2eedb3-ef0e-4ae9-831b-8ae208a31b9b&signerId=9d9e47f7-9c24-4587-8775-f01b17e6fc4d" - } - }, - "SignatureDetails": { - "title": "SignatureDetails", - "required": [ - "aadhaarName", - "aadhaarSuffix", - "birthYear", - "gender", - "postalCode" - ], - "type": "object", - "properties": { - "aadhaarName": { - "type": "string" - }, - "aadhaarSuffix": { - "type": "string" - }, - "birthYear": { - "type": "string" - }, - "gender": { - "type": "string" - }, - "postalCode": { - "type": "string" - } - }, - "example": { - "aadhaarName": "signer name as per aadhaar", - "aadhaarSuffix": "XXXX", - "birthYear": "1972", - "gender": "M", - "postalCode": "560001" - } - }, - "Signeddocumentdownloadurl": { - "title": "Signeddocumentdownloadurl", - "required": ["downloadUrl", "id", "validUpto"], - "type": "object", - "properties": { - "downloadUrl": { - "type": "string" - }, - "id": { - "type": "string" - }, - "validUpto": { - "type": "string" - } - }, - "example": { - "downloadUrl": "download_url_goes_here", - "id": "29e5a985-7d40-4b42-8260-9d9f4ef60aa1", - "validUpto": "2021-10-28T14:09:14+05:30" - } - }, - "SignatureRequestnotyetcompletedcancelleddeclined1": { - "title": "SignatureRequestnotyetcompletedcancelleddeclined1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "document_not_signed", - "detail": "Only signed documents can be downloaded.", - "traceId": "" - } - } - }, - "SignedDocumentdeletedDocumentnotfound1": { - "title": "SignedDocumentdeletedDocumentnotfound1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "signature_request_not_found", - "detail": "Signature Request Not Found.", - "traceId": "" - } - } - }, - "GetEsignAuditReport": { - "title": "GetEsignAuditReport", - "required": ["id", "document", "events"], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "document": { - "$ref": "#/components/schemas/Document" - }, - "events": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Event" - }, - "description": "" - } - }, - "example": { - "id": "805b326f-e38c-4908-8592-0d3c7200a6b4", - "document": { - "id": "c3eaecdd-db27-4d9b-b9bb-ed7f7771b1c6", - "name": "vaccine" - }, - "events": [ - { - "createdAt": "2021-11-22 11:43:39.161115", - "activity": "uploaded", - "initator": { - "name": "Test client", - "type": "apiClient", - "userAgent": "PostmanRuntime/7.28.4", - "IP": "223.179.144.102, 172.31.28.227" - }, - "metaData": {} - }, - { - "createdAt": "2021-11-22 11:44:32.468027", - "activity": "notified", - "initator": { - "name": "Test client", - "type": "apiClient", - "userAgent": "PostmanRuntime/7.28.4", - "IP": "223.179.144.102, 172.31.28.227" - }, - "metaData": { - "signers": [ - { - "identifier": "9876543210", - "displayName": "Akshay P" - }, - { - "identifier": "7042484922", - "displayName": "Rahul" - } - ] - } - }, - { - "createdAt": "2021-11-22 11:44:55.497584", - "activity": "opened", - "initator": { - "name": "Akshay P", - "type": "signer", - "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.69 Safari/537.36", - "IP": "172.31.42.133" - }, - "metaData": {} - }, - { - "createdAt": "2021-11-22 11:46:41.198454", - "activity": "signed", - "initator": { - "name": "Akshay P", - "type": "signer", - "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.69 Safari/537.36", - "IP": "172.31.4.118" - }, - "metaData": { - "signatureDetails": { - "gender": "M", - "issuer": "NSDL e-Governance Infrastructure Limited", - "birthYear": "1993", - "validFrom": "2021-11-22 11:50:47", - "validUpto": "2021-11-22 12:20:46", - "postalCode": "201300", - "aadhaarName": "Rahul Roy", - "serialNumber": "1784230000", - "aadhaarSuffix": "5340" - } - } - } - ] - } - }, - "Document": { - "title": "Document", - "required": ["id", "name"], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "example": { - "id": "c3eaecdd-db27-4d9b-b9bb-ed7f7771b1c6", - "name": "vaccine" - } - }, - "Event": { - "title": "Event", - "required": ["createdAt", "activity", "initator", "metaData"], - "type": "object", - "properties": { - "createdAt": { - "type": "string" - }, - "activity": { - "type": "string" - }, - "initator": { - "$ref": "#/components/schemas/Initator" - }, - "metaData": { - "$ref": "#/components/schemas/MetaData" - } - }, - "example": { - "createdAt": "2021-11-22 11:43:39.161115", - "activity": "uploaded", - "initator": { - "name": "Test client", - "type": "apiClient", - "userAgent": "PostmanRuntime/7.28.4", - "IP": "223.179.144.102, 172.31.28.227" - }, - "metaData": {} - } - }, - "Initator": { - "title": "Initator", - "required": ["name", "type", "userAgent", "IP"], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "userAgent": { - "type": "string" - }, - "IP": { - "type": "string" - } - }, - "example": { - "name": "Test client", - "type": "apiClient", - "userAgent": "PostmanRuntime/7.28.4", - "IP": "223.179.144.102, 172.31.28.227" - } - }, - "MetaData": { - "title": "MetaData", - "type": "object", - "properties": { - "signers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Signer4" - }, - "description": "" - }, - "signatureDetails": { - "$ref": "#/components/schemas/SignatureDetails1" - } - }, - "example": {} - }, - "Signer4": { - "title": "Signer4", - "required": ["identifier", "displayName"], - "type": "object", - "properties": { - "identifier": { - "type": "string" - }, - "displayName": { - "type": "string" - } - }, - "example": { - "identifier": "9876543210", - "displayName": "Akshay P" - } - }, - "SignatureDetails1": { - "title": "SignatureDetails1", - "required": [ - "gender", - "issuer", - "birthYear", - "validFrom", - "validUpto", - "postalCode", - "aadhaarName", - "serialNumber", - "aadhaarSuffix" - ], - "type": "object", - "properties": { - "gender": { - "type": "string" - }, - "issuer": { - "type": "string" - }, - "birthYear": { - "type": "string" - }, - "validFrom": { - "type": "string" - }, - "validUpto": { - "type": "string" - }, - "postalCode": { - "type": "string" - }, - "aadhaarName": { - "type": "string" - }, - "serialNumber": { - "type": "string" - }, - "aadhaarSuffix": { - "type": "string" - } - }, - "example": { - "gender": "M", - "issuer": "NSDL e-Governance Infrastructure Limited", - "birthYear": "1993", - "validFrom": "2021-11-22 11:50:47", - "validUpto": "2021-11-22 12:20:46", - "postalCode": "201300", - "aadhaarName": "Rahul Roy", - "serialNumber": "1784230000", - "aadhaarSuffix": "5340" - } - }, - "Downloaddocument": { - "title": "Downloaddocument", - "required": ["documentType", "downloadUrl", "id", "name"], - "type": "object", - "properties": { - "documentType": { - "type": "string" - }, - "downloadUrl": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "example": { - "documentType": "application/pdf", - "downloadUrl": "https://s3-link-goes-here.com", - "id": "d784d36c-88c8-4670-b320-d164cad73d8c", - "name": "random name" - } - }, - "CreateanOKYCRequestRequest": { - "title": "CreateanOKYCRequestRequest", - "required": ["redirectURL"], - "type": "object", - "properties": { - "redirectURL": { - "type": "string" - } - }, - "example": { - "redirectURL": "https://setu.co" - } - }, - "Success1": { - "title": "Success1", - "required": ["id", "url", "validUpto", "status"], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "validUpto": { - "type": "string" - }, - "status": { - "type": "string" - } - }, - "example": { - "id": "7097e53a-ba29-48a2-983d-878433b4f33e", - "url": "https://setuOKYCURL.co/foobar&sessionId=uuid", - "validUpto": "Wed, 23 Jun 2021 19:33:55 GMT", - "status": "incomplete" - } - }, - "Failure-BadRequest1": { - "title": "Failure-BadRequest1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "invalid_redirect_url", - "detail": "Please enter a valid redirect URL.", - "traceId": "" - } - } - }, - "InternalServerError1": { - "title": "InternalServerError1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "internal_server_error", - "detail": "Internal Server Error", - "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" - } - } - }, - "InitiateOKYCRequest": { - "title": "InitiateOKYCRequest", - "required": ["captchaImage", "requestId"], - "type": "object", - "properties": { - "captchaImage": { - "type": "string" - }, - "requestId": { - "type": "string" - } - }, - "example": { - "captchaImage": "base64-Image-data", - "requestId": "7097e53a-ba29-48a2-983d-878433b4f33e" - } - }, - "Success2": { - "title": "Success2", - "required": ["captchaImage", "captchaRetriesRemaining", "id"], - "type": "object", - "properties": { - "captchaImage": { - "type": "string" - }, - "captchaRetriesRemaining": { - "type": "integer", - "format": "int32" - }, - "id": { - "type": "string" - } - }, - "example": { - "captchaImage": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAAyAK8DASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD3+iiigAooooAKKKKACiiigAooooAKKKKACiiigAqrfalY6XAs+oXttaRM2wSXEqxqWwTjJI5wD+VWq+efEj6h8Qviu+hm5+zww3MlrArncsSxg72AAGWbYT+QzgAhpXJk7Hq0PxS8FzzxwpraBpGCgvBKigk45YqAB7k4FdVaXlrf2yXNncw3Nu+dksLh1bBwcEcHkEVwt38HfCk2kPa21vNb3flhUvfOd2DD+IqTtOe4AHU4xxjhvhXqWoeHviBceFZpfNt5ZJoZER/3azRgnzFyM8hCvbIIJ+6BTsnsLmaep7zRRRUlhRRRQAUUUUAFFFFABWNrnizQfDewatqUNs742x8u5Bzg7FBbHynnGM8Vs189W1snib47zW+qHzo/7RmBXauGWENsQjGCMRqp45Ge5zTSuNGn8Z9X0/W7Lw7eaZeQ3Vu32j54mztOIjhh1U4IyDgjPNdrf+ILvwt8FbHWrGOGS5ttOs9izqSh3eWpyAQejHvXB/Gnw/pmj3ukXOnWkNp9ojljkigjWNPkKkNhQOTvIJ9APSum8af8m6x/9g6w/wDQ4arsVFXkkcvYfG7xXq1gLbS/DsN7rIlaSQW9tLJGtuAoHyKxbduJycgAbRgk8e0+HtQl1bwzpWpTqizXdnDPIsYIUM6BiBkk4yfWvN/2fYIl8FajOIkEz6iyNIFG5lWOMqCepALNgdtx9a9apSteyKq8qfKkfN/7QP8AyPlj/wBgyP8A9Gy1u/8ADOf/AFNX/lP/APttYX7QP/I+WP8A2DI//Rstbv8Awzn/ANTV/wCU/wD+20+hz21PVvB3hz/hEvCllof2v7V9m3/vvL8vdudn+7k4xux17Vu1zz6hpPgDwdYLrOpJFa2UENp57IcysqhRtQZJJwTgZwAT0BNcL/w0R4R/6B2t/wDfiL/47U2bKvY9br581+O7+H3xeGt3ELy2c929zHJ5fEkcmfMVfm+8odhyRyFJGCK900XWtP8AEOkQarpVx9osp93ly7GTdtYqeGAI5BHSpb7TbHVIFg1CytruJW3iO4iWRQ2CM4IPOCfzoTsKSucTd/GLwpDpD3VtcTXF35YZLLyXRix/hLEbRjuQT0OM8Z4b4V6bqHiH4gXHiqaLyreKSaaR0T9200gI8tcnPAct3wAAfvA16TD8LfBcE8cyaIhaNgwDzyupIOeVLEEexGDXVWlna2FsltZ20NtbpnZFCgRVycnAHA5JNO6WwuVt6k1FFFSWFFFFABRRRQAUUUUAFeYeLPhbd33iceIvDt/b2l6ZknMM8eEWRefMBAOSSFJBU5JYk84r0+imnYDyDxP8LPE/iL7FeXevWl7qSxmOd5k8lEXgqqBEO7DGTLHGQV4FegxeGLS88EWfhzWoUuYEtIIJ0SRlV2jC9GGGxuUHtW9RRdjuZPh/w1pHhawksdFtPsttJKZmTzHfLkAE5Yk9FH5VrUUUhN33PN/iB8KP+E616DVP7a+w+Varb+X9l83OGZs53r/e6Y7Vyn/DOf8A1NX/AJT/AP7bXudFO7FZHlviD4UXd78KdO8I2GqQPc6fdG5SeeIxpLlpMg4LFcCU88529s5HJ6Drfjn4R+FVj1bwVavo0TndNBcIsplduHlZGcEY+TJUfwDPQH1zxn4Sh8Y6PDZPf3VhPbXAura5tiA0cyqwRj3IBbOAQeBgivOtR+B+uaxbrb6n8RtRvYFfesdzA8ihsEZAaYjOCefc00+4rdjvfh54i0bxN4Rt7vQ7FNPt43aKSyjjCLBLwzKMAAj5g2QOd3ODkDqqxPCnhbTvB2gRaPpgcwI7O0ku3zJGY5yxUAE4wM46KB2rbqWUFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQB/", - "captchaRetriesRemaining": 4, - "id": "0d209de1-77d1-4069-ad71-3f2cddf261f9" - } - }, - "Exceededcaptcharequests1": { - "title": "Exceededcaptcharequests1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "exceeded_captcha_requests", - "detail": "Exceeded captcha requests", - "traceId": "" - } - } - }, - "Error14": { - "title": "Error14", - "required": ["code", "detail", "traceID"], - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "detail": { - "type": "string" - }, - "traceID": { - "type": "string" - } - }, - "example": { - "code": "internal_server_error", - "detail": "Internal Server Error.", - "traceID": "" - } - }, - "Internalservererror3": { - "title": "Internalservererror3", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error14" - } - }, - "example": { - "error": { - "code": "internal_server_error", - "detail": "Internal Server Error.", - "traceID": "" - } - } - }, - "UpstreamServicesDown1": { - "title": "UpstreamServicesDown1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error14" - } - }, - "example": { - "error": { - "code": "internal_server_error", - "detail": "Upstream services are down", - "traceID": "" - } - } - }, - "APIonlyVerifyOKYCRequestRequest": { - "title": "APIonlyVerifyOKYCRequestRequest", - "required": ["aadhaarNumber", "captchaCode"], - "type": "object", - "properties": { - "aadhaarNumber": { - "type": "string" - }, - "captchaCode": { - "type": "string" - } - }, - "example": { - "aadhaarNumber": "999999990019", - "captchaCode": "2GAD0" - } - }, - "Success3": { - "title": "Success3", - "required": ["code", "message"], - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - } - }, - "example": { - "code": "otp_sent", - "message": "OTP sent to your registered mobile number." - } - }, - "Invalidcaptchaentered1": { - "title": "Invalidcaptchaentered1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "invalid_captcha_entered", - "detail": "Invalid captcha entered", - "traceId": "" - } - } - }, - "Invalidrequestorder": { - "title": "Invalidrequestorder", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "invalid_sequence", - "detail": "Invalid request order.", - "traceId": "" - } - } - }, - "RequestNotFound1": { - "title": "RequestNotFound1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "request_not_found", - "detail": "Request not found.", - "traceId": "" - } - } - }, - "APIonlyCompleteOKYCRequestRequest": { - "title": "APIonlyCompleteOKYCRequestRequest", - "required": ["otp", "shareCode"], - "type": "object", - "properties": { - "otp": { - "type": "string" - }, - "shareCode": { - "type": "string" - } - }, - "example": { - "otp": "123456", - "shareCode": "1234" - } - }, - "CompleteOKYCRequest": { - "title": "CompleteOKYCRequest", - "required": ["aadhaar", "id"], - "type": "object", - "properties": { - "aadhaar": { - "$ref": "#/components/schemas/Aadhaar" - }, - "id": { - "type": "string" - } - }, - "example": { - "aadhaar": { - "address": { - "careOf": "S/O: Mohan", - "country": "India", - "district": "Bangalore", - "house": "# 90 1 Cross", - "landmark": "Near PO", - "locality": "M.G. Road", - "pin": "560072", - "postOffice": "M.G Road", - "state": "Karnataka", - "street": "M.G.Road 1st Main Road", - "subDistrict": "Bangalore North", - "vtc": "Bangalore North" - }, - "dateOfBirth": "22-01-1980", - "email": "550fa5fd91eee3f29f6361a8c89aa9713d4d38811d1a5", - "gender": "M", - "generatedAt": "20210419145604802", - "maskedNumber": "xxxx-xxxx-8112", - "name": "Aditya Mohan", - "phone": "09c91184c1d610282d661dd63d257e3b44446853fb1388c9d5b", - "photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD==", - "verified": { - "email": false, - "phone": false, - "signature": true - }, - "xml": { - "fileUrl": "https://setus3linkgoeshere.com/", - "validUntil": 12345678 - } - }, - "id": "7097e53a-ba29-48a2-983d-878433b4f33e" - } - }, - "Aadhaar": { - "title": "Aadhaar", - "required": [ - "address", - "dateOfBirth", - "email", - "gender", - "generatedAt", - "maskedNumber", - "name", - "phone", - "photo", - "verified", - "xml" - ], - "type": "object", - "properties": { - "address": { - "$ref": "#/components/schemas/Address" - }, - "dateOfBirth": { - "type": "string" - }, - "email": { - "type": "string" - }, - "gender": { - "type": "string" - }, - "generatedAt": { - "type": "string" - }, - "maskedNumber": { - "type": "string" - }, - "name": { - "type": "string" - }, - "phone": { - "type": "string" - }, - "photo": { - "type": "string" - }, - "verified": { - "$ref": "#/components/schemas/Verified" - }, - "xml": { - "$ref": "#/components/schemas/Xml" - } - }, - "example": { - "address": { - "careOf": "S/O: Mohan", - "country": "India", - "district": "Bangalore", - "house": "# 90 1 Cross", - "landmark": "Near PO", - "locality": "M.G. Road", - "pin": "560072", - "postOffice": "M.G Road", - "state": "Karnataka", - "street": "M.G.Road 1st Main Road", - "subDistrict": "Bangalore North", - "vtc": "Bangalore North" - }, - "dateOfBirth": "22-01-1980", - "email": "550fa5fd91eee3f29f6361a8c89aa9713d4d38811d1a5", - "gender": "M", - "generatedAt": "20210419145604802", - "maskedNumber": "xxxx-xxxx-8112", - "name": "Aditya Mohan", - "phone": "09c91184c1d610282d661dd63d257e3b44446853fb1388c9d5b", - "photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD==", - "verified": { - "email": false, - "phone": false, - "signature": true - }, - "xml": { - "fileUrl": "https://setus3linkgoeshere.com/", - "validUntil": 12345678 - } - } - }, - "Address": { - "title": "Address", - "required": [ - "careOf", - "country", - "district", - "house", - "landmark", - "locality", - "pin", - "postOffice", - "state", - "street", - "subDistrict", - "vtc" - ], - "type": "object", - "properties": { - "careOf": { - "type": "string" - }, - "country": { - "type": "string" - }, - "district": { - "type": "string" - }, - "house": { - "type": "string" - }, - "landmark": { - "type": "string" - }, - "locality": { - "type": "string" - }, - "pin": { - "type": "string" - }, - "postOffice": { - "type": "string" - }, - "state": { - "type": "string" - }, - "street": { - "type": "string" - }, - "subDistrict": { - "type": "string" - }, - "vtc": { - "type": "string" - } - }, - "example": { - "careOf": "S/O: Mohan", - "country": "India", - "district": "Bangalore", - "house": "# 90 1 Cross", - "landmark": "Near PO", - "locality": "M.G. Road", - "pin": "560072", - "postOffice": "M.G Road", - "state": "Karnataka", - "street": "M.G.Road 1st Main Road", - "subDistrict": "Bangalore North", - "vtc": "Bangalore North" - } - }, - "Verified": { - "title": "Verified", - "required": ["email", "phone", "signature"], - "type": "object", - "properties": { - "email": { - "type": "boolean" - }, - "phone": { - "type": "boolean" - }, - "signature": { - "type": "boolean" - } - }, - "example": { - "email": false, - "phone": false, - "signature": true - } - }, - "Xml": { - "title": "Xml", - "required": ["fileUrl", "validUntil"], - "type": "object", - "properties": { - "fileUrl": { - "type": "string" - }, - "validUntil": { - "type": "integer", - "format": "int32" - } - }, - "example": { - "fileUrl": "https://setus3linkgoeshere.com/", - "validUntil": 12345678 - } - }, - "Withasharecode": { - "title": "Withasharecode", - "required": ["aadhaar", "status", "id"], - "type": "object", - "properties": { - "aadhaar": { - "$ref": "#/components/schemas/Aadhaar1" - }, - "status": { - "type": "string" - }, - "id": { - "type": "string" - } - }, - "example": { - "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://setus3linkgoeshere.com/", - "validUntil": "Wed, 23 Jun 2021 19:33:55 GMT", - "shareCode": "1234" - } - }, - "status": "complete", - "id": "7097e53a-ba29-48a2-983d-878433b4f33e" - } - }, - "Aadhaar1": { - "title": "Aadhaar1", - "required": [ - "address", - "dateOfBirth", - "email", - "gender", - "generatedAt", - "maskedNumber", - "name", - "phone", - "photo", - "verified", - "xml" - ], - "type": "object", - "properties": { - "address": { - "$ref": "#/components/schemas/Address" - }, - "dateOfBirth": { - "type": "string" - }, - "email": { - "type": "string" - }, - "gender": { - "type": "string" - }, - "generatedAt": { - "type": "string" - }, - "maskedNumber": { - "type": "string" - }, - "name": { - "type": "string" - }, - "phone": { - "type": "string" - }, - "photo": { - "type": "string" - }, - "verified": { - "$ref": "#/components/schemas/Verified" - }, - "xml": { - "$ref": "#/components/schemas/Xml1" - } - }, - "example": { - "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://setus3linkgoeshere.com/", - "validUntil": "Wed, 23 Jun 2021 19:33:55 GMT", - "shareCode": "1234" - } - } - }, - "Xml1": { - "title": "Xml1", - "required": ["fileUrl", "validUntil", "shareCode"], - "type": "object", - "properties": { - "fileUrl": { - "type": "string" - }, - "validUntil": { - "type": "string" - }, - "shareCode": { - "type": "string" - } - }, - "example": { - "fileUrl": "https://setus3linkgoeshere.com/", - "validUntil": "Wed, 23 Jun 2021 19:33:55 GMT", - "shareCode": "1234" - } - }, - "Withoutasharecode": { - "title": "Withoutasharecode", - "required": ["aadhaar", "status", "id"], - "type": "object", - "properties": { - "aadhaar": { - "$ref": "#/components/schemas/Aadhaar2" - }, - "status": { - "type": "string" - }, - "id": { - "type": "string" - } - }, - "example": { - "aadhaar": { - "xml": { - "fileUrl": "https://setus3linkgoeshere.com/", - "validUntil": "Wed, 23 Jun 2021 19:33:55 GMT" - } - }, - "status": "complete", - "id": "7097e53a-ba29-48a2-983d-878433b4f33e" - } - }, - "Aadhaar2": { - "title": "Aadhaar2", - "required": ["xml"], - "type": "object", - "properties": { - "xml": { - "$ref": "#/components/schemas/Xml2" - } - }, - "example": { - "xml": { - "fileUrl": "https://setus3linkgoeshere.com/", - "validUntil": "Wed, 23 Jun 2021 19:33:55 GMT" - } - } - }, - "Xml2": { - "title": "Xml2", - "required": ["fileUrl", "validUntil"], - "type": "object", - "properties": { - "fileUrl": { - "type": "string" - }, - "validUntil": { - "type": "string" - } - }, - "example": { - "fileUrl": "https://setus3linkgoeshere.com/", - "validUntil": "Wed, 23 Jun 2021 19:33:55 GMT" - } - }, - "Incompleterequest": { - "title": "Incompleterequest", - "required": ["url", "id", "validUpto", "status"], - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "id": { - "type": "string" - }, - "validUpto": { - "type": "string" - }, - "status": { - "type": "string" - } - }, - "example": { - "url": "https://setuOKYCURL.co/foobar&someId=uuid", - "id": "7097e53a-ba29-48a2-983d-878433b4f33e", - "validUpto": "Wed, 23 Jun 2021 19:33:55 GMT", - "status": "incomplete" - } - }, - "Upstreamservicedown1": { - "title": "Upstreamservicedown1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error14" - } - }, - "example": { - "error": { - "code": "internal_server_error", - "detail": "Upstream service error", - "traceID": "" - } - } - }, - "CreateaDigilockerRequestRequest": { - "title": "CreateaDigilockerRequestRequest", - "required": ["redirectUrl"], - "type": "object", - "properties": { - "redirectUrl": { - "type": "string" - } - }, - "example": { - "redirectUrl": "https://setu.co" - } - }, - "InvalidredirectURL1": { - "title": "InvalidredirectURL1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "invalid_redirect_url", - "detail": "Please enter a valid redirect URL.", - "traceId": "" - } - } - }, - "FetchadocumentRequest": { - "title": "FetchadocumentRequest", - "required": ["docType", "format", "consent"], - "type": "object", - "properties": { - "docType": { - "type": "string" - }, - "format": { - "type": "string" - }, - "consent": { - "type": "string" - } - }, - "example": { - "docType": "ADHAR", - "format": "pdf", - "consent": "Y" - } - }, - "Consentnotgiven1": { - "title": "Consentnotgiven1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "consent_not_given", - "detail": "Only accepted value for consent is 'Y'", - "traceId": "" - } - } - }, - "Successfetchadocument": { - "title": "Successfetchadocument", - "required": ["fileUrl", "validUpto"], - "type": "object", - "properties": { - "fileUrl": { - "type": "string" - }, - "validUpto": { - "type": "string" - } - }, - "example": { - "fileUrl": "s3_url of the file to be downloaded", - "validUpto": "2021-09-21T09:12:12+05:30" - } - }, - "Tokenrevoked1": { - "title": "Tokenrevoked1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "token_revoked", - "detail": "The user has revoked the token for the given request.", - "traceId": "" - } - } - }, - "Success5": { - "title": "Success5", - "required": ["aadhaar", "id", "status"], - "type": "object", - "properties": { - "aadhaar": { - "$ref": "#/components/schemas/Aadhaar1" - }, - "id": { - "type": "string" - }, - "status": { - "type": "string" - } - }, - "example": { - "aadhaar": { - "address": { - "careOf": "S/O John Doe", - "country": "India", - "district": "district", - "house": "house address", - "landmark": "", - "locality": "locality", - "pin": "123456", - "postOffice": "", - "state": "state", - "street": "", - "subDistrict": "", - "vtc": "vtc" - }, - "dateOfBirth": "01-01-1990", - "email": "", - "gender": "M", - "generatedAt": "2021-10-26T17:17:36.342+05:30", - "maskedNumber": "xxxx-xxxx-1234", - "name": "Jack Doe", - "phone": "", - "photo": "", - "verified": { - "email": false, - "phone": false, - "signature": true - }, - "xml": { - "fileUrl": "https://s3linkgoeshere.com", - "shareCode": "", - "validUntil": "2021-10-09T06:04:16+05:30" - } - }, - "id": "391a45be-d08d-4dd0-b8a8-06e53392d435", - "status": "complete" - } - }, - "Success6": { - "title": "Success6", - "required": ["documents"], - "type": "object", - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document1" - }, - "description": "" - } - }, - "example": { - "documents": [ - { - "availableFormats": ["pdf"], - "description": "Pension Certificate", - "docType": "PECER", - "orgId": "002317", - "orgName": "Accountants General, Tripura", - "parameters": [ - { - "description": "Account No./PPO No.", - "name": "AC_NO" - } - ] - }, - { - "availableFormats": ["pdf"], - "description": "Provident Fund Member Passbook", - "docType": "PRFND", - "orgId": "002317", - "orgName": "Accountants General, Tripura", - "parameters": [ - { - "description": "Account No./PPO No.", - "name": "AC_NO" - } - ] - } - ] - } - }, - "Document1": { - "title": "Document1", - "required": [ - "availableFormats", - "description", - "docType", - "orgId", - "orgName", - "parameters" - ], - "type": "object", - "properties": { - "availableFormats": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "description": { - "type": "string" - }, - "docType": { - "type": "string" - }, - "orgId": { - "type": "string" - }, - "orgName": { - "type": "string" - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Parameters4" - }, - "description": "" - } - }, - "example": { - "availableFormats": ["pdf"], - "description": "Pension Certificate", - "docType": "PECER", - "orgId": "002317", - "orgName": "Accountants General, Tripura", - "parameters": [ - { - "description": "Account No./PPO No.", - "name": "AC_NO" - } - ] - } - }, - "Parameters4": { - "title": "Parameters4", - "required": ["description", "name"], - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "example": { - "description": "Account No./PPO No.", - "name": "AC_NO" - } - }, - "success7": { - "title": "success7", - "required": ["success"], - "type": "object", - "properties": { - "success": { - "type": "boolean" - } - }, - "example": { - "success": true - } - }, - "VerifyPANRequest": { - "title": "VerifyPANRequest", - "required": ["pan", "consent", "reason"], - "type": "object", - "properties": { - "pan": { - "type": "string" - }, - "consent": { - "type": "string" - }, - "reason": { - "type": "string" - } - }, - "example": { - "pan": "ABCDE1234A", - "consent": "Y", - "reason": "Reason for verifying PAN set by the developer" - } - }, - "Success-ValidPAN": { - "title": "Success-ValidPAN", - "required": ["data", "message", "verification", "traceID"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Data" - }, - "message": { - "type": "string" - }, - "verification": { - "type": "string" - }, - "traceID": { - "type": "string" - } - }, - "example": { - "data": { - "aadhaar_seeding_status": "LINKED", - "category": "Individual", - "full_name": "John Doe" - }, - "message": "PAN is valid", - "verification": "SUCCESS", - "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" - } - }, - "Data": { - "title": "Data", - "required": ["category", "full_name"], - "type": "object", - "properties": { - "aadhaar_seeding_status": { - "type": "string" - }, - "category": { - "type": "string" - }, - "full_name": { - "type": "string" - } - }, - "example": { - "category": "Individual", - "full_name": "John Doe" - } - }, - "Success-InvalidPAN": { - "title": "Success-InvalidPAN", - "required": ["verification", "message"], - "type": "object", - "properties": { - "verification": { - "type": "string" - }, - "message": { - "type": "string" - } - }, - "example": { - "verification": "failed", - "message": "PAN is invalid" - } - }, - "Failure-ConsentNotGiven1": { - "title": "Failure-ConsentNotGiven1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "consent_not_given", - "detail": "Consent is required and should be Y/y.", - "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" - } - } - }, - "Failure-InsufficientReasonLength1": { - "title": "Failure-InsufficientReasonLength1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "insufficient_reason_length", - "detail": "Reason should be at least 20 characters in length.", - "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" - } - } - }, - "Failure-InternalServerError1": { - "title": "Failure-InternalServerError1", - "required": ["error"], - "type": "object", - "properties": { - "error": { - "$ref": "#/components/schemas/Error" - } - }, - "example": { - "error": { - "code": "internal_server_error", - "detail": "Internal Server Error. Please reach out to support along with the traceId.", - "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" - } - } - }, - "VerifyBANRequest": { - "title": "VerifyBANRequest", - "required": ["ifsc", "accountNumber"], - "type": "object", - "properties": { - "ifsc": { - "type": "string" - }, - "accountNumber": { - "type": "string" - } - }, - "example": { - "ifsc": "ABCD0123456", - "accountNumber": "1234567890" - } - }, - "Failedverification": { - "title": "Failedverification", - "required": ["verification", "message"], - "type": "object", - "properties": { - "verification": { - "type": "string" - }, - "message": { - "type": "string" - } - }, - "example": { - "verification": "failed", - "message": "This account does not exist or is invalid." - } - }, - "InvalidIFSCBANformat": { - "title": "InvalidIFSCBANformat", - "required": ["verification", "message"], - "type": "object", - "properties": { - "verification": { - "type": "string" - }, - "message": { - "type": "string" - } - }, - "example": { - "verification": "failed", - "message": "Either IFSC or bank account is invalid" - } - }, - "Successfulverification": { - "title": "Successfulverification", - "required": ["data", "message", "verification"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Data1" - }, - "message": { - "type": "string" - }, - "verification": { - "type": "string" - } - }, - "example": { - "data": { - "aadhaar_seeding_status": "LINKED", - "name": "Kumar Gaurav Rathod", - "transactionReference": "120716373986" - }, - "message": "Account exists and is active.", - "verification": "SUCCESS", - "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" - } - }, - "Data1": { - "title": "Data1", - "required": ["name", "transactionReference"], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "transactionReference": { - "type": "string" - } - }, - "example": { - "name": "Kumar Gaurav Rathod", - "transactionReference": "120716373986" - } - }, - "VerifyBANAsyncRequest": { - "title": "VerifyBANAsyncRequest", - "required": ["ifsc", "accountNumber", "narration"], - "type": "object", - "properties": { - "ifsc": { - "type": "string" - }, - "accountNumber": { - "type": "string" - }, - "narration": { - "type": "string" - } - }, - "example": { - "ifsc": "ABCD0123456", - "accountNumber": "1234567890", - "narration": "test transaction for verification" - } - }, - "Requestcreatedsuccessfully": { - "title": "Requestcreatedsuccessfully", - "required": ["id"], - "type": "object", - "properties": { - "id": { - "type": "string" - } - }, - "example": { - "id": "02c2dc4c-1015-4ea0-8ec4-987829fc70cc" - } - }, - "BAVrequestnotcomplete": { - "title": "BAVrequestnotcomplete", - "required": ["verification"], - "type": "object", - "properties": { - "verification": { - "type": "string" - } - }, - "example": { - "verification": "pending" - } - }, - "Invalidtransaction": { - "title": "Invalidtransaction", - "required": ["verification", "message"], - "type": "object", - "properties": { - "verification": { - "type": "string" - }, - "message": { - "type": "string" - } - }, - "example": { - "verification": "failed", - "message": "This transaction is not valid for this account." - } - }, - "Transactionlimit": { - "title": "Transactionlimit", - "required": ["verification", "message"], - "type": "object", - "properties": { - "verification": { - "type": "string" - }, - "message": { - "type": "string" - } - }, - "example": { - "verification": "failed", - "message": "The transaction limit for this account may have been reached." - } + "schemas": { + "UANLookup": { + "title": "UANLookupRequestRequest", + "required": [ + "mobileNumber" + ], + "type": "object", + "properties": { + "mobileNumber": { + "type": "string" } + }, + "example": { + "mobileNumber": "9555xxxxxx" + } }, - "securitySchemes": { - "bearer": { - "type": "http", - "scheme": "bearer" + "SuccessLookup-ValidMobile":{ + "title": "SuccessLookup-ValidMobile", + "required": ["data", "requestId", "statusCode", "traceId"], + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "uan": { + "type": "string" + } + }, + "required": ["uan"] + }, + "requestId": { + "type": "string" + }, + "statusCode": { + "type": "string" + }, + "traceId": { + "type": "string" + } + }, + "example": { + "data": { + "uan":"123456789012" + }, + "requestId": "e347e79b-dddc-49c1-b266-afb2c44843e8", + "statusCode": "200", + "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" + } + }, + "FetchUANDetailsRequestRequest": { + "title": "FetchUANDetailsRequestRequest", + "required": [ + "uan" + ], + "type": "object", + "properties": { + "uan": { + "type": "string" } + }, + "example": { + "uan": "123456789012" + } + }, + + "UANDetails":{ + "title": "UANDetails", + "required": ["uan"], + "type": "object", + "properties": { + "uan": { + "type": "string" + } + }, + "example": { + "uan": "123456789012" + } + }, + "SuccessDetails-ValidUAN":{ + "title": "SuccessDetails-ValidUAN", + "required": ["data", "requestId", "statusCode", "traceId"], + "type": "object", + "properties": { + "data": { + "$ref":"#/components/schemas/UANdata" + }, + "requestId": { + "type": "string" + }, + "statusCode": { + "type": "string" + }, + "traceId": { + "type": "string" + } + }, + "example": { + "data": { + "uan": "123456789012", + "employers": [ + { + "startMonthYear": "12-JUN-2022", + "lastMonthYear": "", + "establishmentId": "", + "establishmentName": "", + "memberId": "" } + ], + "personalDetails": { + "name": "Walter White", + "fatherOrHusbandName": "", + "aadhaarVerificationStatus": "-1", + "contactNo": "" + }, + "summary": { + "minimumWorkExperienceInMonths": 33, + "lastEmployer": { + "employerName": "A1A PRIVATE LIMITED", + "startMonthYear": "12-JUN-2022", + "lastMonthYear": "12-JUN-2022", + "vintageInMonths": 33 + } + } + }, + "requestId": "e347e79b-dddc-49c1-b266-afb2c44843e8", + "statusCode": "200", + "traceId": "1-6346a91a-620cf6cc4f68d2e30316881e" + } + }, + "UANdata": { + "title": "UANdata", + "type": "object", + "required": ["uan", "employers", "personalDetails", "summary"], + "properties": { + "uan": { + "type": "string" + }, + "employers": { + "type": "array", + "items": { + "type": "object", + "required": ["startMonthYear", "lastMonthYear", "establishmentId", "establishmentName", "memberId"], + "properties": { + "startMonthYear": { + "type": "string" + }, + "lastMonthYear": { + "type": "string" + }, + "establishmentId": { + "type": "string" + }, + "establishmentName": { + "type": "string" + }, + "memberId": { + "type": "string" + } + } + } + }, + "personalDetails": { + "type": "object", + "required": ["name", "fatherOrHusbandName", "aadhaarVerificationStatus", "contactNo"], + "properties": { + "name": { + "type": "string" + }, + "fatherOrHusbandName": { + "type": "string" + }, + "aadhaarVerificationStatus": { + "type": "string" + }, + "contactNo": { + "type": "string" + } + } + }, + "summary": { + "type": "object", + "required": ["minimumWorkExperienceInMonths", "lastEmployer"], + "properties": { + "minimumWorkExperienceInMonths": { + "type": "number" + }, + "lastEmployer": { + "type": "object", + "required": ["employerName", "startMonthYear", "lastMonthYear", "vintageInMonths"], + "properties": { + "employerName": { + "type": "string" + }, + "startMonthYear": { + "type": "string" + }, + "lastMonthYear": { + "type": "string" + }, + "vintageInMonths": { + "type": "number" + } + } + } + } + } + }, + "example": { + "uan": "123456789012", + "employers": [ + { + "startMonthYear": "12-JUN-2022", + "lastMonthYear": "", + "establishmentId": "", + "establishmentName": "", + "memberId": "" + } + ], + "personalDetails": { + "name": "Walter White", + "fatherOrHusbandName": "", + "aadhaarVerificationStatus": "-1", + "contactNo": "" + }, + "summary": { + "minimumWorkExperienceInMonths": 33, + "lastEmployer": { + "employerName": "A1A PRIVATE LIMITED", + "startMonthYear": "12-JUN-2022", + "lastMonthYear": "12-JUN-2022", + "vintageInMonths": 33 + } + } + } + }, + "Failure-InternalServerError1": { + "title": "Failure-InternalServerError1", + "required": ["error"], + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + }, + "example": { + "error": { + "code": "internal_server_error", + "detail": "Internal Server Error. Please reach out to support along with the traceId.", + "traceId": "7097e53a-ba29-48a2-983d-878433b4f33e" + } + } + }, + "Error": { + "title": "Error", + "required": ["code", "detail", "traceId"], + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "detail": { + "type": "string" + }, + "traceId": { + "type": "string" + } + }, + "example": { + "code": "invalid_document", + "detail": "The document Id is already being used in a signature", + "traceId": "" + } + } + }, + "securitySchemes": { + "bearer": { + "type": "http", + "scheme": "bearer" } + } }, "security": [ - { - "bearer": [] - } + { + "bearer": [] + } + ], + "tags": [ + { + "name": "EPF" + } ] -} + } \ No newline at end of file From cbc90ec82c59210876b9b8b03f60269361801fac Mon Sep 17 00:00:00 2001 From: Aditya Gannavarapu Date: Tue, 4 Mar 2025 17:25:22 +0530 Subject: [PATCH 3/4] Update redirects and sidebar entry --- content/endpoints.json | 6 ++++++ content/menuItems.json | 2 +- content/redirects.json | 1 + 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/content/endpoints.json b/content/endpoints.json index 434a5551..713dd2b6 100644 --- a/content/endpoints.json +++ b/content/endpoints.json @@ -122,6 +122,12 @@ "path": "ekyc", "order": 8, "visible_in_sidebar": false + }, + { + "name": "EPFO", + "path": "epfo", + "order": 9, + "visible_in_sidebar": false } ] }, diff --git a/content/menuItems.json b/content/menuItems.json index 4f694609..1ff3676f 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 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":"EPFO","path":"epfo","order":9,"visible_in_sidebar":false,"children":[{"name":"API reference","visible_in_sidebar":true,"page_title":"EPFO API reference","path":"api-reference","order":1},{"name":"Quickstart","visible_in_sidebar":true,"page_title":"EPFO quickstart","path":"quickstart","order":0}]}]},{"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 diff --git a/content/redirects.json b/content/redirects.json index 70d6145e..d29c7357 100644 --- a/content/redirects.json +++ b/content/redirects.json @@ -79,6 +79,7 @@ "/data/digilocker": "/data/digilocker/overview", "/data/gst": "/data/gst/quickstart", "/data/ekyc": "/data/ekyc/quickstart", + "/data/epfo": "/data/epfo/quickstart", "/data/match-apis": "/data/match-apis/name-match/overview", "/data/match-apis/name-match": "/data/match-apis/name-match/overview", "/data/uli": "/data/uli/quickstart", From 3bbcf3f848b8d2d8166981d69c77f37d2084f6a7 Mon Sep 17 00:00:00 2001 From: VarunSonava Date: Tue, 4 Mar 2025 23:35:23 +0200 Subject: [PATCH 4/4] New EPF doc: Added request response description and product instance ID for api playground --- api-playground/json/data/epfo/UANDetails.json | 2 +- api-playground/json/data/epfo/UANLookup.json | 2 +- api-references/data/epfo.json | 45 +++++++++++++------ 3 files changed, 34 insertions(+), 15 deletions(-) diff --git a/api-playground/json/data/epfo/UANDetails.json b/api-playground/json/data/epfo/UANDetails.json index 2deec2fa..c6cf6572 100644 --- a/api-playground/json/data/epfo/UANDetails.json +++ b/api-playground/json/data/epfo/UANDetails.json @@ -8,7 +8,7 @@ "x-client-secret": "7IZMe9zvoBBuBukLiCP7n4KLwSOy11oP" }, { - "x-product-instance-id": "" + "x-product-instance-id": "4e863485-0bae-4ab3-b0e4-5744d45b86e7" } ] }, diff --git a/api-playground/json/data/epfo/UANLookup.json b/api-playground/json/data/epfo/UANLookup.json index 30275bdc..05c475a0 100644 --- a/api-playground/json/data/epfo/UANLookup.json +++ b/api-playground/json/data/epfo/UANLookup.json @@ -8,7 +8,7 @@ "x-client-secret": "7IZMe9zvoBBuBukLiCP7n4KLwSOy11oP" }, { - "x-product-instance-id": "" + "x-product-instance-id": "4e863485-0bae-4ab3-b0e4-5744d45b86e7" } ] }, diff --git a/api-references/data/epfo.json b/api-references/data/epfo.json index e15dad35..60a431c9 100644 --- a/api-references/data/epfo.json +++ b/api-references/data/epfo.json @@ -249,7 +249,8 @@ "type": "object", "properties": { "mobileNumber": { - "type": "string" + "type": "string", + "description":"Valid registered Mobile Number with EPFO" } }, "example": { @@ -265,7 +266,8 @@ "type": "object", "properties": { "uan": { - "type": "string" + "type": "string", + "description": "UAN associated with the mobile number" } }, "required": ["uan"] @@ -311,7 +313,8 @@ "type": "object", "properties": { "uan": { - "type": "string" + "type": "string", + "description":"Valid 12 digit UAN assigned to EPF account holder" } }, "example": { @@ -374,7 +377,8 @@ "required": ["uan", "employers", "personalDetails", "summary"], "properties": { "uan": { - "type": "string" + "type": "string", + "description": "UAN passed in the request" }, "employers": { "type": "array", @@ -383,19 +387,29 @@ "required": ["startMonthYear", "lastMonthYear", "establishmentId", "establishmentName", "memberId"], "properties": { "startMonthYear": { - "type": "string" + "type": "string", + "description": "Date of joining" + }, "lastMonthYear": { - "type": "string" + "type": "string", + "description": "Date of exit" + }, "establishmentId": { - "type": "string" + "type": "string", + "description": "Employer's Company ID" + }, "establishmentName": { - "type": "string" + "type": "string", + "description": "Company Name" + }, "memberId": { - "type": "string" + "type": "string", + "description": "User ID associated with the company at EPFO" + } } } @@ -430,16 +444,21 @@ "required": ["employerName", "startMonthYear", "lastMonthYear", "vintageInMonths"], "properties": { "employerName": { - "type": "string" + "type": "string", + "description": "Company Name" }, "startMonthYear": { - "type": "string" + "type": "string", + "description": "Date of joining" }, "lastMonthYear": { - "type": "string" + "type": "string", + "description": "Date of Exit" + }, "vintageInMonths": { - "type": "number" + "type": "number", + "description": "Duration of employment in months at the organisation." } } }