Revoke a certificate

Disables the running MQ credential before recording revocation. The request fails if runtime enforcement is unavailable. Repeated requests preserve the original revocation timestamp.

POST /api/v1/siloc/certificates/{certificateId}/revoke

Revoke a certificate

cURL

curl --request POST \
  --url https://api.example.com/api/v1/siloc/certificates/{certificateId}/revoke \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Idempotency: <x-idempotency>'

200

{
  "authorityCode": 123,
  "daysToExpiry": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "notAfter": "2023-11-07T05:31:56Z",
  "sfnCertificateId": "<string>",
  "subject": "CN=46026562, OU=SILOC",
  "custodyReference": "<string>",
  "notBefore": "2023-11-07T05:31:56Z",
  "revokedAt": "2023-11-07T05:31:56Z",
  "serialNumber": "<string>"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency · string · requerido

Idempotency key for this state-changing request (required, max 255 characters).

Maximum string length: 255

X-Request-ID · string

Request correlation identifier. Generated when omitted.

Parámetros de ruta

certificateId · string<uuid> · requerido

Certificate id.

Respuesta

200

application/json

OK

authorityCode · integer<int64> · requerido

BACEN certificate-authority code (C10/C12 on the SFN wire): 1 SPB-Serpro, 2 SPB-Certisign, 3 Pessoas Fisicas, 4 SPB-Serasa, 5 SPB-CAIXA, 6 SPB-Valid, 7 SPB-Soluti. Derived from the certificate's own ISSUER block (OU=CSPB-N), never supplied. sfnCertificateId is unique only WITHIN this authority, so the two together are the identity.

daysToExpiry · integer<int64> · requerido

Whole days until expiry (0 the day it lapses, negative once expired). Always present — a real 0 is the most urgent operator signal.

id · string<uuid> · requerido

Certificate id.

notAfter · string<date-time> · requerido

Validity end (expiry).

sfnCertificateId · string · requerido

Exact 64-hex C11 identity used on the SFN wire: the hex encoding of the 32-byte slot, whose content is the certificate serial in uppercase ASCII hex, right-aligned and zero-left-padded. No ISPB. Unique only within authorityCode.

subject · string · requerido

Certificate subject DN.

Ejemplo:

"CN=46026562, OU=SILOC"

custodyReference · string

Opaque reference to the private key in the FI's custody; the key itself is never stored here.

notBefore · string<date-time>

Validity start.

revokedAt · string<date-time>

Revocation time. Omitted while the certificate is active.

serialNumber · string

Certificate serial number.