Get Credential Requirements

This API endpoint is used to retrieve a description of the format you must use when sending your credentials to connect a particular LTL carrier. Since different carriers have slightly different credential requirements, this endpoint is useful when connecting a new carrier. You may also review the list of supported LTL carriers, which includes the information needed to connect and disconnect each carrier.

SCAC and Carrier Codes

Each LTL carrier has one or more SCACs (Standard Carrier Alpha Code) used to uniquely identify that carrier. These SCAC for a carrier is referred to as carrier_id in ShipEngine API to streamline the terminology used across different types of shipping carriers. To get the credential requirements for a particular carrier, you need to pass its SCAC as the carrier_code.

Example Request

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

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

Example Response

{
  "credential_requirements": {
    "password": {
      "type": "string",
      "title": "The secret password associated with your Authentication Key"
    },
    "secret": {
      "type": "string",
      "title": "Spot Quote Authentication Key generated by the carrier used for volume pricing only"
    },
    "key": {
      "type": "string",
      "title": "Authentication Key (Production) generated by the carrier"
    },
    "securitycode": {
      "type": "string",
      "title": "Your FedEx account number"
    },
    "username": {
      "type": "string",
      "title": "The associated meter number for your FedEx account number."
    }
  }
}