Skip to main content
GET
/
carrier_accounts
/
{CarrierAccountObjectId}
/
signin
/
initiate
cURL
curl "https://api.goshippo.com/carrier_accounts/2ccf5af209bb484cb20190d9cadbb61c/signin/initiate?redirect_uri=https://client.example.com/cb&state=SplxlOBeZQQYbYS6WxSbIA" \
-H "Authorization: ShippoToken <API_TOKEN>"
{
  "title": "Missing required parameter",
  "detail": "redirect_uri"
}

Documentation Index

Fetch the complete documentation index at: https://docs.goshippo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
default:ShippoToken
required

API key authentication using the ShippoToken scheme. Format: Authorization: ShippoToken <API_TOKEN> Example: Authorization: ShippoToken shippo_live_abc123

Headers

​
SHIPPO-API-VERSION
string
default:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

Example:

"2018-02-08"

Path Parameters

​
CarrierAccountObjectId
string
required

The carrier account ID (UUID) to start a signin process.

Query Parameters

​
redirect_uri
string<uri>
required

Callback URL. The URL that tells the authorization server where to send the user back to after they approve the request.

​
state
string

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.

Response

Redirects the browser to the carrier login page, with the needed parameters