API V3 – Fetch a Carrier Profile

The /v3/carriers/fetch/profile endpoint lets you retrieve the complete details of an individual carrier that you have onboarded into your network.

For TMS integrators, this endpoint is most useful when the broker has sourced and onboarded a new carrier for the purpose of covering a load. The carrier’s complete details can be fetched quickly from BrokerCarrier with just the DOT or MC number.

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 VETCarriers user who is making the API call
id_type
string
One of:


id_number
string
A properly formatted DOT number or MC number

Return values

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

Key
Type
Value
carrier_profile
object
{}
An object with the following fields:

{
object
object
object
object
object
object
object
object
object
array
array
string
array
array
}
response
object
{}
An object with the following fields:

{
string
integer
integer
}

Example response

{
    "carrier_profile": {
        "accounting": {
            "poc_name": "JANE SMITH",
            "phone": "5558675309",
            "email": "jane@democarrier.com",
            "address_1": "123 BOULEVARD ST",
            "address_2": "",
            "locality": "PHOENIX",
            "state": "AZ",
            "zip": "85034",
            "factoring_company": "DENIM"
        },
        "authority": {
            "active": {
                "auth_broker": "no",
                "auth_hhg": "no",
                "auth_pass": "no",
                "auth_property": "yes",
                "auth_status_broker": "none",
                "auth_status_common": "active",
                "auth_status_contract": "none",
                "docket_number": "01237654",
                "docket_prefix": "mc",
                "last_checked": "2023-01-18 21:02:05.171142 UTC",
                "operation_classification": "interstate",
                "operation_code": "a"
            },
            "dot_num": "012376549",
            "dot_num_date": "2020-10-12",
            "dot_num_age": {
                "seconds": 67106601,
                "days": 776.6967708333333
            },
            "operation": "interstate",
            "docket_num": {
                "prefix": "MC",
                "number": "01237654",
                "class": "common"
            },
            "scac": null,
            "cbsa": null,
            "oic_state": "AZ",
            "oic_state_reg_num": null
        },
        "business": {
            "name": "DEMO CARRIER LLC",
            "address_1": "123 BOULEVARD ST",
            "address_2": "",
            "locality": "PHOENIX",
            "state": "AZ",
            "zip": "85034",
            "country": "US",
            "phone": "5558675309"
        },
        "cargo": [
            "General Freight"
        ],
        "contract_signature": {
            "name": "JANE SMITH",
            "title": "PRESIDENT",
            "date_time": "2022-11-22 23:23:07.520912"
        },
        "dispatcher": {
            "phone": "5558675309",
            "email": "jane@democarrier.com"
        },
        "eld": {
            "brand": "Samsara",
            "key": "kj2h3498a7sdkjh23498a7sdkjh35"
        },
        "equipment": {
            "drivers": 2,
            "tractors": 2,
            "reefers": 1
        },
        "insurance": {
            "company": "PROGRESSIVE COMMERCIAL",
            "tractors": "8004444487",
            "reefers": "progressivecommercial@email.progressive.com"
        },
        "lane_preferences": [
            {
                "origin": {    
                    "address_form": "PHOENIX, AZ",    
                    "city": "PHOENIX",    
                    "state": "AZ"
                },
                "destination": {    
                    "address_form": "LOS ANGELES, CA",    
                    "city": "LOS ANGELES",    
                    "state": "CA"
                }
            },
            {
                "origin": {    
                    "address_form": "PHOENIX, AZ",    
                    "city": "PHOENIX",    
                    "state": "AZ"
                },
                "destination": {    
                    "address_form": "EL PASO, TX",    
                    "city": "EL PASO",    
                    "state": "TX"
                }
            },
            {
                "origin": {    
                    "address_form": "PHOENIX, AZ",    
                    "city": "PHOENIX",    
                    "state": "AZ"
                },
                "destination": {    
                    "address_form": "DENVER, CO",    
                    "city": "DENVER",    
                    "state": "CO"
                }
            }
        ],
        "lanes_covered": [
            {
                "origin": {    
                    "address_form": "PHOENIX, AZ 85034",    
                    "city": "PHOENIX",    
                    "state": "AZ",    
                    "zip": "85034"
                },
                "destination": {    
                    "address_form": "EL PASO, TX 79917",    
                    "city": "EL PASO",    
                    "state": "TX",    
                    "zip": "79917"
                }
            }
        ],
        "network_status": "approved",
        "operation_classification": [
            "Authorized for Hire"
        ],
        "services": [
            "expedited",
            "gps",
            "ltl",
            "refrigerated"
        ]
    },
    "response": {
        "date_time": "2022-11-27 16:43:21 UTC",
        "timestamp": 1669567401,
        "status": 200
    }
}