Skip to main content

Get a carrier's profile

The /v2/carrier/network/get/profile endpoint allows you retrieve the complete profile of any carrier in your network, including the details of each lane they have covered for you.

For TMS integrators, use this to import a carrier's details and documents into your TMS before your user assigns a load to them.

HTTP request

Method
URL
GET

Required parameters

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




id_number
string
A properly formatted MC number, DOT number, SCAC, or CBSA code

Return values

This endpoint returns an object with the following keys and values.

Key
Type
Value
business_name
string
Carrier's business name
business_address_1
string
Carrier's business address, line 1
business_address_2
string
null
Carrier's business address, line 2
business_locality
string
Carrier's city
business_state
string
Carrier's state or province, 2-letter abbreviation
business_zip
string
Carrier's zip code
business_phone
string
Carrier's business phone number
authority_type
string
One of:


authority_state
string
null
State of operation for an intrastate carrier, 2-letter abbreviation
authority_state_reg_num
string
null
State-specific authority number for an intrastate carrier
authority_dot_num
string
null
Carrier's DOT number
authority_docket_num
string
null
Carrier's MC/FF/MX number
authority_scac
string
null
Carrier's 4-letter SCAC
authority_cbsa
string
null
Carrier's 4-letter CBSA code
dispatch_phone
string
Carrier's dispatch phone number
dispatch_email
string
Carrier's dispatch email
acc_poc_name
string
Carrier's accounting point of contact name
acc_phone
string
Carrier's accounting phone number
acc_email
string
Carrier's accounting email
acc_address_1
string
Carrier's remit-to address, line 1
acc_address_2
string
null
Carrier's remit-to address, line 2
acc_locality
string
Carrier's remit-to city
acc_state
string
Carrier's remit-to state, 2-letter abbreviation
acc_zip
string
Carrier's remit-to zip code
acc_factoring_company
string
null
Name of the carrier's factoring company
contract_name
string
Name of the carrier's contract signing representative
contract_title
string
Job title of the carrier's contract signing representative
contract_date
string
Precise date and time that the carrier's representative signed the contract
contract_pdf
string
Filename of the signed PDF copy of the contract
doc_w9
string
Filename of the carrier's W-9 or W-8BEN
doc_authority
string
Filename of the carrier's DOT authority certificate
doc_insurance
string
Filename of the carrier's insurance certificate
carrier_status
string
One of:



services
array
[]
Zero or more of:









equipment
object
Object with the following fields:

{
int
int
int
int
int
int
int
int
int
int
int
int
}
eld
object
Object with the following fields:

{
string
string
}

This field is omitted if the carrier has not specified ELD information.
lane_preferences
array
[]
Zero or more objects, each with the following fields:

{
string
string
string
string
}

This field is omitted if the carrier has not specified their lane preferences.
lanes_covered
array
[]
Zero or more objects, each with the following fields:

{
string
string
string
string
string
}

This field is omitted if the carrier has not covered any loads for the broker.

Example response

{
    "business_name": "Acme Trucking Inc",
    "business_address_1": "456 Avenue Ln",
    "business_address_2": null,
    "business_locality": "Reno",
    "business_state": "NV",
    "business_zip": "89501",
    "business_country": "US",
    "business_phone": "5558675309",
    "authority_type": "interstate",
    "authority_state": null,
    "authority_state_reg_num": null,
    "authority_dot_num": "01010101",
    "authority_docket_num": "0101010",
    "authority_scac": null,
    "authority_cbsa": null,
    "dispatch_phone": "5558675309",
    "dispatch_email": "dispatch@acmetrucking.com",
    "acc_poc_name": "Dave Billings",
    "acc_phone": "5558675309",
    "acc_email": "dave@acmetrucking.com",
    "acc_address_1": "456 Avenue Ln",
    "acc_address_2": null,
    "acc_locality": "Reno",
    "acc_state": "NV",
    "acc_zip": "89501",
    "acc_factoring_company": "Triumph Business Capital / Advance Business Capital LLC",
    "contract_name": "Bob Acme",
    "contract_title": "President",
    "contract_date": "2022-02-09 14:06:43.723471",
    "contract_pdf": "606d0b1160d034567af20deba162900c351fb5d896e9d8fee38c377e0ebf9a8b.pdf",
    "doc_w9": "16ed62db27d928b6dc6a9dc0bc2e2066e4ac5c754821c3ba1ece3950a73f67ab.pdf",
    "doc_authority": "524ce3702df365713c4f568f9950c44e5f8a76b4697ec5161d4bb241757e6ef5.pdf",
    "doc_insurance": "2df818dd816f7a21957da5e4a97d79410aba8416f3b674e7db9d7f36738f1f53.pdf",
    "carrier_status": "approved",
    "services": [
        "drayage",
        "hazmat",
        "ltl",
        "partials",
        "refrigerated"
    ],
    "equipment": {
        "conestogas": 1,
        "drivers": 6,
        "drop_decks": 1,
        "dry_vans": 4,
        "expandable_drop_decks": 0,
        "expandable_rgns": 0,
        "flatbeds": 0,
        "lowboys": 1,
        "hot_shots": 2,
        "reefers": 0,
        "rgns": 1,
        "tractors": 4
    },
    "eld": {
        "eld_key": "8hseo5h6ao6aj8bhjg3o86o37659jfh",
        "eld_name": "Samsara"
    },
    "lane_preferences": [
        {
            "point_a_locality": "Reno",
            "point_a_state": "NV",
            "point_b_locality": "Los Angeles",
            "point_b_state": "CA"
        },
        {
            "point_a_locality": "Reno",
            "point_a_state": "NV",
            "point_b_locality": "Portland",
            "point_b_state": "OR"
        },
        {
            "point_a_locality": "Reno",
            "point_a_state": "NV",
            "point_b_locality": "Salt Lake City",
            "point_b_state": "UT"
        },
        {
            "point_a_locality": "Reno",
            "point_a_state": "NV",
            "point_b_locality": "San Diego",
            "point_b_state": "CA"
        },
        {
            "point_a_locality": "Reno",
            "point_a_state": "NV",
            "point_b_locality": "San Jose",
            "point_b_state": "CA"
        },
        {
            "point_a_locality": "Reno",
            "point_a_state": "NV",
            "point_b_locality": "Seattle",
            "point_b_state": "WA"
        }
    ],
    "lanes_covered": [
        {
            "point_a_locality": "Boerne",
            "point_a_state": "TX",
            "point_b_locality": "La Mesa",
            "point_b_state": "CA",
            "last_covered": "2022-02-26 11:06:32.857846"
        },
        {
            "point_a_locality": "La Mesa",
            "point_a_state": "CA",
            "point_b_locality": "Addison",
            "point_b_state": "TX",
            "last_covered": "2022-02-26 11:06:32.857846"
        },
        {
            "point_a_locality": "Addison",
            "point_a_state": "TX",
            "point_b_locality": "Sunnyvale",
            "point_b_state": "CA",
            "last_covered": "2022-02-26 11:06:32.857846"
        }
    ],
    "status": 200
}