Reference

Facts

What Thaw took off the pages, with sums. Account, policy and license numbers come only with the identifiers scope.

GETA document's facts/documents/{document}/facts GETFacts across documents/facts PATCHCorrect a fact/documents/{document}/facts/{fact}

A document's facts

GETapi.thawed.app/v1/documents/{document}/facts

Scope: read · every token has it

Every fact Thaw took off the page, with its role. Account, policy and license numbers come only on a token with the identifiers scope; without it they are left out rather than masked.

Path

documentstring (uuid)pathrequired

Responses

200

The facts, identifiers left out without the scope.

401

No token, a token that has ended, or one issued for the other door. WWW-Authenticate names the resource metadata document.

Problem

404

Nothing of that id in this family or business.

Problem

200 answer

documentNamed

factsarray of Fact

identifiers_shownboolean

Request

curl "https://api.thawed.app/v1/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11/facts" \
  -H "Authorization: Bearer $THAW_TOKEN"

Response 200

{
  "document": {
    "id": "019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11",
    "title": "Bluebonnet Electric bill September 2026",
    "name": "scan.pdf",
    "kind": "document",
    "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
  },
  "facts": [
    {
      "id": "019958a0-4f71-706d-8e52-6c3f5d91b044",
      "key": "staging/019958a0-2d5f…/scan.pdf",
      "label": "Amount due",
      "role": "money",
      "value": "$129.50",
      "number": 129.5,
      "date": "2026-09-12",
      "currency": "USD",
      "page": 1,
      "corrected_by_hand": false
    }
  ],
  "identifiers_shown": false
}

Facts across documents

GETapi.thawed.app/v1/facts

Scope: read · every token has it

Every fact on the documents the filters pick, with the sum of the money ones by currency. role=identifier needs the identifiers scope on a token, or a read-and-change connection.

Query

labelstringquery

Part of the fact's label or key ("premium", "due date").

rolestringquery

moneydatepartytextidentifier

categorystringquery

A category's slug or name.

typestringquery

A type's slug or name.

person_or_thingstringquery

A person or thing's id or name.

yearintegerquery

The year on the document.

include_supersededbooleanquery

Include documents replaced by a newer version.

limitintegerquery

Responses

200

The facts, newest document first.

401

No token, a token that has ended, or one issued for the other door. WWW-Authenticate names the resource metadata document.

Problem

403

The token, the role or the plan does not allow it. A missing scope is named in scope and in the WWW-Authenticate header as insufficient_scope; a plan that does not come with it says which one does.

Problem

422

A field was wrong. errors names each one.

Problem

200 answer

factsarray of any

showinginteger

totalinteger

sum_of_amountsobject

By currency, over every matching money fact, not only the ones shown.

identifiers_shownboolean

Request

curl "https://api.thawed.app/v1/facts" \
  -H "Authorization: Bearer $THAW_TOKEN"

Response 200

{
  "facts": [
    {
      "id": "019958a0-4f71-706d-8e52-6c3f5d91b044",
      "key": "staging/019958a0-2d5f…/scan.pdf",
      "label": "Amount due",
      "role": "money",
      "value": "$129.50",
      "number": 129.5,
      "date": "2026-09-12",
      "currency": "USD",
      "page": 1,
      "corrected_by_hand": false,
      "document": {
        "id": "019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11",
        "title": "Bluebonnet Electric bill September 2026",
        "name": "scan.pdf",
        "kind": "document",
        "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
      }
    }
  ],
  "showing": 3,
  "total": 412,
  "sum_of_amounts": {
    "USD": 1
  },
  "identifiers_shown": false
}

Correct a fact

PATCHapi.thawed.app/v1/documents/{document}/facts/{fact}

Scope: write · change things, on a paid plan Takes Idempotency-Key

The value is the person's from then on. A number is read from it where the fact is money, a date where it is a date.

Path

documentstring (uuid)pathrequired

factstring (uuid)pathrequired

Headers

Idempotency-Keystringheader

Any string of the caller's choosing. The same key with the same body within a day replays the first answer, marked Idempotent-Replayed: true; with a different body it is 422; while the first call is still running it is 409.

BodyJSON

valuestringrequired

Responses

200

The fact, and the document.

401

No token, a token that has ended, or one issued for the other door. WWW-Authenticate names the resource metadata document.

Problem

403

Problem

404

Nothing of that id in this family or business.

Problem

422

A field was wrong. errors names each one.

Problem

200 answer

factFact

documentDocumentRow

One document as a list shows it.

Request

curl -X PATCH "https://api.thawed.app/v1/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11/facts/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11" \
  -H "Authorization: Bearer $THAW_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"value":"$129.50"}'

Body

{
  "value": "$129.50"
}

Response 200

{
  "fact": {
    "id": "019958a0-3e60-7f5c-9d41-5b2e4c80af33",
    "key": "staging/019958a0-2d5f…/scan.pdf",
    "label": "Amount due",
    "role": "money",
    "value": "$129.50",
    "number": 129.5,
    "date": "2026-09-12",
    "currency": "USD",
    "page": 1,
    "corrected_by_hand": false
  },
  "document": {
    "id": "019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11",
    "title": "Bluebonnet Electric bill September 2026",
    "type": "utilities/electric-bill",
    "category": "home",
    "date": "2026-09-12",
    "period": {
      "from": "marisol@example.com",
      "to": "billing@bluebonnet.example"
    },
    "status": "filed",
    "needs_look": false,
    "read": "full",
    "superseded": false,
    "duplicate": false,
    "people_and_things": [
      {
        "id": "019958a0-3e60-7f5c-9d41-5b2e4c80af33",
        "title": "Bluebonnet Electric bill September 2026",
        "name": "Marisol Alvarez",
        "kind": "document",
        "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11",
        "role": "subject"
      }
    ],
    "arrived": "2026-09-12",
    "url": "https://go.thawed.app/documents/019958a0-1c4e-7d3a-9b2f-3f0c2a6e8d11"
  }
}