v1
latestOpenAPI 3.1.02026-07-2277219695.0 KBCarrier Accounts
Connect an existing carrier account using OAuth 2.0
Used by client applications to setup or reconnect an existing carrier account with carriers that support OAuth 2.0
get/carrier_accounts/{CarrierAccountObjectId}/signin/initiate
Path parameters
CarrierAccountObjectIdstring required
The carrier account ID (UUID) to start a signin process.
Query parameters
redirect_uristring uri required
Callback URL. The URL that tells the authorization server where to send the user back to after they approve the request.
statestring
A random string generated by the consuming application and included in the request to prevent CSRF attacks. The consuming application checks that the same value is returned after the user authorizes Shippo.
Headers
SHIPPO-API-VERSIONstring
Example:2018-02-08
Optional string used to pick a non-default API version to use. See our API version guide.