Skip to main content
GET
Get UPA by external user ID
Looks up the UPA by the partner-owned externalUserId supplied at creation and returns the same account bundle as Get an account. The lookup is scoped to the authenticated app and environment.

Authorizations

Authorization
string
header
required

HTTP Basic auth. Username is the Stableyard app ID. Password is the app secret. The optional Stableyard-Version request header must match the environment pin.

Headers

Stableyard-Version
enum<string>

Optional contract-version assertion. Omit it to use the app environment's pinned version. A different supported version is accepted only after that environment is explicitly migrated.

Available options:
2026-09-09

Path Parameters

externalUserId
string
required

Partner-owned external user id supplied when the UPA was created.

Maximum string length: 128
Example:

"user_123"

Response

Account bundle

account
object
required
connectedWallets
object[]
required
paymentHandle
object
settlementProfile
object