Get Document By ID
This allows the user to retrieve a document using it's id.
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| id | Int | String | Yes | N/A | The document's ID found in your CheckIssuing dashboard or in the document's
information returned from various API calls To obtain the file information, pass the file ID prefixed with the "file-" string, e.g., file-245. |
| include_tracking | Boolean | No | false |
Pass true to include the metadata.tracking_data object (with
tracking_number, carrier_id, carrier_code, and
carrier_service) on the returned document. When omitted or false, the
tracking_data object is not added to metadata.
|
Sample Response
Document
Tracking fields
Tracking values are opt-in. Pass include_tracking=true on the request to include them; when
omitted, the tracking_data object below is not added to metadata. When enabled,
the documents/by-id response includes a metadata.tracking_data object on the
document. The response does not include an active_tracking object or top-level tracking
fields. Sub-field values are null until tracking is added (see the staff-facing form or
PUT /admin/documents/{id}/tracking).
| Field | Type | Description |
|---|---|---|
| metadata.tracking_data | Object | Container object for the tracking sub-fields below. Only present when
include_tracking=true is passed.
|
| metadata.tracking_data.tracking_number | String | null | Carrier-issued tracking number. null when no tracking has been recorded. |
| metadata.tracking_data.carrier_id | Integer | null | ID of the tracking carrier stored on the active tracking record. null when no
carrier
is known, including legacy tracking-number-only records. |
| metadata.tracking_data.carrier_code | String | null | Short carrier code (e.g. USPS, FEDEX, UPS,
DHL,
OTHER) for the active tracking record. When the tracking row is missing a carrier we
fall back to the carrier implied by the document's postage selection.
|
| metadata.tracking_data.carrier_service | String | null | Normalized carrier-service code for the active tracking record (e.g.
USPS_PRIORITY, FEDEX_2DAY, UPS_GROUND). null
when no service is set.
|