The recovery mechanisms that apply to an account, and the digest reclaim_custody carries (F-012).

GET

/v1/accounts/{account}/recovery-mechanisms

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

The recovery mechanisms that apply, and the digest a command that makes an account owned carries as its acknowledgement (REQ-AU-9, AC-A5.3).

object

digest

required

Their digest, 32 bytes of hex.

string

mechanisms

required

The mechanisms.

Array

One of:

The recovery authority, after its delay.

object

authority

required

How the audit trail names it.

string

delay

required

The delay, milliseconds.

integer format: uint64

mechanism

required

string

Allowed value: recovery_authority

Example

{
  "mechanisms": [
    {
      "mechanism": "recovery_authority"
    }
  ]
}

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