API Referenceaccount

Mailingaddress

Authentication

AuthorizationBearer

Your API key, sent as Authorization: Bearer usgmk_live_....

Response

box_numberstring

The PMB (private mailbox) number — include it on every inbound mail piece.

formattedstring

The complete address on one line, ready to hand out: “<line1> PMB <box>, <city>, <state>, <postal_code>, <country>”.

line1string or null
line2string or null
line3string or null
citystring or null
statestring or null
postal_codestring or null
countrystring or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error