Skip to main content

Retrieve a carrier document

The /v2/carrier/network/get/document endpoint allows you retrieve a carrier document (W-9 or W-8BEN, operating authority, insurance, signed contract PDF) for storage or display on your system.

For TMS integrators, use this to enable your users to view their carriers' documents from within your UI.

This endpoint must be called from the server side to avoid compromising your secret API key. Do not use your secret key in client-side JavaScript.

HTTP request

Method
URL
GET

Required parameters

Name
Type
Value(s)
pk
string
Your public API key
sk
string
Your secret API key
id_type
string
One of:




id_number
string
A properly formatted MC number, DOT number, SCAC, or CBSA code
doc_type
string
One of:




Return values

This endpoint returns a file with no disposition, which you can then display or download.

Key
Type
Value
blob
A file with one of the following content-type headers: