API ReferenceAccount

Mailing address

Your current USGM address, including PMB number

Authentication

AuthorizationBearer

Your API key, sent as Authorization: Bearer usgmk_live_… in production or usgmk_test_… in the sandbox.

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 nullOptional
line2string or nullOptional
line3string or nullOptional
citystring or nullOptional
statestring or nullOptional
postal_codestring or nullOptional
countrystring or nullOptional

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