API ReferenceAccount

Get account

Your account profile, including name, email, status, and PMB number

Authentication

AuthorizationBearer

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

Response

idstring

Account id (UUID).

namestring
emailstring
created_atdatetime
Registration date.
phone_numberstring or nullOptional
statusstring or nullOptional

Account status as reported by USGM (e.g. APPROVED, SUSPENDED).

box_numberstring or nullOptional

The PMB (private mailbox) number. Null until a mailbox is assigned.

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