Skip to main content
POST
Validate a shipping address
Read the outcome before requesting a courier quote. A successful HTTP request can still report an address problem.
  • verified means the address passed validation.
  • For corrected, missing_information, review_required, failed or none, read detail to decide what to show the user.

Request

Builder key and wallet access token

Response

Error codes

Match the HTTP status and response text to a row below. For guidance on codes shared across endpoints, see Error meanings and recovery.

Authorizations

x-builder-api-key
string
header
required

Your approved builder API key. Keep it on your backend. Gacha and marketplace writes also require wallet action signatures. Redeem also needs a wallet access token, a Bearer token the API issues after the wallet signs a sign-in message.

Authorization
string
header
required

Wallet access token: Bearer authentication for Redeem

Body

application/json
countryCode
string
required
Pattern: ^[A-Z]{2}$
addressLine1
string
required
Required string length: 1 - 35
city
string
required
Required string length: 1 - 200
postalCode
string
required
Required string length: 1 - 20
addressLine2
string
Maximum string length: 35
state
string
Maximum string length: 200

Response

Success

status
string
required
detail
string
required