An account's owner, kind, custody and status: for whoever reaches it, the operator, the identities principal, and a holder of a grant over its owner (amendment 0028).

GET

/v1/accounts/{account}

const url = 'https://example.com/v1/accounts/example';
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 \
  --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

account(account) (SPEC §8.2, amendment 0028): an account as the book holds it, so a service can check whose it is before it adopts it.

object

account

required

The account, did:-shaped.

string

closed

required

Whether it is closed for good: status is closed.

boolean

custody

required

One of:

string
string

The operator may act, under bounded operator authority.

string

Allowed value: delegated

kind

required

One of:

Never negative.

string

Allowed value: customer

opened_at

required

When it was opened, in milliseconds since the epoch.

integer format: uint64

owner

required

The one identity that owns it, did:aledgent:id:….

string

status

required

One of:

It transacts.

string

Allowed value: active

Example

{
  "custody": "delegated",
  "kind": "customer",
  "status": "active"
}

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)).