operation post api v1 files certificates.md

Create a new certificate.

POST /api/v1/files/certificates

Uploads a new Certificate of Insurance (COI) PDF file, validates it, and creates a certificate record. The certificate processing is performed asynchronously in the background. The initial response indicates that the certificate has been accepted for processing with a status of "pending".

Asynchronous Processing:

After uploading a certificate, the platform automatically processes the document and evaluates it against your organization's pre-defined insurance requirements. This evaluation happens asynchronously, so the initial response will have:

Monitoring Certificate Status:

You can monitor the certificate status in two ways:

  1. Polling: Periodically retrieve the certificate using the GET endpoint to check the status field. The status will transition from "pending" → "processing" → ("approved" | "flagged" | "denied" | "error") as processing completes.

  2. Webhooks: Register a webhook endpoint to receive real-time notifications when processing completes. The following events are sent:

Retrieving Review Results:

Once processing is complete, use the expand[]=review_results parameter when retrieving the certificate to get abbreviated review results, or expand[]=review_results.full for complete details including parsed certificate data and detailed audit results.

Servers

Parameters

Body: multipart/form-data (object)

Responses

201

Returns the created certificate object. The certificate has been accepted for processing and will have a status of "pending". Processing happens asynchronously, and you can monitor the status via polling or webhooks.

Body: application/json (object)