The /v4/carriers/load/profile/onboarded/ endpoint lets you load the complete details, including insurance and payment information, of any carrier that you have onboarded into your network.
Notes on this endpoint:
- Authentication via header. To authenticate your API call, pass in your public API key with the X-Api-Key HTTP header.
HTTP Request
| Method | URL |
|---|---|
| GET | https://api.brokercarrier.com/v4/carriers/load/profile/onboarded |
Required Parameters
| Name | Type | Value(s) |
|---|---|---|
| id_type | string |
One of: dot, mc
|
| id_number | string |
The carrier's DOT number or MC number |
Example Response
Request: https://api.brokercarrier.com/v4/carriers/load/profile/onboarded?id_type=mc&id_number=1999999
The example response below shows a fictional carrier. Your real API calls will contain private business data that cannot be published in an example. In this example, the carrier has both payment fields and factoring fields. A real carrier profile will usually have only one or the other.
The payment field below shows a fictional example of the data that is returned for a carrier that does not use a factoring company. The payment->details->ach->routing and payment->details->ach->account fields are encrypted using your secret key. Please contact us when you reach this point, and we will assist you with setting up your secret key for use in decrypting these values.
The factoring field below shows a fictional example of the data that is returned for a carrier that uses a factoring company.
{
"agreement": {
"name": "PETER GIBBONS",
"title": "LOGISTICS COORDINATOR",
"date": "2024-02-02",
"document": {
"title": "Broker-Carrier Agreement",
"filename": "verylongfilenamethatyoucanaccessfromanotherendpoint.pdf"
}
},
"authority": {
"docket_prefix": "MC",
"docket_number": "1999999",
"authorized_for": {
"broker": "n",
"hhg": "n",
"passenger": "n",
"property": "y"
},
"status": {
"broker": "n",
"common": "a",
"contract": "n"
}
},
"cargo": [
"General Freight"
],
"census": {
"address": {
"physical": {
"street": "123 BLVD ST",
"city": "RENO",
"state": "NV",
"zip": "89501"
},
"mailing": {
"street": "123 BLVD ST",
"city": "RENO",
"state": "NV",
"zip": "89501"
}
},
"contact": {
"email": "fictionalfreight@gmail.com",
"phone": "(555) 867-5309",
"fax": null
},
"filing": {
"legal_name": "FICTIONAL FREIGHT LINES LLC",
"dba_name": null,
"ein": "121234567"
},
"registration": {
"dot_number": "4999999",
"operation": "interstate"
},
"size": {
"drivers": 2,
"power_units": 1,
"recent_vmt": {
"mileage": 0,
"year": "0",
"source": "census"
},
"mcs150": {
"date": "2023-05-23",
"mileage": 0,
"mileage_year": ""
}
}
},
"dispatcher": {
"name": "PETER GIBBONS",
"email": "fictionaldispatch@gmail.com",
"phone": "5558675310"
},
"documents": {
"agreement": "verylongfilenamethatyoucanaccessfromanotherendpoint.pdf",
"authority_cert": "verylongfilenamethatyoucanaccessfromanotherendpoint.pdf",
"factoring_noa": "verylongfilenamethatyoucanaccessfromanotherendpoint.pdf",
"insurance_cert": "verylongfilenamethatyoucanaccessfromanotherendpoint.pdf",
"tax_form": "verylongfilenamethatyoucanaccessfromanotherendpoint.pdf"
},
"equipment": [
"Dry Van",
"Flatbed"
],
"factoring": {
"company": "Consultants Factoring",
"poc_name": "BOB SLYDELL",
"document": {
"title": "Notice of Assigment",
"filename": "verylongfilenamethatyoucanaccessfromanotherendpoint.pdf"
}
},
"insurance": {
"company": "Musthave Insurance, Inc",
"phone": "5558675311",
"email": "certs@musthaveinsurance.com",
"policy_number": "PN123456789-01SMC",
"policy_exp": "2025-02-02"
},
"lane_preferences": [
{
"origin": "RENO, NV",
"destination": "SACRAMENTO, CA",
"distance": 131.62,
"duration": 127.382
}
],
payment": {
"poc": {
"name": "PETER GIBBONS",
"phone": "5558675309",
"email": "fictionalbilling@gmail.com"
},
"remit_to": {
"address": "123 BLVD ST",
"city": "RENO",
"state": "NV",
"zip": "89501"
},
"details": {
"ein": "991234567",
"ach" {
"routing": "[ENCRYPTED-VALUE]",
"account": "[ENCRYPTED-VALUE]"
}
}
},
"services": [
"Satellite/GPS/ELD",
"Power Only (Semi)"
],
"sms": {
"inspections": {
"total": 1,
"driver": {
"total": 1,
"oos": 0,
"oos_percent": 0
},
"vehicle": {
"total": 0,
"oos": 0,
"oos_percent": 0
},
"unsafe_driving": {
"w_violations": 1,
"measure": "21",
"acute_critical": "N"
},
"hours_of_service": {
"w_violations": 0,
"measure": "0",
"acute_critical": "N"
},
"driver_fitness": {
"w_violations": 0,
"measure": "0",
"acute_critical": "N"
},
"controlled_substances": {
"w_violations": 0,
"measure": "0",
"acute_critical": "N"
},
"vehicle_maintenance": {
"w_violations": 0,
"measure": "0",
"acute_critical": "N"
}
},
"violations": {
"total": 1,
"controlled_substances": {
"total": 0,
"oos": 0
},
"driver_fitness": {
"total": 0,
"oos": 0
},
"hazmat": {
"total": 0,
"oos": 0
},
"hours_of_service": {
"total": 0,
"oos": 0
},
"unsafe_driving": {
"total": 1,
"oos": 0
},
"vehicle_maintenance": {
"total": 0,
"oos": 0
}
},
"crashes": {
"total": 0,
"w_injuries": 0,
"w_fatalities": 0,
"w_tow_away": 0,
"w_citation": 0
}
},
"vins": {
"total": 1,
"list": [
{
"vin": "3HSDJFPRXGY268590",
"license_state": "NV",
"license_plate": "ABC123Z",
"type": "TRUCK TRACTOR"
}
]
}
}