Get Credential Requirements

This endpoint is used to retrieve a description of the format you must use when sending your credentials to connect a particular LTL carrier. Since each carrier will have different credential requirements, use this endpoint to ensure you know what is required to connect successfully.

SCAC & Carrier Codes

Each LTL carrier has one or more SCACs (Standard Carrier Alpha Code) used to uniquely identify that carrier. The SCAC for a carrier is referred to as carrier_id. To get the credential requirements for a particular carrier, you need to pass its SCAC as the carrier_code.

Example Request & Response

GET /v-beta/ltl/carriers/:carrier_code/credential_requirements

1
2
3
GET /v-beta/ltl/carriers/FXFE/credential_requirements HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
    "credential_requirements": [
        {
            "name": "account_number",
            "title": "Carrier account number",
            "type": "string"
        },
        {
            "name": "key",
            "title": "Authentication Key (Production) generated by the carrier",
            "type": "string"
        },
        {
            "name": "password",
            "title": "The secret password associated with your Authentication Key",
            "type": "string"
        },
        {
            "name": "secret",
            "title": "Spot Quote Authentication Key generated by the carrier used for volume pricing only",
            "type": "string"
        },
        {
            "name": "securitycode",
            "title": "Your FedEx account number",
            "type": "string"
        },
        {
            "name": "username",
            "title": "The associated meter number for your FedEx account number.",
            "type": "string"
        }
    ]
}