Create a JWT
Creates a short-lived JSON Web Token (JWT) that client-side applications can use to authenticate against the Shippo API without exposing a long-lived API token.
Authenticate this request with either a Shippo API token
(Authorization: ShippoToken <API_TOKEN>) or an OAuth bearer token
(Authorization: Bearer <OAUTH_BEARER_TOKEN>). Platform accounts can mint a token
on behalf of a Managed Shippo Account by setting the SHIPPO-ACCOUNT-ID header.
The returned token is valid for 12 hours. Send it on subsequent requests as
Authorization: JWT <JWT_TOKEN>.
Authorizations
API key authentication using the ShippoToken scheme. Format: Authorization: ShippoToken <API_TOKEN> Example: Authorization: ShippoToken shippo_live_abc123
Headers
Optional string used to pick a non-default API version to use. See our API version guide.
"2018-02-08"
Optional. The object ID of a Managed Shippo Account. Platform accounts set this to mint a JWT scoped to one of their managed accounts.
Body
The scope to request for the token.
The scope requested for the token.
"embedded:carriers"
Response
Success
The encoded JSON Web Token. Pass it on subsequent API requests as
Authorization: JWT <JWT_TOKEN>.
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY3QiOnsidXNlcl9pZCI6MTIzNDU2N30sImV4cCI6MTcwMDAwMDAwMCwiaXNfdGVzdCI6dHJ1ZSwib2F1dGhfYXBwX2lkIjoxMDAwMSwib3JpZ2luYWxfYXV0aF9zdHJhdGVneSI6IkpXVEF1dGgiLCJwYXJ0bmVyX25hbWUiOiJleGFtcGxlLXBhcnRuZXIiLCJwbGF0Zm9ybV9pZCI6MTAwMCwidXNlcl9pZCI6MTIzNDU2NywidXNlcl9vYmplY3RfaWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJ1c2VybmFtZSI6InNoaXBwb3RsZUBzaGlwcG8uY29tIn0.EXAMPLE_SIGNATURE_NOT_VALID"
Unix timestamp (seconds) of when the token expires. This matches the exp claim
inside the token itself. Tokens are valid for 12 hours from issue.
1700000000