API V3 – Fetch a Carrier Document

The /v3/carriers/fetch/document endpoint lets 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, this endpoint is most useful when viewing the profile information of a carrier within your system.

Rather than copying these documents to your systems and taking on that storage cost, you can instead use BrokerCarrier as a file server for carrier documents. The added benefit of this is that you will always receive the most up-to-date document that we have for the given carrier.

Notes on this endpoint:

  1. Requires secret key. This endpoint must be called from the server side to avoid compromising your secret API key. Please 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
email
string
Email address of the BrokerCarrier user who is making the API call
id_type
string
One of:


id_number
string
A properly formatted DOT number or MC number
doc_type
string
One of:




action
string
One of:


Return values

This endpoint returns a file with a disposition of either 'inline' or 'download', depending on the specified action parameter in the request.

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