TAtarifflo
Audit

Start a pre-audit run

Files the uploaded documents under a fresh audit request and runs the pre-audit (ingest, classification, rate and savings). Answers 202 with the run id; the result is delivered as a pre_audit.completed webhook to the key environment's URL (or Tarifflo-Webhook-Url) and pollable at GET /audit/runs/{jobId}. config: "post" (PSC) is not available yet.

Requires the API key scope audit.

post/audit/runs

Request

  • Base URL
    https://api.tarifflo.com/api/v2
  • URL
    https://api.tarifflo.com/api/v2/audit/runs
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Headers

Idempotency-Keystring

Repeats of the same request with the same key answer the first result (72 hours) with Idempotent-Replayed: true.

Request body

config'pre' | 'post' required
fileIdsstring[] required
clientNamestring

The audit client to file under (default "API Intake").

requestNamestring
destinationCountriesstring[]

Markets to rate for (default US).

dryRunboolean

Price the request at the organization's card and reserve nothing; answers 200 with the estimate.

Response

Queued (or, for dryRun, priced with 200)

OR

Changes

No recorded changes to this operation across all 1 revision of this API.