Retrieve a Document

Retrieve details for a document. If the document status is SCANNED, a content URL and thumbnail URL are also returned.

Endpoint

GET /v1/documents/{documentId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

documentId REQUIRED

string

Semantic ID of the document (example: driving-license).

Note Use the List Document Types API to retrieve a list of semantic IDs.

Request Body

None

Returns

Returns the Document object. This object contains the document details, including the document ID and status. If the document status is SCANNED, a content URL and thumbnail URL are also returned.

You can download the latest version of the document by calling the content URL (url.value) with an HTTP GET request.
You can download the thumbnail image by calling the thumbnail URL (thumbnailUrl.value) with an HTTP GET request.

SAMPLE RESPONSE

				
					{
  "id": "b175994b-fd5b-46d6-aba9-73638902f4a0",
  "providerExternalId": "b648fc",
  "provider": "ABC",
  "businessAccountId": "733df8ac-5d93-4e5a-b665-36a1525353d8",
  "holderId": "4b79e405-959e-41b5-92c5-1f49e6b71745",
  "holderType": "CUSTOMER",
  "documentType": "driving-license",
  "name": "John Doe Driving License",
  "description": "driving license",
  "number": "123-456-789",
  "issuingDate": "2022-02-03",
  "issuingCountryCode": "US",
  "issuingStateCode": "NY",
  "extension": "JPG",
  "contentLength": 81169,
  "version": "1",
  "expiryDate": "2024-02-03",
  "url": {
    "value": "https://documents.rocketkor.net/7260554c5",
    "allowed": "GET",
    "expiresIn": 600
  },
  "thumbnailUrl": {
    "value": "https://documents.rocketkor.net/8145796e7",
    "allowed": "GET",
    "expiresIn": 600
  },
  "status": "SCANNED",
  "verificationStatus": "UNVERIFIED",
  "metadata": {
    "docRefId": "100000333"
  },
  "createdBy": {
    "id": "c503092d-e6c4-4f7a-b893-46ebe56b18a8",
    "type": "service-account"
  },
  "createdAt": "2023-05-03T23:11:59.656Z",
  "updatedBy": {
    "id": "c503092d-e6c4-4f7a-b893-46ebe56b18a8",
    "type": "service-account"
  },
  "updatedAt": "2023-06-05T23:11:59.656Z"
}