Skip to main content
POST
Register an approval key

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Headers

Idempotency-Key
string
required

Client-supplied key that deduplicates retried requests. Reusing a key returns the original result instead of repeating the action.

Api-Signature
string
required

A hex-encoded Ed25519 signature of timestamp_epoch_seconds + uppercase(http_method) + request_path + request_body.

Pattern: ^[0-9A-Fa-f]{128,160}$
Api-Timestamp
integer<int64>
required

Current timestamp, represented as unix epoch seconds

Body

application/json
class
enum<string>
required

The kind of credential registered. Only Anchorage Digital API keys are supported.

Available options:
api_key
apiKeyId
string
required

The approver's API key id: hex-encoded SHA-256 of its access key, as shown when the key was issued. A key is nominated at most once per organization, for all time: once registered it cannot be nominated again, even after it is archived. The key must be an ACTIVE API key of the caller's organization.

Pattern: ^[0-9a-fA-F]{64}$
publicKey
string
required

The key's Ed25519 public key, hex-encoded (32 bytes). Must be the canonical encoding of a point on the curve outside the small-order subgroup; a key from any standard generator is. Must be the public key Anchorage Digital holds for apiKeyId; a nomination whose key does not match is refused.

Pattern: ^[0-9a-fA-F]{64}$
label
string
required

A name for the key, used only in audit records. It does not identify the key holder. Surrounding whitespace is removed; what remains must be 1 to 128 characters.

Required string length: 1 - 128
approvalGroupId
string<uuid>
required

The approval group the key joins, in canonical lowercase hyphenated form. Must be an ACTIVE approval group of the caller's organization; the key belongs to it for its whole life and cannot be moved to another group. Optional until approval groups can be created through this API; it becomes required then, and a key registered without one belongs to no group.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"3486b413-93d3-4447-afce-2b9c9dc34a32"

Response

Change accepted

data
Approval Key Change Accepted · object
required