Usage Info

This method returns comprehensive details about a specific Document, including file metadata, upload status, hash information, and audit trail data. Each document includes its unique identifier, associated Subject Record, file properties, including name and size as well as the upload completion status, SHA256 hash for integrity verification, and timestamps for creation and updates.

Use this method when you need to verify document details before processing, retrieve complete document metadata for audit purposes, check upload completion status and file integrity, or display detailed document information to users for review and confirmation.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
document_id	string	Yes	The identifier for the Document to get details about.

Example

{
  "document_id": "d_1rQYvnUQdcatd4TcZQu0l8"
}

Response

Data

Parameter	Type	Description
document	object	The document parameters are defined in the tables below.

Document Parameters

Parameter	Type	Description
document_id	string	The unique identifier for the Document.
subject_record_id	string	The identifier for the Subject Record.
file_name	string	The name of the uploaded file.
file_size	integer	The file size in bytes.
upload_status	string	The current upload status of the document.
hash	string	The SHA256 hash of the document file for integrity verification.
comment	string	Optional comment associated with the document. Will be `null` if no comment was provided.
uploaded_by	string	The identifier of the user who uploaded the document.
created_at	string	The timestamp when the document was created (ISO 8601 format).
updated_at	string	The timestamp when the document was last updated (ISO 8601 format).
deleted_at	string	The timestamp when the document was deleted (ISO 8601 format). Will be `null` if not deleted.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6OI5blm21ZoSlq0PC3RqJV",
    "version": "2025-03-24"
  },
  "data": {
    "document": {
      "document_id": "d_1rQYvnUQdcatd4TcZQu0l8",
      "subject_record_id": "sr_6G6k9XmRMEgrPz8126tg3m",
      "file_name": "passport.pdf",
      "file_size": 1048576,
      "document_path": "sr_6G6k9XmRMEgrPz8126tg3m/d_1rQYvnUQdcatd4TcZQu0l8.pdf",
      "upload_status": "COMPLETED",
      "hash": "sha256-hash",
      "comment": null,
      "uploaded_by": "user_123",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z",
      "deleted_at": null
    }
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `document_id` provided does not exist.