Generate receipt-backed audit reports | Freight Rate Intelligence API

curl -X POST https://freightrateintelligence.com/v1/reports/audit \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "report_type": "RECEIPT_TRACE"
}'

{
  "ok": true,
  "data": {
    "report_type": "RECEIPT_TRACE",
    "generated_at": "2024-01-15T09:30:00Z",
    "target_receipt": "string",
    "chain_length": 1,
    "receipt_chain": [
      {
        "receipt_id": "string",
        "timestamp": "string",
        "skill_name": "string",
        "confidence_level": "string",
        "auth_obj_id": "string",
        "prev_receipt_hash": "string",
        "metadata_summary": {}
      }
    ],
    "data_sources": [
      {
        "source": "string",
        "series_id": "string",
        "description": "string",
        "value_used": 1.1,
        "unit": "string",
        "observation_date": "string"
      }
    ],
    "verification": {
      "chain_valid": true,
      "chain_continuous": true,
      "timestamps_sequential": true,
      "all_sources_attributed": true,
      "all_confidence_present": true,
      "chain_length": 1,
      "issues": [
        "string"
      ],
      "verified_at": "2024-01-15T09:30:00Z"
    },
    "confidence": {
      "level": "HIGH",
      "score": 1.1,
      "label": "string",
      "factors": [
        "string"
      ]
    },
    "model_type": "AUDIT_REPORT",
    "model_disclaimer": "string",
    "factor_versions": [
      {
        "source": "EIA",
        "series_id": "PET.EMD_EPD2DXL0_PTE_R30_DPG.W",
        "version": "latest",
        "fetched_at": "2024-01-15T09:30:00Z"
      }
    ]
  },
  "receipt_id": "rcpt_01abc...",
  "auth_obj_id": "auth_01xyz..."
}

Produces auditable reports tracing data from API response back to original government data sources. Supports receipt trace, lane history, methodology audit, and factor provenance reports. Requires Professional tier.

Authentication

AuthorizationBearer

Your Freight Rate Intelligence API key. Get one at freightrateintelligence.com/dashboard/settings

Request

This endpoint expects an object.

report_typeenumRequired

RECEIPT_TRACE: trace a single receipt through the hash chain. LANE_HISTORY: all receipts for a lane in a date range. DATA_SOURCES: catalog of all data sources and their freshness.

Allowed values:

receipt_idstringOptional

Receipt ID to trace (required for RECEIPT_TRACE). Format: rcpt_XX_XXXXXXXXXX

laneobjectOptional

Lane specification (required for LANE_HISTORY)

date_rangeobjectOptional

Optional date range filter for LANE_HISTORY reports. Defaults to last 30 days.

formatenumOptionalDefaults to JSON

JSON is currently supported. PDF export coming in a future release.

Allowed values:

Response

Audit report with receipt

okboolean

dataobject

Skill-specific response data

receipt_idstring

auth_obj_idstring

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error