Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Capture

Doc form data

Get field data for all <glossary:Form>s captured in a <glossary:Document>.

A detailed description of the response can be found on the form data data type definition.

get/v1/document/forms/fields

Query parameters

doc_uuidstring

The unique identifier of the <glossary:Document> that contains the form data. Mutually exclusive with pk.

pkstring

The <glossary:PK> of the <glossary:Document> that contains the form data. Mutually exclusive with doc_uuid.

Response

200

statusinteger

A numerical code that indicates the status of the request.

messagestring

A textual description that indicates details about this response's status.

Example response

{
  "status": 200,
  "response": {
    "pk": 133771,
    "uuid": "988a30fe-d25e-40b4-9724-f4c06bacbab5",
    "forms": [
      {
        "pk": 12304,
        "uuid": "e6d7d3c7-444c-4cf3-99c7-65bdabb309f9",
        "form_type": "ACCOUNT_SUMMARY",
        "form_config_pk": 1013,
        "tables": [],
        "raw_fields": {
          "examplefield:field_name": {
            "value": "1379.82",
            "source_filename": "simple_bank_statement.pdf"
          }
        }
      }
    ]
  },
  "message": "OK"
}