An account's custody, its recoveries and successions, and its named successor (F-012).

GET

/v1/accounts/{account}/custody

const url = 'https://example.com/v1/accounts/example/custody';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/accounts/example/custody \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Parameters

Path Parameters

account

required

string

A did:aledgent identifier.

Responses

200

The answer, from one consistent view (REQ-QR-2).

application/json

An account’s custody as its authority holders see it (INV-20, REQ-AU-16, F-012).

object

account

required

The account.

string

changes

required

Every recovery and succession recorded for it, with its effective_at.

Array<object>

One recovery or succession recorded for an account.

object

effective_at

required

When it may complete.

integer format: uint64

initiated_at

required

When it was opened.

integer format: uint64

kind

required

recovery or succession.

string

pending

required

Its identity: the operation reference that opened it.

string

state

required

pending, cancelled or completed.

string

custody

required

One of:

string
string

The operator may act, under bounded operator authority.

string

Allowed value: delegated

epoch

required

Its custody epoch: how many custody changes it has had. A reclaim proof signs it.

integer format: uint64

owner

required

Its owner.

string

successor

The successor named, if one is.

string | null

Example

{
  "custody": "delegated"
}

4XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

5XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

Headers

Retry-After

integer

On ERR-DecisionUnavailable (503): seconds to wait before retrying with the same client key (DEC-27 (g)).