operation get api v1 files certificates parameter.md
Retrieve a certificate.
GET /api/v1/files/certificates/{certificate}
Retrieves the details of an existing certificate by its ID. Use this endpoint to poll for certificate status updates during asynchronous processing.
Certificate Status Lifecycle:
The certificate status transitions through the following states:
pending- Certificate has been uploaded but processing has not startedprocessing- Certificate is currently being processedapproved- Certificate passed all insurance requirementsflagged- Certificate failed some requirements (may require manual review)denied- Certificate was deniederror- An error occurred during processing
Retrieving Review Results:
Once processing is complete, use the expand parameter to retrieve review results:
expand[]=review_results- Returns abbreviated results with summary countsexpand[]=review_results.full- Returns full parsed certificate data and detailed audit results for each insurance requirement
Servers
- Production server: https://api.1099policy.com (Production server)
Parameters
Path parameters
- certificate (string)
The ID of the desired certificate.
Query parameters
- expand (array[string])
Specifies which fields in the response should be expanded. Useexpand[]=review_resultsfor abbreviated review results, orexpand[]=review_results.fullfor full review results including parsed certificate data and detailed audit results.
Responses
200
Returns a certificate object if a valid certificate ID was provided. The status field indicates the current processing state, and review_results will be null until processing completes.
Body: application/json (object)
- contractor (string)
The ID of the contractor associated with this certificate. - created (integer(int64))
Time at which the certificate was uploaded. - filename (string)
The original filename of the uploaded PDF. - id (string)
Unique identifier for the certificate. - pdf_url (string | null)
URL to access the certificate PDF. This will benulluntil the certificate has been processed and stored. - review_results (object | null)
Review results from the certificate evaluation. This will benulluntil processing completes. Useexpand[]=review_resultsto include abbreviated results, orexpand[]=review_results.fullfor complete details. - status (string)
The current processing status of the certificate. Status transitions:pending→processing→ (approved|flagged|denied|error). Use polling or webhooks to monitor status changes. - updated (integer(int64))
Time at which the certificate was last updated.
404
Certificate not found