Skip to main content
GET
/
kyc
/
entitylocker
/
sessions
/
{session_id}
/
documents
/
{doc_type}
Fetch Document
curl --request GET \
  --url https://test-api.sandbox.co.in/kyc/entitylocker/sessions/{session_id}/documents/{doc_type} \
  --header 'Authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>'
{
  "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"
}
https://mintcdn.com/sandboxfinancialtechnologiesprivatelimited/gviqebbpT5NUt_6i/static/svg/Postman.svg?fit=max&auto=format&n=gviqebbpT5NUt_6i&q=85&s=da47f2b7e10d87befec951aed9468de3

Run in Postman

A document can only be fetched if the user has provided consent for it.

Sample Responses

See sample XML response returned by EntityLocker for GSTN Details and Udyam Certificate.

Headers

​
Authorization
string
required

JWT access token. For token-generation steps, refer to the Quickstart Guide.

​
x-api-key
string
required

API key used to identify and authenticate the client.

​
x-api-version
string

Specifies the API version for the request.

Path Parameters

​
session_id
string
required

Session identifier generated during EntityLocker Initiate Session API .

​
doc_type
enum<string>
required

Document type identifying which EntityLocker document to retrieve. Must match one of the consented doc_types values.

Available options:
company_master_details,
gstn_details,
udhyam_certificate

Response

​
code
integer
required

HTTP status code

​
timestamp
integer
required

Unix timestamp (in milliseconds) indicating when the server generated the response

​
data
object
required
​
transaction_id
string
required

Unique identifier for tracking the request across systems