certificate.revoked

POST

The certification authority revoked the certificate; it never signs again.

Parameters

Header Parameters

webhook-id

required

string format: uuid

The event id (UUIDv7), the same on every attempt and replay: deduplicate on it.

webhook-timestamp

required

string

/^\d+$/

Unix time (seconds) of this attempt. Refuse values more than 5 minutes from your clock.

webhook-signature

required

string

Space-separated v1,<base64> signatures: HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<body> with the base64-decoded part of the whsec_ secret. Accept the request if any of them matches (there is one per valid secret during a rotation).

Request Body^required

Media typeapplication/json

One of:

Certificate event

Certificate event

An event about a .p12 certificate: data is the Certificate as the API returned it when the event happened (texts in English).

object

id

required

string format: uuid

Example

01a14082-3c1d-7f0e-8b2a-6d5e4f3a2b10

type

required

string

Allowed values: certificate.verified certificate.pending certificate.blocked certificate.revoked certificate.reactivated

Example

certificate.verified

environment

required

Mode of the resource.

string

Allowed values: test live

createdAt

required

string format: date-time

data

required

An issuer’s .p12 signing certificate. Flashpi checks the upload asynchronously (processing, then accepted or rejected); the file and its password are never returned.

object

id

required

string format: uuid

issuerId

required

string format: uuid

environment

required

Mode of the API key that uploaded it. A certificate of the issuer onboarding serves every mode (allModes): it shows the mode of the API key that reads it.

string

Allowed values: test live

allModes

required

Whether it serves every mode (test and live): a certificate uploaded through the issuer onboarding (POST /v1/issuer-onboardings). False for one uploaded for one mode.

boolean

status

required

string

Allowed values: processing accepted rejected

Example

processing

usable

required

Whether it signs documents now: accepted, within its validity and not blocked.

boolean

subject

required

Subject distinguished name.

string | null

issuedBy

required

Distinguished name of the certification authority that issued it.

string | null

serialNumber

required

string | null

Example

4f2a9c01

validFrom

required

string | null format: date-time

validUntil

required

string | null format: date-time

sha256Fingerprint

required

SHA-256 of the certificate, hex.

string | null

ruc

required

The RUC found in the certificate, when its authority writes one.

string | null

Example

1790000000001

revocation

required

Any of:

object

Whether the certification authority revoked the certificate. good: verified not revoked. pending: could not be verified yet; it still signs until blockAt and is checked again hourly. blocked: still unverified after 7 days, or its chain is no longer trusted (blockedReason); it does not sign. revoked: never signs again.

object

status

required

string

Allowed values: good pending blocked revoked

Example

good

checkedAt

required

string format: date-time

nextCheckAt

required

string | null format: date-time

blockAt

required

Pending only: when it stops signing if still unverified.

string | null format: date-time

blockedReason

required

string | null

Allowed values: revocation_status_unverified untrusted_certificate_chain

null

null

rejection

required

Any of:

object

Why the upload was rejected.

object

code

required

string

Example

invalid_password

message

required

string

Example

The password does not open the .p12 file.

null

null

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

object

The body sent to thin endpoints: the event without its snapshot. Read it with GET /v1/events/{id}.

object

id

required

string format: uuid

type

required

string

Allowed values: invoice.authorized invoice.rejected purchase_settlement.authorized purchase_settlement.rejected credit_note.authorized credit_note.rejected debit_note.authorized debit_note.rejected waybill.authorized waybill.rejected withholding.authorized withholding.rejected certificate.verified certificate.pending certificate.blocked certificate.revoked certificate.reactivated document.ride.generated document.ride.failed document.email.sent document.email.delivered document.email.bounced document.email.complained document.email.failed account.email_paused account.email_resumed

environment

required

string

Allowed values: test live

createdAt

required

string format: date-time

Responses

2XX

Acknowledged. Anything else is retried.