Query parameters

• limit integer

  A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.

  Minimum value is 1, maximum value is 100. Default value is 10.

• starting_after string

  A cursor for use in pagination. starting_after is a certificate ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with ca_123, your subsequent call can include starting_after=ca_123 in order to fetch the next page of the list.

• ending_before string

  A cursor for use in pagination. ending_before is a certificate ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with ca_456, your subsequent call can include ending_before=ca_456 in order to fetch the previous page of the list.

• expand array[string]

  Specifies which fields in the response should be expanded. Use expand[]=review_results for abbreviated review results, or expand[]=review_results.full for full review results including parsed certificate data and detailed audit results.

Responses

• 200 application/json

  Returns an array of certificate objects. If no more certificates are available, the resulting array will be empty.

  Hide response attributes Show response attributes 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 be null until the certificate has been processed and stored.

  • review_results object | null

    Review results from the certificate evaluation. This will be null until processing completes. Use expand[]=review_results to include abbreviated results, or expand[]=review_results.full for complete details.

    Hide review_results attributes Show review_results attributes object | null

    • audit_results array[object]

      Detailed results for each insurance requirement evaluation (expanded format only).

      Hide audit_results attributes Show audit_results attributes object

      • created integer

        Timestamp when this result was created.

      • id string
      • manually_approved boolean

        Whether this result was manually approved.

      • message string

        Human-readable message about the evaluation result.

      • result string

        Whether this requirement passed or failed.

        Values are pass or fail.

      • rule_name string

        Human-readable name of the rule.

      • rule_path string

        The path to the rule being evaluated.

    • created integer

      Timestamp when the audit was created.

    • id string

      The ID of the certificate audit.

    • parsed_certificate_json object

      Full parsed certificate data extracted from the PDF (expanded format only). Contains structured data including coverages, limits, dates, and parties.

    • status string

      The final evaluation status.

      Values are pending, processing, approved, flagged, denied, or error.

    • summary object

      Summary of rule evaluation (abbreviated format only).

      Hide summary attributes Show summary attributes object

      • failed integer

        Number of requirements that failed.

      • passed integer

        Number of requirements that passed.

      • total_rules integer

        Total number of insurance requirements evaluated.

    • updated integer

      Timestamp when the audit was last updated.

  • 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.

    Values are pending, processing, approved, flagged, denied, or error.

  • updated integer(int64)

    Time at which the certificate was last updated.