FIfireblocks
Approvals (Beta)

Register an approval key

Register an approval public key for an API user, used to sign approval requests. Up to 2 active keys are supported per API user. Returns the server-generated key ID used for deletion.

The userId must be the authenticated API user's own ID. Registering a key for another user is not supported and is rejected.

Registration may require approval. In that case the response carries ccrIdPendingRegistration, the key reads as APPROVAL_API_KEY_STATUS_PENDING_REGISTRATION and cannot sign until the request is approved. A rejected request removes the key.

Endpoint Permission: Owner, Admin, Non-Signing Admin, Approver, Signer, Security Admin.

post/management/api_users/{userId}/approval_keys

Request

Path parameters

userIdstring required

The ID of the API user to register the approval key for.

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

namestring required

A human-readable label for the key.

Example request

{
  "name": "primary signing key",
  "approvalApiPublicKey": {
    "algorithm": "ECDSA_SECP256R1",
    "publicKeyPem": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQ...\n-----END PUBLIC KEY-----"
  }
}

Response

The approval key was registered.

keyIdstring required

The server-generated ID of the registered key, used for deletion.

ccrIdPendingRegistrationstring required

Always returned. An empty string when the key is active immediately. Otherwise, the ID of the approval request that must be approved before the key becomes active. The request appears in GET /v1/approvals.

Example response

{
  "keyId": "fab543c0-d6be-414c-aa05-5c6c84269d7a",
  "ccrIdPendingRegistration": "19331"
}

Changes

No recorded changes to this operation across all 1 revision of this API.