Get Document Information

Retrieves detailed metadata and status information for a specific customer document.

This endpoint provides comprehensive document information including file details, document type, verification status, and administrative metadata without returning the actual file content.

Endpoint

GET/v2/customer/{customerId}/file/{id}/info

Link

Gateway APIstagep.tst-apidmndelss.com

Request

Path Parameters

Parameter	Type	Description	Required	Example
customerId	string	Customer ID that owns the document.	Yes	"cust_12345"
id	string	Document unique ID to retrieve info for.	Yes	"doc_abc123"

Headers

Key	Value	Required
Authorization	123	Yes
Accept	application/json	Yes

---

Response (200 OK)

Returns comprehensive document metadata including file information, document type, verification status, and administrative details.

Response Fields

Document Object

Field	Type	Description	Example
id	string	Unique document identifier.	"doc_abc123"
customerId	string	Customer ID who owns the document.	"cust_12345"
fileName	string	Original filename.	"passport_scan.pdf"
size	integer	File size in bytes.	2048576
mime	string	MIME type of the document.	"application/pdf"
docType	string	Document type/category.	"PASSPORT"
info	string	Additional information/notes.	"Primary identification document"
isLock	boolean	Whether document is locked from modifications.	false
createAt	string	Document creation timestamp.	"2024-05-15T10:30:00Z"
status	string	Current verification status.	"DST_APPROVED"

Example Response:

json

{
  "document": {
    "id": "doc_abc123",
    "customerId": "cust_12345",
    "fileName": "john_doe_passport.pdf",
    "size": 2048576,
    "mime": "application/pdf",
    "docType": "PASSPORT",
    "info": "Primary identification - US passport",
    "isLock": false,
    "createAt": "2024-05-15T10:30:00Z",
    "status": "DST_APPROVED"
  }
}

---

Field Details

Document Type Values

Document Type	Description	Use Case
PASSPORT	Passport document	Identity verification
DRIVERS_LICENCE_FRONT	Driver's license (front)	Identity verification
DRIVERS_LICENCE_BACK	Driver's license (back)	Identity verification
GOVERNMENT_ID_FRONT	Government ID (front)	Identity verification
GOVERNMENT_ID_BACK	Government ID (back)	Identity verification
IDENTITY_CARD_FRONT	Identity card (front)	Identity verification
IDENTITY_CARD_BACK	Identity card (back)	Identity verification
UTILITY_BILL	Utility bill	Address verification
BANK_STATEMENT	Bank statement	Financial verification
INCORPORATION_DOCUMENTS	Business incorporation docs	Business verification
ARTICLES_OF_INCORPORATION	Articles of incorporation	Business verification
BENEFICIAL_CERTIFICATE	Beneficial ownership certificate	Business verification
FINANCIAL_STATEMENT	Financial statements	Financial verification
LEASE_AGREEMENT	Lease agreement	Address verification
PAYSLIP	Payslip	Income verification
SOCIAL_SECURITY_CARD	Social security card	Identity verification
POWER_OF_ATTORNEY	Power of attorney	Authorization
ACCOUNT_AGREEMENT	Account agreement	Compliance
OPERATION_DOCUMENT	Operation-related document	Transaction support
OTHER_1, OTHER_2, OTHER_3	Miscellaneous documents	Various purposes

Document Status Values

Status	Description	Meaning
DST_APPROVED	Document approved	Document verified and accepted
DST_SUBMITTED	Document submitted	Awaiting review
DST_CHANGES_REQUESTED	Changes requested	Requires modifications/resubmission
DST_MISSING	Document missing	Required document not provided
DST_REJECTED	Document rejected	Failed verification

Common MIME Types

MIME Type	Description	Typical Use
application/pdf	PDF document	Contracts, statements
image/jpeg	JPEG image	Photos, scans
image/png	PNG image	Screenshots, digital images
application/msword	Word document	Agreements, letters
application/vnd.openxmlformats-officedocument.wordprocessingml.document	Word document (modern)	Agreements, letters

---

Examples

Request

bash

curl -X GET 'https://stagep.tst-apidmndelss.com/v2/customer/cust_12345/file/doc_abc123/info' \
  -H 'Authorization: 123' \
  -H 'Accept: application/json'

Approved Passport Example

Response:

json

{
  "document": {
    "id": "doc_pass123",
    "customerId": "cust_12345",
    "fileName": "us_passport_scan.pdf",
    "size": 3120450,
    "mime": "application/pdf",
    "docType": "PASSPORT",
    "info": "US passport - primary ID verification",
    "isLock": true,
    "createAt": "2024-05-10T14:20:00Z",
    "status": "DST_APPROVED"
  }
}

Pending Utility Bill Example

Response:

json

{
  "document": {
    "id": "doc_util456",
    "customerId": "cust_67890",
    "fileName": "electricity_bill_may_2024.jpg",
    "size": 1856320,
    "mime": "image/jpeg",
    "docType": "UTILITY_BILL",
    "info": "Address verification - electricity bill",
    "isLock": false,
    "createAt": "2024-05-18T09:15:00Z",
    "status": "DST_SUBMITTED"
  }
}

Business Incorporation Documents Example

Response:

json

{
  "document": {
    "id": "doc_biz789",
    "customerId": "cust_99999",
    "fileName": "articles_of_incorporation.pdf",
    "size": 5120480,
    "mime": "application/pdf",
    "docType": "ARTICLES_OF_INCORPORATION",
    "info": "Business verification - Delaware incorporation",
    "isLock": false,
    "createAt": "2024-05-05T11:45:00Z",
    "status": "DST_CHANGES_REQUESTED"
  }
}

Rejected Bank Statement Example

Response:

json

{
  "document": {
    "id": "doc_bank321",
    "customerId": "cust_44444",
    "fileName": "bank_statement_q1_2024.pdf",
    "size": 2987654,
    "mime": "application/pdf",
    "docType": "BANK_STATEMENT",
    "info": "Financial verification - insufficient transaction history",
    "isLock": true,
    "createAt": "2024-04-28T16:30:00Z",
    "status": "DST_REJECTED"
  }
}

Locked Identity Document Example

Response:

json

{
  "document": {
    "id": "doc_id654",
    "customerId": "cust_77777",
    "fileName": "drivers_license_front.png",
    "size": 2456789,
    "mime": "image/png",
    "docType": "DRIVERS_LICENCE_FRONT",
    "info": "Primary ID - California driver's license",
    "isLock": true,
    "createAt": "2024-05-12T13:20:00Z",
    "status": "DST_APPROVED"
  }
}

---

Error Responses

1. Document Not Found:

   json

   { "error": "Document not found: doc_99999" }

2. Customer Not Found:

   json

   { "error": "Customer not found: cust_99999" }

3. Unauthorized:

   json

   { "error": "Unauthorized" }

4. Access Denied:

   json

   { "error": "Access denied to document" }

---

Notes

• Metadata Only: This endpoint returns document metadata, not the actual file content
• File Size: Size is returned in bytes (e.g., 2048576 = ~2MB)
• Lock Status: Locked documents cannot be modified or deleted
• Status Flow: Documents typically progress: SUBMITTED → APPROVED/CHANGES_REQUESTED/REJECTED
• Compliance: Document types are categorized for regulatory compliance (KYC/AML)

Common Use Cases:

• Document status tracking and monitoring
• Compliance auditing and reporting
• Customer onboarding progress tracking
• Document verification workflow management
• File management and organization

Document Lifecycle:

1. Upload → Document submitted by customer
2. Review → Compliance team evaluates document
3. Decision → Document approved, rejected, or changes requested
4. Lock → Approved documents often locked to prevent modifications