Read one key ceremony

GET/cards/security/ceremonies/{id}

Verified bank staff with cards:read observe the registry; opening a ceremony, entering a component, personalising a card and unlocking a PIN take the narrow cards:security:write and a step-up in the last five minutes, never cards:write. Approving another member of staff's ceremony adds cards:security:approve. The maker never approves their own ceremony and never enters a component. Both HSM adapters are simulators and are refused in prod.

Path parameters

idstringRequired

Returns

200 OK

componentsarray of objectsRequired

4 child attributes

check_valuestringRequired

custodianstringRequired

entered_atstring · date-timeRequired

ordinalintegerRequired

components_requiredintegerRequired

decimalizationstringOptional

decisionobject or nullOptional

CeremonyDecision is the approver's decision.

4 child attributes

decided_atstring · date-timeRequired

decided_bystringRequired

decisionstringRequired

notestringOptional

document_sha256stringRequired

idstringRequired

kek_key_idstringOptional

key_idstringOptional

kindstringRequired

labelstringRequired

networkstringRequired

opened_atstring · date-timeRequired

opened_bystringRequired

pvkiintegerRequired

reasonstringRequired

request_idstringOptional

Example req_2tVh8nqLxq4GbDe0K1F6S9zRcWm

result_key_idstringOptional

statusstringRequired

templateobjectRequired

KeyTemplate names the attributes of a key the HSM creates or imports.

6 child attributes

algorithmstringRequired

T (TDEA), A (AES) or H (HMAC)

exportabilitystringRequired

E or N

key_versionstringRequired

Two characters; "00" when unversioned

lengthintegerRequired

Key length in bytes

mode_of_usestringRequired

One character, for example B

usagestringRequired

ANSI X9.143 key usage, for example P0

updated_atstring · date-timeRequired

zone_key_indexstringOptional

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503