SwaggerUI

0.0.0 OAS3

api

GET/api/v5/submissions

Lists submissions

Parameters

Name Description
complete_time__gte
string($date-time)
(query)
complete_time__lt
string($date-time)
(query)
correlation_id
array[string]
(query)
exception
array[string]
(query)		 Exception Type
- unsupported_filetype - UNSUPPORTED_FILETYPE
- password_protected_file - PASSWORD_PROTECTED_FILE
- required_field_missing - REQUIRED_FIELD_MISSING
- illegible_field - ILLEGIBLE_FIELD
- consensus_field_autotranscribed - CONSENSUS_FIELD_AUTOTRANSCRIBED
- validation_override - VALIDATION_OVERRIDE
- failed_pages - FAILED_PAGES
- image_fetch_failed - IMAGE_FETCH_FAILED
- normalization_error - NORMALIZATION_ERROR
- flex_process_single_page_only - FLEX_PROCESS_SINGLE_PAGE_ONLY
- supervision_always_field_autotranscribed - SUPERVISION_ALWAYS_FIELD_AUTOTRANSCRIBED
- supervision_always_field_autoidentified - SUPERVISION_ALWAYS_FIELD_AUTOIDENTIFIED
- supervision_required_but_disabled - SUPERVISION_REQUIRED_BUT_DISABLED
- character_limit_reached - CHARACTER_LIMIT_REACHED
- id_supervision_required_but_disabled - ID_SUPERVISION_REQUIRED_BUT_DISABLED
- max_pages_limit_exceeded - MAX_PAGES_LIMIT_EXCEEDED
Available values : character_limit_reached, consensus_field_autotranscribed, failed_pages, flex_process_single_page_only, id_supervision_required_but_disabled, illegible_field, image_fetch_failed, max_pages_limit_exceeded, normalization_error, password_protected_file, required_field_missing, supervision_always_field_autoidentified, supervision_always_field_autotranscribed, supervision_required_but_disabled, unsupported_filetype, validation_override
--character_limit_reachedconsensus_field_autotranscribedfailed_pagesflex_process_single_page_onlyid_supervision_required_but_disabledillegible_fieldimage_fetch_failedmax_pages_limit_exceedednormalization_errorpassword_protected_filerequired_field_missingsupervision_always_field_autoidentifiedsupervision_always_field_autotranscribedsupervision_required_but_disabledunsupported_filetypevalidation_override
flow_uuid
array[string]
(query)
goal_time__gte
string($date-time)
(query)
goal_time__lt
string($date-time)
(query)
halted
array[string]
(query)		 Halted
- true - true
- false - false
Available values : false, true
--falsetrue
id
array[integer]
(query)
layout
array[string]
(query)
layout_tag
array[string]
(query)
limit
integer
(query)		 Number of results to return per page.
offset
integer
(query)		 The initial index from which to return the results.
start_time__gte
string($date-time)
(query)
start_time__lt
string($date-time)
(query)
state
array[string]
(query)		 Submission State
- processing - PROCESSING
- supervision - SUPERVISION
- failed - FAILED
- complete - COMPLETE
Available values : complete, failed, processing, supervision
--completefailedprocessingsupervision
substate
array[string]
(query)		 Submission Substate
- manual_transcription - MANUAL_TRANSCRIPTION
- manual_field_identification - MANUAL_FIELD_IDENTIFICATION
- manual_table_identification - MANUAL_TABLE_IDENTIFICATION
- manual_routing_transcription - MANUAL_ROUTING_TRANSCRIPTION
- machine_routing_decision - MACHINE_ROUTING_DECISION
- manual_document_organization - MANUAL_DOCUMENT_ORGANIZATION
- flexible_extraction - FLEXIBLE_EXTRACTION
- custom_supervision - CUSTOM_SUPERVISION
Available values : custom_supervision, flexible_extraction, machine_routing_decision, manual_document_organization, manual_field_identification, manual_routing_transcription, manual_table_identification, manual_transcription
--custom_supervisionflexible_extractionmachine_routing_decisionmanual_document_organizationmanual_field_identificationmanual_routing_transcriptionmanual_table_identificationmanual_transcription

Responses

