Documents

Get records (JSON)

Returns all records for a document with pure extracted values per class schema. (JSON)

get/documents/{id}/records

Request

  • Base URL: https://klaaro.ai/api/v1
  • URL: https://klaaro.ai/api/v1/documents/{id}/records
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

includeUnapprovedboolean

Response

OK

Example response

{
  "records": [
    {
      "id": "2c0c2e50-5df6-4b1e-9a5e-c4b6e7a6c1b4",
      "documentId": "b6d2a7f6-0f44-44c8-8cc2-1d2e2bd7a5d5",
      "class": {
        "slug": "invoice",
        "name": "Invoice",
        "schemaHash": "9b7c7b2f6f9f0c52d32a1a6d0d1f3c747c1f9e8b132a4d2e2b9a7c6f0e1d2c3b",
        "classHash": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456"
      },
      "data": {
        "total": 120,
        "line_items": [
          {
            "amount": 120
          }
        ]
      }
    }
  ]
}

Changes

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