OCocrolus
Capture

Form data

Retrieve field data for a <glossary:Form>.

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

get/v1/form

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v1/form
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

Query parameters

uuidstring

The unique identifier of a <glossary:Form>. If both pk and uuid are provided, pk is used and uuid is ignored.

pkinteger

The unique primary key of a Form. If both pk and uuid are provided, pk is used and uuid is ignored.

Response

Success

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": 12304,
    "id": 12304,
    "uuid": "e6d7d3c7-444c-4cf3-99c7-65bdabb309f9",
    "form_type": "ACCOUNT_SUMMARY",
    "raw_fields": {
      "examplefield:field_name": {
        "value": "1379.82",
        "source_filename": "simple_bank_statement.pdf"
      }
    }
  },
  "message": "OK"
}

Changes

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