Skip to main content
POST
Require or clear the admin approval on a sandbox ceremony

Authorizations

x-api-key
string
header
required

Path Parameters

customerId
string
required
Example:

"cus_1A2b3C4d5E6f7G8h9I0jKl"

Body

application/json
target
enum<string>
required

Which change the gate applies to. signer_add is a new signer, machine or passkey. signer_remove is a signer you delete. passkey_enrollment is a passkey you add to a signer that is already enrolled; the first passkey of a new signer arrives under signer_add. Each one applies at once in sandbox and waits for one administrator approval in production. A signer who enrolls through OAuth waits for no approval in either environment. Promotion, demotion and signing-quorum changes already wait for an approval in sandbox, so they take no gate.

Available options:
signer_add,
signer_remove,
passkey_enrollment
requireApproval
boolean
required

True makes every later change of this kind wait for an admin approval, as production does: the call answers 202 with a ceremony id and an admin verification URL, and you complete it with the ceremony-stamp endpoint. False restores the sandbox default, where the change applies at once.

Response

target
enum<string>
required
Available options:
signer_add,
signer_remove,
passkey_enrollment
requireApproval
boolean
required