Code Description Links
200 Media type
application/json
Controls Accept header.
- Example Value
- Schema
```json
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"id": 0,
"external_id": "string",
"state": "processing",
"substate": "manual_transcription",
"exceptions": [
"string"
],
"halted": true,
"start_time": "2026-07-27T09:17:09.683Z",
"goal_time": "2026-07-27T09:17:09.683Z",
"goal_time_source": "string",
"sla_rule_name": "string",
"sla_rule_definition": "string",
"complete_time": "2026-07-27T09:17:09.683Z",
"supervision_url": "string",
"metadata": "string",
"data_deleted": true,
"data_deleted_details": "string",
"source_routing_tags": [
"string"
],
"submission_files": [
{
"name": "string",
"upload_type": "string",
"url": "string"
}
],
"document_folders": [
{
"id": 0,
"start_time": "2026-07-27T09:17:09.683Z",
"name": "string",
"submission_id": 0,
"documents": [
0
],
"unassigned_pages": [
0
],
"metadata": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
}
}
],
"documents": [
{
"id": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"submission_id": 0,
"state": "string",
"substate": "string",
"exceptions": [
"string"
],
"start_time": "2026-07-27T09:17:09.683Z",
"goal_time": "2026-07-27T09:17:09.683Z",
"complete_time": "2026-07-27T09:17:09.683Z",
"layout_variation_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"layout_variation_name": "string",
"layout_tags": [
"string"
],
"layout_version_uuid": "string",
"layout_version_name": "string",
"document_folders": [
0
],
"supervision_url": "string",
"type": "string",
"metadata": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"download_url": "string",
"decisions": [
{
"decision": "string",
"choice": "string",
"task_purpose_name": "string"
}
],
"pages": [
{
"id": 0,
"state": "string",
"substate": "string",
"exceptions": [
"string"
],
"page_type": "string",
"file_page_number": 0,
"submission_page_number": 0,
"layout_variation_page_number": 0,
"document_page_number": 0,
"submitted_filename": "string",
"image_url": "string",
"corrected_image_url": "string",
"rejected": true,
"decisions": [
{
"decision": "string",
"choice": "string",
"task_purpose_name": "string"
}
],
"identifiers": [
{
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
]
}
],
"document_fields": [
{
"decisions": [
{
"decision": "string",
"choice": "string",
"task_purpose_name": "string"
}
],
"id": 0,
"state": "string",
"substate": "string",
"exceptions": [
"string"
],
"name": "string",
"output_name": "string",
"field_definition_attributes": {
"required": true,
"data_type": "string",
"multiline": true,
"routing": true,
"duplicate": true,
"supervision_override": "string"
},
"transcription": {
"raw": "string",
"normalized": "string",
"source": "string",
"data_deleted": true,
"confidence": 0,
"user_transcribed": "string"
},
"field_image_url": "string",
"page_id": 0,
"occurrence_index": 0,
"locations": [
{
"position": 0,
"page_id": 0,
"location_image_url": "string"
}
],
"groups": [
{
"uuid": "string",
"name": "string"
}
]
}
],
"document_tables": [
{
"id": 0,
"table_number": 0,
"name": "string",
"layout_variation_table_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"parent_table_id": 0,
"parent_layout_variation_table_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"rows": [
{
"id": 0,
"row_number": 0,
"parent_row_id": 0,
"parent_row_number": 0,
"cells": [
{
"id": 0,
"column_name": "string",
"output_name": "string",
"document_table_row_id": 0,
"layout_variation_table_column_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"page_id": 0,
"raw": "string",
"normalized": "string",
"exceptions": [
"string"
],
"user_transcribed": "string",
"state": "string",
"bounding_box": [
0
],
"decisions": [
{
"decision": "string",
"choice": "string",
"task_purpose_name": "string"
}
]
}
]
}
]
}
]
}
],
"unassigned_pages": [
{
"id": 0,
"state": "string",
"substate": "string",
"exceptions": [
"string"
],
"page_type": "string",
"file_page_number": 0,
"submission_page_number": 0,
"layout_variation_page_number": 0,
"document_page_number": 0,
"submitted_filename": "string",
"image_url": "string",
"corrected_image_url": "string",
"rejected": true,
"decisions": [
{
"decision": "string",
"choice": "string",
"task_purpose_name": "string"
}
],
"identifiers": [
{
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
]
}
],
"rejected_documents": [
{
"id": 0,
"reject_username": "string",
"reject_reason": {
"id": 0,
"code": "string",
"description": "string"
},
"layout_variation_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"layout_variation_name": "string",
"pages": [
{
"id": 0,
"state": "string",
"substate": "string",
"exceptions": [
"string"
],
"page_type": "string",
"file_page_number": 0,
"submission_page_number": 0,
"layout_variation_page_number": 0,
"document_page_number": 0,
"submitted_filename": "string",
"image_url": "string",
"corrected_image_url": "string",
"rejected": true,
"decisions": [
{
"decision": "string",
"choice": "string",
"task_purpose_name": "string"
}
],
"identifiers": [
{
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
]
}
]
}
],
"cases": [
{
"id": 0,
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"external_case_id": "string",
"start_time": "2026-07-27T09:17:09.683Z",
"update_time": "2026-07-27T09:17:09.683Z",
"to_delete_time": "2026-07-27T09:17:09.683Z",
"notes": "string",
"documents": [
0
],
"unassigned_pages": [
0
],
"submission_files": [
"string"
],
"submissions": [
0
],
"decisions": [
{
"decision": "string",
"choice": "string",
"task_purpose_name": "string"
}
]
}
]
},
{
"id": 0,
"external_id": "string",
"state": "processing",
"substate": "manual_transcription",
"exceptions": [
"string"
],
"halted": true,
"start_time": "2026-07-27T09:17:09.684Z",
"goal_time": "2026-07-27T09:17:09.684Z",
"goal_time_source": "string",
"sla_rule_name": "string",
"sla_rule_definition": "string",
"complete_time": "2026-07-27T09:17:09.684Z",
"supervision_url": "string",
"metadata": "string",
"data_deleted": true,
"data_deleted_details": "string",
"source_routing_tags": [
"string"
]
}
]
}		 No links

POST/api/v5/submissions

GET/api/v5/submissions/{id}

POST/api/v5/submissions/bulk_delete

Schemas

Case

Decision

DocumentFolder

Field

FieldDefinitionAttribute

FieldDictionaryGroup

FieldLocation

FlatSubmission

NestedDocument

NestedPage

NestedSubmission

PaginatedSubmissionList

RejectReason

RejectedDocument

StateEnum

Submission

SubmissionBulkDeletionRequest

SubmissionBulkDeletionRequestValidationError

SubmissionBulkDeletionResponse

SubmissionCreation

SubmissionCreationCase

SubmissionCreationJson

SubmissionCreationJsonBase64File

SubmissionCreationJsonFile

SubmissionCreationJsonFileUrl

SubmissionCreationResult

SubmissionFile

SubstateEnum

Table

TableCell

TableRow

Transcription