List extracted fields

GET

/v1/loans/{ref}/fields

curl --request GET \
  --url http://localhost:8080/v1/loans/example/fields

Returns every extracted field of the latest package version with provenance: document, page, page-relative bounding box, raw text, normalised value, value kind, confidence and extraction method. Any staff role or an API key with status:read. 404 for an unknown reference.

Parameters

Path Parameters

ref

required

string

Responses

200

OK

Media typeapplication/json

Array<object>

An extracted value with provenance. BoundingBox? ExtractedFieldView.Bbox is page-relative.

object

id

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

documentId

required

string format: uuid

fieldName

required

string

rawText

required

null | string

normalizedValue

required

null | string

valueKind

required

string

pageNo

required

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

bbox

required

One of:

null

null

object

Page-relative box: fractions of page width/height, origin top-left, so it survives any render scale.

object

x

required

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

y

required

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

w

required

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

h

required

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

confidence

required

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

method

required

string

extractedAt

required

string format: date-time

Example^generated

[
  {
    "id": 1,
    "documentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "fieldName": "example",
    "rawText": "example",
    "normalizedValue": "example",
    "valueKind": "example",
    "pageNo": 1,
    "bbox": {
      "x": 1,
      "y": 1,
      "w": 1,
      "h": 1
    },
    "confidence": 1,
    "method": "example",
    "extractedAt": "2026-04-15T12:00:00Z"
  }
]