Get Submission Documents

The Get Submission Documents API allows you to retrieve all documents associated with a specific submission. This is useful for accessing uploaded identification documents, proofs of address, and other supporting materials submitted by customers during the onboarding process.

API Endpoint

GET {base_url}/ExtForm/submissions/{submissionId}/documents

Request Format

This endpoint accepts a GET request with a submission ID parameter in the URL path.

Path Parameters

Parameter	Type	Required	Description
submissionId	string	Yes	The unique identifier of the submission to retrieve documents for

Request Headers

Authorization: Bearer {token}

Response Format

{
  "statusCode": 200,
  "messages": ["Processed successfully"],
  "result": [
    {
      "id": "a1b2c3d4-5e6f-7g8h-9i0j-k1l2m3n4o5p6",
      "fileName": "d7e8f9g0_passport.jpg",
      "originalFileName": "passport.jpg",
      "description": "Passport document",
      "documentTypeId": "Passport",
      "fileSizeInBytes": 2456789,
      "contentType": "image/jpeg",
      "shA256Hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6"
    },
    {
      "id": "b2c3d4e5-6f7g-8h9i-0j1k-l2m3n4o5p6q7",
      "fileName": "h8i9j0k1_idcard_front.png",
      "originalFileName": "idcard_front.png",
      "description": "ID Card Front",
      "documentTypeId": "IdCardFront",
      "fileSizeInBytes": 1234567,
      "contentType": "image/png",
      "shA256Hash": "b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a1"
    }
  ]
}

Response Fields

Field	Description
id	Unique identifier for the document
fileName	System-generated filename for the document (with GUID prefix)
originalFileName	Original filename provided when the document was uploaded
description	Description of the document (if provided)
documentTypeId	Type identifier for the document (maps to document type enum)
fileSizeInBytes	Size of the document file in bytes
contentType	MIME type of the document file
shA256Hash	SHA-256 hash of the document file for integrity verification

Document Types

For a complete list of document types and their descriptions, please refer to the Document Types documentation. Common document types include:

• Passport - Passport document
• IdCardFront - Front side of ID card
• IdCardBack - Back side of ID card
• ProofOfAddress - Document verifying residential address
• CompanyRegistration - Company registration certificate
• SourceOfFundsDocument - Document verifying source of funds

Example Usage

cURL Example

curl -X GET \
  {base_url}/ExtForm/submissions/a1b2c3d4-5e6f-7g8h-9i0j-k1l2m3n4o5p6/documents \
  -H 'Authorization: Bearer your_token_here'

Error Handling

Status Code	Description	Solution
400	"Submission ID is required"	Ensure you're providing a valid submissionId parameter
401	Unauthorized	Verify your authentication token
403	Forbidden	Check that your account has permission to access this submission's documents
404	Submission not found	Verify that the submission ID exists
500	Internal server error	Contact support with the error details

Important Notes

1. This API returns metadata about documents, not the actual document content.
2. To download the actual document content, use the Download Document API.
3. The SHA-256 hash can be used to verify document integrity after download.

Related Resources

• Get Submissions API - Retrieving submissions
• Upload Documents API - Uploading documents to a submission
• Download Document API - Downloading a specific document
• Delete Documents API - Deleting documents
• Document Types Reference - List of document types and their descriptions