---
title: "Get Document"
method: GET
path: "/services/document/v1/documents/{documentId}"
tags: ["Multi-Modal: Document"]
---

# Get Document

`GET /services/document/v1/documents/{documentId}`

## Request

- Base URL: `https://na12.api.project44.com`
- URL: `https://na12.api.project44.com/services/document/v1/documents/{documentId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/api/v4/oauth2/token`
- TypeScript: <https://skmtc.dev/project44/apis/project44-rest-api/docs/services/document/v1/documents/:documentId/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a document by ID

## Path parameters

- `documentId` string, uuid, required

## Response `200`

Successful Response

- Document
  - `addedByCompany` string: The company name of the tenant owning this document.
  - `addedByUser` string: The name of the user owning this document.
  - `createdDateTime` string, date-time: The date and time when this document was created. This value is read only.
  - `deletedDateTime` string, date-time: The date and time when this document was deleted. This value is read only.
  - `files` Image[]: The list of images related to this document.
    - `mediaType` 'PDF' | 'PNG' | 'JPEG' | 'GIF' | 'TIF': An enumeration.
    - `sizeInBytes` integer: The file size of this image in bytes
    - `type` 'ORIGINAL' | 'THUMBNAIL': An enumeration.
    - `url` string: The url of this image.
  - `identifiers` Identifier[]: The list of identifiers related to this document. When x-tenant-role is 'CARRIER' InternalEntityType.SHIPPER_TENANT_UUID is MANDATORY if you want to associate this Document to Shipment. InternalEntityType.SHIPPER_TENANT_UUID is number identifying Shipper in project44.
    - `type` union: The identifier type that can identify this entity.
      - 'AIR_WAYBILL' | 'BILL_OF_LADING' | 'HOUSE_BILL_OF_LADING' | 'BOOKING_NUMBER' | 'CARRIER_IATA' | 'CARRIER_ICAO' | 'CARRIER_NAME' | 'CARRIER_SCAC' | 'FFW_SCAC' | 'CONTAINER_ID' | 'CUSTOMER_REFERENCE' | 'DELIVERY_NUMBER' | 'EXTERNAL' | 'FLIGHT_NUMBER' | 'ORDER' | 'PICKUP' | 'PRO' | 'PURCHASE_ORDER' | 'RAIL_CAR_ID' | 'RAIL_WAYBILL' | 'TRACKING_NUMBER' | 'TRAILER_ID' | 'UNKNOWN' | 'VESSEL_IMO' | 'VESSEL_NAME' | 'WAYBILL' | 'VESSEL_CALL_SIGN' | 'VESSEL_MMSI' | 'CARRIER_US_DOT_NUMBER' | 'CARRIER_MC_NUMBER' | 'SUBSCRIPTION_ID' | 'HOUSE_AIR_WAYBILL' | 'SALES_ORDER' | 'WAREHOUSE_MOVEMENT_ORDER' | 'ADVANCED_SHIPMENT_NOTICE' | 'DRIVER_MOBILE_PHONE_NUMBER' | 'VEHICLE_ID' | 'LICENSE_PLATE' | 'SENSITECH_DEVICE_ID' | 'EMERSON_DEVICE_ID' | 'TIVE_DEVICE_ID' | 'VOYAGE_NUMBER' | 'CARRIER_MASTER_ID' | 'CARRIER_NMC_ID' | 'CONTAINER_TYPE' | 'TRAIN_NUMBER' | 'WAGON_ID' | 'CAPACITY_PROVIDER_ACCOUNT_GROUP' | 'CAPACITY_PROVIDER_ACCOUNT_CODE' | 'SERIAL_NUMBER' | 'VEHICLE_IDENTIFICATION_NUMBER' | 'REFERENCE_NUMBER' | 'CONTAINER_PIN' | 'INVOICE_ID' | 'VESSEL_P44_ID': The type of identifier provided to distinguish the Shipment.
      - 'MASTER_SHIPMENT_ID' | 'BOOKING_ID' | 'STOP_ID' | 'DRIVER_ID' | 'TRUCKLOAD_TRACKING_ID' | 'ORDER_ID' | 'SHIPPER_TENANT_UUID': An enumeration.
    - `value` string: Identifier.
  - `id` string, uuid: The id of this document. Will always be populated on response.
  - `lastModifiedDateTime` string, date-time: The date and time when this document was last modified. This value is read only.
  - `mode` 'AIR' | 'OCEAN' | 'TL' | 'LTL' | 'PARCEL' | 'RAIL' | 'BARGE': The mode of transportation for a document.
  - `name` string: The name of this document.
  - `parsedData` object: Parsed data extracted from the document. The structure varies based on document type and content.
  - `type` 'BILL_OF_LADING' | 'HOUSE_BILL_OF_LADING' | 'AIRWAY_BILL' | 'COMMERCIAL_INVOICE' | 'CUSTOMS_DOCUMENTS' | 'PACKING_SLIP' | 'CERTIFICATE_OF_ORIGIN' | 'PROOF_OF_DELIVERY' | 'DELIVERY_RECEIPT' | 'ECMR' | 'WEIGHT_CERTIFICATE' | 'INSPECTION_CERTIFICATE' | 'LETTER_OF_AUTHORIZATION' | 'LUMPER_CERTIFICATE' | 'INVOICE' | 'HAZMAT_DOCUMENT' | 'SHIPPING_LABEL' | 'OTHER': An enumeration.

---

[API](https://skmtc.dev/project44/apis/project44-rest-api.md) - [All operations](https://skmtc.dev/project44/apis/project44-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/project44/apis/project44-rest-api/revisions/cdf9675e2294?raw)