Use this API to read a known document's metadata and its linked incoming interchange, outgoing interchange, sender, or receiver. It is a lookup API: it does not search for documents, download their payloads, or change their status.
Base path: /api/rest/entities/document. See API Conventions for authentication and shared terms.
.NET clients
For .NET clients, we recommend using the Bizbrains.Link.Api.Proxy NuGet package. See .NET client library for the public NuGet feed, supported APIs, and shared guidance.
Access and operations
The API Document View role contains these permissions:
|
GET path below the base |
Result |
Required permission |
|---|---|---|
|
|
Document metadata |
|
|
|
Linked incoming interchange |
|
|
|
Linked outgoing interchange |
|
|
|
Sending partner |
|
|
|
Receiving partner |
|
Every route takes the document's numeric ID, including the interchange and partner routes. Do not substitute the interchange ID or partner ID. The operations check their permissions and do not apply an additional current-user partner filter in this lookup flow.
Example: inspect an outgoing document
Use a document ID already obtained from your integration or Link tracking:
LINK_API_BASE='https://<your-link-api-host>'
LINK_PAT='<your-personal-access-token>'
DOCUMENT_ID='<numeric-document-id>'
curl --silent --show-error --fail-with-body \
--user ":${LINK_PAT}" \
"${LINK_API_BASE}/api/rest/entities/document/${DOCUMENT_ID}"
curl --silent --show-error --fail-with-body \
--user ":${LINK_PAT}" \
"${LINK_API_BASE}/api/rest/entities/document/${DOCUMENT_ID}/interchangeout"
curl --silent --show-error --fail-with-body \
--user ":${LINK_PAT}" \
"${LINK_API_BASE}/api/rest/entities/document/${DOCUMENT_ID}/partnerout"
Each successful lookup returns 200 with that entity as JSON. Document metadata includes identifiers, document number, and configured format/type names; it is not the file content or full tracking history. The requests are independent reads, so related values can change between requests while processing continues.
Missing data
The controller returns 404 if the requested document or related entity cannot be resolved. A 404 from interchangeout can mean that the document exists but has no outgoing interchange yet. Similarly, an unresolved partner is not proof that the document itself is missing. Check the document lookup first when diagnosing a related lookup.
The controller exposes five reads in this API. Permissions with names such as API_Document_GetStatus or API_Document_Create do not establish that a corresponding route exists here. Use your environment's Document Swagger section for its available operations.