Approvals (Beta)

Approve an approval request

Approve a pending approval request as the authenticated API user. The caller signs the request's signable data with the private key of a registered approval API key and submits the base64url-encoded signature, optionally with the key ID. The server verifies the signature against the registered public key — using the given key ID, or matching against all of the user's registered keys when the key ID is omitted — and advances the approval quorum.

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

post/approvals/{requestId}/approve

Request

Path parameters

requestIdstring required

The approval request ID.

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

keyIdstring

The ID of the approval API key used to sign the request. Optional — if omitted, the signature is verified against all of the user's registered approval API keys.

signaturestring required

Base64url-encoded signature over the request's signable data, produced with the private key of a registered approval API key. If keyId is provided the signature must match that key; otherwise it is matched against all of the user's registered keys.

Example request

{
  "keyId": "64e6b6a3-a607-40e0-8a1e-fe93976ffd46",
  "signature": "MEUCIQD...signature...Ok"
}

Response

The approval request was approved.

Changes

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