Gas station

List gas stations that could sponsor a specific account

Returns the gas stations that could be chosen as sponsor for the given account: every sponsor in the account domain or one of its ancestor domains, excluding the account itself. If the account is already effectively sponsored, returns isSponsored=true with the existing sponsor and an empty items list (an entity is only sponsored once), unless includeAll=true, in which case items still lists the lineage candidates (the current sponsor may appear among them).

get/v1/domains/{domainId}/sponsors/account/{accountId}/valid-sponsors

Request

Base URL
https://docs.ripple.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/sponsors/account/:accountId/valid-sponsors/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

domainIdstring uuid required

Domain ID of the account to list valid sponsors for

accountIdstring uuid required

Account ID to list valid sponsors for

Query parameters

includeAllboolean

When true, items lists the lineage candidates even if the account is already sponsored (the current sponsor may appear among them). Defaults to false.

Response

Valid sponsor candidates returned

isSponsoredboolean required

Whether the account is already effectively sponsored

Changes

No recorded changes to this operation across all 3 revisions of this API.