{ "openapi": "3.1.0", "info": { "title": "in-co-sandbox-kyc", "description": "", "version": "1.0.0" }, "tags": [ { "name": "kyc" }, { "name": "digilocker-sdk" }, { "name": "digilocker" }, { "name": "aadhaar" }, { "name": "bank" }, { "name": "pan" }, { "name": "mca" }, { "name": "entitylocker" }, { "name": "entitylocker-sdk" } ], "paths": { "/kyc/digilocker-sdk/sessions/create": { "post": { "summary": "Create Session", "deprecated": false, "description": "", "operationId": "createSession", "tags": [ "kyc", "digilocker-sdk" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "Media type of the request body.", "required": false, "example": "application/json", "schema": { "type": "string", "enum": [ "application/json" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "@entity": { "type": "string", "enum": [ "in.co.sandbox.kyc.digilocker.sdk.session.request" ] }, "flow": { "type": "string", "enum": [ "signin", "signup" ], "description": "DigiLocker authentication flow to initiate for the user. Use `signin` for existing DigiLocker users or `signup` to create a new account." }, "doc_types": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "aadhaar", "driving_license", "pan" ] }, "description": "List of DigiLocker document types for which user consent is being requested." } }, "required": [ "@entity", "flow", "doc_types" ], "additionalProperties": false }, "examples": { "200 - OK": { "value": { "@entity": "in.co.sandbox.kyc.digilocker.sdk.session.request", "flow": "signin", "doc_types": [ "aadhaar", "pan" ] }, "summary": "200 - OK" }, "400 - Invalid request body": { "value": { "@entity": "in.co.sandbox.kyc.digilocker.sdk.session.request", "flow": "signin", "doc_types": [ "aadhaar", "driving_license", "pan" ] }, "summary": "400 - Invalid request body" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "timestamp": { "type": "integer" }, "transaction_id": { "type": "string" }, "data": { "type": "object", "properties": { "@entity": { "type": "string", "enum": [ "in.co.sandbox.kyc.digilocker.sdk.session" ] }, "id": { "type": "string", "description": "Session ID", "format": "uuid" }, "status": { "type": "string", "enum": [ "created" ], "description": "Status of the Session" }, "created_at": { "type": "integer" } } }, "code": { "type": "integer" } }, "required": [ "timestamp", "transaction_id", "data", "code" ] }, "examples": { "200 - OK": { "summary": "200 - OK", "value": { "timestamp": 1750331120324, "transaction_id": "5ccad959-0bf4-4472-a3dd-d57e2b61b5a9", "data": { "@entity": "in.co.sandbox.kyc.digilocker.sdk.session", "id": "0454f149-26d0-41ef-9f14-c54f4b5f7b70", "status": "created", "created_at": 1750331120324 }, "code": 200 } } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "400 - Invalid request body": { "summary": "400 - Invalid request body", "value": { "code": 400, "timestamp": 1760426007752, "message": "Invalid request body", "transaction_id": "f654ccdb-919f-486d-851d-0fc5d0050c17" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/digilocker-sdk/sessions/{session_id}/status": { "get": { "summary": "Session Status", "deprecated": false, "description": "", "operationId": "getSessionStatus", "tags": [ "kyc", "digilocker-sdk" ], "parameters": [ { "name": "session_id", "in": "path", "description": "Session identifier generated during DigiLocker SDK [Create Session API](https://developer.sandbox.co.in/api-reference/kyc/digilocker-sdk/endpoints/create-session) .", "required": true, "example": "839fd8a0-d645-42e1-a904-bb43353b0139", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "@entity": { "type": "string", "const": "in.co.sandbox.kyc.digilocker.session" }, "status": { "type": "string", "enum": [ "created", "initialized", "authorized", "succeeded", "failed", "expired" ] }, "documents_consented": { "type": "array", "items": { "type": "string", "enum": [ "aadhaar", "driving_license", "pan" ] } }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } }, "required": [ "id", "created_at", "@entity", "status" ] }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "200 - Session Created": { "summary": "200 - Session Created", "value": { "code": 200, "timestamp": 1752580258171, "data": { "id": "839fd8a0-d645-42e1-a904-bb43353b0139", "created_at": 1752579445983, "@entity": "in.co.sandbox.kyc.digilocker.sdk.session", "status": "created" }, "transaction_id": "800ff751-2191-4b7d-b20a-8301790a3e19" } }, "200 - Session Expired": { "summary": "200 - Session Expired", "value": { "code": 200, "timestamp": 1752580258171, "data": { "id": "839fd8a0-d645-42e1-a904-bb43353b0139", "created_at": 1752579445983, "updated_at": 1752579445983, "@entity": "in.co.sandbox.kyc.digilocker.sdk.session", "status": "expired" }, "transaction_id": "800ff751-2191-4b7d-b20a-8301790a3e19" } } } } }, "headers": {} }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "503 - Source unavailable": { "summary": "503 - Source unavailable", "value": { "code": 503, "timestamp": 1000000000000, "transaction_id": "6c05f692-c32f-4de0-92b4-56684bdf16f0", "message": "Source Unavailable" } } } } }, "headers": {} }, "521": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "521 - Data Not Found": { "summary": "521 - Data Not Found", "value": { "code": 521, "timestamp": 1782806266274, "message": "Data not found for: 55470e27-3d8a-451f-ac1e-9c0f3d1454821", "transaction_id": "a599615c-c732-4538-9840-4bb5cd3c19d2" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/digilocker-sdk/sessions/{session_id}/documents/{doc_type}": { "get": { "summary": "Get Document", "deprecated": false, "description": "", "operationId": "getDocument", "tags": [ "kyc", "digilocker-sdk" ], "parameters": [ { "name": "session_id", "in": "path", "description": "Session identifier generated during DigiLocker SDK [Create Session API](https://developer.sandbox.co.in/api-reference/kyc/digilocker-sdk/endpoints/create-session) .", "required": true, "example": "4b4bf7aa-f4da-47a8-9b32-895edfc03630", "schema": { "type": "string" } }, { "name": "doc_type", "in": "path", "description": "Document type identifying which DigiLocker document to retrieve. Must match one of the consented doc_types values.", "required": true, "example": "aadhaar", "schema": { "type": "string", "enum": [ "aadhaar", "pan", "driving_license" ] } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "data": { "type": "object", "properties": { "files": { "type": "array", "items": { "type": "object", "properties": { "@entity": { "type": "string", "const": "org.quicko.drive.file" }, "url": { "type": "string" }, "size": { "type": "integer" }, "metadata": { "type": "object", "properties": { "ContentType": { "type": "string" }, "issuer_id": { "type": "string" }, "issuer": { "type": "string" }, "LastModified": { "type": "string" }, "description": { "type": "string" } }, "required": [ "ContentType", "issuer_id", "issuer", "LastModified", "description" ] } }, "required": [ "@entity", "url", "size", "metadata" ] } } }, "required": [ "files" ] }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "200 - OK": { "summary": "200 - OK", "value": { "code": 200, "timestamp": 1751975529441, "data": { "files": [ { "@entity": "org.quicko.drive.file", "url": "https://in-co-sandbox-kyc-digilocker-dev.s3.ap-south-1.amazonaws.com/non-persistent/e385432b-575c-4b6f-8928-79136dbc0d4f/4b4bf7aa-f4da-47a8-9b32-895edfc03630/in.gov.uidai-ADHAR-0d5fe4d692c73e23c59a694eaaabc75a.xml?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=%2F20250708%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20250708T115214Z&X-Amz-Expires=3600&X-Amz-Signature=8cc4b0e8eb3794601c7fdb7e85f3a6bb3a8e1842403c8aeae5c05b7af03bdadb&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject", "size": 16598, "metadata": { "ContentType": "application/xml", "issuer_id": "in.gov.uidai", "issuer": "Unique Identification Authority of India (UIDAI)", "LastModified": "09/05/2025", "description": "Aadhaar Card" } } ] }, "transaction_id": "a4d43b74-0f9c-480c-9300-f011100b674b" } } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "400 - Consent not provided": { "summary": "400 - Consent not provided", "value": { "code": 400, "timestamp": 1760432035872, "message": "Consent for pan not provided", "transaction_id": "3d1d2d37-3179-4a3c-8397-2287084d1de1" } } } } }, "headers": {} }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "503 - Source unavailable": { "summary": "503 - Source unavailable", "value": { "code": 503, "timestamp": 1000000000000, "transaction_id": "6c05f692-c32f-4de0-92b4-56684bdf16f0", "message": "Source Unavailable" } } } } }, "headers": {} }, "521": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "521 - Data Not Found": { "summary": "521 - Data Not Found", "value": { "code": 521, "timestamp": 1782806266274, "message": "Data not found for: 55470e27-3d8a-451f-ac1e-9c0f3d1454821", "transaction_id": "a599615c-c732-4538-9840-4bb5cd3c19d2" } } } } }, "headers": {} }, "523": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "523 - Invalid Session Status": { "summary": "523 - Invalid Session Status", "value": { "code": 523, "timestamp": 1782806184804, "message": "Invalid session status: created", "transaction_id": "de90173f-8255-4ac0-b26b-a41b8a872fee" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/digilocker-sdk/sessions/{session_id}/user/profile": { "get": { "summary": "Get User Profile ", "deprecated": false, "description": "Gets the User Profile details from Digilocker.", "operationId": "getUserProfile", "tags": [ "kyc", "digilocker-sdk" ], "parameters": [ { "name": "session_id", "in": "path", "description": "Session identifier generated during DigiLocker SDK [Create Session API](https://developer.sandbox.co.in/api-reference/kyc/digilocker-sdk/endpoints/create-session) .", "required": true, "example": "6a4779c9-b11a-457e-ae56-bbb1fdd3dd2c", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code." }, "timestamp": { "type": "integer", "description": "Unix timestamp (in milliseconds) indicating when the server generated the response." }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Digilocker Id" }, "@entity": { "type": "string", "description": "Entity identifier that specifies the type of response being returned." }, "date_of_birth": { "type": "integer", "description": "Date of Birth of User" }, "mobile": { "type": "string", "description": "Mobile Number of User" }, "name": { "type": "string", "description": "Full Name of User" }, "gender": { "type": "string", "description": "Gender of User" }, "eaadhaar": { "type": "boolean", "description": "Boolean indicating eaadhaar status of User" }, "email": { "type": "string", "description": "Email Address of User" } }, "required": [ "@entity", "id", "name", "date_of_birth", "gender", "eaadhaar", "mobile", "email" ], "description": "Response payload containing the requested data or error details." }, "transaction_id": { "type": "string", "description": "Unique identifier for tracking the request across systems." } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "200 - OK": { "summary": "200 - OK", "value": { "code": 200, "timestamp": 1777276051968, "data": { "id": "b5522c8f-2321-577b-8e73-ae1366d9c591", "@entity": "in.co.sandbox.kyc.digilocker.user.profile", "date_of_birth": "18/08/2003", "mobile": "9004813042", "name": "Anurag Bansal", "gender": "male", "eaadhaar": true, "email": "" }, "transaction_id": "6e76fc24-2491-4582-8a03-685fbda4acf7" } } } } }, "headers": {} }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "503 - Source unavailable": { "summary": "503 - Source unavailable", "value": { "code": 503, "timestamp": 1000000000000, "transaction_id": "6c05f692-c32f-4de0-92b4-56684bdf16f0", "message": "Source Unavailable" } } } } }, "headers": {} }, "521": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "521 - Data Not Found": { "summary": "521 - Data Not Found", "value": { "code": 521, "timestamp": 1782806266274, "message": "Data not found for: 55470e27-3d8a-451f-ac1e-9c0f3d1454821", "transaction_id": "a599615c-c732-4538-9840-4bb5cd3c19d2" } } } } }, "headers": {} }, "523": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "523 - Invalid Session Status": { "summary": "523 - Invalid Session Status", "value": { "code": 523, "timestamp": 1782806184804, "message": "Invalid session status: created", "transaction_id": "de90173f-8255-4ac0-b26b-a41b8a872fee" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/digilocker/user/verify": { "post": { "summary": "Verify User Account", "deprecated": false, "description": "Verifies if a user with the provided credentials exists on digilocker.", "operationId": "verifyUserAccount", "tags": [ "kyc", "digilocker" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "Media type of the request body.", "required": false, "example": "application/json", "schema": { "type": "string", "enum": [ "application/json" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Request payload for Digilocker user verification. At least one of the fields 'aadhaar_number' or 'mobile' must be provided.", "properties": { "@entity": { "type": "string", "enum": [ "in.co.sandbox.kyc.digilocker.user.verification.request" ], "description": "Entity identifier that specifies the type of request being made." }, "aadhaar_number": { "type": "string", "pattern": "^[0-9]{12}$", "description": "12-digit Aadhaar number without spaces or separators." }, "mobile": { "type": "string", "pattern": "^[0-9]{10}$", "description": "10-digit Indian mobile number without country code." } }, "required": [ "@entity" ], "anyOf": [ { "required": [ "aadhaar_number" ] }, { "required": [ "mobile" ] } ] }, "examples": { "User exists - validated with mobile": { "value": { "@entity": "in.co.sandbox.kyc.digilocker.user.verification.request", "mobile": "9687205427" }, "summary": "User exists - validated with mobile" }, "User does not exist - validated with mobile": { "value": { "@entity": "in.co.sandbox.kyc.digilocker.user.verification.request", "mobile": "9999999999" }, "summary": "User does not exist - validated with mobile" }, "User exists - validated with Aadhaar number": { "value": { "@entity": "in.co.sandbox.kyc.digilocker.user.verification.request", "aadhaar_number": "1234567890123" }, "summary": "User exists - validated with Aadhaar number" }, "User does not exist - validated with Aadhaar number": { "value": { "@entity": "in.co.sandbox.kyc.digilocker.user.verification.request", "aadhaar_number": "987654321098" }, "summary": "User does not exist - validated with Aadhaar number" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code." }, "timestamp": { "type": "integer", "description": "Unix timestamp (in milliseconds) indicating when the server generated the response." }, "data": { "type": "object", "description": "Response payload containing the requested data or error details.", "properties": { "@entity": { "type": "string", "enum": [ "in.co.sandbox.kyc.digilocker.user.verification.response" ], "description": "Entity identifier that specifies the type of response being returned." }, "user_exists": { "type": "boolean", "description": "Indicates whether a Digilocker account exists for the provided Aadhaar number or mobile number." } }, "required": [ "@entity", "user_exists" ] }, "transaction_id": { "type": "string", "description": "Unique identifier for tracking the request across systems." } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "User exists - validated with mobile": { "summary": "User exists - validated with mobile", "value": { "code": 200, "timestamp": 1751975600361, "data": { "@entity": "in.co.sandbox.kyc.digilocker.user.verification.response", "user_exists": true }, "transaction_id": "a11c4e00-fae1-4092-a55f-b4f0be92ffeb" } }, "User does not exist - validated with mobile": { "summary": "User does not exist - validated with mobile", "value": { "code": 200, "timestamp": 1751975600361, "data": { "@entity": "in.co.sandbox.kyc.digilocker.user.verification.response", "user_exists": false }, "transaction_id": "a11c4e00-fae1-4092-a55f-b4f0be92ffeb" } }, "User exists - validated with Aadhaar number": { "summary": "User exists - validated with Aadhaar number", "value": { "code": 200, "timestamp": 1751975600361, "data": { "@entity": "in.co.sandbox.kyc.digilocker.user.verification.response", "user_exists": true }, "transaction_id": "a11c4e00-fae1-4092-a55f-b4f0be92ffeb" } }, "User does not exist - validated with Aadhaar number": { "summary": "User does not exist - validated with Aadhaar number", "value": { "code": 200, "timestamp": 1751975600361, "data": { "@entity": "in.co.sandbox.kyc.digilocker.user.verification.response", "user_exists": false }, "transaction_id": "a11c4e00-fae1-4092-a55f-b4f0be92ffeb" } } } } }, "headers": {} }, "429": { "description": "There were too many requests to DigiLocker. Wait, then send the request again.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 429, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Too Many Requests": { "summary": "Too Many Requests", "value": { "code": 429, "timestamp": 1782806266274, "message": "Too Many Requests", "transaction_id": "b1e2c3d4-3333-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} }, "500": { "description": "The request failed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 500, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Failed to verify user": { "summary": "Failed to verify user", "value": { "code": 500, "timestamp": 1782806266274, "message": "Failed to verify user", "transaction_id": "b1e2c3d4-4444-4a5b-8c6d-7e8f9a0b1c2d" } }, "Failed to verify user in VerifyUserManager Source Unavailable": { "summary": "Failed to verify user in VerifyUserManager: Source Unavailable", "value": { "code": 500, "timestamp": 1782806266274, "message": "Failed to verify user in VerifyUserManager: Source Unavailable", "transaction_id": "b1e2c3d4-4444-4a5b-8c6d-7e8f9a0b1c2d" } }, "Internal Server Error": { "summary": "Internal Server Error", "value": { "code": 500, "timestamp": 1782806266274, "message": "Internal Server Error", "transaction_id": "b1e2c3d4-4444-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} }, "503": { "description": "DigiLocker is not available. Send the request again later.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 503, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Source Unavailable": { "summary": "Source Unavailable", "value": { "code": 503, "timestamp": 1782806266274, "message": "Source Unavailable", "transaction_id": "b1e2c3d4-5555-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/digilocker/sessions/init": { "post": { "summary": "Initiate session", "deprecated": false, "description": "", "operationId": "initiateSession", "tags": [ "kyc", "digilocker" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "Media type of the request body.", "required": false, "example": "application/json", "schema": { "type": "string", "enum": [ "application/json" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "@entity": { "type": "string", "enum": [ "in.co.sandbox.kyc.digilocker.session.request" ] }, "flow": { "type": "string", "enum": [ "signin", "signup" ], "description": "Authentication flow to initiate on DigiLocker. Use `signin` for existing users or `signup` to create a new DigiLocker account." }, "redirect_url": { "type": "string", "format": "uri", "pattern": "^https://", "description": "HTTPS URL where the user will be redirected after granting or denying DigiLocker consent. Must be a valid, publicly accessible URL." }, "doc_types": { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1, "enum": [ "aadhaar", "pan", "driving_license" ] }, "description": "List of DigiLocker document types for which user consent is being requested." }, "options": { "type": "object", "properties": { "verification_method": { "type": "array", "items": { "type": "string", "enum": [ "aadhaar", "pan", "driving_license", "email", "username", "mobile", "other" ] }, "minItems": 1, "description": "Verification methods allowed during DigiLocker sign-up." }, "pinless": { "type": "boolean", "description": "Allow users to sign in using OTP without entering a DigiLocker PIN. Applicable only for the `signin` flow." }, "usernameless": { "type": "boolean", "description": "Allow users to skip username creation during DigiLocker sign-up. Applicable only for the `signup` flow." }, "verified_mobile": { "type": "string", "pattern": "^[6-9][0-9]{9}$", "description": "Mobile number already verified by your system to skip DigiLocker mobile OTP during sign-up." } }, "description": "Configuration object controlling the DigiLocker authentication and sign-up user experience." }, "consent_expiry": { "type": "integer", "description": "Unix epoch timestamp (milliseconds) after which the consent request expires. Must be at least 1 hour in the future." } }, "required": [ "@entity", "flow", "redirect_url", "doc_types" ] }, "examples": { "200 - OK": { "value": { "@entity": "in.co.sandbox.kyc.digilocker.session.request", "flow": "signin", "redirect_url": "https://developer.sandbox.co.in/", "doc_types": [ "aadhaar" ], "options": { "verification_method": [ "aadhaar" ], "pinless": true, "usernameless": true, "verified_mobile": "9687205427" } }, "summary": "200 - OK" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "data": { "type": "object", "properties": { "@entity": { "type": "string" }, "authorization_url": { "type": "string" }, "session_id": { "type": "string" } }, "required": [ "@entity", "authorization_url", "session_id" ] }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "200 - OK": { "summary": "200 - OK", "value": { "code": 200, "timestamp": 1751975600361, "data": { "@entity": "in.co.sandbox.kyc.digilocker.session.response", "authorization_url": "https://digilocker.meripehchaan.gov.in/public/oauth2/1/authorize?response_type=code&client_id=IW55C7A3B0&state=e385432b-575c-4b6f-8928-79136dbc0d4f%7Cf1bd0342-cc1d-4051-8301-e8ee17e3a3c3%7Chttps%3A%2F%2Fdeveloper.sandbox.co.in%2F&code_verifier=ADlMHKsr~L8YIwLoIOGgwwRQoouE-m~Z9yu0KWstrsKrdAtUY2IkmOoDWZNn80_G&code_challenge=pnowXsaM5mBqNR3NfSfsaLBC2JYjoy2eRLOwKNVjFY8&code_challenge_method=S256&scope=files.issueddocs&redirect_uri=https%3A%2F%2Fdeveloper.sandbox.co.in%2F&pla=Y&dl_flow=signup&plsignup=Y&amr=driving_license%2Baadhaar%2Bpan%2Bemail%2Busername%2Bmobile%2Bother&verified_mobile=9004813042&req_doctype=PANCR%2CADHAR%2CDRVLC&consent_valid_till=1752061999", "session_id": "f1bd0342-cc1d-4051-8301-e8ee17e3a3c3" }, "transaction_id": "a11c4e00-fae1-4092-a55f-b4f0be92ffeb" } } } } }, "headers": {} }, "400": { "description": "The request data is not correct. The `redirect_url` must be a full URL. The `consent_expiry` must be more than one hour in the future.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 400, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Invalid redirect url": { "summary": "Invalid redirect_url", "value": { "code": 400, "timestamp": 1782806266274, "message": "Invalid redirect_url", "transaction_id": "c2d3e4f5-1111-4a5b-8c6d-7e8f9a0b1c2d" } }, "Invalid consent expiry": { "summary": "Invalid consent_expiry", "value": { "code": 400, "timestamp": 1782806266274, "message": "Invalid consent_expiry", "transaction_id": "c2d3e4f5-1111-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} }, "500": { "description": "The request failed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 500, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Failed to initialize session": { "summary": "Failed to initialize session", "value": { "code": 500, "timestamp": 1782806266274, "message": "Failed to initialize session", "transaction_id": "c2d3e4f5-3333-4a5b-8c6d-7e8f9a0b1c2d" } }, "Failed to create session": { "summary": "Failed to create session", "value": { "code": 500, "timestamp": 1782806266274, "message": "Failed to create session", "transaction_id": "c2d3e4f5-3333-4a5b-8c6d-7e8f9a0b1c2d" } }, "Internal Server Error": { "summary": "Internal Server Error", "value": { "code": 500, "timestamp": 1782806266274, "message": "Internal Server Error", "transaction_id": "c2d3e4f5-3333-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/digilocker/sessions/{session_id}/status": { "get": { "summary": "Get session status", "deprecated": false, "description": "", "operationId": "getSessionStatus", "tags": [ "kyc", "digilocker" ], "parameters": [ { "name": "session_id", "in": "path", "description": "Session identifier generated during DigiLocker [Initiate Session API](https://developer.sandbox.co.in/api-reference/kyc/digilocker/endpoints/initiate_session) .", "required": true, "example": "839fd8a0-d645-42e1-a904-bb43353b0139", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" }, "@entity": { "type": "string" }, "status": { "type": "string", "enum": [ "created", "succeeded", "failed", "expired" ], "description": "Lifecycle state of the DigiLocker session. `created`: session initiated, consent not yet completed. `succeeded`: user completed DigiLocker consent and documents can be fetched. `expired`: the DigiLocker access token backing this session is no longer valid (for example, after the token's natural expiry), so the session can no longer be used to fetch documents or the profile. `failed`: authorization did not complete and the session is unusable, including when the cause was transient; start a new session." }, "documents_consented": { "type": "array", "items": { "type": "string", "enum": [ "aadhaar", "pan", "driving_license" ] }, "description": "Document types the user has consented to on DigiLocker. Only present when `status` is `succeeded`." } }, "required": [ "id", "created_at", "@entity", "status" ] }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "200 - Session Created": { "summary": "200 - Session Created", "value": { "code": 200, "timestamp": 1752580258171, "data": { "id": "839fd8a0-d645-42e1-a904-bb43353b0139", "created_at": 1752579445983, "@entity": "in.co.sandbox.kyc.digilocker.session", "status": "created" }, "transaction_id": "800ff751-2191-4b7d-b20a-8301790a3e19" } }, "200 - Session Succeeded": { "summary": "200 - Session Succeeded", "value": { "code": 200, "timestamp": 1752580258171, "data": { "id": "839fd8a0-d645-42e1-a904-bb43353b0139", "created_at": 1752579445983, "updated_at": 1752579512340, "@entity": "in.co.sandbox.kyc.digilocker.session", "status": "succeeded", "documents_consented": [ "aadhaar", "pan" ] }, "transaction_id": "800ff751-2191-4b7d-b20a-8301790a3e19" } }, "200 - Session Failed": { "summary": "200 - Session Failed", "value": { "code": 200, "timestamp": 1752580258171, "data": { "id": "839fd8a0-d645-42e1-a904-bb43353b0139", "created_at": 1752579445983, "updated_at": 1752579498221, "@entity": "in.co.sandbox.kyc.digilocker.session", "status": "failed" }, "transaction_id": "800ff751-2191-4b7d-b20a-8301790a3e19" } }, "200 - Session Expired": { "summary": "200 - Session Expired", "value": { "code": 200, "timestamp": 1752580258171, "data": { "id": "839fd8a0-d645-42e1-a904-bb43353b0139", "created_at": 1752579445983, "updated_at": 1752580200110, "@entity": "in.co.sandbox.kyc.digilocker.session", "status": "expired" }, "transaction_id": "800ff751-2191-4b7d-b20a-8301790a3e19" } } } } }, "headers": {} }, "429": { "description": "There were too many requests to DigiLocker. Wait, then send the request again.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 429, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Too Many Requests": { "summary": "Too Many Requests", "value": { "code": 429, "timestamp": 1782806266274, "message": "Too Many Requests", "transaction_id": "d3e4f5a6-1111-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} }, "500": { "description": "The request failed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 500, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Failed to get session status": { "summary": "Failed to get session status", "value": { "code": 500, "timestamp": 1782806266274, "message": "Failed to get session status", "transaction_id": "d3e4f5a6-2222-4a5b-8c6d-7e8f9a0b1c2d" } }, "Failed to get session": { "summary": "Failed to get session", "value": { "code": 500, "timestamp": 1782806266274, "message": "Failed to get session", "transaction_id": "d3e4f5a6-2222-4a5b-8c6d-7e8f9a0b1c2d" } }, "Failed to update session": { "summary": "Failed to update session", "value": { "code": 500, "timestamp": 1782806266274, "message": "Failed to update session", "transaction_id": "d3e4f5a6-2222-4a5b-8c6d-7e8f9a0b1c2d" } }, "Internal Server Error": { "summary": "Internal Server Error", "value": { "code": 500, "timestamp": 1782806266274, "message": "Internal Server Error", "transaction_id": "d3e4f5a6-2222-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} }, "503": { "description": "DigiLocker is not available. Send the request again later.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 503, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Source Unavailable": { "summary": "Source Unavailable", "value": { "code": 503, "timestamp": 1000000000000, "message": "Source Unavailable", "transaction_id": "6c05f692-c32f-4de0-92b4-56684bdf16f0" } } } } }, "headers": {} }, "521": { "description": "The server cannot find a session with this `session_id`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 521, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Data not found": { "summary": "Data not found", "value": { "code": 521, "timestamp": 1782806266274, "message": "Data not found for: 196c64a5-8cfb-45dd-a51c-0c8534774d07", "transaction_id": "a599615c-c732-4538-9840-4bb5cd3c19d2" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/digilocker/sessions/{session_id}/user/profile": { "get": { "summary": "Get User Profile", "deprecated": false, "description": "Gets the User Profile Details from Digilocker.", "operationId": "getUserProfile", "tags": [ "kyc", "digilocker" ], "parameters": [ { "name": "session_id", "in": "path", "description": "Session identifier generated during DigiLocker [Initiate Session API](https://developer.sandbox.co.in/api-reference/kyc/digilocker/endpoints/initiate_session) .", "required": true, "example": "{{session_id}}", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code." }, "timestamp": { "type": "integer", "description": "Unix timestamp (in milliseconds) indicating when the server generated the response." }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Digilocker Id" }, "@entity": { "type": "string", "description": "Entity identifier that specifies the type of response being returned." }, "date_of_birth": { "type": "integer", "description": "Date of Birth of User" }, "mobile": { "type": "string", "description": "Mobile Number of User" }, "name": { "type": "string", "description": "Full Name of User" }, "gender": { "type": "string", "description": "Gender of User", "enum": [ "male", "female", "transgender" ] }, "eaadhaar": { "type": "boolean", "description": "Boolean indicating eaadhaar status of User" }, "email": { "type": "string", "description": "Email Address of User" } }, "required": [ "@entity", "id", "name", "date_of_birth", "gender", "eaadhaar", "mobile", "email" ], "description": "Response payload containing the requested data or error details." }, "transaction_id": { "type": "string", "description": "Unique identifier for tracking the request across systems." } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "200 - OK": { "summary": "200 - OK", "value": { "code": 200, "timestamp": 1744874068219, "data": { "id": "b5522c8f-2321-577b-8e73-ae1366d9c591", "@entity": "in.co.sandbox.kyc.digilocker.user.profile", "date_of_birth": 1071145000000, "mobile": "9825013730", "name": "Kaival Mehta", "gender": "male", "eaadhaar": true }, "transaction_id": "0793c784-fcaa-44d9-b8fc-f6a382a67f70" } } } } }, "headers": {} }, "429": { "description": "There were too many requests to DigiLocker. Wait, then send the request again.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 429, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Too Many Requests": { "summary": "Too Many Requests", "value": { "code": 429, "timestamp": 1782806266274, "message": "Too Many Requests", "transaction_id": "e4f5a6b7-3333-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} }, "500": { "description": "The request failed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 500, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Failed to get user details": { "summary": "Failed to get user details", "value": { "code": 500, "timestamp": 1782806266274, "message": "Failed to get user details", "transaction_id": "e4f5a6b7-4444-4a5b-8c6d-7e8f9a0b1c2d" } }, "Failed to expire session": { "summary": "Failed to expire session", "value": { "code": 500, "timestamp": 1782806266274, "message": "Failed to expire session", "transaction_id": "e4f5a6b7-4444-4a5b-8c6d-7e8f9a0b1c2d" } }, "Internal Server Error": { "summary": "Internal Server Error", "value": { "code": 500, "timestamp": 1782806266274, "message": "Internal Server Error", "transaction_id": "e4f5a6b7-4444-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} }, "503": { "description": "DigiLocker is not available. Send the request again later.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 503, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Source Unavailable": { "summary": "Source Unavailable", "value": { "code": 503, "timestamp": 1000000000000, "message": "Source Unavailable", "transaction_id": "6c05f692-c32f-4de0-92b4-56684bdf16f0" } } } } }, "headers": {} }, "521": { "description": "The server cannot find a session with this `session_id`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 521, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Data not found": { "summary": "Data not found", "value": { "code": 521, "timestamp": 1782806266274, "message": "Data not found for: 196c64a5-8cfb-45dd-a51c-0c8534774d07", "transaction_id": "a599615c-c732-4538-9840-4bb5cd3c19d2" } } } } }, "headers": {} }, "523": { "description": "The session cannot be used. Either the session did not complete the DigiLocker consent flow, or the DigiLocker access token is no longer valid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 523, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Invalid session status: created": { "summary": "Invalid session status: created", "value": { "code": 523, "timestamp": 1782806266274, "message": "Invalid session status: created", "transaction_id": "e4f5a6b7-5555-4a5b-8c6d-7e8f9a0b1c2d" } }, "Session expired": { "summary": "Session expired", "value": { "code": 523, "timestamp": 1782806266274, "message": "Session expired", "transaction_id": "e4f5a6b7-5555-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/digilocker/sessions/{session_id}/documents/{doc_type}": { "get": { "summary": "Fetch document", "deprecated": false, "description": "", "operationId": "getDocument", "tags": [ "kyc", "digilocker" ], "parameters": [ { "name": "session_id", "in": "path", "description": "Session identifier generated during DigiLocker [Initiate Session API](https://developer.sandbox.co.in/api-reference/kyc/digilocker/endpoints/initiate_session) .", "required": true, "example": "{{session_id}}", "schema": { "type": "string" } }, { "name": "doc_type", "in": "path", "description": "Document type identifying which DigiLocker document to retrieve. Must match one of the consented doc_types values.", "required": true, "example": "aadhaar", "schema": { "type": "string", "enum": [ "aadhaar", "pan", "driving_license" ] } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "data": { "type": "object", "properties": { "files": { "type": "array", "items": { "type": "object", "properties": { "@entity": { "type": "string", "const": "org.quicko.drive.file" }, "url": { "type": "string" }, "size": { "type": "integer" }, "metadata": { "type": "object", "properties": { "ContentType": { "type": "string" }, "issuer_id": { "type": "string" }, "issuer": { "type": "string" }, "LastModified": { "type": "string" }, "description": { "type": "string" } }, "required": [ "ContentType", "issuer_id", "issuer", "LastModified", "description" ] } } } } }, "required": [ "files" ] }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "200 - OK": { "summary": "200 - OK", "value": { "code": 200, "timestamp": 1751975529441, "data": { "files": [ { "@entity": "org.quicko.drive.file", "url": "https://in-co-sandbox-kyc-digilocker-dev.s3.ap-south-1.amazonaws.com/non-persistent/e385432b-575c-4b6f-8928-79136dbc0d4f/4b4bf7aa-f4da-47a8-9b32-895edfc03630/in.gov.uidai-ADHAR-0d5fe4d692c73e23c59a694eaaabc75a.xml?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=%2F20250708%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20250708T115214Z&X-Amz-Expires=3600&X-Amz-Signature=8cc4b0e8eb3794601c7fdb7e85f3a6bb3a8e1842403c8aeae5c05b7af03bdadb&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject", "size": 16598, "metadata": { "ContentType": "application/xml", "issuer_id": "in.gov.uidai", "issuer": "Unique Identification Authority of India (UIDAI)", "LastModified": "09/05/2025", "description": "Aadhaar Card" } } ] }, "transaction_id": "a4d43b74-0f9c-480c-9300-f011100b674b" } } } } }, "headers": {} }, "400": { "description": "The `doc_type` is not valid, or the user did not give consent for this document.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 400, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Invalid document type": { "summary": "Invalid document type", "value": { "code": 400, "timestamp": 1782806266274, "message": "Invalid document type", "transaction_id": "f5a6b7c8-1111-4a5b-8c6d-7e8f9a0b1c2d" } }, "Consent for aadhaar not provided": { "summary": "Consent for aadhaar not provided", "value": { "code": 400, "timestamp": 1782806266274, "message": "Consent for aadhaar not provided", "transaction_id": "f5a6b7c8-1111-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} }, "404": { "description": "DigiLocker cannot provide the document. DigiLocker has no record of the document, or the issuer did not provide it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 404, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Doctype not found": { "summary": "Doctype not found", "value": { "code": 404, "timestamp": 1782806266274, "message": "Doctype not found", "transaction_id": "f5a6b7c8-5555-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} }, "429": { "description": "There were too many requests to DigiLocker. Wait, then send the request again.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 429, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Too Many Requests": { "summary": "Too Many Requests", "value": { "code": 429, "timestamp": 1782806266274, "message": "Too Many Requests", "transaction_id": "f5a6b7c8-6666-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} }, "500": { "description": "The request failed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 500, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Failed to get document": { "summary": "Failed to get document", "value": { "code": 500, "timestamp": 1782806266274, "message": "Failed to get document", "transaction_id": "f5a6b7c8-7777-4a5b-8c6d-7e8f9a0b1c2d" } }, "Failed to expire session": { "summary": "Failed to expire session", "value": { "code": 500, "timestamp": 1782806266274, "message": "Failed to expire session", "transaction_id": "f5a6b7c8-7777-4a5b-8c6d-7e8f9a0b1c2d" } }, "Internal Server Error": { "summary": "Internal Server Error", "value": { "code": 500, "timestamp": 1782806266274, "message": "Internal Server Error", "transaction_id": "f5a6b7c8-7777-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} }, "503": { "description": "DigiLocker is not available. Send the request again later.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 503, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Source Unavailable": { "summary": "Source Unavailable", "value": { "code": 503, "timestamp": 1000000000000, "message": "Source Unavailable", "transaction_id": "6c05f692-c32f-4de0-92b4-56684bdf16f0" } } } } }, "headers": {} }, "521": { "description": "The server cannot find a session with this `session_id`.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 521, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Data not found": { "summary": "Data not found", "value": { "code": 521, "timestamp": 1782806266274, "message": "Data not found for: 196c64a5-8cfb-45dd-a51c-0c8534774d07", "transaction_id": "a599615c-c732-4538-9840-4bb5cd3c19d2" } } } } }, "headers": {} }, "523": { "description": "The session cannot be used. Either the session did not complete the DigiLocker consent flow, or the DigiLocker access token is no longer valid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 523, "description": "The HTTP status code." }, "timestamp": { "type": "integer", "description": "The time of the response. The unit is milliseconds from the Unix epoch." }, "message": { "type": "string", "description": "The error message." }, "transaction_id": { "type": "string", "description": "The unique identifier of the request." } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Invalid session status: created": { "summary": "Invalid session status: created", "value": { "code": 523, "timestamp": 1782806266274, "message": "Invalid session status: created", "transaction_id": "f5a6b7c8-8888-4a5b-8c6d-7e8f9a0b1c2d" } }, "Session expired": { "summary": "Session expired", "value": { "code": 523, "timestamp": 1782806266274, "message": "Session expired", "transaction_id": "f5a6b7c8-8888-4a5b-8c6d-7e8f9a0b1c2d" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/aadhaar/okyc/otp": { "post": { "summary": "Aadhaar Offline e-KYC Generate OTP", "deprecated": false, "description": "", "operationId": "generateOTP", "tags": [ "kyc", "aadhaar" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "Media type of the request body.", "required": false, "example": "application/json", "schema": { "type": "string", "enum": [ "application/json" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "@entity": { "type": "string", "enum": [ "in.co.sandbox.kyc.aadhaar.okyc.otp.request" ] }, "aadhaar_number": { "type": "string", "description": "12-digit Aadhaar number of the individual for whom the OTP will be generated. Must contain exactly 12 numeric digits with no spaces or separators.", "minLength": 12, "maxLength": 12, "pattern": "^[0-9]{12}$" }, "consent": { "type": "string", "enum": [ "Y", "y" ], "description": "Explicit consent from the end user to use their Aadhaar details for OTP-based verification. Must be passed as \"Y\" or \"y\" to proceed." }, "reason": { "type": "string", "description": "Purpose for initiating Aadhaar OTP verification, such as identity verification or KYC compliance. Used for audit, compliance, and request traceability." } }, "required": [ "@entity", "aadhaar_number", "consent", "reason" ] }, "examples": { "200 - OTP Generated": { "value": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.request", "aadhaar_number": "123456789012", "consent": "y", "reason": "For KYC" }, "summary": "200 - OTP Generated" }, "200 - OTP Generated | Invalid OTP": { "value": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.request", "aadhaar_number": "123456789015", "consent": "y", "reason": "For KYC" }, "summary": "200 - OTP Generated | Invalid OTP" }, "200 - OTP Generated | OTP Expired": { "value": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.request", "aadhaar_number": "123456789016", "consent": "y", "reason": "For KYC" }, "summary": "200 - OTP Generated | OTP Expired" }, "200 - OTP Generated | Invalid Reference ID": { "value": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.request", "aadhaar_number": "123456789017", "consent": "y", "reason": "For KYC" }, "summary": "200 - OTP Generated | Invalid Reference ID" }, "200 - OTP Generated | Request under process": { "value": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.request", "aadhaar_number": "123456789018", "consent": "y", "reason": "For KYC" }, "summary": "200 - OTP Generated | Request under process" }, "200 - Invalid Aadhaar Card": { "value": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.request", "aadhaar_number": "123456789013", "consent": "y", "reason": "For KYC" }, "summary": "200 - Invalid Aadhaar Card" }, "422 - Invalid Aadhaar number pattern": { "value": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.request", "aadhaar_number": "1234567890123", "consent": "y", "reason": "For KYC" }, "summary": "422 - Invalid Aadhaar number pattern" }, "503 - Source Unavailable": { "value": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.request", "aadhaar_number": "123456789020", "consent": "y", "reason": "For KYC" }, "summary": "503 - Source Unavailable" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string", "format": "uuid" }, "data": { "type": "object", "properties": { "@entity": { "type": "string", "const": "in.co.sandbox.kyc.aadhaar.okyc.otp.response" }, "reference_id": { "type": "integer" }, "message": { "type": "string" } }, "required": [ "@entity", "reference_id", "message" ] } }, "required": [ "data", "transaction_id", "timestamp", "code" ] }, "examples": { "200 - OTP Generated": { "summary": "200 - OTP Generated", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "7d75d9db-0870-4719-8884-a3eee7bd68d5", "data": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.response", "reference_id": 1234567, "message": "OTP sent successfully" } } }, "200 - OTP Generated | Invalid OTP": { "summary": "200 - OTP Generated | Invalid OTP", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "7774ca39-156c-44f4-bcb2-9ea4c918810e", "data": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.response", "reference_id": 1234568, "message": "OTP sent successfully" } } }, "200 - OTP Generated | OTP Expired": { "summary": "200 - OTP Generated | OTP Expired", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "c5780d5a-6af4-4689-a853-bc6460bfc5fb", "data": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.response", "reference_id": 1234569, "message": "OTP sent successfully" } } }, "200 - OTP Generated | Invalid Reference ID": { "summary": "200 - OTP Generated | Invalid Reference ID", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "85ce458f-51c7-452c-8970-f0b76f82f6f1", "data": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.response", "reference_id": 1234566, "message": "OTP sent successfully" } } }, "200 - OTP Generated | Request under process": { "summary": "200 - OTP Generated | Request under process", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "2532e897-fd40-4b07-ae1f-d0274a2dc37d", "data": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.response", "reference_id": 1234570, "message": "OTP sent successfully" } } }, "200 - Invalid Aadhaar Card": { "summary": "200 - Invalid Aadhaar Card", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "db1d7415-2ce9-4a5a-ad98-b5d5a9499915", "data": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.response", "reference_id": 78829, "message": "Invalid Aadhaar Card" } } } } } }, "headers": {} }, "422": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string", "format": "uuid" }, "message": { "type": "string" } }, "required": [ "transaction_id", "timestamp", "code", "message" ] }, "examples": { "422 - Invalid Aadhaar number pattern": { "summary": "422 - Invalid Aadhaar number pattern", "value": { "code": 422, "timestamp": 1000000000000, "transaction_id": "bc23288b-308f-4cd3-b688-94334bcfbcb6", "message": "Invalid Aadhaar number pattern" } } } } }, "headers": {} }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string", "format": "uuid" }, "message": { "type": "string" } }, "required": [ "code", "timestamp", "transaction_id", "message" ] }, "examples": { "503 - Source Unavailable": { "summary": "503 - Source Unavailable", "value": { "code": 503, "timestamp": 1000000000000, "transaction_id": "d9d89bfd-64fd-4a28-91b5-d7c26f3931c6", "message": "Source Unavailable" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/aadhaar/okyc/otp/verify": { "post": { "summary": "Aadhaar Offline e-KYC Verify OTP", "deprecated": false, "description": "", "operationId": "verifyOTP", "tags": [ "kyc", "aadhaar" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "Media type of the request body.", "required": false, "example": "application/json", "schema": { "type": "string", "enum": [ "application/json" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "@entity": { "type": "string", "const": "in.co.sandbox.kyc.aadhaar.okyc.request" }, "reference_id": { "type": "string", "description": "Unique reference identifier returned by the [Generate OTP API](https://developer.sandbox.co.in/api-reference/kyc/aadhaar/endpoints/generate_otp) for this Aadhaar verification flow. Used to correlate the OTP submission with the original request." }, "otp": { "type": "string", "description": "6-digit one-time password sent to the mobile number linked with the Aadhaar. Must be entered exactly as received and is valid only for the associated reference_id.", "pattern": "^[0-9]{6}$", "minLength": 6, "maxLength": 6 } }, "required": [ "@entity", "reference_id", "otp" ] }, "examples": { "200 - Success": { "value": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.request", "reference_id": "1234567", "otp": "121212" }, "summary": "200 - Success" }, "200 - Invalid OTP": { "value": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.request", "reference_id": "1234568", "otp": "121211" }, "summary": "200 - Invalid OTP" }, "200 - OTP Expired": { "value": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.request", "reference_id": "1234569", "otp": "121711" }, "summary": "200 - OTP Expired" }, "200 - Request under process": { "value": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.request", "reference_id": "1234570", "otp": "121811" }, "summary": "200 - Request under process" }, "422 - OTP missing in request": { "value": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.request", "ref_id": "1234567", "otp": "" }, "summary": "422 - OTP missing in request" }, "503 - Source Unavailable": { "value": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.request", "reference_id": "1234567", "otp": "112233" }, "summary": "503 - Source Unavailable" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string" }, "data": { "type": "object", "properties": { "@entity": { "type": "string", "const": "in.co.sandbox.kyc.aadhaar.okyc" }, "reference_id": { "type": "integer" }, "status": { "type": "string" }, "message": { "type": "string" }, "care_of": { "type": "string" }, "full_address": { "type": "string" }, "date_of_birth": { "type": "string" }, "email_hash": { "type": "string" }, "gender": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "object", "properties": { "@entity": { "type": "string" }, "country": { "type": "string" }, "district": { "type": "string" }, "house": { "type": "string" }, "landmark": { "type": "string" }, "pincode": { "type": "string" }, "post_office": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "subdistrict": { "type": "string" }, "vtc": { "type": "string" } }, "required": [ "@entity", "country", "district", "house", "landmark", "pincode", "post_office", "state", "street", "subdistrict", "vtc" ] }, "year_of_birth": { "type": "string" }, "mobile_hash": { "type": "string" }, "photo": { "type": "string" }, "share_code": { "type": "string" } }, "required": [ "@entity", "reference_id", "status", "message", "care_of", "full_address", "date_of_birth", "email_hash", "gender", "name", "address", "year_of_birth", "mobile_hash", "photo", "share_code" ] } }, "required": [ "code", "timestamp", "transaction_id", "data" ] }, "examples": { "200 - Success": { "summary": "200 - Success", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "90d6ea41-210f-43c2-b830-83d6a03aaa77", "data": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc", "reference_id": 1234567, "status": "VALID", "message": "Aadhaar Card Exists", "care_of": "S/O: Johnny Doe", "full_address": "Mangal Kanaka Niwas, Main Cross 3rd, Bengaluru, Bengaluru-Karnataka, India ", "date_of_birth": "21-04-1985", "email_hash": "044917e2c4c62a439d068.......d9f71bbde10b1d227a914e", "gender": "M", "name": "John Doe", "address": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc.address", "country": "India", "district": "Bengaluru", "house": "Mangal Kanaka Niwas", "landmark": "", "pincode": "581615", "post_office": "Bengaluru", "state": "Karnataka", "street": "Main Cross 3rd", "subdistrict": "", "vtc": "Bengaluru" }, "year_of_birth": "1985", "mobile_hash": "044917e2c4c62a439d068.......d9f71bbde10b1d227a914e", "photo": "data:image/jpeg;base64,/9j/4AAQSk.......mj/2Q==", "share_code": "1234" } } }, "200 - Invalid OTP": { "summary": "200 - Invalid OTP", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "93589946-3cbd-4a3d-863d-0157e8572047", "data": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc", "message": "Invalid OTP" } } }, "200 - OTP Expired": { "summary": "200 - OTP Expired", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "bacdbbc4-8fc7-4f95-8d3a-b19b466657d2", "data": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc", "message": "OTP Expired" } } }, "200 - Request under process": { "summary": "200 - Request under process", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "d51b4e29-0388-4bfb-9daf-aae713e95438", "data": { "@entity": "in.co.sandbox.kyc.aadhaar.okyc", "message": "Request under process, please try after 30 seconds" } } } } } }, "headers": {} }, "422": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "timestamp", "transaction_id", "message" ] }, "examples": { "422 - OTP missing in request": { "summary": "422 - OTP missing in request", "value": { "code": 422, "timestamp": 1000000000000, "transaction_id": "19df85de-0ed5-43a0-afa3-fced43eef994", "message": "OTP missing in request" } } } } }, "headers": {} }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string", "format": "uuid" }, "message": { "type": "string" } }, "required": [ "code", "timestamp", "transaction_id", "message" ] }, "examples": { "503 - Source Unavailable": { "summary": "503 - Source Unavailable", "value": { "code": 503, "timestamp": 1000000000000, "transaction_id": "da6d6d57-5215-41eb-94cb-cb543966734e", "message": "Source Unavailable" } } } } }, "headers": {} } }, "security": [] } }, "/bank/{ifsc}": { "get": { "summary": "IFSC Verification", "deprecated": false, "description": "You can identify a bank branch details from given IFSC code", "operationId": "verifyIFSC", "tags": [ "kyc", "bank" ], "parameters": [ { "name": "ifsc", "in": "path", "description": "11-digit alpha-numeric code used to identify the bank branches", "required": true, "example": "HDFC0001234", "schema": { "type": "string", "pattern": "^[A-Za-z]{4}[a-zA-Z0-9]{7}$" } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "MICR": { "type": "string" }, "BRANCH": { "type": "string" }, "ADDRESS": { "type": "string" }, "STATE": { "type": "string" }, "CONTACT": { "type": "string" }, "UPI": { "type": "boolean" }, "RTGS": { "type": "boolean" }, "CITY": { "type": "string" }, "CENTRE": { "type": "string" }, "DISTRICT": { "type": "string" }, "NEFT": { "type": "boolean" }, "IMPS": { "type": "boolean" }, "SWIFT": { "type": "string" }, "ISO3166": { "type": "string" }, "BANK": { "type": "string" }, "BANKCODE": { "type": "string" }, "IFSC": { "type": "string" } }, "required": [ "MICR", "BRANCH", "ADDRESS", "STATE", "CONTACT", "UPI", "RTGS", "CITY", "CENTRE", "DISTRICT", "NEFT", "IMPS", "SWIFT", "ISO3166", "BANK", "BANKCODE", "IFSC" ] }, "examples": { "200 - Success": { "summary": "200 - Success", "value": { "MICR": "302240007", "BRANCH": "PARK STREET", "ADDRESS": "3 PARK STREET M I ROAD M I ROAD", "STATE": "RAJASTHAN", "CONTACT": "+919875003333", "UPI": true, "RTGS": true, "CITY": "JAIPUR", "CENTRE": "JAIPUR", "DISTRICT": "JAIPUR", "NEFT": true, "IMPS": true, "SWIFT": "HDFCINBB", "ISO3166": "IN-RJ", "BANK": "HDFC Bank", "BANKCODE": "HDFC", "IFSC": "HDFC0001234" } } } } }, "headers": {} }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "headers": {} } }, "security": [] } }, "/bank/{ifsc}/accounts/{account_number}/verify": { "get": { "summary": "Bank Account Verification [Penny-Drop]", "deprecated": false, "description": "", "operationId": "verifyBankUsingPennyDrop", "tags": [ "kyc", "bank" ], "parameters": [ { "name": "ifsc", "in": "path", "description": "11-digit alpha-numeric code used to identify the bank branches", "required": true, "example": "SBIN0061411", "schema": { "type": "string", "pattern": "^[A-Za-z]{4}[a-zA-Z0-9]{7}$" } }, { "name": "account_number", "in": "path", "description": "Bank account number. Max length: 40 characters", "required": true, "example": "42090969996", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "`optional` Name. Max length: 100 characters", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "mobile", "in": "query", "description": "`optional` Mobile. Length: 10 digits", "required": false, "example": "", "schema": { "type": "string", "pattern": "^[6-9]\\d{9}$" } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-accept-cache", "in": "header", "description": "Controls cache behavior for the request:\ntrue — Return cached response if available\nfalse — Bypass cache and fetch fresh data from origin\nDefault: If omitted, returns fresh data from origin", "required": false, "example": "false", "schema": { "type": "boolean" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string" }, "data": { "type": "object", "properties": { "@entity": { "type": "string", "const": "@in.co.sandbox.bank.account.penny_drop_verification_response" }, "message": { "type": "string" }, "account_exists": { "type": "boolean" }, "name_at_bank": { "type": "string" }, "utr": { "type": "string", "pattern": "[0-9]", "minLength": 12, "maxLength": 22 }, "amount_deposited": { "type": "string" } }, "required": [ "@entity", "message", "account_exists", "name_at_bank", "utr", "amount_deposited" ] } }, "required": [ "code", "timestamp", "transaction_id", "data" ] }, "examples": { "200 - Success": { "summary": "200 - Success", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "46e33c70-e192-49cb-8d0f-e0c4489d0958", "data": { "@entity": "@in.co.sandbox.bank.account.penny_drop_verification_response", "message": "Bank Account details verified successfully.", "account_exists": true, "name_at_bank": "John Doe", "utr": "329613870973", "amount_deposited": "1" } } }, "200 - Invalid account number or ifsc provided": { "summary": "200 - Invalid account number or ifsc provided", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "d3ae9904-3c19-4123-b360-6c2d060a3cab", "data": { "@entity": "@in.co.sandbox.bank.account.penny_drop_verification_response", "message": "Invalid account number or ifsc provided", "account_exists": false } } }, "200 - Given account is an NRE account": { "summary": "200 - Given account is an NRE account", "value": { "code": 200, "timestamp": 1698047469406, "transaction_id": "33f8ce3e-ca54-4364-ae85-2f54bae21610", "data": { "@entity": "@in.co.sandbox.bank.account.penny_drop_verification_response", "message": "Given account is an NRE account", "account_exists": true } } }, "200 - Account is blocked": { "summary": "200 - Account is blocked", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "85ff18b4-d955-414c-b078-617a6f545311", "data": { "@entity": "@in.co.sandbox.bank.account.penny_drop_verification_response", "message": "Account is blocked", "account_exists": true } } }, "200 - IFSC is invalid": { "summary": "200 - IFSC is invalid", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "15870757-53ea-4121-8037-b7cf1e9b7e92", "data": { "@entity": "@in.co.sandbox.bank.account.penny_drop_verification_response", "message": "IFSC is invalid" } } }, "200 - Source bank declined": { "summary": "200 - Source bank declined", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "6391647d-3dae-41ab-a59d-607202c8800e", "data": { "@entity": "@in.co.sandbox.bank.account.penny_drop_verification_response", "message": "Source bank declined" } } }, "200 - Beneficiary bank offline": { "summary": "200 - Beneficiary bank offline", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "a470d6c2-0589-4bf1-a46e-c11c347a9fba", "data": { "@entity": "@in.co.sandbox.bank.account.penny_drop_verification_response", "message": "Beneficiary bank offline" } } }, "200 - NPCI Unavailable": { "summary": "200 - NPCI Unavailable", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "a3083c7e-a879-402c-a8db-506d14f9f694", "data": { "@entity": "@in.co.sandbox.bank.account.penny_drop_verification_response", "message": "NPCI Unavailable" } } }, "200 - IMPS Mode fail": { "summary": "200 - IMPS Mode fail", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "7bd3baa3-13ac-49f5-acd9-1d7fb9dea291", "data": { "@entity": "@in.co.sandbox.bank.account.penny_drop_verification_response", "message": "IMPS Mode fail" } } } } } }, "headers": {} }, "422": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "timestamp", "transaction_id", "message" ] }, "examples": { "422 - Invalid IFSC pattern": { "summary": "422 - Invalid IFSC pattern", "value": { "code": 422, "timestamp": 1000000000000, "transaction_id": "69ab2c4e-b157-405c-9c9c-37b6aa7f319f", "message": "Invalid IFSC pattern" } }, "422 - Please provide a valid bank account": { "summary": "422 - Please provide a valid bank account", "value": { "code": 422, "timestamp": 1000000000000, "transaction_id": "d2167bd1-8481-4a37-8912-8aca82a7e02a", "message": "Please provide a valid bank account" } }, "422 - Invalid IFSC provided": { "summary": "422 - Invalid IFSC provided", "value": { "code": 422, "timestamp": 1000000000000, "transaction_id": "9ea80340-0833-4c62-9615-92978a1f266c", "message": "Invalid IFSC provided" } } } } }, "headers": {} }, "500": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "timestamp", "transaction_id", "message" ] }, "examples": { "500 - Failed at bank": { "summary": "500 - Failed at bank", "value": { "code": 500, "timestamp": 1000000000000, "transaction_id": "3675d6b1-5852-4215-94bf-b24f9efaf3dd", "message": "Failed at bank" } }, "500 - Transaction failed": { "summary": "500 - Transaction failed", "value": { "code": 500, "timestamp": 1000000000000, "transaction_id": "b27c715f-6e3a-47ad-9dd5-85c6f43268d2", "message": "Transaction failed" } }, "500 - IMPS not supported on Beneficiary account": { "summary": "500 - IMPS not supported on Beneficiary account", "value": { "code": 500, "timestamp": 1000000000000, "transaction_id": "52e751ec-845c-4f68-8fe4-5a5e4dcdde70", "message": "IMPS not supported on Beneficiary account" } } } } }, "headers": {} }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "timestamp", "transaction_id", "message" ] }, "examples": { "503 - Source Unavailable": { "summary": "503 - Source Unavailable", "value": { "code": 503, "timestamp": 1000000000000, "transaction_id": "2f67b66e-7202-4319-8fc3-12eb99a91d21", "message": "Source Unavailable" } } } } }, "headers": {} } }, "security": [] } }, "/bank/{ifsc}/accounts/{account_number}/penniless-verify": { "get": { "summary": "Bank Account Verification [Penny-Less]", "deprecated": false, "description": "", "operationId": "verifyBankUsingPennyLess", "tags": [ "kyc", "bank" ], "parameters": [ { "name": "ifsc", "in": "path", "description": "11-digit alpha-numeric code used to identify the bank branches", "required": true, "example": "UTIB0002006", "schema": { "type": "string", "pattern": "^[A-Za-z]{4}[a-zA-Z0-9]{7}$" } }, { "name": "account_number", "in": "path", "description": "Bank account number. Max length: 40 characters", "required": true, "example": "919010019387396", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name. Max length: 100 characters", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "mobile", "in": "query", "description": "Mobile. Length: 10 digits", "required": false, "example": "", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-accept-cache", "in": "header", "description": "Controls cache behavior for the request:\ntrue — Return cached response if available\nfalse — Bypass cache and fetch fresh data from origin\nDefault: If omitted, returns fresh data from origin", "required": false, "example": "true", "schema": { "type": "boolean" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string" }, "data": { "type": "object", "properties": { "@entity": { "type": "string", "const": "@in.co.sandbox.bank.account.penny_less_verification_response" }, "account_exists": { "type": "boolean" }, "name_at_bank": { "type": "string" } }, "required": [ "@entity", "account_exists", "name_at_bank" ] } }, "required": [ "code", "timestamp", "transaction_id", "data" ] }, "examples": { "200 - Success": { "summary": "200 - Success", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "3fd57890-2b90-4b41-ab10-1ffeaef85fb3", "data": { "@entity": "@in.co.sandbox.bank.account.penny_less_verification_response", "account_exists": true, "name_at_bank": "JOHN DOE" } } }, "200 - Success Business": { "summary": "200 - Success Business", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "744fb880-f2c8-4500-b782-40bdcfa16876", "data": { "@entity": "@in.co.sandbox.bank.account.penny_less_verification_response", "account_exists": true, "name_at_bank": "JAKE INCORPORATED" } } }, "200 - Invalid Account or IFSC": { "summary": "200 - Invalid Account or IFSC", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "82499e2e-3846-4a5f-848d-a2f79fda73e8", "data": { "@entity": "@in.co.sandbox.bank.account.penny_less_verification_response", "message": "Invalid account number or ifsc provided", "account_exists": false } } }, "200 - Beneficiary Bank Offline": { "summary": "200 - Beneficiary Bank Offline", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "a9f811e7-2341-43b5-aa2f-ee77c373b606", "data": { "@entity": "@in.co.sandbox.bank.account.penny_less_verification_response", "message": "Beneficiary bank offline" } } }, "200 - Account Blocked": { "summary": "200 - Account Blocked", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "4e666e3e-dd0c-440a-935e-d2cef89c6fd3", "data": { "@entity": "@in.co.sandbox.bank.account.penny_less_verification_response", "message": "Account is blocked", "account_exists": true } } } } } }, "headers": {} }, "422": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "timestamp", "transaction_id", "message" ] }, "examples": { "422 - Invalid IFSC pattern": { "summary": "422 - Invalid IFSC pattern", "value": { "code": 422, "timestamp": 1000000000000, "transaction_id": "630fe70b-ef99-418f-9d63-928b60213814", "message": "Invalid IFSC pattern" } } } } }, "headers": {} }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "timestamp", "transaction_id", "message" ] }, "examples": { "503 - Source Unavailable": { "summary": "503 - Source Unavailable", "value": { "code": 503, "timestamp": 1000000000000, "transaction_id": "6739777f-6e7a-4091-8165-f9c2d5b0e992", "message": "Source Unavailable" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/pan/verify": { "post": { "summary": "Verify PAN Details", "deprecated": false, "description": "", "operationId": "verifyPAN", "tags": [ "kyc", "pan" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-accept-cache", "in": "header", "description": "Pass true to accept the cached response. If the header is not passed, or if false is sent as the value, the request will hit the origin.", "required": false, "example": "true", "schema": { "type": "boolean" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "Media type of the request body.", "required": false, "example": "application/json", "schema": { "type": "string", "enum": [ "application/json" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "@entity": { "type": "string", "enum": [ "in.co.sandbox.kyc.pan_verification.request" ] }, "pan": { "type": "string", "pattern": "^[A-Z]{5}[0-9]{4}[A-Z]{1}$", "description": "Permanent Account Number to be verified against official PAN records." }, "name_as_per_pan": { "type": "string", "minLength": 2, "description": "Full name of the PAN holder exactly as printed on the PAN card." }, "date_of_birth": { "type": "string", "pattern": "^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/([0-9]{4})$", "description": "Date of birth or date of incorporation associated with the PAN in DD/MM/YYYY format." }, "consent": { "type": "string", "enum": [ "Y", "y" ], "description": "Explicit consent from the end user to retrieve and verify PAN details." }, "reason": { "type": "string", "minLength": 20, "description": "Purpose for requesting PAN verification." } }, "required": [ "@entity", "pan", "name_as_per_pan", "date_of_birth", "consent", "reason" ], "additionalProperties": false }, "examples": { "200 - Sucess Individual": { "value": { "@entity": "in.co.sandbox.kyc.pan_verification.request", "pan": "XXXPX1234A", "name_as_per_pan": "John Ronald Doe", "date_of_birth": "11/11/2001", "consent": "Y", "reason": "For onboarding customers" }, "summary": "200 - Sucess Individual" }, "200 - Success Individual 2": { "value": { "@entity": "in.co.sandbox.kyc.pan_verification.request", "pan": "XXXPX1234H", "name_as_per_pan": "Tony Duck", "date_of_birth": "10/11/1999", "consent": "Y", "reason": "For onboarding customers" }, "summary": "200 - Success Individual 2" }, "200 - Success Individual 3": { "value": { "@entity": "in.co.sandbox.kyc.pan_verification.request", "pan": "XXXPX1234O", "name_as_per_pan": "James Hope", "date_of_birth": "10/11/1999", "consent": "Y", "reason": "For onboarding customers" }, "summary": "200 - Success Individual 3" }, "200 - Success Individual 4": { "value": { "@entity": "in.co.sandbox.kyc.pan_verification.request", "pan": "XXXPX1234L", "name_as_per_pan": "James Hope Jr", "date_of_birth": "10/11/1999", "consent": "Y", "reason": "For onboarding customers" }, "summary": "200 - Success Individual 4" }, "200 - Success PAN Trust": { "value": { "@entity": "in.co.sandbox.kyc.pan_verification.request", "pan": "XXXTX1234P", "name_as_per_pan": "Acme Trust", "date_of_birth": "10/11/1999", "consent": "Y", "reason": "For onboarding customers" }, "summary": "200 - Success PAN Trust" }, "200 - Success PAN Company": { "value": { "@entity": "in.co.sandbox.kyc.pan_verification.request", "pan": "XXXCX1234B", "name_as_per_pan": "Ron Doe Private Limited", "date_of_birth": "10/11/1969", "consent": "Y", "reason": "For onboarding customers" }, "summary": "200 - Success PAN Company" }, "200 - Success PAN AOP": { "value": { "@entity": "in.co.sandbox.kyc.pan_verification.request", "pan": "XXXAX2345A", "name_as_per_pan": "Doe Associations", "date_of_birth": "08/12/1991", "consent": "Y", "reason": "For onboarding customers" }, "summary": "200 - Success PAN AOP" }, "200 - Success PAN BOI": { "value": { "@entity": "in.co.sandbox.kyc.pan_verification.request", "pan": "XXXBX3456B", "name_as_per_pan": "Doe Industries", "date_of_birth": "08/12/1991", "consent": "Y", "reason": "For onboarding customers" }, "summary": "200 - Success PAN BOI" }, "422 - Invalid PAN Pattern": { "value": { "pan": "XXXPX123EE", "name_as_per_pan": "Bob Hope", "date_of_birth": "10/11/1999", "consent": "Y", "reason": "For onboarding customers" }, "summary": "422 - Invalid PAN Pattern" }, "503 - Source Unavailable": { "value": { "@entity": "in.co.sandbox.kyc.pan_verification.request", "pan": "XXXPX1234Z", "name_as_per_pan": "John Ronald Doe", "date_of_birth": "11/11/2001", "consent": "Y", "reason": "For onboarding customers" }, "summary": "503 - Source Unavailable" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string" }, "data": { "type": "object", "properties": { "@entity": { "type": "string", "const": "in.co.sandbox.kyc.pan_verification.response" }, "pan": { "type": "string" }, "category": { "type": "string" }, "status": { "type": "string" }, "remarks": { "type": [ "string", "null" ] }, "name_as_per_pan_match": { "type": "boolean" }, "date_of_birth_match": { "type": "boolean" }, "aadhaar_seeding_status": { "type": "string", "enum": [ "y", "n", "na" ] } }, "required": [ "@entity", "pan", "category", "status", "remarks", "name_as_per_pan_match", "date_of_birth_match", "aadhaar_seeding_status" ] } }, "required": [ "code", "timestamp", "transaction_id", "data" ] }, "examples": { "200 - Sucess Individual": { "summary": "200 - Sucess Individual", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "3b862714-d27d-4907-9027-e6399f8a8d46", "data": { "@entity": "in.co.sandbox.kyc.pan_verification.response", "pan": "XXXPX1234A", "category": "individual", "status": "valid", "remarks": null, "name_as_per_pan_match": true, "date_of_birth_match": true, "aadhaar_seeding_status": "y" } } }, "200 - Success Individual 2": { "summary": "200 - Success Individual 2", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "9cc69288-ed1b-4c8c-b25c-99eefad3e5fe", "data": { "@entity": "in.co.sandbox.kyc.pan_verification.response", "pan": "XXXPX1234H", "category": "individual", "status": "valid", "remarks": "Holder is Deceased", "name_as_per_pan_match": true, "date_of_birth_match": true, "aadhaar_seeding_status": "n" } } }, "200 - Success Individual 3": { "summary": "200 - Success Individual 3", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "bce2ed4d-aec0-49be-82cb-ed875f75ba5e", "data": { "@entity": "in.co.sandbox.kyc.pan_verification.response", "pan": "XXXPX1234O", "category": "individual", "status": "valid", "remarks": null, "name_as_per_pan_match": true, "date_of_birth_match": false, "aadhaar_seeding_status": "n" } } }, "200 - Success Individual 4": { "summary": "200 - Success Individual 4", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "8ee5bad9-7692-49e1-b300-7537a34c0e3d", "data": { "@entity": "in.co.sandbox.kyc.pan_verification.response", "pan": "XXXPX1234L", "category": "individual", "status": "valid", "remarks": null, "name_as_per_pan_match": false, "date_of_birth_match": false, "aadhaar_seeding_status": "n" } } }, "200 - Success PAN Trust": { "summary": "200 - Success PAN Trust", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "0ad0afbe-e74f-48dc-9472-9e0b9d8e916f", "data": { "@entity": "in.co.sandbox.kyc.pan_verification.response", "pan": "XXXTX1234P", "category": "trust", "status": "valid", "remarks": "Liquidated", "name_as_per_pan_match": true, "date_of_birth_match": false, "aadhaar_seeding_status": "na" } } }, "200 - Success PAN Company": { "summary": "200 - Success PAN Company", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "c5a081b4-6e75-4e39-bcfb-bb9c5903b633", "data": { "@entity": "in.co.sandbox.kyc.pan_verification.response", "pan": "XXXCX1234B", "category": "company", "status": "valid", "remarks": "Merger", "name_as_per_pan_match": true, "date_of_birth_match": true, "aadhaar_seeding_status": "na" } } }, "200 - Success PAN AOP": { "summary": "200 - Success PAN AOP", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "72f05811-a832-4812-9b15-3c390fb31862", "data": { "@entity": "in.co.sandbox.kyc.pan_verification.response", "pan": "XXXAX2345A", "category": "association_of_persons", "status": "valid", "remarks": null, "name_as_per_pan_match": false, "date_of_birth_match": false, "aadhaar_seeding_status": "na" } } }, "200 - Success PAN BOI": { "summary": "200 - Success PAN BOI", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "bd5d57d7-745c-4d68-9dc7-49cc7433bdaf", "data": { "@entity": "in.co.sandbox.kyc.pan_verification.response", "pan": "XXXBX3456B", "category": "body_of_individuals", "status": "valid", "remarks": null, "name_as_per_pan_match": false, "date_of_birth_match": true, "aadhaar_seeding_status": "na" } } } } } }, "headers": {} }, "422": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "422 - Invalid PAN Pattern": { "summary": "422 - Invalid PAN Pattern", "value": { "code": 422, "timestamp": 1000000000000, "transaction_id": "9e50cb77-e1f5-47c0-acf5-7b5b19bdc308", "message": "Invalid Pan pattern" } } } } }, "headers": {} }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "503 - Source Unavailable": { "summary": "503 - Source Unavailable", "value": { "code": 503, "timestamp": 1000000000000, "transaction_id": "6c05f692-c32f-4de0-92b4-56684bdf16f0", "message": "Source Unavailable" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/pan-aadhaar/status": { "post": { "summary": "PAN Aadhaar Link Status", "deprecated": false, "description": "Linking your PAN card with Aadhaar has been made mandatory for certain services, such as filing your income tax returns. Use this API to get PAN-Aadhaar link status.", "operationId": "verifyPANAadhaarLinkStatus", "tags": [ "kyc", "pan" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "Media type of the request body.", "required": false, "example": "application/json", "schema": { "type": "string", "enum": [ "application/json" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "@entity": { "type": "string", "enum": [ "in.co.sandbox.kyc.pan_aadhaar.status" ] }, "pan": { "type": "string", "pattern": "^[A-Z]{5}[0-9]{4}[A-Z]{1}$", "description": "Permanent Account Number to be verified against Aadhaar linkage records." }, "aadhaar_number": { "type": "string", "pattern": "^[0-9]{12}$", "description": "12-digit Aadhaar number of the PAN holder used to validate PAN–Aadhaar linkage." }, "consent": { "type": "string", "enum": [ "Y", "y" ], "description": "Explicit consent from the end user to retrieve and verify PAN and Aadhaar linkage information." }, "reason": { "type": "string", "minLength": 20, "description": "Purpose for requesting PAN–Aadhaar verification." } }, "required": [ "@entity", "pan", "aadhaar_number", "consent", "reason" ], "additionalProperties": false }, "examples": { "200 - Success": { "value": { "@entity": "in.co.sandbox.kyc.pan_aadhaar.status", "pan": "XXXPX1234A", "aadhaar_number": "123456789012", "consent": "y", "reason": "For Testing" }, "summary": "200 - Success" }, "200 - PAN-aadhaar not linked": { "value": { "@entity": "in.co.sandbox.kyc.pan_aadhaar.status", "pan": "XXXPX1234X", "aadhaar_number": "999999999999", "consent": "y", "reason": "For Testing" }, "summary": "200 - PAN-aadhaar not linked" }, "200 - Invalid Aadhaar": { "value": { "@entity": "in.co.sandbox.kyc.pan_aadhaar.status", "pan": "XXXPX3456X", "aadhaar_number": "999999999999", "consent": "y", "reason": "For Testing" }, "summary": "200 - Invalid Aadhaar" }, "200 - Invalid PAN": { "value": { "@entity": "in.co.sandbox.kyc.pan_aadhaar.status", "pan": "XXXPX3456X", "aadhaar_number": "999999999999", "consent": "y", "reason": "For Testing" }, "summary": "200 - Invalid PAN" }, "422 - Individual pan required": { "value": { "@entity": "in.co.sandbox.kyc.pan_aadhaar.status", "pan": "XXPP45X", "aadhaar_number": "666666666666", "consent": "y", "reason": "For Testing" }, "summary": "422 - Individual pan required" }, "422 - Invalid pan pattern": { "value": { "@entity": "in.co.sandbox.kyc.pan_aadhaar.status", "pan": "XXPP45X", "aadhaar_number": "666666666666", "consent": "y", "reason": "For Testing" }, "summary": "422 - Invalid pan pattern" }, "422 - Consent is required": { "value": { "@entity": "in.co.sandbox.kyc.pan_aadhaar.status", "pan": "XXPPX2345X", "aadhaar_number": "666666666666", "consent": "n", "reason": "For Testing" }, "summary": "422 - Consent is required" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string" }, "data": { "type": "object", "properties": { "@entity": { "type": "string", "const": "in.co.sandbox.kyc.pan_aadhaar.status.response" }, "aadhaar_seeding_status": { "type": "string", "enum": [ "y", "n", "na" ] }, "message": { "type": "string" } }, "required": [ "@entity", "aadhaar_seeding_status", "message" ] } }, "required": [ "code", "timestamp", "transaction_id", "data" ] }, "examples": { "200 - Success": { "summary": "200 - Success", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "de97e30a-2043-4ab0-84ff-0fbba3434a8f", "data": { "@entity": "in.co.sandbox.kyc.pan_aadhaar.status.response", "aadhaar_seeding_status": "y", "message": "Your PAN is linked to Aadhaar Number XXXX XXXX 9999." } } }, "200 - PAN-aadhaar not linked": { "summary": "200 - PAN-aadhaar not linked", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "42a18b62-9be5-4173-9883-8cba620b7cef", "data": { "@entity": "in.co.sandbox.kyc.pan_aadhaar.status.response", "aadhaar_seeding_status": "n", "message": "PAN not linked with Aadhaar" } } }, "200 - Invalid Aadhaar": { "summary": "200 - Invalid Aadhaar", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "bfad0d71-21f5-4066-b1b8-1589da33b19e", "data": { "@entity": "in.co.sandbox.kyc.pan_aadhaar.status.response", "aadhaar_seeding_status": "n", "message": "Please enter a valid Aadhaar Number" } } }, "200 - Invalid PAN": { "summary": "200 - Invalid PAN", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "6a348ca6-adb7-441a-8abf-bbcde1a87c1d", "data": { "@entity": "in.co.sandbox.kyc.pan_aadhaar.status.response", "aadhaar_seeding_status": "n", "message": "PAN does not exist" } } } } } }, "headers": {} }, "422": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "422 - Individual pan required": { "summary": "422 - Individual pan required", "value": { "code": 422, "timestamp": 1000000000000, "transaction_id": "6f1ed927-879b-4519-88b6-2059ece4145a", "message": "Individuals PAN is required" } }, "422 - Invalid pan pattern": { "summary": "422 - Invalid pan pattern", "value": { "code": 422, "timestamp": 1000000000000, "transaction_id": "457acce3-f417-4cec-a3d4-364950ffc424", "message": "Invalid PAN pattern" } }, "422 - Consent is required": { "summary": "422 - Consent is required", "value": { "code": 422, "timestamp": 1000000000000, "transaction_id": "713b76de-a033-4ffb-92d5-b86971ebf305", "message": "invalid parameter: Consent is required." } } } } }, "headers": {} }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "transaction_id": { "type": "string" }, "message": { "type": "string" } } }, "examples": { "503 - Source Unavailable": { "summary": "503 - Source Unavailable", "value": { "code": 503, "timestamp": 1000000000000, "transaction_id": "6c05f692-c32f-4de0-92b4-56684bdf16f0", "message": "Source Unavailable" } } } } } } }, "security": [] } }, "/kyc/mca/company/master-data": { "post": { "summary": "Company Master Data", "deprecated": false, "description": "Fetch companies's details using CIN or LLPIN", "operationId": "getCompanyMasterData", "tags": [ "kyc", "mca" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "Media type of the request body.", "required": false, "example": "application/json", "schema": { "type": "string", "enum": [ "application/json" ] } }, { "name": "x-accept-cache", "in": "header", "description": "Optional cache-control header. For cache behavior details, refer to [Response Caching](https://developer.sandbox.co.in/docs/response-caching#x-accept-cache-header).", "required": false, "example": "true", "schema": { "type": "boolean" } }, { "name": "x-source", "in": "header", "description": "Optional source selector. Allowed values are `primary` and `secondary`. For request-behavior details, refer to the [MCA Overview](https://developer.sandbox.co.in/api-reference/kyc/mca/overview).", "required": false, "example": "primary", "schema": { "type": "string", "enum": [ "primary", "secondary" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "required": [ "cin" ] } ], "properties": { "cin": { "type": "string", "description": "Corporate Identification Number of the company", "pattern": "^[LU]\\d{5}[A-Z]{2}\\d{4}[A-Z]{3}\\d{6}$", "minLength": 21, "maxLength": 21 } }, "additionalProperties": false }, "example": { "cin": "U47219GJ2023PTC143977" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP-like status code for the API response" }, "timestamp": { "type": "integer", "description": "Response timestamp in epoch milliseconds" }, "data": { "type": "array", "items": { "type": "object", "properties": { "@entity": { "type": "string", "const": "in.co.sandbox.kyc.mca.company_master_data", "description": "Type discriminator for MCA company master data" }, "cin": { "type": "string", "description": "Corporate Identification Number of the company", "pattern": "^[LU]\\d{5}[A-Z]{2}\\d{4}[A-Z]{3}\\d{6}$", "minLength": 21, "maxLength": 21 }, "company_name": { "type": "string" }, "company_roc_code": { "type": "string" }, "company_category": { "type": "string" }, "company_sub_category": { "type": "string" }, "company_class": { "type": "string" }, "authorized_capital": { "type": "number" }, "paidup_capital": { "type": "number" }, "company_registration_date": { "type": "string", "format": "date" }, "registered_office_address": { "type": "string" }, "listing_status": { "type": "string" }, "company_status": { "type": "string" }, "company_state_code": { "type": "string" }, "company_origin": { "type": "string" }, "nic_code": { "type": "string" }, "company_industrial_classification": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "@entity", "cin", "updated_at" ], "additionalProperties": false } }, "transaction_id": { "type": "string", "description": "Unique transaction identifier for the API request" } }, "required": [ "code", "timestamp", "data", "transaction_id" ], "additionalProperties": false }, "examples": { "Success": { "summary": "Success", "value": { "code": 200, "timestamp": 1782021074236, "data": [ { "updated_at": 1783351002317, "@entity": "in.co.sandbox.kyc.mca.company_master_data", "cin": "U72900GJ2015PTC082637", "company_name": "QUICKO INFOSOFT PRIVATE LIMITED", "company_roc_code": "ROC Ahmedabad", "company_category": "Company limited by shares", "company_sub_category": "Non-government company", "company_class": "Private", "authorized_capital": 15200000, "paidup_capital": 14566670, "company_registration_date": "2015-03-19", "registered_office_address": "B/701 ,Amrapali Lakeview Tower Opp.Vastrapur Lake, Vastrapur,Ahmedabad,Ahmedabad,Gujarat,380015-India", "listing_status": "Unlisted", "company_status": "Active", "company_state_code": "gujarat", "company_origin": "India", "nic_code": "72900", "company_industrial_classification": "Business Services" } ], "transaction_id": "321e98ad-b002-4c4e-ad6b-34121e06c127" } } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Invalid request body": { "summary": "Invalid request body", "value": { "code": 400, "timestamp": 1783331537495, "message": "Invalid request body", "transaction_id": "242c5503-7ae0-4b01-b5ac-6f14177c0096" } } } } }, "headers": {} }, "521": { "description": "", "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Company master data not found": { "summary": "Company master data not found", "value": { "code": 521, "timestamp": 1783331595884, "message": "Company master data not found for CIN: U34300GJ2017PLC097818", "transaction_id": "66e9235e-a9b2-4646-a39c-79fc3df114b0" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/mca/company/master-data/search": { "get": { "summary": "Search Company", "deprecated": false, "description": "Fetch companies's details using CIN or LLPIN through `cin`, or search by company name", "operationId": "getSearchCompanyMasterData", "tags": [ "kyc", "mca" ], "parameters": [ { "name": "cin", "in": "query", "description": "Corporate Identification Number (CIN) or Limited Liability Partnership Identification Number (LLPIN).", "required": false, "example": "U47219GJ2023PTC143977", "schema": { "type": "string" } }, { "name": "company_name", "in": "query", "description": "", "required": false, "example": "mac", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "Media type of the request body.", "required": false, "example": "application/json", "schema": { "type": "string", "enum": [ "application/json" ] } }, { "name": "x-accept-cache", "in": "header", "description": "Optional cache-control header. For cache behavior details, refer to [Response Caching](https://developer.sandbox.co.in/docs/response-caching#x-accept-cache-header).", "required": false, "example": "true", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP-like status code for the API response" }, "timestamp": { "type": "integer", "description": "Response timestamp in epoch milliseconds" }, "data": { "type": "array", "items": { "type": "object", "properties": { "@entity": { "type": "string", "const": "in.co.sandbox.kyc.mca.company_master_data", "description": "Type discriminator for MCA company master data" }, "cin": { "type": "string", "description": "Corporate Identification Number of the company", "pattern": "^[LU]\\d{5}[A-Z]{2}\\d{4}[A-Z]{3}\\d{6}$", "minLength": 21, "maxLength": 21 }, "company_name": { "type": "string" } }, "required": [ "@entity", "cin" ], "additionalProperties": false } }, "transaction_id": { "type": "string", "description": "Unique transaction identifier for the API request" } }, "required": [ "code", "timestamp", "data", "transaction_id" ], "additionalProperties": false }, "examples": { "Success (cin)": { "summary": "Success (cin)", "value": { "code": 200, "timestamp": 1783319160519, "data": { "@entity": "in.co.sandbox.kyc.mca.company_master_data_search_response", "records": [ { "@entity": "in.co.sandbox.kyc.mca.company_master_data_search_result", "cin": "U72900GJ2015PTC082637", "company_name": "QUICKO INFOSOFT PRIVATE LIMITED" } ], "limit": 5, "offset": 0, "count": 1, "has_more": false }, "transaction_id": "5979f864-959f-4cf3-9c24-ecc9f2bd6431" } }, "Success (company_name_prefix)": { "summary": "Success (company_name_prefix)", "value": { "code": 200, "timestamp": 1783320692092, "data": { "@entity": "in.co.sandbox.kyc.mca.company_master_data_search_response", "records": [ { "@entity": "in.co.sandbox.kyc.mca.company_master_data_search_result", "cin": "U36912DL2013PTC248756", "company_name": "MAC 9 JEWELS & BULLIONS PRIVATE LIMITED" }, { "@entity": "in.co.sandbox.kyc.mca.company_master_data_search_result", "cin": "U36100DL2012PTC238252", "company_name": "MAC 9 WOOD TAILORS INDIA PRIVATE LIMITED" }, { "@entity": "in.co.sandbox.kyc.mca.company_master_data_search_result", "cin": "ACG-1117", "company_name": "MAC ACOUSTIC & INTERIOR PRODUCTS LLP" }, { "@entity": "in.co.sandbox.kyc.mca.company_master_data_search_result", "cin": "AAJ-9269", "company_name": "MAC ADMARKETING LLP" }, { "@entity": "in.co.sandbox.kyc.mca.company_master_data_search_result", "cin": "AAJ-9420", "company_name": "MAC ADMARKETING SOLUTIONS LLP" } ], "limit": 5, "offset": 0, "count": 5, "has_more": true }, "transaction_id": "d30d7e23-6e2b-4969-b6a6-6f98dbe6d8f2" } } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "CIN & company_name both in params": { "summary": "CIN & company_name both in params", "value": { "code": 400, "timestamp": 1783330459899, "message": "pass only one of cin or company_name", "transaction_id": "b924650c-c144-4830-b8b8-553ae91e06e7" } }, "Validation(company_name)": { "summary": "Validation(company_name)", "value": { "code": 400, "timestamp": 1783330663497, "message": "company_name must be at least 3 characters long", "transaction_id": "5186a98d-ac23-49e1-92aa-c08b1bd0b39d" } }, "Validation(CIN)": { "summary": "Validation(CIN)", "value": { "code": 400, "timestamp": 1783331352587, "message": "cin must be a valid MCA CIN", "transaction_id": "e3a67f96-aad0-4595-b960-0a02cf2902e1" } } } } }, "headers": {} }, "521": { "description": "", "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "Data not found(CIN)": { "summary": "Data not found(CIN)", "value": { "code": 521, "timestamp": 1783330331399, "message": "Company master data not found: U34300GJ2017PLC097818", "transaction_id": "f449ae15-1ec4-48b3-ac9f-3c4fc5d41ae8" } }, "Data not found(company_name)": { "summary": "Data not found(company_name)", "value": { "code": 521, "timestamp": 1783330331399, "message": "Company master data not found: sadsssa$%", "transaction_id": "f449ae15-1ec4-48b3-ac9f-3c4fc5d41ae8" } } } } }, "headers": {} } }, "security": [] } }, "/mca/director/master-data/search": { "post": { "summary": "Director Master Data", "deprecated": false, "description": "Fetch director's details using DIN", "operationId": "getDirectorMasterData", "tags": [ "kyc", "mca" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "Media type of the request body.", "required": false, "example": "application/json", "schema": { "type": "string", "enum": [ "application/json" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "@entity": { "type": "string", "enum": [ "in.co.sandbox.kyc.mca.master_data.request" ] }, "id": { "type": "string", "pattern": "^[0-9]{8}$", "description": "8-digit Director Identification Number (DIN) issued by the central government to an individual appointed as a company director." }, "consent": { "type": "string", "enum": [ "Y", "y" ], "description": "Explicit consent from the end user to retrieve and verify the director’s information." }, "reason": { "type": "string", "minLength": 20, "description": "Purpose for requesting verification of the director’s information." } }, "required": [ "@entity", "id", "consent", "reason" ], "additionalProperties": false }, "examples": { "200 - Success": { "value": { "@entity": "in.co.sandbox.kyc.mca.master_data.request", "id": "9999999", "consent": "y", "reason": "For Director KYC" }, "summary": "200 - Success" }, "422 - Invalid DIN": { "value": { "@entity": "in.co.sandbox.kyc.mca.master_data.request", "id": "9999991", "consent": "y", "reason": "For Director KYC" }, "summary": "422 - Invalid DIN" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "200 - Success": { "summary": "200 - Success", "value": { "code": 200, "timestamp": 1000000000000, "transaction_id": "48a196a7-e1c3-44da-b833-fe705af36f32", "data": { "@entity": "in.co.sandbox.kyc.mca.director", "director_data": { "@entity": "in.co.sandbox.kyc.mca.director.director_data", "din": "99999999", "name": "JOHN DOE" }, "llp_data": [ { "@entity": "in.co.sandbox.kyc.mca.director.llp_data", "end_date": "-", "llp_name": "JOHN DOE PRIVATE LIMITED", "designation": "Director", "begin_date": "19/03/2015", "llpin/fllpin": "ABC-1234" } ], "company_data": [ { "@entity": "in.co.sandbox.kyc.mca.director.company_data", "end_date": "-", "company_name": "JOHN DOE PRIVATE LIMITED", "designation": "Director", "begin_date": "19/03/2015", "cin/fcrn": "U12300GJ2015PTC123456" }, { "@entity": "in.co.sandbox.kyc.mca.director.company_data", "end_date": "-", "designation": "Director", "company_name": "JD PRIVATE LIMITED", "begin_date": "09/06/2017", "cin/fcrn": "U12300GJ2017PTC123456" } ] } } } } } }, "headers": {} }, "422": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "422 - Invalid DIN": { "summary": "422 - Invalid DIN", "value": { "code": 422, "message": "DIN Entered does not match MCA records, Please enter a valid DIN.", "timestamp": 1000000000000, "transaction_id": "48e396ea-6ba3-44ba-a41b-14ffa97b8076" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/entitylocker/sessions/init": { "post": { "summary": "Initiate session", "deprecated": false, "description": "", "operationId": "initiateSession", "tags": [ "kyc", "entitylocker" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "Media type of the request body.", "required": false, "example": "application/json", "schema": { "type": "string", "enum": [ "application/json" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "@entity": { "type": "string", "enum": [ "in.co.sandbox.kyc.entitylocker.session.request" ] }, "flow": { "type": "string", "enum": [ "signin", "signup" ], "description": "EntityLocker user journey to initiate for this session. Use `signin` for existing users or `signup` to create a new EntityLocker account." }, "redirect_url": { "type": "string", "format": "uri", "pattern": "^https://", "description": "HTTPS URL where the user will be redirected after completing the EntityLocker consent flow." }, "consent_expiry": { "type": "integer", "minimum": 0, "description": "Unix timestamp in milliseconds after which the consent request becomes invalid. Must be at least 1 hour later than the current server time." } }, "required": [ "@entity", "flow", "redirect_url" ] }, "examples": { "200 - Session initiated": { "value": { "@entity": "in.co.sandbox.kyc.entitylocker.session.request", "flow": "signin", "redirect_url": "https://sandbox.co.in/", "consent_expiry": 1765887697411 }, "summary": "200 - Session initiated" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code." }, "timestamp": { "type": "integer", "description": "Unix timestamp (in milliseconds) indicating when the server generated the response." }, "data": { "type": "object", "description": "Response payload containing the requested data or error details.", "properties": { "@entity": { "type": "string" }, "authorization_url": { "type": "string", "description": "The URL to which the user should be redirected to complete the authorization flow. This URL initiates the user authentication and consent process." }, "session_id": { "type": "string", "description": "A unique identifier for the user session. This ID is used to track and manage the state of the user's consent." } }, "required": [ "@entity", "authorization_url", "session_id" ] }, "transaction_id": { "type": "string", "description": "Unique identifier for tracking the request across systems." } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "200 - Session initiated": { "summary": "200 - Session initiated", "value": { "code": 200, "timestamp": 1765534184274, "data": { "@entity": "in.co.sandbox.kyc.entitylocker.session.response", "authorization_url": "https://entity.digilocker.gov.in/public/oauth2/1/authorize?response_type=code&client_id=VRF23C1E3B&redirect_uri=https%3A%2F%2Fdev-api.sandbox.co.in%2Fcallbacks%2Fkyc%2Fentitylocker%2Foauth&state=ZDgyMDM0NzItMTFiMC00ZGRhLWFlOWItY2U0YzI0OTRmMWRkfGQzZjg4OTdlLWYxZmYtNDQ0OS05NzA0LTcwNzNmNjkzMDI5NnxodHRwczovL3NhbmRib3guY28uaW4v&code_challenge=yxAtiqiBw2FrXmavMHn7bVnq7nW-sWRNI50JTMuYtAE&code_challenge_method=S256&consent_valid_till=1767205777", "session_id": "d3f8897e-f1ff-4449-9704-7073f6930296" }, "transaction_id": "02683ff9-2abc-42ab-a050-945f21068bce" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/entitylocker/sessions/{session_id}/status": { "get": { "summary": "Get session status", "deprecated": false, "description": "", "operationId": "getSessionStatus", "tags": [ "kyc", "entitylocker" ], "parameters": [ { "name": "session_id", "in": "path", "description": "Session identifier generated during EntityLocker [Initiate Session API](https://developer.sandbox.co.in/api-reference/kyc/entitylocker/endpoints/initiate_session) .", "required": true, "example": "139fd8a0-d645-42e1-a904-bb43353b0139", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code." }, "timestamp": { "type": "integer", "description": "Unix timestamp (in milliseconds) indicating when the server generated the response." }, "data": { "type": "object", "properties": { "@entity": { "type": "string", "const": "in.co.sandbox.kyc.entitylocker.session" }, "id": { "type": "string", "description": "Unique identifier for the session." }, "status": { "type": "string", "description": "The current status of the session. It reflects the state or condition of the consent." }, "documents_consented": { "type": "array", "description": "Lists the types of documents included in the user's consent. It is present only when the consent `status` is 'succeeded'.", "items": { "type": "string", "enum": [ "company_master_details", "gstn_details", "udhyam_certificate" ] } }, "created_at": { "type": "integer", "description": "Unix timestamp (in milliseconds) indicating when the entity was created." }, "updated_at": { "type": "integer", "description": "Unix timestamp (in milliseconds) indicating when the entity was last updated." } }, "required": [ "@entity", "id", "status", "created_at" ], "if": { "properties": { "status": { "const": "succeeded" } }, "required": [ "status" ] }, "then": { "properties": { "documents_consented": { "type": "string" } }, "required": [ "documents_consented" ] } }, "transaction_id": { "type": "string", "description": "Unique identifier for tracking the request across systems." } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "200 - Session Created": { "summary": "200 - Session Created", "value": { "code": 200, "timestamp": 1752580258171, "data": { "@entity": "in.co.sandbox.kyc.entitylocker.session", "id": "139fd8a0-d645-42e1-a904-bb43353b0139", "status": "created", "created_at": 1752579445983 }, "transaction_id": "900ff751-2191-4b7d-b20a-8301790a3e29" } }, "200 - Session Succeeded": { "summary": "200 - Session Succeeded", "value": { "code": 200, "timestamp": 1765781194203, "data": { "id": "eed074e1-3bf0-4733-bc5a-4718fced542e", "created_at": 1765781019627, "updated_at": 1765781050695, "@entity": "in.co.sandbox.kyc.entitylocker.session", "status": "succeeded", "documents_consented": [ "company_master_details", "gstn_details", "udhyam_certificate" ] }, "transaction_id": "ee4a3ef4-b0a0-4649-972f-4676d8858e08" } } } } }, "headers": {} }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "503 - Source unavailable": { "summary": "503 - Source unavailable", "value": { "code": 503, "timestamp": 1000000000000, "transaction_id": "6c05f692-c32f-4de0-92b4-56684bdf16f0", "message": "Source Unavailable" } } } } }, "headers": {} }, "521": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "521 - Data Not Found": { "summary": "521 - Data Not Found", "value": { "code": 521, "timestamp": 1782806266274, "message": "Data not found for: 55470e27-3d8a-451f-ac1e-9c0f3d1454821", "transaction_id": "a599615c-c732-4538-9840-4bb5cd3c19d2" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/entitylocker/sessions/{session_id}/documents/{doc_type}": { "get": { "summary": "Fetch Document", "deprecated": false, "description": "", "operationId": "getDocument", "tags": [ "kyc", "entitylocker" ], "parameters": [ { "name": "session_id", "in": "path", "description": "Session identifier generated during EntityLocker [Initiate Session API](https://developer.sandbox.co.in/api-reference/kyc/entitylocker/endpoints/initiate_session) .", "required": true, "example": "eed074e1-3bf0-4733-bc5a-4718fced542e", "schema": { "type": "string" } }, { "name": "doc_type", "in": "path", "description": "Document type identifying which EntityLocker document to retrieve. Must match one of the consented doc_types values.", "required": true, "example": "company_master_details", "schema": { "type": "string", "enum": [ "company_master_details", "gstn_details", "udhyam_certificate" ] } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code" }, "timestamp": { "type": "integer", "description": "Unix timestamp (in milliseconds) indicating when the server generated the response" }, "data": { "type": "object", "properties": { "files": { "type": "array", "description": "An array containing details of the requested files. Each item in the array represents a single file.", "items": { "type": "object", "properties": { "@entity": { "type": "string" }, "url": { "type": "string", "description": "The URL from which the file can be downloaded. This is a direct link to the file's location." }, "size": { "type": "integer", "description": "The size of the file in bytes. This value indicates the total data volume of the file." }, "metadata": { "type": "object", "description": "An object containing additional descriptive information about the file. This includes details like content type, issuer, and modification date.", "properties": { "ContentType": { "type": "string", "description": "The MIME type of the file. This specifies the format of the file, e.g., \"application/pdf\"." }, "issuer_id": { "type": "string", "description": "A unique identifier for the entity that issued or created the file. This ID helps in tracing the origin of the document." }, "issuer": { "type": "string", "description": "The name of the entity that issued or created the file. This provides a human-readable name for the file's source." }, "LastModified": { "type": "string", "description": "The date and time when the file was last modified. This timestamp is typically in ISO 8601 format." }, "description": { "type": "string", "description": "A textual description of the file's content or purpose. This provides additional context about the file." } }, "required": [ "ContentType", "issuer_id", "issuer", "LastModified", "description" ] } } } } }, "required": [ "files" ] }, "transaction_id": { "type": "string", "description": "Unique identifier for tracking the request across systems" } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "200 - Fetched Document": { "summary": "200 - Fetched Document", "value": { "code": 200, "timestamp": 1765781088023, "data": { "files": [ { "@entity": "org.quicko.drive.file", "url": "https://in-co-sandbox-kyc-entitylocker-storage-dev.s3.ap-south-1.amazonaws.com/non-persistent/workspaces/d8203472-11b0-4dda-ae9b-ce4c2494f1dd/sessions/eed074e1-3bf0-4733-bc5a-4718fced542e/documents/in.gov.mca-CPMTD-U72900GJ2023PTC138457.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAWLM5S7CBMS6H2ZMW%2F20251215%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20251215T064454Z&X-Amz-Expires=3600&X-Amz-Signature=22eb8dfb06b4579cde97b6ab9f2a00776c59c414870fad65a037033ebf1aa427&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject", "size": 108598, "metadata": { "ContentType": "application/pdf", "issuer_id": "in.gov.mca", "issuer": "Ministry of Corporate Affairs (MCA), Govt. of India", "LastModified": "19/12/2024", "description": "Company Master Details" } } ] }, "transaction_id": "aa10bddf-1fc6-45a9-b0af-dc13613de60c" } } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "400 - Consent not provided": { "summary": "400 - Consent not provided", "value": { "code": 400, "timestamp": 1765888053322, "message": "Consent for udhyam_certificate not provided", "transaction_id": "3f0590ab-b977-43ae-8b9d-667d984cceb2" } } } } }, "headers": {} }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "503 - Source unavailable": { "summary": "503 - Source unavailable", "value": { "code": 503, "timestamp": 1000000000000, "transaction_id": "6c05f692-c32f-4de0-92b4-56684bdf16f0", "message": "Source Unavailable" } } } } }, "headers": {} }, "521": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "521 - Data Not Found": { "summary": "521 - Data Not Found", "value": { "code": 521, "timestamp": 1782806266274, "message": "Data not found for: 55470e27-3d8a-451f-ac1e-9c0f3d1454821", "transaction_id": "a599615c-c732-4538-9840-4bb5cd3c19d2" } } } } }, "headers": {} }, "523": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "523 - Invalid Session Status": { "summary": "523 - Invalid Session Status", "value": { "code": 523, "timestamp": 1782806184804, "message": "Invalid session status: created", "transaction_id": "de90173f-8255-4ac0-b26b-a41b8a872fee" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/entitylocker/sessions/{session_id}/entity": { "get": { "summary": "Get Entity Details", "deprecated": false, "description": "", "operationId": "getEntityDetails", "tags": [ "kyc", "entitylocker" ], "parameters": [ { "name": "session_id", "in": "path", "description": "Session identifier generated during EntityLocker [Initiate Session API](https://developer.sandbox.co.in/api-reference/kyc/entitylocker/endpoints/initiate_session) .", "required": true, "example": "c4124d99-4854-446f-9b04-b8f8c12785d0", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code." }, "timestamp": { "type": "integer", "description": "Unix timestamp (in milliseconds) indicating when the server generated the response." }, "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "A unique identifier for the entity. This ID is used to distinguish individual entities within the system and follows a UUID format." }, "@entity": { "type": "string" }, "date_of_incorporation": { "type": "string", "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$", "description": "The date when the entity was officially incorporated. This field is provided in DD/MM/YYYY format, e.g., 01/01/2023." }, "email": { "type": "string", "format": "email", "description": "The primary email address associated with the entity. This email is used for official communications and must follow a valid email format." }, "mobile": { "type": "string", "description": "The primary mobile phone number for the entity. This number is used for direct contact and verification purposes." }, "name": { "type": "string", "description": "The official registered name of the entity. This field represents the legal name of the company or organization." }, "verified_by": { "type": "string", "enum": [ "pan", "ud", "cin" ], "description": "The method or document used to verify the entity's identity. Valid values are 'pan' for Permanent Account Number, 'ud' for Udyam Registration, or 'cin' for Corporate Identification Number." } }, "required": [ "id", "@entity", "date_of_incorporation", "email", "mobile", "name", "verified_by" ], "description": "Response payload containing the requested data or error details." }, "transaction_id": { "type": "string", "format": "uuid", "description": "Unique identifier for tracking the request across systems." } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "200 - Entity Details fetched": { "summary": "200 - Entity Details fetched", "value": { "code": 200, "timestamp": 1765888767565, "data": { "id": "4e8455e8-27db-50a0-99e9-0b0211a4811d", "@entity": "in.co.sandbox.kyc.entitylocker.entity", "date_of_incorporation": "16/01/2023", "email": "help@sandbox.co.in", "mobile": "9099983246", "name": "SANDBOX FINANCIAL TECHNOLOGIES PRIVATE LIMITED", "verified_by": "cin" }, "transaction_id": "c4124d99-4854-446f-9b04-b8f8c12785d0" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/entitylocker/sessions/{session_id}/user/profile": { "get": { "summary": "Get User Profile Details", "deprecated": false, "description": "", "operationId": "getUserDetails", "tags": [ "kyc", "entitylocker" ], "parameters": [ { "name": "session_id", "in": "path", "description": "Session identifier generated during EntityLocker [Initiate Session API](https://developer.sandbox.co.in/api-reference/kyc/entitylocker/endpoints/initiate_session) .", "required": true, "example": "7603165e-e591-4342-bb19-1d9f4caabb0f", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code" }, "timestamp": { "type": "integer", "description": "Unix timestamp (in milliseconds) indicating when the server generated the response" }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "A unique identifier for the authorized individual associated with the company." }, "@entity": { "type": "string" }, "date_of_birth": { "type": "string", "description": "The date of birth of the authorized individual associated with the company. Expected in a standard date format (e.g., DD/MM/YYYY)." }, "mobile": { "type": "string", "description": "The mobile phone number of the authorized individual associated with the company." }, "eaadhaar": { "type": "boolean", "description": "Indicates whether the authorized individual has eaadhaar or not." }, "gender": { "type": "string", "description": "The gender of the authorized individual associated with the company." }, "name": { "type": "string", "description": "The full name of the authorized individual associated with the company." } }, "required": [ "id", "@entity", "date_of_birth", "mobile", "eaadhaar", "gender", "name" ], "description": "Response payload containing the requested data or error details." }, "transaction_id": { "type": "string", "description": "Unique identifier for tracking the request across systems" } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "200 - Profile Details fetched": { "summary": "200 - Profile Details fetched", "value": { "code": 200, "timestamp": 1765889000461, "data": { "id": "96b14651-a333-547d-8de9-fee0be4f941e", "@entity": "in.co.sandbox.kyc.entitylocker.user.profile", "date_of_birth": "28/01/2002", "mobile": "9512120133", "eaadhaar": true, "gender": "male", "name": "Henil Rupesh Shah" }, "transaction_id": "7603165e-e591-4342-bb19-1d9f4caabb0f" } } } } }, "headers": {} }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "503 - Source unavailable": { "summary": "503 - Source unavailable", "value": { "code": 503, "timestamp": 1000000000000, "transaction_id": "6c05f692-c32f-4de0-92b4-56684bdf16f0", "message": "Source Unavailable" } } } } }, "headers": {} }, "521": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "521 - Data Not Found": { "summary": "521 - Data Not Found", "value": { "code": 521, "timestamp": 1782806266274, "message": "Data not found for: 55470e27-3d8a-451f-ac1e-9c0f3d1454821", "transaction_id": "a599615c-c732-4538-9840-4bb5cd3c19d2" } } } } }, "headers": {} }, "523": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "523 - Invalid Session Status": { "summary": "523 - Invalid Session Status", "value": { "code": 523, "timestamp": 1782806184804, "message": "Invalid session status: created", "transaction_id": "de90173f-8255-4ac0-b26b-a41b8a872fee" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/entitylocker-sdk/sessions/create": { "post": { "summary": "Create Session", "deprecated": false, "description": "", "operationId": "createSession", "tags": [ "kyc", "entitylocker-sdk" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } }, { "name": "x-api-version", "in": "header", "description": "Specifies the API version for the request.", "required": false, "example": "1.0.0", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "Media type of the request body.", "required": false, "example": "application/json", "schema": { "type": "string", "enum": [ "application/json" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "@entity": { "type": "string", "enum": [ "in.co.sandbox.kyc.entitylocker.sdk.session.request" ] }, "flow": { "type": "string", "enum": [ "signin", "signup" ], "description": "EntityLocker authentication flow to initiate for the user. Use `signin` for existing EntityLocker users or `signup` to create a new account." }, "doc_types": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "company_master_details", "gstn_details", "udhyam_certificate" ] }, "description": "List of EntityLocker document types for which user consent is being requested." } }, "required": [ "@entity", "flow", "doc_types" ], "additionalProperties": false }, "examples": { "200 - OK": { "value": { "@entity": "in.co.sandbox.kyc.entitylocker.sdk.session.request", "flow": "signin", "doc_types": [ "company_master_details", "gstn_details", "udhyam_certificate" ] }, "summary": "200 - OK" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "timestamp": { "type": "integer" }, "transaction_id": { "type": "string" }, "data": { "type": "object", "properties": { "@entity": { "type": "string" }, "id": { "type": "string", "description": "A unique identifier for the user session. This ID is used to track and manage the state of the user's consent." }, "status": { "type": "string", "description": "The current status of the session. It reflects the state or condition of the consent." }, "created_at": { "type": "integer" } }, "required": [ "@entity", "id", "status", "created_at" ] }, "code": { "type": "integer" } }, "required": [ "timestamp", "transaction_id", "data", "code" ] }, "examples": { "200 - OK": { "summary": "200 - OK", "value": { "timestamp": 1750331120324, "transaction_id": "5ccad959-0bf4-4472-a3dd-d57e2b61b5a9", "data": { "@entity": "in.co.sandbox.kyc.entitylocker.sdk.session", "id": "0454f149-26d0-41ef-9f14-c54f4b5f7b70", "status": "created", "created_at": 1750331120324 }, "code": 200 } } } } }, "headers": {} } }, "security": [] } }, "/kyc/entitylocker-sdk/sessions/{session_id}/status": { "get": { "summary": "Session Status", "deprecated": false, "description": "", "operationId": "getSessionStatus", "tags": [ "kyc", "entitylocker-sdk" ], "parameters": [ { "name": "session_id", "in": "path", "description": "Session identifier generated during EntityLocker SDK [Create Session API](https://developer.sandbox.co.in/api-reference/kyc/entitylocker-sdk/endpoints/create_session) .", "required": true, "example": "5ed01344-d9b2-4b44-b0c7-e2901c834999", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code." }, "timestamp": { "type": "integer", "description": "Unix timestamp (in milliseconds) indicating when the server generated the response." }, "data": { "type": "object", "properties": { "@entity": { "type": "string", "const": "in.co.sandbox.kyc.entitylocker.sdk.session" }, "id": { "type": "string", "description": "Unique identifier for the session." }, "status": { "type": "string", "description": "The current status of the session. It reflects the state or condition of the consent." }, "documents_consented": { "type": "array", "description": "Lists the types of documents included in the user's consent. It is present only when the consent `status` is 'succeeded'.", "items": { "type": "string", "enum": [ "company_master_details", "gstn_details", "udhyam_certificate" ] } }, "created_at": { "type": "integer", "description": "Unix timestamp (in milliseconds) indicating when the entity was created." }, "updated_at": { "type": "integer", "description": "Unix timestamp (in milliseconds) indicating when the entity was last updated." } }, "required": [ "@entity", "id", "status", "created_at" ], "if": { "properties": { "status": { "const": "succeeded" } }, "required": [ "status" ] }, "then": { "properties": { "documents_consented": { "type": "string" } }, "required": [ "documents_consented" ] } }, "transaction_id": { "type": "string", "description": "Unique identifier for tracking the request across systems." } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "200 - Session Created": { "summary": "200 - Session Created", "value": { "code": 200, "timestamp": 1752580258171, "data": { "id": "839fd8a0-d645-42e1-a904-bb43353b0139", "created_at": 1752579445983, "@entity": "in.co.sandbox.kyc.entitylocker.sdk.session", "status": "created" }, "transaction_id": "800ff751-2191-4b7d-b20a-8301790a3e19" } } } } }, "headers": {} }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "503 - Source unavailable": { "summary": "503 - Source unavailable", "value": { "code": 503, "timestamp": 1000000000000, "transaction_id": "6c05f692-c32f-4de0-92b4-56684bdf16f0", "message": "Source Unavailable" } } } } }, "headers": {} }, "521": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "521 - Data Not Found": { "summary": "521 - Data Not Found", "value": { "code": 521, "timestamp": 1782806266274, "message": "Data not found for: 55470e27-3d8a-451f-ac1e-9c0f3d1454821", "transaction_id": "a599615c-c732-4538-9840-4bb5cd3c19d2" } } } } }, "headers": {} } }, "security": [] } }, "/kyc/entitylocker-sdk/sessions/{session_id}/documents/{doc_type}": { "get": { "summary": "Get Document", "deprecated": false, "description": "", "operationId": "getDocument", "tags": [ "kyc", "entitylocker-sdk" ], "parameters": [ { "name": "session_id", "in": "path", "description": "Session identifier generated during EntityLocker SDK [Create Session API](https://developer.sandbox.co.in/api-reference/kyc/entitylocker-sdk/endpoints/create_session) .", "required": true, "example": "4b4bf7aa-f4da-47a8-9b32-895edfc03630", "schema": { "type": "string" } }, { "name": "doc_type", "in": "path", "description": "Document type identifying which EntityLocker document to retrieve. Must match one of the consented doc_types values.", "required": true, "example": "company_master_details", "schema": { "type": "string", "enum": [ "company_master_details", "gstn_details", "udhyam_certificate" ] } }, { "name": "Authorization", "in": "header", "description": "JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).", "required": true, "example": "{{access_token}}", "schema": { "type": "string" } }, { "name": "x-api-key", "in": "header", "description": "API key used to identify and authenticate the client.", "required": true, "example": "{{api_key}}", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code" }, "timestamp": { "type": "integer", "description": "Unix timestamp (in milliseconds) indicating when the server generated the response" }, "data": { "type": "object", "properties": { "files": { "type": "array", "description": "An array containing details of the requested files. Each item in the array represents a single file.", "items": { "type": "object", "properties": { "@entity": { "type": "string" }, "url": { "type": "string", "description": "The URL from which the file can be downloaded. This is a direct link to the file's location." }, "size": { "type": "integer", "description": "The size of the file in bytes. This value indicates the total data volume of the file." }, "metadata": { "type": "object", "description": "An object containing additional descriptive information about the file. This includes details like content type, issuer, and modification date.", "properties": { "ContentType": { "type": "string", "description": "The MIME type of the file. This specifies the format of the file, e.g., \"application/pdf\"." }, "issuer_id": { "type": "string", "description": "A unique identifier for the entity that issued or created the file. This ID helps in tracing the origin of the document." }, "issuer": { "type": "string", "description": "The name of the entity that issued or created the file. This provides a human-readable name for the file's source." }, "LastModified": { "type": "string", "description": "The date and time when the file was last modified. This timestamp is typically in ISO 8601 format." }, "description": { "type": "string", "description": "A textual description of the file's content or purpose. This provides additional context about the file." } }, "required": [ "ContentType", "issuer_id", "issuer", "LastModified", "description" ] } } } } }, "required": [ "files" ] }, "transaction_id": { "type": "string", "description": "Unique identifier for tracking the request across systems" } }, "required": [ "code", "timestamp", "data", "transaction_id" ] }, "examples": { "200 - Document Fetched": { "summary": "200 - Document Fetched", "value": { "code": 200, "timestamp": 1751975529441, "data": { "files": [ { "@entity": "org.quicko.drive.file", "url": "https://in-co-sandbox-kyc-digilocker-dev.s3.ap-south-1.amazonaws.com/non-persistent/e385432b-575c-4b6f-8928-79136dbc0d4f/4b4bf7aa-f4da-47a8-9b32-895edfc03630/in.gov.uidai-ADHAR-0d5fe4d692c73e23c59a694eaaabc75a.xml?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Date=20250708T115214Z&X-Amz-Expires=3600&X-Amz-Signature=8cc4b0e8eb3794601c7fdb7e85f3a6bb3a8e1842403c8aeae5c05b7af03bdadb&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject", "size": 16598, "metadata": { "ContentType": "application/xml", "issuer_id": "in.gov.mca", "issuer": "Ministry of Corporate Affairs (MCA), Govt. of India", "LastModified": "09/05/2025", "description": "Company Master Details" } } ] }, "transaction_id": "a4d43b74-0f9c-480c-9300-f011100b674b" } } } } }, "headers": {} }, "400": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "400 - Consent not provided": { "summary": "400 - Consent not provided", "value": { "code": 400, "timestamp": 1760432035872, "message": "Consent for gstn_details not provided", "transaction_id": "3d1d2d37-3179-4a3c-8397-2287084d1de1" } } } } }, "headers": {} }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "503 - Source unavailable": { "summary": "503 - Source unavailable", "value": { "code": 503, "timestamp": 1000000000000, "transaction_id": "6c05f692-c32f-4de0-92b4-56684bdf16f0", "message": "Source Unavailable" } } } } }, "headers": {} }, "521": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "521 - Data Not Found": { "summary": "521 - Data Not Found", "value": { "code": 521, "timestamp": 1760428752393, "message": "Data not found for: 839fd8a0-d645-42e1-a904-bb43353b0139", "transaction_id": "8be099b1-8d19-457e-b907-5b825740d9cc" } } } } }, "headers": {} }, "523": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "timestamp": { "type": "integer" }, "message": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "code", "timestamp", "message", "transaction_id" ] }, "examples": { "523 - Invalid Session Lifecycle": { "summary": "523 - Invalid Session Lifecycle", "value": { "code": 523, "timestamp": 1760431743347, "message": "Cannot get document due to invalid session lifecycle", "transaction_id": "031c9d24-99c4-49cb-b4ba-11e8c3630f9f" } } } } }, "headers": {} } }, "security": [] } } }, "webhooks": {}, "components": { "schemas": {}, "responses": {}, "securitySchemes": {} }, "servers": [ { "url": "https://test-api.sandbox.co.in", "description": "test" }, { "url": "https://api.sandbox.co.in", "description": "prod" } ], "security": [] }