To get started with our API, we provide comprehensive documentation on how to consume our API. Our API implementation follows the JSON API Standard. We suggest to have a look at that first, if you are unfamiliar with that.
\nAll requests you send to our API follow the same schema, with all the resulting \"resources\" having a type, id, attributes and relationships. For instance a document resource will have type: \"documents\", its own id , and document-resource specific attributes and relationships as detailed below in the respective sections.
A resource can always be requested by its id, if you know it, i.e. api/v2/documents/123456. Such a request returns one result (or a Not Found).
When requesting resources, you can alternatively pass in a filter. For instance api/v2/files?filter[file_type]=input_file&filter[batch_id]=123456 will give you the input files of a certain batch. Such requests return zero or more results.
You can also include related resources (from the relationships). For instance api/v2/batches/123456?include=input_files . In this case, you receive the one batch plus its input files included.
Which strategy is better when requesting related resources, filter or include, depends on your situation. For instance, filter can use pagination while include can not. Request by id will be quick, but you may need to include more if your really interested in some related resources, which may be slower.
One strategy may be faster than the other. Try both during development of your integration!
\nUsing include too much may result in massive payloads, so is generally to be avoided.
To authenticate against our API you need to submit a Bearer Token with your requests. To get started you need an account on our platform.
\n\nThe Parashift App is divided into individual tenants, which are identified by the tenant_id. 1-n API keys can be defined for each tenant.
\nAfter signing in, you can create API keys in the Developer / API Keys module.
More information: Postman Bearer Token
\nDon't forget to add these headers for every request you submit to the API.
\nIf you want to talk to our Parashift Platform API, use the following base URL and choose one of the documented requests.
\nBase URL: https://api.parashift.io/v2/
e.g.
\nOur API's follow the jsonapi standard to a large extend. The following status codes are issued as a response to your API requests.
\nA collection potentially consists of a large amount of resources. To cope with that the result set can be paginated.
\nThe default page size is 20.
\nThe maximum page size is 200.
\nAssume the hypothetical resource \"documents\" and you want a page size of 10 and select page 2, the request would look like this:
\nGET /v2/documents?page[size]=10&page[number]=2&stats[total]=count\n\nNote that in the above example the answer will also include the total number of records by virtue of stats[total]=count.
On any collection endpoint, there is a certain set of filters enabled by default. Depending on the endpoint, there might be additional filters available, which will be specifically documented in these cases.
\nIn all cases, ATTRIBUTENAME is a placeholder for the specific field name. Example: A not filter for a field named title would be described as ATTRIBUTENAME_not and would result in title_not. Multiple filters can be added to the same request.
\nHaving a theoretical resource called document and we want to filter for all documents with status pending, the result would look like this:
\nGET /v2/documents?filter[status]=pending\n\nHaving a theoretical resource called document and we want to filter for all documents with status pending and a certain date range, the result would look like this:
\nGET /v2/documents?filter[status]=pending&filter[created_at_range]=2020-07-01..2020-08-01\n\nHaving a theoretical resource called document and we want to filter for all documents with status pending and query page 2, the result would look like this:
\nGET /v2/documents?filter[status]=pending&page[number]=2\n\nThere are some limitations to the files uploaded to the API.
\ndelivery: base64 encoded string
\nmime type, automated processing: pdf, jpg, png or tiff
\nmime type, manual processing: any, must be configured in upload configuration
\nmaximum page count: 500
\nminimum file size: 100 bytes (anything smaller and we assume something went wrong)
\nmaximum file size: 20 MB
\nIn some cases it is desirable to provide meta data together with requests for later processing. A usual use case would be to add an external document id or other correlation id from a third party system to match returned requests to their original source.
\nTo this end you can pass along your custom fields to the Parashift platform rather than tracking the id of the document in your system. The custom fields are passed along through the whole process and will be available on every documents endpoint.
\nUsually integrators use the Parashift document identifier (id) to keep track of uploaded documents, match processed/documents against documents and query documents. To this end the custom_fields cannot be used as they are not searchable. The external_id, even though searchable and therefore suited for this, performs worse then the Parashift document id and should only be used if the Parashift document id can not be saved/tracked in the to be integrated system.
\nYou can just pass along a hash of custom fields via the custom_field attribute when submitting documents:
\n{\n \"data\": {\n \"type\": \"documents\",\n \"attributes\": {\n ...\n \"custom_fields\": {\n \"customer_id\": \"1234\",\n \"my_own_document_id\": \"EX12345678910\"\n }\n ...\n }\n }\n}\n\nAny following request to that document will contain the custom fields for your convenience.
\nYou can just pass along one external identifier attribute when submitting documents:
\n{\n \"data\": {\n \"type\": \"documents\",\n \"attributes\": {\n ...\n \"external_id\": \"EX12345678910\",\n ...\n }\n }\n}\n\nAny following request to that document will contain the external_id for your convenience.
\nYou can query for documents with your external identifier.
\nGET /v2/documents?filter[external_id]=EX12345678910\n\nEach submitted document is processed asynchronously.
\nIntegrations usually follow the following pattern.
\nYou upload a document (POST submit document)
\nParashift processes it
\n(optional) You pull for the status of uploaded documents (GET list documents)
\nYou fetch the result (GET show document)
\nDepending on your use case you want to fetch data at different points in the document process. Therefore it is important to understand the overall document status as well as the Parashift processing workflow with workflow_step and workflow_status.
The top level indicator of the overall document state is status. While processing a document the document goes through different workflow_step. Each step is devided into different workflow_status starting by \"started\" and finalized with \"done\".
If you want to be notified for status changes, you can configure webhooks to do just that.
\nA detailed description about webhook capabilities can be found in our support knowledge base:
\n\nBackwards compatible, non-breaking changes can be introduced without prior notice.
\nThis includes:
\nadding new endpoints to the API
\nadding new (optional) parameters to requests
\nextending an API endpoint or object with additional attributes
\nchanges to the implementation of this specification (e.g. to improve performance, security, or maintainability \"under the hood\")
\nTherefor client applications, doing API result parsing, should always be implemented with Forward Compatibility in mind, i.e. not break on receiving additional attributes.
\nThe JSON:API specification mandates that resource ids are strings. Where such ids are included as attributes (independent of whether the referenced resource is included as a relationship), they are also strings, even if they appear to be valid integers.
\nCommunication with the API uses https to protect your data on the transport layer.
Only the following TLS versions and ciphers are supported:
TLSv1.2
\nTLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (ecdh_x25519)
\nTLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (ecdh_x25519)
\nTLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (ecdh_x25519)
\nTLSv1.3
\nTLS_AES_256_GCM_SHA384 (ecdh_x25519)
\nTLS_CHACHA20_POLY1305_SHA256 (ecdh_x25519)
\nTLS_AES_128_GCM_SHA256 (ecdh_x25519)
\nPerformance Tip for Pagination
\nWhen paginating, it is recommended to stop fetching pages once the number of results is smaller than the defined page size.
\nFor better performance, query documents step by step: instead of using page[number]=2, use the maximum ID from the first response and continue with filter[id_gt]=. This achieves the same result with fewer resources.
This query shows a document and lists all linked fields. For documents with many fields [> 1000, e.g. long documents with many line items] it is recommended to instead use the \"document_fields\" endpoint and query for all fields of a given document. Listing fields supports pagination and and minimizes chances for a slow response or even a timeout and keeps the response size manageble.
\n\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456"],"host":["api","parashift","io"],"query":[{"key":"include","value":"document_fields"}],"variable":[]}},"response":[{"id":"fd060c30-cec1-4c37-9d77-4de8097fc327","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/documents/123456?include=document_fields","protocol":"https","host":["api","parashift","io"],"path":["v2","documents","123456"],"query":[{"key":"include","value":"document_fields"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 08:56:37 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"20950"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"7fdf119a418965246c1096c754181648\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"11a2fc59db8d0b53d00320169018c4b5"},{"key":"X-Runtime","value":"0.243370"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"20073826\",\n \"type\": \"documents\",\n \"attributes\": {\n \"batch_id\": \"1007495019\",\n \"batch_index\": 0,\n \"classification_lower_threshold\": 0.0,\n \"classification_upper_threshold\": 0.9,\n \"created_at\": \"2025-03-12T12:12:34.535581Z\",\n \"custom_fields\": {\n \"SomeCustomField\": \"These custom fields cannot be queried.\",\n \"AnotherCustomField\": \"If you want to query for an external ID please use external_id.\",\n \"YetAnotherCustomField\": \"external_id can be queried and used for lookups to get your data back.\"\n },\n \"discarded_at\": null,\n \"document_type_identifier\": \"pp-correspondence\",\n \"error_codes\": [],\n \"exported_at\": null,\n \"external_id\": \"EX123456789\",\n \"language\": \"en\",\n \"language_confidence\": 0.9999939372619904,\n \"name\": \"My fancy document name\",\n \"not_for_training\": false,\n \"recognition_confidence\": 0.9698362122781529,\n \"sla_deadline\": \"2025-03-12T15:12:34.557918Z\",\n \"status\": \"done\",\n \"tags\": [],\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.655546Z\",\n \"upload_configuration\": \"client\",\n \"validation_required\": true,\n \"workflow_status\": \"done\",\n \"workflow_step\": \"qc\"\n },\n \"relationships\": {\n \"comments\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/comments?filter[document_id]=20073826\"\n }\n },\n \"document_fields\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/document_fields?filter[document_id]=20073826\"\n },\n \"data\": [\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061824\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061825\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061826\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061827\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061828\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061829\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061830\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061831\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061832\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061833\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061834\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061835\"\n }\n ]\n },\n \"output_files\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files?filter[document_id]=20073826&filter[file_type]=output_file\"\n }\n },\n \"pages\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/pages?filter[document_id]=20073826\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"1059061824\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99929,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1186178442496132,\n \"right\": 0.1897885507993811,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Pizza Züri,\",\n \"recognition_confidence\": 0.99931,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Pizza Züri\",\n \"prediction_confidence\": 0.99998,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.226740Z\",\n \"user_value\": null,\n \"value\": \"Pizza Züri\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061825\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1954615781330583,\n \"right\": 0.3063434760185663,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Badenerstrasse\",\n \"recognition_confidence\": 0.99992,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-street\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Badenerstrasse\",\n \"prediction_confidence\": 0.99997,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.239118Z\",\n \"user_value\": null,\n \"value\": \"Badenerstrasse\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061826\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99937,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3862815884476534,\n \"right\": 0.4342444559051057,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Zürich,\",\n \"recognition_confidence\": 0.99937,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-city\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Zürich\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.252434Z\",\n \"user_value\": null,\n \"value\": \"Zürich\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061827\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9998,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3465703971119133,\n \"right\": 0.3821557503867973,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"8048\",\n \"recognition_confidence\": 0.9998,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-postal-code\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"8048\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.267558Z\",\n \"user_value\": null,\n \"value\": \"8048\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061828\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99992,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3104693140794224,\n \"right\": 0.3408973697782362,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"558,\",\n \"recognition_confidence\": 0.99993,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-house-number\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"558\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.282760Z\",\n \"user_value\": null,\n \"value\": \"558\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061829\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99896,\n \"coordinates\": {\n \"top\": 0.1712574850299401,\n \"left\": 0.1186178442496132,\n \"right\": 0.4223826714801444,\n \"bottom\": 0.1808383233532934\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"recognition_confidence\": 0.99917,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"prediction_confidence\": 0.99978,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.297010Z\",\n \"user_value\": null,\n \"value\": \"Ristorante & Pizzeria VESUVIO da Antonio\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061830\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.1181021144920062,\n \"right\": 0.2243424445590511,\n \"bottom\": 0.217564870259481\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Glatttalstrasse\",\n \"recognition_confidence\": 0.99991,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-street\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Glatttalstrasse\",\n \"prediction_confidence\": 0.99998,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.313704Z\",\n \"user_value\": null,\n \"value\": \"Glatttalstrasse\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061831\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99972,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.2264053635894791,\n \"right\": 0.2460030943785456,\n \"bottom\": 0.217564870259481\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"40\",\n \"recognition_confidence\": 0.99973,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-house-number\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"40\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.326626Z\",\n \"user_value\": null,\n \"value\": \"40\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061832\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99986,\n \"coordinates\": {\n \"top\": 0.2263473053892216,\n \"left\": 0.1181021144920062,\n \"right\": 0.1526560082516761,\n \"bottom\": 0.237125748502994\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"8052\",\n \"recognition_confidence\": 0.99987,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-postal-code\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"8052\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.335607Z\",\n \"user_value\": null,\n \"value\": \"8052\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061833\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99897,\n \"coordinates\": {\n \"top\": 0.2259481037924152,\n \"left\": 0.1578133058277462,\n \"right\": 0.2068076328004126,\n \"bottom\": 0.2367265469061876\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Zürich,\",\n \"recognition_confidence\": 0.99898,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-city\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Zürich\",\n \"prediction_confidence\": 0.99999,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.343573Z\",\n \"user_value\": null,\n \"value\": \"Zürich\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061834\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99322,\n \"coordinates\": {\n \"top\": 0.3377245508982036,\n \"left\": 0.1181021144920062,\n \"right\": 0.4657039711191336,\n \"bottom\": 0.3584830339321357\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Cancel Pizza selling agreement\",\n \"recognition_confidence\": 0.99991,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-subject\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Cancel Pizza selling agreement\",\n \"prediction_confidence\": 0.99331,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.352534Z\",\n \"user_value\": null,\n \"value\": \"Cancel Pizza selling agreement\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061835\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9988,\n \"coordinates\": {\n \"top\": 0.3405189620758483,\n \"left\": 0.6462093862815884,\n \"right\": 0.7663744198040227,\n \"bottom\": 0.3548902195608782\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"date\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"16.07.2020\",\n \"recognition_confidence\": 0.99961,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-document-date\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"2020-07-16\",\n \"prediction_confidence\": 0.99919,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.360322Z\",\n \"user_value\": null,\n \"value\": \"2020-07-16\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n }\n ],\n \"meta\": {}\n}"}],"_postman_id":"df28ead0-df14-48ef-a8f8-c697c67b1d20"},{"name":"Show document including document_fields (specifying attributes)","id":"473e4326-b8e5-4efe-a2e0-fb51faddb68e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456?include=document_fields&fields[documents]=batch_id,name,created_at,external_id,document_type_identifier,status&fields[document_fields]=fieldset_identifier,identifier,data_type,value,item_index,confidence","description":"A way to reduce traffic and the size of the resulting json is to specify the attributes.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456"],"host":["api","parashift","io"],"query":[{"key":"include","value":"document_fields"},{"key":"fields[documents]","value":"batch_id,name,created_at,external_id,document_type_identifier,status"},{"key":"fields[document_fields]","value":"fieldset_identifier,identifier,data_type,value,item_index,confidence"}],"variable":[]}},"response":[{"id":"e93eed96-416a-4fda-ab6c-e246ee16d1e4","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/documents/123456?include=document_fields&fields[documents]=batch_id,name,created_at,external_id,document_type_identifier,status&fields[document_fields]=fieldset_identifier,identifier,data_type,value,item_index,confidence","protocol":"https","host":["api","parashift","io"],"path":["v2","documents","123456"],"query":[{"key":"include","value":"document_fields"},{"key":"fields[documents]","value":"batch_id,name,created_at,external_id,document_type_identifier,status"},{"key":"fields[document_fields]","value":"fieldset_identifier,identifier,data_type,value,item_index,confidence"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 08:56:37 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"20950"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"7fdf119a418965246c1096c754181648\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"11a2fc59db8d0b53d00320169018c4b5"},{"key":"X-Runtime","value":"0.243370"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"20073826\",\n \"type\": \"documents\",\n \"attributes\": {\n \"batch_id\": \"1007495019\",\n \"created_at\": \"2025-03-12T12:12:34.535581Z\",\n \"document_type_identifier\": \"pp-correspondence\",\n \"external_id\": \"EX123456789\",\n \"name\": \"My fancy document name\",\n \"status\": \"done\"\n },\n \"relationships\": {\n \"comments\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/comments?filter[document_id]=20073826\"\n }\n },\n \"document_fields\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/document_fields?filter[document_id]=20073826\"\n },\n \"data\": [\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061824\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061825\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061826\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061827\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061828\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061829\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061830\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061831\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061832\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061833\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061834\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061835\"\n }\n ]\n },\n \"output_files\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files?filter[document_id]=20073826&filter[file_type]=output_file\"\n }\n },\n \"pages\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/pages?filter[document_id]=20073826\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"1059061824\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99929,\n \"data_type\": \"string\",\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-company-name\",\n \"item_index\": null,\n \"value\": \"Pizza Züri\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061825\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"data_type\": \"string\",\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-street\",\n \"item_index\": null,\n \"value\": \"Badenerstrasse\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061826\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99937,\n \"data_type\": \"string\",\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-city\",\n \"item_index\": null,\n \"value\": \"Zürich\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061827\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9998,\n \"data_type\": \"string\",\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-postal-code\",\n \"item_index\": null,\n \"value\": \"8048\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061828\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99992,\n \"data_type\": \"string\",\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-house-number\",\n \"item_index\": null,\n \"value\": \"558\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061829\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99896,\n \"data_type\": \"string\",\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-company-name\",\n \"item_index\": null,\n \"value\": \"Ristorante & Pizzeria VESUVIO da Antonio\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061830\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"data_type\": \"string\",\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-street\",\n \"item_index\": null,\n \"value\": \"Glatttalstrasse\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061831\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99972,\n \"data_type\": \"string\",\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-house-number\",\n \"item_index\": null,\n \"value\": \"40\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061832\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99986,\n \"data_type\": \"string\",\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-postal-code\",\n \"item_index\": null,\n \"value\": \"8052\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061833\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99897,\n \"data_type\": \"string\",\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-city\",\n \"item_index\": null,\n \"value\": \"Zürich\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061834\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99322,\n \"data_type\": \"string\",\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-subject\",\n \"item_index\": null,\n \"value\": \"Cancel Pizza selling agreement\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061835\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9988,\n \"data_type\": \"date\",\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-document-date\",\n \"item_index\": null,\n \"value\": \"2020-07-16\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n }\n ],\n \"meta\": {}\n}"}],"_postman_id":"473e4326-b8e5-4efe-a2e0-fb51faddb68e"},{"name":"Show document including document_fields (with extraction_candidates)","id":"a8666d51-1425-41e9-b0a2-f139dfe5aa4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456?include=document_fields&extra_fields[document_fields]=extraction_candidates","description":"This query shows a document and lists all linked fields. For documents with many fields [> 1000, e.g. long documents with many line items] it is recommended to instead use the \"document_fields\" endpoint and query for all fields of a given document. Listing fields supports pagination and and minimizes chances for a slow response or even a timeout and keeps the response size manageble.
\n\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456"],"host":["api","parashift","io"],"query":[{"key":"include","value":"document_fields"},{"key":"extra_fields[document_fields]","value":"extraction_candidates"}],"variable":[]}},"response":[{"id":"0d193249-1a03-42c2-a5de-37776be2556d","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/documents/123456?include=document_fields&extra_fields[document_fields]=extraction_candidates","protocol":"https","host":["api","parashift","io"],"path":["v2","documents","123456"],"query":[{"key":"include","value":"document_fields"},{"key":"extra_fields[document_fields]","value":"extraction_candidates"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 08:57:23 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"27591"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"473311fa80abf3a33958cc27d9aaf910\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"94fd68663348902374e0bf5ed9aac5dd"},{"key":"X-Runtime","value":"0.275197"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"20073826\",\n \"type\": \"documents\",\n \"attributes\": {\n \"batch_id\": \"1007495019\",\n \"batch_index\": 0,\n \"classification_lower_threshold\": 0.0,\n \"classification_upper_threshold\": 0.9,\n \"created_at\": \"2025-03-12T12:12:34.535581Z\",\n \"custom_fields\": {\n \"SomeCustomField\": \"These custom fields cannot be queried.\",\n \"AnotherCustomField\": \"If you want to query for an external ID please use external_id.\",\n \"YetAnotherCustomField\": \"external_id can be queried and used for lookups to get your data back.\"\n },\n \"discarded_at\": null,\n \"document_type_identifier\": \"pp-correspondence\",\n \"error_codes\": [],\n \"exported_at\": null,\n \"external_id\": \"EX123456789\",\n \"language\": \"en\",\n \"language_confidence\": 0.9999939372619904,\n \"name\": \"My fancy document name\",\n \"not_for_training\": false,\n \"recognition_confidence\": 0.9698362122781529,\n \"sla_deadline\": \"2025-03-12T15:12:34.557918Z\",\n \"status\": \"done\",\n \"tags\": [],\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.655546Z\",\n \"upload_configuration\": \"client\",\n \"validation_required\": true,\n \"workflow_status\": \"done\",\n \"workflow_step\": \"qc\"\n },\n \"relationships\": {\n \"comments\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/comments?filter[document_id]=20073826\"\n }\n },\n \"document_fields\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/document_fields?extra_fields[document_fields]=extraction_candidates&filter[document_id]=20073826\"\n },\n \"data\": [\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061824\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061825\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061826\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061827\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061828\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061829\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061830\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061831\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061832\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061833\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061834\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061835\"\n }\n ]\n },\n \"output_files\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files?filter[document_id]=20073826&filter[file_type]=output_file\"\n }\n },\n \"pages\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/pages?filter[document_id]=20073826\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"1059061824\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99929,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1186178442496132,\n \"right\": 0.1897885507993811,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Pizza Züri,\",\n \"recognition_confidence\": 0.99931,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Pizza Züri\",\n \"prediction_confidence\": 0.99998,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.226740Z\",\n \"user_value\": null,\n \"value\": \"Pizza Züri\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Pizza Züri,\",\n \"prediction_value\": \"Pizza Züri\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1186178442496132,\n \"right\": 0.1897885507993811,\n \"bottom\": 0.1636726546906188\n },\n \"confidence\": 0.9992903856609202,\n \"recognition_confidence\": 0.9993057297730239,\n \"prediction_confidence\": 0.9999846452275349\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061825\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1954615781330583,\n \"right\": 0.3063434760185663,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Badenerstrasse\",\n \"recognition_confidence\": 0.99992,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-street\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Badenerstrasse\",\n \"prediction_confidence\": 0.99997,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.239118Z\",\n \"user_value\": null,\n \"value\": \"Badenerstrasse\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Badenerstrasse\",\n \"prediction_value\": \"Badenerstrasse\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1954615781330583,\n \"right\": 0.3063434760185663,\n \"bottom\": 0.1636726546906188\n },\n \"confidence\": 0.9998935204272208,\n \"recognition_confidence\": 0.9999200618105846,\n \"prediction_confidence\": 0.9999734564947965\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061826\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99937,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3862815884476534,\n \"right\": 0.4342444559051057,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Zürich,\",\n \"recognition_confidence\": 0.99937,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-city\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Zürich\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.252434Z\",\n \"user_value\": null,\n \"value\": \"Zürich\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Zürich,\",\n \"prediction_value\": \"Zürich\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3862815884476534,\n \"right\": 0.4342444559051057,\n \"bottom\": 0.1636726546906188\n },\n \"confidence\": 0.9993700630547878,\n \"recognition_confidence\": 0.9993721667678415,\n \"prediction_confidence\": 0.9999978949653356\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061827\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9998,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3465703971119133,\n \"right\": 0.3821557503867973,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"8048\",\n \"recognition_confidence\": 0.9998,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-postal-code\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"8048\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.267558Z\",\n \"user_value\": null,\n \"value\": \"8048\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"8048\",\n \"prediction_value\": \"8048\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3465703971119133,\n \"right\": 0.3821557503867973,\n \"bottom\": 0.1636726546906188\n },\n \"confidence\": 0.9997964413785434,\n \"recognition_confidence\": 0.9997981034079544,\n \"prediction_confidence\": 0.9999983376349632\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061828\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99992,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3104693140794224,\n \"right\": 0.3408973697782362,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"558,\",\n \"recognition_confidence\": 0.99993,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-house-number\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"558\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.282760Z\",\n \"user_value\": null,\n \"value\": \"558\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"558,\",\n \"prediction_value\": \"558\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3104693140794224,\n \"right\": 0.3408973697782362,\n \"bottom\": 0.1636726546906188\n },\n \"confidence\": 0.9999242180154694,\n \"recognition_confidence\": 0.9999286090587134,\n \"prediction_confidence\": 0.9999956086432529\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061829\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99896,\n \"coordinates\": {\n \"top\": 0.1712574850299401,\n \"left\": 0.1186178442496132,\n \"right\": 0.4223826714801444,\n \"bottom\": 0.1808383233532934\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"recognition_confidence\": 0.99917,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"prediction_confidence\": 0.99978,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.297010Z\",\n \"user_value\": null,\n \"value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"prediction_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.1712574850299401,\n \"left\": 0.1186178442496132,\n \"right\": 0.4223826714801444,\n \"bottom\": 0.1808383233532934\n },\n \"confidence\": 0.9989555637157892,\n \"recognition_confidence\": 0.9991721333449782,\n \"prediction_confidence\": 0.9997832509314847\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061830\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.1181021144920062,\n \"right\": 0.2243424445590511,\n \"bottom\": 0.217564870259481\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Glatttalstrasse\",\n \"recognition_confidence\": 0.99991,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-street\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Glatttalstrasse\",\n \"prediction_confidence\": 0.99998,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.313704Z\",\n \"user_value\": null,\n \"value\": \"Glatttalstrasse\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Glatttalstrasse\",\n \"prediction_value\": \"Glatttalstrasse\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.1181021144920062,\n \"right\": 0.2243424445590511,\n \"bottom\": 0.217564870259481\n },\n \"confidence\": 0.9998863635069857,\n \"recognition_confidence\": 0.9999055187489851,\n \"prediction_confidence\": 0.9999808429480183\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061831\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99972,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.2264053635894791,\n \"right\": 0.2460030943785456,\n \"bottom\": 0.217564870259481\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"40\",\n \"recognition_confidence\": 0.99973,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-house-number\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"40\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.326626Z\",\n \"user_value\": null,\n \"value\": \"40\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"40\",\n \"prediction_value\": \"40\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.2264053635894791,\n \"right\": 0.2460030943785456,\n \"bottom\": 0.217564870259481\n },\n \"confidence\": 0.9997235277755387,\n \"recognition_confidence\": 0.9997282023370957,\n \"prediction_confidence\": 0.9999953241675628\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061832\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99986,\n \"coordinates\": {\n \"top\": 0.2263473053892216,\n \"left\": 0.1181021144920062,\n \"right\": 0.1526560082516761,\n \"bottom\": 0.237125748502994\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"8052\",\n \"recognition_confidence\": 0.99987,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-postal-code\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"8052\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.335607Z\",\n \"user_value\": null,\n \"value\": \"8052\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"8052\",\n \"prediction_value\": \"8052\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.2263473053892216,\n \"left\": 0.1181021144920062,\n \"right\": 0.1526560082516761,\n \"bottom\": 0.237125748502994\n },\n \"confidence\": 0.9998642975821332,\n \"recognition_confidence\": 0.999865622064533,\n \"prediction_confidence\": 0.9999986753395951\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061833\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99897,\n \"coordinates\": {\n \"top\": 0.2259481037924152,\n \"left\": 0.1578133058277462,\n \"right\": 0.2068076328004126,\n \"bottom\": 0.2367265469061876\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Zürich,\",\n \"recognition_confidence\": 0.99898,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-city\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Zürich\",\n \"prediction_confidence\": 0.99999,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.343573Z\",\n \"user_value\": null,\n \"value\": \"Zürich\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Zürich,\",\n \"prediction_value\": \"Zürich\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.2259481037924152,\n \"left\": 0.1578133058277462,\n \"right\": 0.2068076328004126,\n \"bottom\": 0.2367265469061876\n },\n \"confidence\": 0.9989662511830831,\n \"recognition_confidence\": 0.9989804199333285,\n \"prediction_confidence\": 0.9999858167888352\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061834\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99322,\n \"coordinates\": {\n \"top\": 0.3377245508982036,\n \"left\": 0.1181021144920062,\n \"right\": 0.4657039711191336,\n \"bottom\": 0.3584830339321357\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Cancel Pizza selling agreement\",\n \"recognition_confidence\": 0.99991,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-subject\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Cancel Pizza selling agreement\",\n \"prediction_confidence\": 0.99331,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.352534Z\",\n \"user_value\": null,\n \"value\": \"Cancel Pizza selling agreement\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Cancel Pizza selling agreement\",\n \"prediction_value\": \"Cancel Pizza selling agreement\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.3377245508982036,\n \"left\": 0.1181021144920062,\n \"right\": 0.4657039711191336,\n \"bottom\": 0.3584830339321357\n },\n \"confidence\": 0.993218096148804,\n \"recognition_confidence\": 0.9999124534221087,\n \"prediction_confidence\": 0.9933050566073121\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061835\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9988,\n \"coordinates\": {\n \"top\": 0.3405189620758483,\n \"left\": 0.6462093862815884,\n \"right\": 0.7663744198040227,\n \"bottom\": 0.3548902195608782\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"date\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"16.07.2020\",\n \"recognition_confidence\": 0.99961,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-document-date\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"2020-07-16\",\n \"prediction_confidence\": 0.99919,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.360322Z\",\n \"user_value\": null,\n \"value\": \"2020-07-16\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"16.07.2020\",\n \"prediction_value\": \"2020-07-16\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.3405189620758483,\n \"left\": 0.6462093862815884,\n \"right\": 0.7663744198040227,\n \"bottom\": 0.3548902195608782\n },\n \"confidence\": 0.9987996992719399,\n \"recognition_confidence\": 0.9996079738711465,\n \"prediction_confidence\": 0.9991914084117632\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n }\n ],\n \"meta\": {}\n}"}],"_postman_id":"a8666d51-1425-41e9-b0a2-f139dfe5aa4f"},{"name":"Show document (with classification_candidates)","id":"e69de171-30f6-424e-9134-9782df496802","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456?extra_fields[documents]=classification_candidates","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456"],"host":["api","parashift","io"],"query":[{"key":"extra_fields[documents]","value":"classification_candidates"}],"variable":[]}},"response":[{"id":"b424ebb7-fb12-4c46-a73f-478782fe9059","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/documents/123456?extra_fields[documents]=classification_candidates","protocol":"https","host":["api","parashift","io"],"path":["v2","documents","123456"],"query":[{"key":"extra_fields[documents]","value":"classification_candidates"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 08:58:24 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1589"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"d77739bc8d5a1e312941f2a0ad0098fc\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"6988931aef54b8e9b4b235bf92a40cc7"},{"key":"X-Runtime","value":"0.166966"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"20073826\",\n \"type\": \"documents\",\n \"attributes\": {\n \"batch_id\": \"1007495019\",\n \"batch_index\": 0,\n \"classification_lower_threshold\": 0.0,\n \"classification_upper_threshold\": 0.9,\n \"created_at\": \"2025-03-12T12:12:34.535581Z\",\n \"custom_fields\": {\n \"SomeCustomField\": \"These custom fields cannot be queried.\",\n \"AnotherCustomField\": \"If you want to query for an external ID please use external_id.\",\n \"YetAnotherCustomField\": \"external_id can be queried and used for lookups to get your data back.\"\n },\n \"discarded_at\": null,\n \"document_type_identifier\": \"pp-correspondence\",\n \"error_codes\": [],\n \"exported_at\": null,\n \"external_id\": \"EX123456789\",\n \"language\": \"en\",\n \"language_confidence\": 0.9999939372619904,\n \"name\": \"My fancy document name\",\n \"not_for_training\": false,\n \"recognition_confidence\": 0.9698362122781529,\n \"sla_deadline\": \"2025-03-12T15:12:34.557918Z\",\n \"status\": \"done\",\n \"tags\": [],\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.655546Z\",\n \"upload_configuration\": \"client\",\n \"validation_required\": true,\n \"workflow_status\": \"done\",\n \"workflow_step\": \"qc\",\n \"classification_candidates\": [\n {\n \"identifier\": \"pp-correspondence\",\n \"confidence\": 0.9995386600494385\n }\n ]\n },\n \"relationships\": {\n \"comments\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/comments?filter[document_id]=20073826\"\n }\n },\n \"document_fields\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/document_fields?filter[document_id]=20073826\"\n }\n },\n \"output_files\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files?filter[document_id]=20073826&filter[file_type]=output_file\"\n }\n },\n \"pages\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/pages?filter[document_id]=20073826\"\n }\n }\n }\n },\n \"meta\": {}\n}"}],"_postman_id":"e69de171-30f6-424e-9134-9782df496802"},{"name":"Show document (with recognition_text)","id":"a811506c-80c4-451b-b10e-116af5685406","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456?extra_fields[documents]=recognition_text","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456"],"host":["api","parashift","io"],"query":[{"key":"extra_fields[documents]","value":"recognition_text"}],"variable":[]}},"response":[{"id":"46320b69-e00f-44d6-bf82-a4e9c0f6e4c4","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/documents/123456?extra_fields[documents]=recognition_text","protocol":"https","host":["api","parashift","io"],"path":["v2","documents","123456"],"query":[{"key":"extra_fields[documents]","value":"recognition_text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 08:58:58 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"3542"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"456535d36027aec3ce1e8e68defc5c96\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"f0aecfaf5d6a228a700e8f5f8bb69aae"},{"key":"X-Runtime","value":"0.203879"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"20073826\",\n \"type\": \"documents\",\n \"attributes\": {\n \"batch_id\": \"1007495019\",\n \"batch_index\": 0,\n \"classification_lower_threshold\": 0.0,\n \"classification_upper_threshold\": 0.9,\n \"created_at\": \"2025-03-12T12:12:34.535581Z\",\n \"custom_fields\": {\n \"SomeCustomField\": \"These custom fields cannot be queried.\",\n \"AnotherCustomField\": \"If you want to query for an external ID please use external_id.\",\n \"YetAnotherCustomField\": \"external_id can be queried and used for lookups to get your data back.\"\n },\n \"discarded_at\": null,\n \"document_type_identifier\": \"pp-correspondence\",\n \"error_codes\": [],\n \"exported_at\": null,\n \"external_id\": \"EX123456789\",\n \"language\": \"en\",\n \"language_confidence\": 0.9999939372619904,\n \"name\": \"My fancy document name\",\n \"not_for_training\": false,\n \"recognition_confidence\": 0.9698362122781529,\n \"sla_deadline\": \"2025-03-12T15:12:34.557918Z\",\n \"status\": \"done\",\n \"tags\": [],\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.655546Z\",\n \"upload_configuration\": \"client\",\n \"validation_required\": true,\n \"workflow_status\": \"done\",\n \"workflow_step\": \"qc\",\n \"recognition_text\": \"entoso\\nPizza Züri, Badenerstrasse 558, 8048 Zürich, Schweiz\\nRistorante & Pizzeria VESUVIO da Antonio\\nVito Corleone\\nGlatttalstrasse 40\\nreceived\\n8052 Zürich, Schweiz\\n16.11.2020\\nHamburg\\nCancel Pizza selling agreement 16.07.2020\\nContract Number: 897-565471\\nDear Mr. Corleone,\\nThis is some random text put here to make this example correspondence nicer. Originally I used a Lorem\\nIpsum text but that led to funny consequences with our language detection which decided that it was\\nfor some reason an Italian document. Let's add an invoice number RE-1234-20 to show that we can also\\nextract data that is put in flowing text.\\nPizza\\nPrice Yumminess\\nMargherita\\n7.00 5\\nProsciutto e funghi\\n8.00 6\\nCarbonara\\n8.50 10\\nSo now I replaced the Lorem Ipsum text with some real good looking text so that it hopefully will detect\\nthat this letter is indeed written in English. Let's see how it works out.\\nWarm regards,\\nThilo Rossa\\nT. Rossa\\nPhone: +41 79 381 07 12\\n回数県\\nparashift\\nMail: thilo.rossa@parashift.io\\nPS12345678\\nentoso\\nPizza Züri, Badenerstrasse 558, 8048 Zürich, Schweiz\\nRistorante & Pizzeria VESUVIO da Antonio\\nVito Corleone\\nGlatttalstrasse 40\\nreceived\\n8052 Zürich, Schweiz\\n16.11.2020\\nHamburg\\nCancel Pizza selling agreement 16.07.2020\\nContract Number: 897-565471\\nDear Mr. Corleone,\\nThis is some random text put here to make this example correspondence nicer. Originally I used a Lorem\\nIpsum text but that led to funny consequences with our language detection which decided that it was\\nfor some reason an Italian document. Let's add an invoice number RE-1234-20 to show that we can also\\nextract data that is put in flowing text.\\nPizza\\nPrice Yumminess\\nMargherita\\n7.00 5\\nProsciutto e funghi\\n8.00 6\\nCarbonara\\n8.50 10\\nSo now I replaced the Lorem Ipsum text with some real good looking text so that it hopefully will detect\\nthat this letter is indeed written in English. Let's see how it works out.\\nWarm regards,\\nThilo Rossa\\nT. Rossa\\nPhone: +41 79 381 07 12\\n回数県\\nparashift\\nMail: thilo.rossa@parashift.io\\nPS12345678\"\n },\n \"relationships\": {\n \"comments\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/comments?filter[document_id]=20073826\"\n }\n },\n \"document_fields\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/document_fields?filter[document_id]=20073826\"\n }\n },\n \"output_files\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files?filter[document_id]=20073826&filter[file_type]=output_file\"\n }\n },\n \"pages\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/pages?filter[document_id]=20073826\"\n }\n }\n }\n },\n \"meta\": {}\n}"}],"_postman_id":"a811506c-80c4-451b-b10e-116af5685406"},{"name":"Show document including output files","id":"014e26cc-06f7-49aa-a87e-d3d8bdf14930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456?include=output_files&extra_fields[files]=url","description":"If the option output file creation is set in the upload profile, you can receive the created PDF files.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456"],"host":["api","parashift","io"],"query":[{"key":"include","value":"output_files"},{"key":"extra_fields[files]","value":"url"}],"variable":[]}},"response":[{"id":"0a3704cb-baaa-4faf-9fdb-c51b84d33bea","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/documents/123456?include=output_files&extra_fields[files]=url","protocol":"https","host":["api","parashift","io"],"path":["v2","documents","123456"],"query":[{"key":"include","value":"output_files"},{"key":"extra_fields[files]","value":"url"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 08:59:40 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"2444"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"a111e493dbdfd54a1b7f18f23280092d\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"a5b2ea3bc29e0427f766d7d02cdc0409"},{"key":"X-Runtime","value":"2.900589"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"20073826\",\n \"type\": \"documents\",\n \"attributes\": {\n \"batch_id\": \"1007495019\",\n \"batch_index\": 0,\n \"classification_lower_threshold\": 0.0,\n \"classification_upper_threshold\": 0.9,\n \"created_at\": \"2025-03-12T12:12:34.535581Z\",\n \"custom_fields\": {\n \"SomeCustomField\": \"These custom fields cannot be queried.\",\n \"AnotherCustomField\": \"If you want to query for an external ID please use external_id.\",\n \"YetAnotherCustomField\": \"external_id can be queried and used for lookups to get your data back.\"\n },\n \"discarded_at\": null,\n \"document_type_identifier\": \"pp-correspondence\",\n \"error_codes\": [],\n \"exported_at\": null,\n \"external_id\": \"EX123456789\",\n \"language\": \"en\",\n \"language_confidence\": 0.9999939372619904,\n \"name\": \"My fancy document name\",\n \"not_for_training\": false,\n \"recognition_confidence\": 0.9698362122781529,\n \"sla_deadline\": \"2025-03-12T15:12:34.557918Z\",\n \"status\": \"done\",\n \"tags\": [],\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.655546Z\",\n \"upload_configuration\": \"client\",\n \"validation_required\": true,\n \"workflow_status\": \"done\",\n \"workflow_step\": \"qc\"\n },\n \"relationships\": {\n \"comments\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/comments?filter[document_id]=20073826\"\n }\n },\n \"document_fields\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/document_fields?filter[document_id]=20073826\"\n }\n },\n \"output_files\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files?filter[document_id]=20073826&filter[file_type]=output_file\"\n },\n \"data\": {\n \"type\": \"files\",\n \"id\": \"173818653\"\n }\n },\n \"pages\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/pages?filter[document_id]=20073826\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"173818653\",\n \"type\": \"files\",\n \"attributes\": {\n \"record_id\": \"20073826\",\n \"record_type\": \"documents\",\n \"file_type\": \"output_file\",\n \"mime_type\": \"application/pdf\",\n \"file_name\": \"20073826.pdf\",\n \"index\": 0,\n \"url\": \"https://storage.parashift.io/myuniquedownloadstring\",\n \"meta\": {},\n \"created_at\": \"2025-03-12T12:12:56.905163Z\"\n }\n }\n ],\n \"meta\": {}\n}"}],"_postman_id":"014e26cc-06f7-49aa-a87e-d3d8bdf14930"},{"name":"List recognition tokens of a document","id":"ae15c917-3c91-46c2-978d-3ffebcb90285","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456/recognitions","description":"The response to this request uses a different model:
\nTo integrate Parashift into a process, it is advisable to mark finished documents as \"exported\" after external processing. This makes it easy to exclude these processes when polling.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456","mark_as_exported"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"0e1d174b-df95-4d91-9e92-4f13c0c590d7","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456/mark_as_exported"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.10"},{"key":"Date","value":"Mon, 10 May 2021 11:34:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"44136fa355b3678a1146ad16f7e8649e\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"1e1f3047304b1305c2ca5f4863750612"},{"key":"X-Runtime","value":"0.127236"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"72f93936-042a-4689-b222-25b3a762467f"},{"name":"Clear \"exported_at\"","id":"227ad302-8514-455c-a01b-3badb8434473","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456/mark_as_not_exported","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456","mark_as_not_exported"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"61754464-9789-4da7-8b55-8e1e9a69e75a","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456/mark_as_not_exported"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.10"},{"key":"Date","value":"Mon, 10 May 2021 11:34:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"44136fa355b3678a1146ad16f7e8649e\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"1e1f3047304b1305c2ca5f4863750612"},{"key":"X-Runtime","value":"0.127236"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"227ad302-8514-455c-a01b-3badb8434473"},{"name":"Classify document","id":"206cf429-b1d0-4aaf-8cbf-015867c3a5b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"documents\",\n \"attributes\": {\n \"document_type_identifier\": \"pp-delivery-note\"\n }\n }\n}"},"url":"https://api.parashift.io/v2/documents/123456/classify","description":"This request can be used to confirm the classification or as part of the feedback loop to improve the training of the classification model, please check the knowledge base article Feeback Loop.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456","classify"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"f8202f7b-5bdf-47eb-adc7-b2fb2c068aeb","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"documemts\",\n \"attributes\": {\n \"document_type_identifier\": \"pp-delivery-note\"\n }\n }\n}"},"url":"https://api.parashift.io/v2/documents/123456/classify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.10"},{"key":"Date","value":"Wed, 13 Apr 2022 09:37:58 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"1d172e2378b196f597441487754688ad\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"8b1458f38ed5ad527ae4146b140db091"},{"key":"X-Runtime","value":"0.279908"},{"key":"Vary","value":"Origin"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"20073826\",\n \"type\": \"documents\",\n \"attributes\": {\n \"batch_id\": \"1007495019\",\n \"batch_index\": 0,\n \"classification_lower_threshold\": 0.0,\n \"classification_upper_threshold\": 0.9,\n \"created_at\": \"2025-03-12T12:12:34.535581Z\",\n \"custom_fields\": {\n \"SomeCustomField\": \"These custom fields cannot be queried.\",\n \"AnotherCustomField\": \"If you want to query for an external ID please use external_id.\",\n \"YetAnotherCustomField\": \"external_id can be queried and used for lookups to get your data back.\"\n },\n \"discarded_at\": null,\n \"document_type_identifier\": \"pp-correspondence\",\n \"error_codes\": [],\n \"exported_at\": null,\n \"external_id\": \"EX123456789\",\n \"language\": \"en\",\n \"language_confidence\": 0.9999939372619904,\n \"name\": \"My fancy document name\",\n \"not_for_training\": false,\n \"recognition_confidence\": 0.9698362122781529,\n \"sla_deadline\": \"2025-03-12T15:12:34.557918Z\",\n \"status\": \"in_progress\",\n \"tags\": [],\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.655546Z\",\n \"upload_configuration\": \"client\",\n \"validation_required\": true,\n \"workflow_status\": \"extraction\",\n \"workflow_step\": \"started\"\n },\n \"relationships\": {\n \"comments\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/comments?filter[document_id]=20073826\"\n }\n },\n \"document_fields\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/document_fields?filter[document_id]=20073826\"\n }\n },\n \"output_files\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files?filter[document_id]=20073826&filter[file_type]=output_file\"\n }\n },\n \"pages\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/pages?filter[document_id]=20073826\"\n }\n }\n }\n },\n \"meta\": {}\n}"}],"_postman_id":"206cf429-b1d0-4aaf-8cbf-015867c3a5b8"},{"name":"Edit document","id":"8e0851a7-127e-42f5-8192-ed4d07240a46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"id\": \"123456\",\r\n \"type\": \"documents\",\r\n \"attributes\": {\r\n \"custom_fields\": {\r\n \"SomeCustomField\": \"These custom fields cannot be queried.\",\r\n \"AnotherCustomField\": \"If you want to query for an external ID please use external_id.\",\r\n \"YetAnotherCustomField\": \"external_id can be queried and used for lookups to get your data back.\"\r\n },\r\n \"external_id\": \"EX1234567890\",\r\n \"name\": \"It gets better and better\",\r\n \"not_for_training\": true,\r\n \"validation_required\": false,\r\n \"upload_configuration\" : \"scan\",\r\n \"tags\" : [\"Production\"]\r\n }\r\n }\r\n}"},"url":"https://api.parashift.io/v2/documents/123456","description":"Edit document attributes, just put any combination of the following attributes into request body
\ncustom_fields{} (merge with existing custom_fields{}, remove key if set to null , keep key but empty if \"\"
external_id
not_for_training
validation_required
upload_configuration
tags[] (overwrite existing tags)
Tags can be added to the document for better overview, classification and filtering of documents.
\nFor clarity: this request will replace all tags on this document for the tenant that is sending the request with the provided array.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"cfe52584-506c-44f3-9917-ec7ec9ee888f","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"id\": \"123456\",\r\n \"type\": \"documents\",\r\n \"attributes\": {\r\n \"tags\" : []\r\n }\r\n }\r\n}"},"url":"https://api.parashift.io/v2/documents/123456"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:16:43 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1442"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"053b34347e0abb6b703348c402f7b823\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"c2c83755a49aafbeef2710333d90bbb1"},{"key":"X-Runtime","value":"0.203183"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"20073826\",\n \"type\": \"documents\",\n \"attributes\": {\n \"batch_id\": \"1007495019\",\n \"batch_index\": 0,\n \"classification_lower_threshold\": 0.0,\n \"classification_upper_threshold\": 0.9,\n \"created_at\": \"2025-03-12T12:12:34.535581Z\",\n \"custom_fields\": {\n \"SomeCustomField\": \"These custom fields cannot be queried.\",\n \"AnotherCustomField\": \"If you want to query for an external ID please use external_id.\",\n \"YetAnotherCustomField\": \"external_id can be queried and used for lookups to get your data back.\"\n },\n \"discarded_at\": null,\n \"document_type_identifier\": \"pp-correspondence\",\n \"error_codes\": [],\n \"exported_at\": null,\n \"external_id\": \"EX1234567890\",\n \"language\": \"en\",\n \"language_confidence\": 0.9999939372619904,\n \"name\": \"It gets better and better\",\n \"not_for_training\": true,\n \"recognition_confidence\": 0.9698362122781529,\n \"sla_deadline\": \"2025-03-12T15:12:34.557918Z\",\n \"status\": \"done\",\n \"tags\": [],\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:22:48.799621Z\",\n \"upload_configuration\": \"scan\",\n \"validation_required\": false,\n \"workflow_status\": \"done\",\n \"workflow_step\": \"qc\"\n },\n \"relationships\": {\n \"comments\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/comments?filter[document_id]=20073826\"\n }\n },\n \"document_fields\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/document_fields?filter[document_id]=20073826\"\n }\n },\n \"output_files\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files?filter[document_id]=20073826&filter[file_type]=output_file\"\n }\n },\n \"pages\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/pages?filter[document_id]=20073826\"\n }\n }\n }\n },\n \"meta\": {}\n}"}],"_postman_id":"4712f108-c279-4a8d-b36a-b0406c78174a"},{"name":"Add tags","id":"b033a509-6091-40c3-ab97-25412951ec58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"id\": \"123456\",\r\n \"type\": \"documents\",\r\n \"attributes\": {\r\n \"tags\" : [\"New tag1\", \"New tag2\"]\r\n }\r\n }\r\n}"},"url":"https://api.parashift.io/v2/documents/123456/tags/add","description":"Tags can be added to the document for better overview, classification and filtering of documents.
\nFor clarity: this request adds 1-n tags to existing list of tags
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456","tags","add"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"1288df10-45ba-41e4-af9b-4ba784018e74","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"id\": \"123456\",\r\n \"type\": \"documents\",\r\n \"attributes\": {\r\n \"tags\" : [\"New tag1\", \"New tag2\"]\r\n }\r\n }\r\n}"},"url":"https://api.parashift.io/v2/documents/123456/tags/add"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:16:43 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1442"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"053b34347e0abb6b703348c402f7b823\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"c2c83755a49aafbeef2710333d90bbb1"},{"key":"X-Runtime","value":"0.203183"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"20073826\",\n \"type\": \"documents\",\n \"attributes\": {\n \"batch_id\": \"1007495019\",\n \"batch_index\": 0,\n \"classification_lower_threshold\": 0.0,\n \"classification_upper_threshold\": 0.9,\n \"created_at\": \"2025-03-12T12:12:34.535581Z\",\n \"custom_fields\": {\n \"SomeCustomField\": \"These custom fields cannot be queried.\",\n \"AnotherCustomField\": \"If you want to query for an external ID please use external_id.\",\n \"YetAnotherCustomField\": \"external_id can be queried and used for lookups to get your data back.\"\n },\n \"discarded_at\": null,\n \"document_type_identifier\": \"pp-correspondence\",\n \"error_codes\": [],\n \"exported_at\": null,\n \"external_id\": \"EX1234567890\",\n \"language\": \"en\",\n \"language_confidence\": 0.9999939372619904,\n \"name\": \"It gets better and better\",\n \"not_for_training\": true,\n \"recognition_confidence\": 0.9698362122781529,\n \"sla_deadline\": \"2025-03-12T15:12:34.557918Z\",\n \"status\": \"done\",\n \"tags\": [\n \"Production\",\n \"New tag1\",\n \"New tag2\"\n ],\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:22:48.799621Z\",\n \"upload_configuration\": \"scan\",\n \"validation_required\": false,\n \"workflow_status\": \"done\",\n \"workflow_step\": \"qc\"\n },\n \"relationships\": {\n \"comments\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/comments?filter[document_id]=20073826\"\n }\n },\n \"document_fields\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/document_fields?filter[document_id]=20073826\"\n }\n },\n \"output_files\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files?filter[document_id]=20073826&filter[file_type]=output_file\"\n }\n },\n \"pages\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/pages?filter[document_id]=20073826\"\n }\n }\n }\n },\n \"meta\": {}\n}"}],"_postman_id":"b033a509-6091-40c3-ab97-25412951ec58"},{"name":"Remove tags","id":"c39d5f79-d42e-4cff-a955-933ffff621c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"id\": \"123456\",\r\n \"type\": \"documents\",\r\n \"attributes\": {\r\n \"tags\" : [\"New tag1\"]\r\n }\r\n }\r\n}"},"url":"https://api.parashift.io/v2/documents/123456/tags/remove","description":"Tags can be added to the document for better overview, classification and filtering of documents.
\nFor clarity: this request removes 1-n tags of the existing list of tags
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456","tags","remove"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"bc79f419-66b4-4d6d-be12-973842402a05","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"id\": \"123456\",\r\n \"type\": \"documents\",\r\n \"attributes\": {\r\n \"tags\" : [\"New tag1\"]\r\n }\r\n }\r\n}"},"url":"https://api.parashift.io/v2/documents/123456/tags/remove"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:16:43 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1442"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"053b34347e0abb6b703348c402f7b823\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"c2c83755a49aafbeef2710333d90bbb1"},{"key":"X-Runtime","value":"0.203183"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"20073826\",\n \"type\": \"documents\",\n \"attributes\": {\n \"batch_id\": \"1007495019\",\n \"batch_index\": 0,\n \"classification_lower_threshold\": 0.0,\n \"classification_upper_threshold\": 0.9,\n \"created_at\": \"2025-03-12T12:12:34.535581Z\",\n \"custom_fields\": {\n \"SomeCustomField\": \"These custom fields cannot be queried.\",\n \"AnotherCustomField\": \"If you want to query for an external ID please use external_id.\",\n \"YetAnotherCustomField\": \"external_id can be queried and used for lookups to get your data back.\"\n },\n \"discarded_at\": null,\n \"document_type_identifier\": \"pp-correspondence\",\n \"error_codes\": [],\n \"exported_at\": null,\n \"external_id\": \"EX1234567890\",\n \"language\": \"en\",\n \"language_confidence\": 0.9999939372619904,\n \"name\": \"It gets better and better\",\n \"not_for_training\": true,\n \"recognition_confidence\": 0.9698362122781529,\n \"sla_deadline\": \"2025-03-12T15:12:34.557918Z\",\n \"status\": \"done\",\n \"tags\": [\n \"Production\",\n \"New tag2\"\n ],\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:22:48.799621Z\",\n \"upload_configuration\": \"scan\",\n \"validation_required\": false,\n \"workflow_status\": \"done\",\n \"workflow_step\": \"qc\"\n },\n \"relationships\": {\n \"comments\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/comments?filter[document_id]=20073826\"\n }\n },\n \"document_fields\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/document_fields?filter[document_id]=20073826\"\n }\n },\n \"output_files\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files?filter[document_id]=20073826&filter[file_type]=output_file\"\n }\n },\n \"pages\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/pages?filter[document_id]=20073826\"\n }\n }\n }\n },\n \"meta\": {}\n}"}],"_postman_id":"c39d5f79-d42e-4cff-a955-933ffff621c9"},{"name":"Patch fields","id":"f6d0741a-5328-4255-a7e7-519a01adeae3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n\t\t\"id\": \"123456\",\r\n\t\t\"type\": \"documents\"\r\n\t},\r\n\t\"included\": [\r\n\t\t{\r\n\t\t\t\"type\": \"document_fields\",\r\n\t\t\t\"attributes\": {\r\n \"fieldset_identifier\": \"pp-sender-address\",\r\n \"identifier\": \"pp-sender-address-company-name\",\r\n \"item_index\": null,\r\n\t\t\t\t\"confirm_warnings\": true,\r\n\t\t\t\t\"external_value\": \"Pizza Züri\",\r\n\t\t\t\t\"page_number\": 0,\r\n\t\t\t\t\"coordinates\": {\r\n\t\t\t\t\t\"top\": 0.56,\r\n\t\t\t\t\t\"left\": 0.50,\r\n\t\t\t\t\t\"right\": 0.62,\r\n\t\t\t\t\t\"bottom\": 0.59\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t},\r\n {\r\n\t\t\t\"type\": \"document_fields\",\r\n\t\t\t\"attributes\": {\r\n \"fieldset_identifier\": null,\r\n \"identifier\": \"pp-document-date\",\r\n \"item_index\": null,\r\n\t\t\t\t\"confirm_warnings\": true,\r\n\t\t\t\t\"external_value\": \"2020-07-16\",\r\n\t\t\t\t\"page_number\": 0,\r\n\t\t\t\t\"coordinates\": {\r\n \"top\": 0.341,\r\n \"left\": 0.647,\r\n \"right\": 0.76,\r\n \"bottom\": 0.35\r\n }\r\n\t\t\t}\r\n\t\t}\r\n\t]\r\n\t\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.parashift.io/v2/documents/123456/?include=document_fields","description":"With this request, you can update values of existing fields, identified by its fieldset_identifier, identifier and item_index [null if non repeatable, 0 - n, if repeatable].
\nAs mentioned, you can only update existing fields here, not add new lines in position data, for example.
\nIt is important to send the coordinates [each attribute between 0 and 1, related to the page] and page_number [zero based].
\nThe format of the value depends on the data type of the field. Floats should be returned using the point as decimal separator, e.g. \"123.4\" and dates in format \"yyyy-mm-dd\", e.g. \"2025-03-13\".
\nBe careful as this can have a negative effect on the extraction models if the coordinates are not correct. The coordinates should be a little too small rather than too large, as otherwise incorrect fragments could end up in the field.
\nThis is part of the feedback loop to improve the training of the extraction model, please check the knowledge base article Feeback Loop.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456",""],"host":["api","parashift","io"],"query":[{"key":"include","value":"document_fields"}],"variable":[]}},"response":[{"id":"767dad53-ca4e-4ce3-957e-71ce0d78378f","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n\t\t\"id\": \"123456\",\r\n\t\t\"type\": \"documents\"\r\n\t},\r\n\t\"included\": [\r\n\t\t{\r\n\t\t\t\"type\": \"document_fields\",\r\n\t\t\t\"attributes\": {\r\n \"fieldset_identifier\": \"pp-sender-address\",\r\n \"identifier\": \"pp-sender-address-company-name\",\r\n \"item_index\": null,\r\n\t\t\t\t\"confirm_warnings\": true,\r\n\t\t\t\t\"external_value\": \"Pizza Züri\",\r\n\t\t\t\t\"page_number\": 0,\r\n\t\t\t\t\"coordinates\": {\r\n\t\t\t\t\t\"top\": 0.56,\r\n\t\t\t\t\t\"left\": 0.50,\r\n\t\t\t\t\t\"right\": 0.62,\r\n\t\t\t\t\t\"bottom\": 0.59\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t},\r\n {\r\n\t\t\t\"type\": \"document_fields\",\r\n\t\t\t\"attributes\": {\r\n \"fieldset_identifier\": null,\r\n \"identifier\": \"pp-document-date\",\r\n \"item_index\": null,\r\n\t\t\t\t\"confirm_warnings\": true,\r\n\t\t\t\t\"external_value\": \"2020-07-16\",\r\n\t\t\t\t\"page_number\": 0,\r\n\t\t\t\t\"coordinates\": {\r\n \"top\": 0.341,\r\n \"left\": 0.647,\r\n \"right\": 0.76,\r\n \"bottom\": 0.35\r\n }\r\n\t\t\t}\r\n\t\t}\r\n\t]\r\n\t\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.parashift.io/v2/documents/123456/?include=document_fields","protocol":"https","host":["api","parashift","io"],"path":["v2","documents","123456",""],"query":[{"key":"include","value":"document_fields"}]}},"_postman_previewlanguage":"json","header":[{},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"20073826\",\n \"type\": \"documents\",\n \"attributes\": {\n \"batch_id\": \"1007495019\",\n \"batch_index\": 0,\n \"classification_lower_threshold\": 0.0,\n \"classification_upper_threshold\": 0.9,\n \"created_at\": \"2025-03-12T12:12:34.535581Z\",\n \"custom_fields\": {\n \"SomeCustomField\": \"These custom fields cannot be queried.\",\n \"AnotherCustomField\": \"If you want to query for an external ID please use external_id.\",\n \"YetAnotherCustomField\": \"external_id can be queried and used for lookups to get your data back.\"\n },\n \"discarded_at\": null,\n \"document_type_identifier\": \"pp-correspondence\",\n \"error_codes\": [],\n \"exported_at\": null,\n \"external_id\": \"EX1234567890\",\n \"language\": \"en\",\n \"language_confidence\": 0.9999939372619904,\n \"name\": \"It gets better and better\",\n \"not_for_training\": true,\n \"recognition_confidence\": 0.9698362122781529,\n \"sla_deadline\": \"2025-03-12T15:12:34.557918Z\",\n \"status\": \"done\",\n \"tags\": [\n \"Production\",\n \"New tag2\"\n ],\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:22:48.799621Z\",\n \"upload_configuration\": \"scan\",\n \"validation_required\": false,\n \"workflow_status\": \"done\",\n \"workflow_step\": \"qc\"\n },\n \"relationships\": {\n \"comments\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/comments?filter[document_id]=20073826\"\n }\n },\n \"document_fields\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/document_fields?filter[document_id]=20073826\"\n },\n \"data\": [\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061824\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061825\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061826\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061827\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061828\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061829\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061830\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061831\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061832\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061833\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061834\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061835\"\n }\n ]\n },\n \"output_files\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files?filter[document_id]=20073826&filter[file_type]=output_file\"\n }\n },\n \"pages\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/pages?filter[document_id]=20073826\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"1059061824\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": null,\n \"coordinates\": {},\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": null,\n \"recognition_confidence\": null,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-company-name\",\n \"item_index\": null,\n \"page_number\": null,\n \"prediction_value\": null,\n \"prediction_confidence\": null,\n \"status\": \"pending\",\n \"validation_status\": \"pending\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-13T11:53:07.822887Z\",\n \"user_value\": null,\n \"value\": null\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061825\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1954615781330583,\n \"right\": 0.3063434760185663,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Badenerstrasse\",\n \"recognition_confidence\": 0.99992,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-street\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Badenerstrasse\",\n \"prediction_confidence\": 0.99997,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.239118Z\",\n \"user_value\": null,\n \"value\": \"Badenerstrasse\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061826\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99937,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3862815884476534,\n \"right\": 0.4342444559051057,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Zürich,\",\n \"recognition_confidence\": 0.99937,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-city\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Zürich\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.252434Z\",\n \"user_value\": null,\n \"value\": \"Zürich\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061827\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9998,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3465703971119133,\n \"right\": 0.3821557503867973,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"8048\",\n \"recognition_confidence\": 0.9998,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-postal-code\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"8048\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.267558Z\",\n \"user_value\": null,\n \"value\": \"8048\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061828\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99992,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3104693140794224,\n \"right\": 0.3408973697782362,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"558,\",\n \"recognition_confidence\": 0.99993,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-house-number\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"558\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.282760Z\",\n \"user_value\": null,\n \"value\": \"558\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061829\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99896,\n \"coordinates\": {\n \"top\": 0.1712574850299401,\n \"left\": 0.1186178442496132,\n \"right\": 0.4223826714801444,\n \"bottom\": 0.1808383233532934\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"recognition_confidence\": 0.99917,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"prediction_confidence\": 0.99978,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.297010Z\",\n \"user_value\": null,\n \"value\": \"Ristorante & Pizzeria VESUVIO da Antonio\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061830\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.1181021144920062,\n \"right\": 0.2243424445590511,\n \"bottom\": 0.217564870259481\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Glatttalstrasse\",\n \"recognition_confidence\": 0.99991,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-street\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Glatttalstrasse\",\n \"prediction_confidence\": 0.99998,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.313704Z\",\n \"user_value\": null,\n \"value\": \"Glatttalstrasse\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061831\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99972,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.2264053635894791,\n \"right\": 0.2460030943785456,\n \"bottom\": 0.217564870259481\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"40\",\n \"recognition_confidence\": 0.99973,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-house-number\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"40\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.326626Z\",\n \"user_value\": null,\n \"value\": \"40\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061832\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99986,\n \"coordinates\": {\n \"top\": 0.2263473053892216,\n \"left\": 0.1181021144920062,\n \"right\": 0.1526560082516761,\n \"bottom\": 0.237125748502994\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"8052\",\n \"recognition_confidence\": 0.99987,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-postal-code\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"8052\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.335607Z\",\n \"user_value\": null,\n \"value\": \"8052\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061833\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99897,\n \"coordinates\": {\n \"top\": 0.2259481037924152,\n \"left\": 0.1578133058277462,\n \"right\": 0.2068076328004126,\n \"bottom\": 0.2367265469061876\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Zürich,\",\n \"recognition_confidence\": 0.99898,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-city\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Zürich\",\n \"prediction_confidence\": 0.99999,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.343573Z\",\n \"user_value\": null,\n \"value\": \"Zürich\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061834\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99322,\n \"coordinates\": {\n \"top\": 0.3377245508982036,\n \"left\": 0.1181021144920062,\n \"right\": 0.4657039711191336,\n \"bottom\": 0.3584830339321357\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Cancel Pizza selling agreement\",\n \"recognition_confidence\": 0.99991,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-subject\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Cancel Pizza selling agreement\",\n \"prediction_confidence\": 0.99331,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.352534Z\",\n \"user_value\": null,\n \"value\": \"Cancel Pizza selling agreement\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061835\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9988,\n \"coordinates\": {\n \"top\": 0.3405189620758483,\n \"left\": 0.6462093862815884,\n \"right\": 0.7663744198040227,\n \"bottom\": 0.3548902195608782\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"date\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"16.07.2020\",\n \"recognition_confidence\": 0.99961,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-document-date\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"2020-07-16\",\n \"prediction_confidence\": 0.99919,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.360322Z\",\n \"user_value\": null,\n \"value\": \"2020-07-16\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n }\n ],\n \"meta\": {}\n}"}],"_postman_id":"f6d0741a-5328-4255-a7e7-519a01adeae3"},{"name":"Delete field values","id":"59929cd0-0a1e-4948-819c-615dceeea201","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456/document_fields/pp-sender-address/pp-sender-address-company-name","description":"With this request, you can delete the value of an existing field, identified by its item_index, fieldset_identifier and identifier.
\nThe URL is composed of /fieldset_identifier/item_index/identifier. If any of these values are null, they must be omitted.
This command can also be used to delete entire blocks by specifying only a partial path. For example, using /fieldset_identifier will delete all fields within the fieldset at once.
The field itself is not deleted, only the value and associated attributes such as coordinates, page number, confidences, ....
\nThis is part of the feedback loop to improve the training of the extraction model, please check the knowledge base article Feeback Loop.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456","document_fields","pp-sender-address","pp-sender-address-company-name"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"588b7dde-fbeb-45ed-a34b-a5abfbe10c3c","name":"204 No Content - Deletion of header field","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456/document_fields/pp-document-date"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:31:09 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1014"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"144777852ddd60e215758a3ce42477ad\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"4f994b9fe77dddb104ed63976a12e714"},{"key":"X-Runtime","value":"0.207110"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":""},{"id":"2449543b-c2cc-4d31-bbec-5708da3f8f7d","name":"204 No Content - Deletion of header field, part of a fieldset","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456/document_fields/pp-sender-address/pp-sender-address-company-name"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:31:09 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1014"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"144777852ddd60e215758a3ce42477ad\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"4f994b9fe77dddb104ed63976a12e714"},{"key":"X-Runtime","value":"0.207110"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":""},{"id":"165922b4-bd4a-4234-9687-c7783443b50b","name":"204 No Content - Deletion of all fields of a fieldset","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456/document_fields/pp-sender-address"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:31:09 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1014"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"144777852ddd60e215758a3ce42477ad\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"4f994b9fe77dddb104ed63976a12e714"},{"key":"X-Runtime","value":"0.207110"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":""},{"id":"91a20ee0-b556-4d13-a2c8-7917dcacb93f","name":"204 No Content - Deletion of repeatable fields","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456/document_fields/pp-p2p-line-items/0/pp-p2p-line-item-quantity"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:31:09 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1014"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"144777852ddd60e215758a3ce42477ad\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"4f994b9fe77dddb104ed63976a12e714"},{"key":"X-Runtime","value":"0.207110"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"59929cd0-0a1e-4948-819c-615dceeea201"}],"id":"a6ed9b2c-f23e-4525-a59e-6541aa091e81","description":"If this endpoint is used to query the results of a document, it must be taken into account that only the first 20 fields are returned by default. It is therefore recommended to use the parameters page[size] and page[number] to iterate over all pages and thus obtain all fields, see Pagination, search & filter
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","document_fields"],"host":["api","parashift","io"],"query":[{"key":"filter[document_id]","value":"123456"}],"variable":[]}},"response":[{"id":"66708ac3-15fc-4a62-bd38-322562edc1a8","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/document_fields?filter[document_id]=123456","protocol":"https","host":["api","parashift","io"],"path":["v2","document_fields"],"query":[{"key":"filter[document_id]","value":"123456"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:30:03 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"16826"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"dce60c9aa52980e92eee2357c3606c8a\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"84fe0ed01ff735789cf40d9c2fc6bd3b"},{"key":"X-Runtime","value":"0.282126"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"1059061824\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99929,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1186178442496132,\n \"right\": 0.1897885507993811,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Pizza Züri,\",\n \"recognition_confidence\": 0.99931,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Pizza Züri\",\n \"prediction_confidence\": 0.99998,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.226740Z\",\n \"user_value\": null,\n \"value\": \"Pizza Züri\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061825\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1954615781330583,\n \"right\": 0.3063434760185663,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Badenerstrasse\",\n \"recognition_confidence\": 0.99992,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-street\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Badenerstrasse\",\n \"prediction_confidence\": 0.99997,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.239118Z\",\n \"user_value\": null,\n \"value\": \"Badenerstrasse\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061826\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99937,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3862815884476534,\n \"right\": 0.4342444559051057,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Zürich,\",\n \"recognition_confidence\": 0.99937,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-city\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Zürich\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.252434Z\",\n \"user_value\": null,\n \"value\": \"Zürich\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061827\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9998,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3465703971119133,\n \"right\": 0.3821557503867973,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"8048\",\n \"recognition_confidence\": 0.9998,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-postal-code\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"8048\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.267558Z\",\n \"user_value\": null,\n \"value\": \"8048\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061828\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99992,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3104693140794224,\n \"right\": 0.3408973697782362,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"558,\",\n \"recognition_confidence\": 0.99993,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-house-number\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"558\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.282760Z\",\n \"user_value\": null,\n \"value\": \"558\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061829\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99896,\n \"coordinates\": {\n \"top\": 0.1712574850299401,\n \"left\": 0.1186178442496132,\n \"right\": 0.4223826714801444,\n \"bottom\": 0.1808383233532934\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"recognition_confidence\": 0.99917,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"prediction_confidence\": 0.99978,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.297010Z\",\n \"user_value\": null,\n \"value\": \"Ristorante & Pizzeria VESUVIO da Antonio\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061830\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.1181021144920062,\n \"right\": 0.2243424445590511,\n \"bottom\": 0.217564870259481\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Glatttalstrasse\",\n \"recognition_confidence\": 0.99991,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-street\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Glatttalstrasse\",\n \"prediction_confidence\": 0.99998,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.313704Z\",\n \"user_value\": null,\n \"value\": \"Glatttalstrasse\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061831\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99972,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.2264053635894791,\n \"right\": 0.2460030943785456,\n \"bottom\": 0.217564870259481\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"40\",\n \"recognition_confidence\": 0.99973,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-house-number\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"40\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.326626Z\",\n \"user_value\": null,\n \"value\": \"40\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061832\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99986,\n \"coordinates\": {\n \"top\": 0.2263473053892216,\n \"left\": 0.1181021144920062,\n \"right\": 0.1526560082516761,\n \"bottom\": 0.237125748502994\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"8052\",\n \"recognition_confidence\": 0.99987,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-postal-code\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"8052\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.335607Z\",\n \"user_value\": null,\n \"value\": \"8052\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061833\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99897,\n \"coordinates\": {\n \"top\": 0.2259481037924152,\n \"left\": 0.1578133058277462,\n \"right\": 0.2068076328004126,\n \"bottom\": 0.2367265469061876\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Zürich,\",\n \"recognition_confidence\": 0.99898,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-city\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Zürich\",\n \"prediction_confidence\": 0.99999,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.343573Z\",\n \"user_value\": null,\n \"value\": \"Zürich\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061834\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99322,\n \"coordinates\": {\n \"top\": 0.3377245508982036,\n \"left\": 0.1181021144920062,\n \"right\": 0.4657039711191336,\n \"bottom\": 0.3584830339321357\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Cancel Pizza selling agreement\",\n \"recognition_confidence\": 0.99991,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-subject\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Cancel Pizza selling agreement\",\n \"prediction_confidence\": 0.99331,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.352534Z\",\n \"user_value\": null,\n \"value\": \"Cancel Pizza selling agreement\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061835\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9988,\n \"coordinates\": {\n \"top\": 0.3405189620758483,\n \"left\": 0.6462093862815884,\n \"right\": 0.7663744198040227,\n \"bottom\": 0.3548902195608782\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"date\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"16.07.2020\",\n \"recognition_confidence\": 0.99961,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-document-date\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"2020-07-16\",\n \"prediction_confidence\": 0.99919,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.360322Z\",\n \"user_value\": null,\n \"value\": \"2020-07-16\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n }\n ],\n \"meta\": {}\n}"}],"_postman_id":"2056c8ed-fd77-4697-857e-c733d36664f5"},{"name":"List fields by document ID (with extraction_candidates)","id":"042d037f-c2cc-4e55-90e3-971860f89186","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/document_fields?filter[document_id]=123456&extra_fields[document_fields]=extraction_candidates","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","document_fields"],"host":["api","parashift","io"],"query":[{"key":"filter[document_id]","value":"123456"},{"key":"extra_fields[document_fields]","value":"extraction_candidates"}],"variable":[]}},"response":[{"id":"6775ad2c-8b5f-4b7a-adf2-14afac3af258","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/document_fields?filter[document_id]=123456","protocol":"https","host":["api","parashift","io"],"path":["v2","document_fields"],"query":[{"key":"filter[document_id]","value":"123456"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:30:03 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"16826"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"dce60c9aa52980e92eee2357c3606c8a\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"84fe0ed01ff735789cf40d9c2fc6bd3b"},{"key":"X-Runtime","value":"0.282126"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"1059061824\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99929,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1186178442496132,\n \"right\": 0.1897885507993811,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Pizza Züri,\",\n \"recognition_confidence\": 0.99931,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Pizza Züri\",\n \"prediction_confidence\": 0.99998,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.226740Z\",\n \"user_value\": null,\n \"value\": \"Pizza Züri\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Pizza Züri,\",\n \"prediction_value\": \"Pizza Züri\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1186178442496132,\n \"right\": 0.1897885507993811,\n \"bottom\": 0.1636726546906188\n },\n \"confidence\": 0.9992903856609202,\n \"recognition_confidence\": 0.9993057297730239,\n \"prediction_confidence\": 0.9999846452275349\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061825\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1954615781330583,\n \"right\": 0.3063434760185663,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Badenerstrasse\",\n \"recognition_confidence\": 0.99992,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-street\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Badenerstrasse\",\n \"prediction_confidence\": 0.99997,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.239118Z\",\n \"user_value\": null,\n \"value\": \"Badenerstrasse\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Badenerstrasse\",\n \"prediction_value\": \"Badenerstrasse\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1954615781330583,\n \"right\": 0.3063434760185663,\n \"bottom\": 0.1636726546906188\n },\n \"confidence\": 0.9998935204272208,\n \"recognition_confidence\": 0.9999200618105846,\n \"prediction_confidence\": 0.9999734564947965\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061826\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99937,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3862815884476534,\n \"right\": 0.4342444559051057,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Zürich,\",\n \"recognition_confidence\": 0.99937,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-city\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Zürich\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.252434Z\",\n \"user_value\": null,\n \"value\": \"Zürich\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Zürich,\",\n \"prediction_value\": \"Zürich\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3862815884476534,\n \"right\": 0.4342444559051057,\n \"bottom\": 0.1636726546906188\n },\n \"confidence\": 0.9993700630547878,\n \"recognition_confidence\": 0.9993721667678415,\n \"prediction_confidence\": 0.9999978949653356\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061827\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9998,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3465703971119133,\n \"right\": 0.3821557503867973,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"8048\",\n \"recognition_confidence\": 0.9998,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-postal-code\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"8048\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.267558Z\",\n \"user_value\": null,\n \"value\": \"8048\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"8048\",\n \"prediction_value\": \"8048\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3465703971119133,\n \"right\": 0.3821557503867973,\n \"bottom\": 0.1636726546906188\n },\n \"confidence\": 0.9997964413785434,\n \"recognition_confidence\": 0.9997981034079544,\n \"prediction_confidence\": 0.9999983376349632\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061828\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99992,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3104693140794224,\n \"right\": 0.3408973697782362,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"558,\",\n \"recognition_confidence\": 0.99993,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-house-number\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"558\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.282760Z\",\n \"user_value\": null,\n \"value\": \"558\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"558,\",\n \"prediction_value\": \"558\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3104693140794224,\n \"right\": 0.3408973697782362,\n \"bottom\": 0.1636726546906188\n },\n \"confidence\": 0.9999242180154694,\n \"recognition_confidence\": 0.9999286090587134,\n \"prediction_confidence\": 0.9999956086432529\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061829\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99896,\n \"coordinates\": {\n \"top\": 0.1712574850299401,\n \"left\": 0.1186178442496132,\n \"right\": 0.4223826714801444,\n \"bottom\": 0.1808383233532934\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"recognition_confidence\": 0.99917,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"prediction_confidence\": 0.99978,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.297010Z\",\n \"user_value\": null,\n \"value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"prediction_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.1712574850299401,\n \"left\": 0.1186178442496132,\n \"right\": 0.4223826714801444,\n \"bottom\": 0.1808383233532934\n },\n \"confidence\": 0.9989555637157892,\n \"recognition_confidence\": 0.9991721333449782,\n \"prediction_confidence\": 0.9997832509314847\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061830\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.1181021144920062,\n \"right\": 0.2243424445590511,\n \"bottom\": 0.217564870259481\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Glatttalstrasse\",\n \"recognition_confidence\": 0.99991,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-street\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Glatttalstrasse\",\n \"prediction_confidence\": 0.99998,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.313704Z\",\n \"user_value\": null,\n \"value\": \"Glatttalstrasse\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Glatttalstrasse\",\n \"prediction_value\": \"Glatttalstrasse\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.1181021144920062,\n \"right\": 0.2243424445590511,\n \"bottom\": 0.217564870259481\n },\n \"confidence\": 0.9998863635069857,\n \"recognition_confidence\": 0.9999055187489851,\n \"prediction_confidence\": 0.9999808429480183\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061831\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99972,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.2264053635894791,\n \"right\": 0.2460030943785456,\n \"bottom\": 0.217564870259481\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"40\",\n \"recognition_confidence\": 0.99973,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-house-number\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"40\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.326626Z\",\n \"user_value\": null,\n \"value\": \"40\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"40\",\n \"prediction_value\": \"40\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.2264053635894791,\n \"right\": 0.2460030943785456,\n \"bottom\": 0.217564870259481\n },\n \"confidence\": 0.9997235277755387,\n \"recognition_confidence\": 0.9997282023370957,\n \"prediction_confidence\": 0.9999953241675628\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061832\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99986,\n \"coordinates\": {\n \"top\": 0.2263473053892216,\n \"left\": 0.1181021144920062,\n \"right\": 0.1526560082516761,\n \"bottom\": 0.237125748502994\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"8052\",\n \"recognition_confidence\": 0.99987,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-postal-code\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"8052\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.335607Z\",\n \"user_value\": null,\n \"value\": \"8052\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"8052\",\n \"prediction_value\": \"8052\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.2263473053892216,\n \"left\": 0.1181021144920062,\n \"right\": 0.1526560082516761,\n \"bottom\": 0.237125748502994\n },\n \"confidence\": 0.9998642975821332,\n \"recognition_confidence\": 0.999865622064533,\n \"prediction_confidence\": 0.9999986753395951\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061833\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99897,\n \"coordinates\": {\n \"top\": 0.2259481037924152,\n \"left\": 0.1578133058277462,\n \"right\": 0.2068076328004126,\n \"bottom\": 0.2367265469061876\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Zürich,\",\n \"recognition_confidence\": 0.99898,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-city\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Zürich\",\n \"prediction_confidence\": 0.99999,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.343573Z\",\n \"user_value\": null,\n \"value\": \"Zürich\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Zürich,\",\n \"prediction_value\": \"Zürich\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.2259481037924152,\n \"left\": 0.1578133058277462,\n \"right\": 0.2068076328004126,\n \"bottom\": 0.2367265469061876\n },\n \"confidence\": 0.9989662511830831,\n \"recognition_confidence\": 0.9989804199333285,\n \"prediction_confidence\": 0.9999858167888352\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061834\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99322,\n \"coordinates\": {\n \"top\": 0.3377245508982036,\n \"left\": 0.1181021144920062,\n \"right\": 0.4657039711191336,\n \"bottom\": 0.3584830339321357\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Cancel Pizza selling agreement\",\n \"recognition_confidence\": 0.99991,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-subject\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Cancel Pizza selling agreement\",\n \"prediction_confidence\": 0.99331,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.352534Z\",\n \"user_value\": null,\n \"value\": \"Cancel Pizza selling agreement\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Cancel Pizza selling agreement\",\n \"prediction_value\": \"Cancel Pizza selling agreement\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.3377245508982036,\n \"left\": 0.1181021144920062,\n \"right\": 0.4657039711191336,\n \"bottom\": 0.3584830339321357\n },\n \"confidence\": 0.993218096148804,\n \"recognition_confidence\": 0.9999124534221087,\n \"prediction_confidence\": 0.9933050566073121\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061835\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9988,\n \"coordinates\": {\n \"top\": 0.3405189620758483,\n \"left\": 0.6462093862815884,\n \"right\": 0.7663744198040227,\n \"bottom\": 0.3548902195608782\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"date\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"16.07.2020\",\n \"recognition_confidence\": 0.99961,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-document-date\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"2020-07-16\",\n \"prediction_confidence\": 0.99919,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.360322Z\",\n \"user_value\": null,\n \"value\": \"2020-07-16\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"16.07.2020\",\n \"prediction_value\": \"2020-07-16\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.3405189620758483,\n \"left\": 0.6462093862815884,\n \"right\": 0.7663744198040227,\n \"bottom\": 0.3548902195608782\n },\n \"confidence\": 0.9987996992719399,\n \"recognition_confidence\": 0.9996079738711465,\n \"prediction_confidence\": 0.9991914084117632\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n }\n ],\n \"meta\": {}\n}"}],"_postman_id":"042d037f-c2cc-4e55-90e3-971860f89186"},{"name":"List fields by document ID (using pagination)","id":"aa10132d-d506-42c7-97e1-ff30d9180786","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/document_fields?filter[document_id]=123456&page[size]=200&page[number]=1","description":"If this endpoint is used to query the results of a document, it must be taken into account that only the first 20 fields are returned by default. It is therefore recommended to use the parameters page[size] and page[number] to iterate over all pages and thus obtain all fields, see Pagination, search & filter
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","document_fields"],"host":["api","parashift","io"],"query":[{"key":"filter[document_id]","value":"123456"},{"key":"page[size]","value":"200"},{"key":"page[number]","value":"1"}],"variable":[]}},"response":[{"id":"af1afd96-8de9-45a1-9f6f-3149f4e64cfd","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/document_fields?filter[document_id]=123456&page[size]=200&page[number]=1","protocol":"https","host":["api","parashift","io"],"path":["v2","document_fields"],"query":[{"key":"filter[document_id]","value":"123456"},{"key":"page[size]","value":"200"},{"key":"page[number]","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:30:03 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"16826"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"dce60c9aa52980e92eee2357c3606c8a\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"84fe0ed01ff735789cf40d9c2fc6bd3b"},{"key":"X-Runtime","value":"0.282126"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"1059061824\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99929,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1186178442496132,\n \"right\": 0.1897885507993811,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Pizza Züri,\",\n \"recognition_confidence\": 0.99931,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Pizza Züri\",\n \"prediction_confidence\": 0.99998,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.226740Z\",\n \"user_value\": null,\n \"value\": \"Pizza Züri\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061825\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1954615781330583,\n \"right\": 0.3063434760185663,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Badenerstrasse\",\n \"recognition_confidence\": 0.99992,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-street\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Badenerstrasse\",\n \"prediction_confidence\": 0.99997,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.239118Z\",\n \"user_value\": null,\n \"value\": \"Badenerstrasse\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061826\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99937,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3862815884476534,\n \"right\": 0.4342444559051057,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Zürich,\",\n \"recognition_confidence\": 0.99937,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-city\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Zürich\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.252434Z\",\n \"user_value\": null,\n \"value\": \"Zürich\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061827\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9998,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3465703971119133,\n \"right\": 0.3821557503867973,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"8048\",\n \"recognition_confidence\": 0.9998,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-postal-code\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"8048\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.267558Z\",\n \"user_value\": null,\n \"value\": \"8048\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061828\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99992,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3104693140794224,\n \"right\": 0.3408973697782362,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"558,\",\n \"recognition_confidence\": 0.99993,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-house-number\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"558\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.282760Z\",\n \"user_value\": null,\n \"value\": \"558\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061829\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99896,\n \"coordinates\": {\n \"top\": 0.1712574850299401,\n \"left\": 0.1186178442496132,\n \"right\": 0.4223826714801444,\n \"bottom\": 0.1808383233532934\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"recognition_confidence\": 0.99917,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"prediction_confidence\": 0.99978,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.297010Z\",\n \"user_value\": null,\n \"value\": \"Ristorante & Pizzeria VESUVIO da Antonio\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061830\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.1181021144920062,\n \"right\": 0.2243424445590511,\n \"bottom\": 0.217564870259481\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Glatttalstrasse\",\n \"recognition_confidence\": 0.99991,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-street\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Glatttalstrasse\",\n \"prediction_confidence\": 0.99998,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.313704Z\",\n \"user_value\": null,\n \"value\": \"Glatttalstrasse\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061831\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99972,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.2264053635894791,\n \"right\": 0.2460030943785456,\n \"bottom\": 0.217564870259481\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"40\",\n \"recognition_confidence\": 0.99973,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-house-number\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"40\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.326626Z\",\n \"user_value\": null,\n \"value\": \"40\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061832\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99986,\n \"coordinates\": {\n \"top\": 0.2263473053892216,\n \"left\": 0.1181021144920062,\n \"right\": 0.1526560082516761,\n \"bottom\": 0.237125748502994\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"8052\",\n \"recognition_confidence\": 0.99987,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-postal-code\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"8052\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.335607Z\",\n \"user_value\": null,\n \"value\": \"8052\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061833\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99897,\n \"coordinates\": {\n \"top\": 0.2259481037924152,\n \"left\": 0.1578133058277462,\n \"right\": 0.2068076328004126,\n \"bottom\": 0.2367265469061876\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Zürich,\",\n \"recognition_confidence\": 0.99898,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-city\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Zürich\",\n \"prediction_confidence\": 0.99999,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.343573Z\",\n \"user_value\": null,\n \"value\": \"Zürich\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061834\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99322,\n \"coordinates\": {\n \"top\": 0.3377245508982036,\n \"left\": 0.1181021144920062,\n \"right\": 0.4657039711191336,\n \"bottom\": 0.3584830339321357\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Cancel Pizza selling agreement\",\n \"recognition_confidence\": 0.99991,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-subject\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Cancel Pizza selling agreement\",\n \"prediction_confidence\": 0.99331,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.352534Z\",\n \"user_value\": null,\n \"value\": \"Cancel Pizza selling agreement\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061835\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9988,\n \"coordinates\": {\n \"top\": 0.3405189620758483,\n \"left\": 0.6462093862815884,\n \"right\": 0.7663744198040227,\n \"bottom\": 0.3548902195608782\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"date\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"16.07.2020\",\n \"recognition_confidence\": 0.99961,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-document-date\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"2020-07-16\",\n \"prediction_confidence\": 0.99919,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.360322Z\",\n \"user_value\": null,\n \"value\": \"2020-07-16\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n }\n ],\n \"meta\": {}\n}"},{"id":"261584ec-c13e-499b-8221-0933810b769d","name":"200 OK, if no further content","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/document_fields?filter[document_id]=123456&page[size]=200&page[number]=2","protocol":"https","host":["api","parashift","io"],"path":["v2","document_fields"],"query":[{"key":"filter[document_id]","value":"123456"},{"key":"page[size]","value":"200"},{"key":"page[number]","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:30:03 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"16826"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"dce60c9aa52980e92eee2357c3606c8a\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"84fe0ed01ff735789cf40d9c2fc6bd3b"},{"key":"X-Runtime","value":"0.282126"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n\t\"data\": [],\n\t\"meta\": {}\n}"}],"_postman_id":"aa10132d-d506-42c7-97e1-ff30d9180786"},{"name":"Show field","id":"6072045a-056a-463c-82ed-4651935d8076","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/document_fields/123456789","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","document_fields","123456789"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"e443874a-15e7-4f69-b17e-7fe5913d9952","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/document_fields/123456789"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:31:09 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1014"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"144777852ddd60e215758a3ce42477ad\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"4f994b9fe77dddb104ed63976a12e714"},{"key":"X-Runtime","value":"0.207110"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"1059061824\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99929,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1186178442496132,\n \"right\": 0.1897885507993811,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Pizza Züri,\",\n \"recognition_confidence\": 0.99931,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Pizza Züri\",\n \"prediction_confidence\": 0.99998,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.226740Z\",\n \"user_value\": null,\n \"value\": \"Pizza Züri\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n \"meta\": {}\n}"}],"_postman_id":"6072045a-056a-463c-82ed-4651935d8076"},{"name":"Show field (with extraction_candidates)","id":"76e5e5a1-3e5b-47e2-8dae-5161afb90546","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/document_fields/123456789?extra_fields[document_fields]=extraction_candidates","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","document_fields","123456789"],"host":["api","parashift","io"],"query":[{"key":"extra_fields[document_fields]","value":"extraction_candidates"}],"variable":[]}},"response":[{"id":"56202f12-43c5-4a04-b0fa-f6689bf4f6dd","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/document_fields/123456789?extra_fields[document_fields]=extraction_candidates","protocol":"https","host":["api","parashift","io"],"path":["v2","document_fields","123456789"],"query":[{"key":"extra_fields[document_fields]","value":"extraction_candidates"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:31:31 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1434"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"30c5802f918f9992c853371871be274a\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"08c1cab1e7c204412c74e3127b735a49"},{"key":"X-Runtime","value":"0.412885"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"1059061824\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99929,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1186178442496132,\n \"right\": 0.1897885507993811,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Pizza Züri,\",\n \"recognition_confidence\": 0.99931,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Pizza Züri\",\n \"prediction_confidence\": 0.99998,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.226740Z\",\n \"user_value\": null,\n \"value\": \"Pizza Züri\",\n \"extraction_candidates\": [\n {\n \"recognition_value\": \"Pizza Züri,\",\n \"prediction_value\": \"Pizza Züri\",\n \"page_number\": 0,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1186178442496132,\n \"right\": 0.1897885507993811,\n \"bottom\": 0.1636726546906188\n },\n \"confidence\": 0.9992903856609202,\n \"recognition_confidence\": 0.9993057297730239,\n \"prediction_confidence\": 0.9999846452275349\n }\n ]\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n \"meta\": {}\n}"}],"_postman_id":"76e5e5a1-3e5b-47e2-8dae-5161afb90546"},{"name":"Get field image","id":"d586e5f1-e054-4bea-9850-4085b7145cfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/document_fields/123456789/image","description":"Returns the image of a field based on its coordinates to visually represent the content of a field.
\nThe response is a raw image file, not embedded in JSON.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","document_fields","123456789","image"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"116025e6-87cd-44a6-8938-319ac31feeda","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/document_fields/123456789/image"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:31:09 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1014"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"144777852ddd60e215758a3ce42477ad\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"4f994b9fe77dddb104ed63976a12e714"},{"key":"X-Runtime","value":"0.207110"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d586e5f1-e054-4bea-9850-4085b7145cfa"},{"name":"Patch field","id":"15385ab1-c92e-4581-a21e-54c38ff5d063","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"id\": \"123456789\",\r\n \"type\": \"document_fields\",\r\n \"attributes\": {\r\n \"coordinates\": {\r\n \"top\": 0.1528942115768463,\r\n \"left\": 0.1186178442496132,\r\n \"right\": 0.1897885507993811,\r\n \"bottom\": 0.1636726546906188\r\n },\r\n \"confirm_warnings\" : true,\r\n \"page_number\": 0,\r\n \"external_value\": \"Pizza Züri\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.parashift.io/v2/document_fields/123456789","description":"With this request, you can update the value of an existing field, identified by its id.
\nIt is important to send the coordinates [each attribute between 0 and 1, related to the page] and page_number [zero based].
\nThe format of the value depends on the data type of the field. Floats should be returned using the point as decimal separator, e.g. \"123.4\" and dates in format \"yyyy-mm-dd\", e.g. \"2025-03-13\".
\nBe careful as this can have a negative effect on the extraction models if the coordinates are not correct. The coordinates should be a little too small rather than too large, as otherwise incorrect fragments could end up in the field.
\nThis is part of the feedback loop to improve the training of the extraction model, please check the knowledge base article Feeback Loop.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","document_fields","123456789"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"e160773a-9671-4fc2-9500-300543134b10","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"id\": \"123456789\",\r\n \"type\": \"document_fields\",\r\n \"attributes\": {\r\n \"coordinates\": {\r\n \"top\": 0.1528942115768463,\r\n \"left\": 0.1186178442496132,\r\n \"right\": 0.1897885507993811,\r\n \"bottom\": 0.1636726546906188\r\n },\r\n \"confirm_warnings\" : true,\r\n \"page_number\": 0,\r\n \"external_value\": \"Pizza Züri\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.parashift.io/v2/document_fields/123456789"},"_postman_previewlanguage":"json","header":[{},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"1059061824\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": null,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"bottom\": 0.1636726546906188,\n \"left\": 0.1186178442496132,\n \"right\": 0.1897885507993811\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Pizza Züri,\",\n \"recognition_confidence\": 0.97365,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": \"Pizza Züri\",\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": null,\n \"prediction_confidence\": null,\n \"status\": \"in_progress\",\n \"validation_status\": \"done\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-13T11:21:24.378770Z\",\n \"user_value\": null,\n \"value\": \"Pizza Züri\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n \"meta\": {}\n}"}],"_postman_id":"15385ab1-c92e-4581-a21e-54c38ff5d063"},{"name":"Delete field value","id":"e8c1b865-7e12-476a-b96c-172dcb73596c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/document_fields/123456789","description":"With this request, you can delete the value of an existing field, identified by its id.
\nThe field itself is not deleted, only the value and associated attributes such as coordinates, page number, confidences, ....
\nThis is part of the feedback loop to improve the training of the extraction model, please check the knowledge base article Feeback Loop.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","document_fields","123456789"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"ef80e8b5-64dd-4ea3-a6a6-334c052acd8e","name":"204 No Content","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.parashift.io/v2/document_fields/123456789"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:31:09 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1014"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"144777852ddd60e215758a3ce42477ad\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"4f994b9fe77dddb104ed63976a12e714"},{"key":"X-Runtime","value":"0.207110"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e8c1b865-7e12-476a-b96c-172dcb73596c"}],"id":"7f8c865e-52e8-476d-828a-519ad1efdc05","description":"An alternative, possibly better than going at input files though batches, is directly through api/v2/files?filter[file_type]=input_file&filter[batch_id]=12345678&extra_fields[files]=url. Try out which version works best for your case.
Edit batch attributes, just put any combination of the following attributes into request body
\ncustom_fields{} (merge with existing custom_fields{}, remove key if set to null , keep key but empty if \"\"
external_id
validation_required
upload_configuration
The request deletes the batch and all documents belonging to the batch.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","batches","1234567"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"eb53f162-aa47-40ec-bb89-5826c74fd5fc","name":"204 No Content","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/batches/1234567"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.17.10"},{"key":"Date","value":"Wed, 12 May 2021 08:19:31 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Request-Id","value":"031afdba330618f5bff7f425d700d379"},{"key":"X-Runtime","value":"0.765038"},{"key":"Vary","value":"Origin"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"acf713d4-9234-4e9b-96fa-c1151316d476"}],"id":"2ef08c91-0d91-4f7e-b16a-f2567af925a2","description":"List all pages to a specific document. If a page has no document_id (null) it is \"deleted\", we de-associate it with a document
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","pages"],"host":["api","parashift","io"],"query":[{"key":"filter[document_id]","value":"123456"}],"variable":[]}},"response":[{"id":"046ee03b-90af-42af-8cf2-0909cd224721","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/pages?filter[document_id]=123456","protocol":"https","host":["api","parashift","io"],"path":["v2","pages"],"query":[{"key":"filter[document_id]","value":"123456"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:38:42 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1220"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"5ad7b06079c3c33f2519fa07e26c6ad3\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"523c48587a8de0d410581d75dce2c147"},{"key":"X-Runtime","value":"0.187334"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"1013756793\",\n \"type\": \"pages\",\n \"attributes\": {\n \"batch_id\": \"1007495019\",\n \"batch_index\": 0,\n \"created_at\": \"2025-03-12T12:12:37.404869Z\",\n \"document_id\": \"20073826\",\n \"document_index\": 0,\n \"input_file_id\": \"173818522\",\n \"input_file_index\": 0,\n \"tenant_id\": \"1385\"\n },\n \"relationships\": {\n \"batch\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/batches/1007495019\"\n }\n },\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n },\n \"color_jpeg\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files/173818549\"\n }\n },\n \"input_file\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files/173818522\"\n }\n }\n }\n },\n {\n \"id\": \"1013756794\",\n \"type\": \"pages\",\n \"attributes\": {\n \"batch_id\": \"1007495019\",\n \"batch_index\": 1,\n \"created_at\": \"2025-03-12T12:12:37.560612Z\",\n \"document_id\": \"20073826\",\n \"document_index\": 1,\n \"input_file_id\": \"173818523\",\n \"input_file_index\": 0,\n \"tenant_id\": \"1385\"\n },\n \"relationships\": {\n \"batch\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/batches/1007495019\"\n }\n },\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n },\n \"color_jpeg\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files/173818554\"\n }\n },\n \"input_file\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files/173818523\"\n }\n }\n }\n }\n ],\n \"meta\": {}\n}"}],"_postman_id":"0997ae27-9de9-4740-8f5f-22aaec00bd15"},{"name":"List pages of a document including color_jpeg","id":"d0e77d7f-fa69-446d-a3c5-efb4f75cb403","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/pages?filter[document_id]=123456&include=color_jpeg&extra_fields[files]=url","description":"By using this request, a download link is created with which the page can be downloaded. This link expires after 30 minutes.
\nAn alternative, possibly better than going at color_jpegs though pages, is directly through api/v2/files?filter[file_type]=color_jpeg&filter[document_id]=1234568&extra_fields[files]=url. Try out which version works best for your case.
The Parashift Platform distinguishes between pages and files. These are either assigned to the document or the batch. A detailed description can be found in Batches, Documents, Files, Pages.
\nTo search by attributes, the \"record_id\" and \"record_type\" must be defined. It is easier to search using the artificial attribute \"document_id\", see search via document_id
\nBy using this request, a download link is created with which the file can be downloaded. This link expires after 30 minutes.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","files"],"host":["api","parashift","io"],"query":[{"key":"filter[record_id]","value":"123456"},{"key":"filter[record_type]","value":"document"},{"key":"filter[file_type]","value":"output_file"},{"key":"extra_fields[files]","value":"url"}],"variable":[]}},"response":[{"id":"dbe4deb8-3509-4eb4-9f8b-a8ece15ac665","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/files?filter[record_id]=123456&filter[record_type]=document&filter[file_type]=output_file&extra_fields[files]=url","protocol":"https","host":["api","parashift","io"],"path":["v2","files"],"query":[{"key":"filter[record_id]","value":"123456"},{"key":"filter[record_type]","value":"document"},{"key":"filter[file_type]","value":"output_file"},{"key":"extra_fields[files]","value":"url"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:43:14 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1000"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"b2976370d08ed62cd9c6c69a4087f055\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"f9b26953527bdac3e377e6691a6da4c6"},{"key":"X-Runtime","value":"0.122286"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"173818653\",\n \"type\": \"files\",\n \"attributes\": {\n \"record_id\": \"20073826\",\n \"record_type\": \"documents\",\n \"file_type\": \"output_file\",\n \"mime_type\": \"application/pdf\",\n \"file_name\": \"20073826.pdf\",\n \"index\": 0,\n \"url\": \"https://storage.parashift.io/myuniquedownloadstring\",\n \"meta\": {},\n \"created_at\": \"2025-03-12T12:12:56.905163Z\"\n }\n }\n ],\n \"meta\": {}\n}"}],"_postman_id":"78c121e6-211f-4555-8295-e12bbd2a83f6"},{"name":"List output files of a document including URL (search via document_id)","id":"dc3252bb-10e5-4f27-b6c5-2ac2d2b41830","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/files?filter[document_id]=123456&filter[file_type]=output_file&extra_fields[files]=url","description":"By using this request, a download link is created with which the file can be downloaded. This link expires after 30 minutes.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","files"],"host":["api","parashift","io"],"query":[{"key":"filter[document_id]","value":"123456"},{"key":"filter[file_type]","value":"output_file"},{"key":"extra_fields[files]","value":"url"}],"variable":[]}},"response":[{"id":"1d7e1372-1868-4615-896f-f4a7013fa51b","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/files?filter[document_id]=123456&filter[file_type]=output_file&extra_fields[files]=url","protocol":"https","host":["api","parashift","io"],"path":["v2","files"],"query":[{"key":"filter[document_id]","value":"123456"},{"key":"filter[file_type]","value":"output_file"},{"key":"extra_fields[files]","value":"url"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:43:14 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1000"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"b2976370d08ed62cd9c6c69a4087f055\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"f9b26953527bdac3e377e6691a6da4c6"},{"key":"X-Runtime","value":"0.122286"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"173818653\",\n \"type\": \"files\",\n \"attributes\": {\n \"record_id\": \"20073826\",\n \"record_type\": \"documents\",\n \"file_type\": \"output_file\",\n \"mime_type\": \"application/pdf\",\n \"file_name\": \"20073826.pdf\",\n \"index\": 0,\n \"url\": \"https://storage.parashift.io/myuniquedownloadstring\",\n \"meta\": {},\n \"created_at\": \"2025-03-12T12:12:56.905163Z\"\n }\n }\n ],\n \"meta\": {}\n}"}],"_postman_id":"dc3252bb-10e5-4f27-b6c5-2ac2d2b41830"},{"name":"List input files of a batch including URL","id":"58648e9d-0774-4b40-a04a-f71cb8b86481","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/files?filter[batch_id]=1234567&filter[file_type]=input_file&extra_fields[files]=url","description":"By using this request, a download link is created with which the file can be downloaded. This link expires after 30 minutes.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","files"],"host":["api","parashift","io"],"query":[{"key":"filter[batch_id]","value":"1234567"},{"key":"filter[file_type]","value":"input_file"},{"key":"extra_fields[files]","value":"url"}],"variable":[]}},"response":[{"id":"e2b117b9-5bcc-433e-81b8-dba3e576b54d","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"https://api.parashift.io/v2/files?filter[batch_id]=1234567&filter[file_type]=input_file&extra_fields[files]=url","protocol":"https","host":["api","parashift","io"],"path":["v2","files"],"query":[{"key":"filter[batch_id]","value":"1234567"},{"key":"filter[file_type]","value":"input_file"},{"key":"extra_fields[files]","value":"url"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:43:55 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"2022"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"51b2f25d79aeeda2d081f6dc8672b939\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"81eb7025eaa4a225075efc8a2267ff56"},{"key":"X-Runtime","value":"0.140123"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"141717081\",\n \"type\": \"files\",\n \"attributes\": {\n \"record_id\": \"1002718374\",\n \"record_type\": \"batches\",\n \"file_type\": \"input_file\",\n \"mime_type\": \"application/pdf\",\n \"file_name\": \"Correspondence5-1.pdf\",\n \"index\": 1,\n \"url\": \"https://storage.parashift.io/myuniquedownloadstring\",\n \"meta\": {},\n \"created_at\": \"2024-10-01T16:13:01.135600Z\"\n }\n },\n {\n \"id\": \"141717080\",\n \"type\": \"files\",\n \"attributes\": {\n \"record_id\": \"1002718374\",\n \"record_type\": \"batches\",\n \"file_type\": \"input_file\",\n \"mime_type\": \"application/pdf\",\n \"file_name\": \"Correspondence5-1.pdf\",\n \"index\": 0,\n \"url\": \"https://storage.parashift.io/myuniquedownloadstring\",\n \"meta\": {},\n \"created_at\": \"2024-10-01T16:13:01.042352Z\"\n }\n }\n ],\n \"meta\": {}\n}"}],"_postman_id":"58648e9d-0774-4b40-a04a-f71cb8b86481"},{"name":"Show file","id":"d8dbee5b-50c4-4c23-941e-521ce67988a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/files/9876543","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","files","9876543"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"3e201819-16d1-488a-b4e4-127b099d45ed","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/files/9876543"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:46:09 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"288"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"f4fd6cab11c6146217233c99aa12e5c5\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"71693005519d2ea079763973942512f7"},{"key":"X-Runtime","value":"0.126936"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"173818549\",\n \"type\": \"files\",\n \"attributes\": {\n \"record_id\": \"1013756793\",\n \"record_type\": \"pages\",\n \"file_type\": \"color_jpeg\",\n \"mime_type\": \"image/jpeg\",\n \"file_name\": \"e5b469a1-9f0d-4f1e-a930-558a57c83c2c.jpeg\",\n \"index\": 0,\n \"meta\": {\n \"width\": 1932,\n \"height\": 2500\n },\n \"created_at\": \"2025-03-12T12:12:39.575505Z\"\n }\n },\n \"meta\": {}\n}"}],"_postman_id":"d8dbee5b-50c4-4c23-941e-521ce67988a5"}],"id":"b66d93a5-8cfd-4991-a4b9-17f1c835cc06","description":"Within the Parashift Platform, a Batch has Pages (generated from the batch's input_files). Pages can be assigned to a Document (in separation). Pages have a color_jpeg file. A detailed description can be found in Batches, Documents, Files, Pages.
\nIn Parashift, users can leave comments directly in a document - whether to ask questions or to support internal workflows and collaboration.
\nUsing the document_types endpoint, you can list all available document types along with their associated fields and fieldsets, including the data type of each field.
Parashift supports the integration of both master and transactional data, such as vendor master data or account assignment lists.
\nTo make this data accessible within Parashift, it must be uploaded to the platform.
\nThe supported base formats are:
\nExcel files (.xlsx)
SQLite databases (.sqlite3)
When using Excel, each sheet is treated as a separate table, and the first row is interpreted as the column header.
\nImportant: Whenever you upload data, all tables must be included in the file.
\nThe upload will completely replace the existing dataset:
\nAll existing tables will be deleted.
\nNew tables from the uploaded file will be created.
\nIf a table with the same name exists, it will be overwritten.
\nMake sure your upload always includes the full set of required tables.
\nThis step is required if the process starts in the external system rather than in the Parashift Platform. To improve batch identification, it is recommended to provide the external system's ID as external_id, e.g., \"EX0000001\".
The file(s) must be provided in Base64 encoding.
\nThe following parameters determine the processing of the document.
\nIf the classification_scope is empty, the classification module considers all available document types to classify the document. However, the classification_scope can also be restricted to a specific document type or a defined set of document types.
The classification and recognition in the Parashift Platform return a confidence value. Thresholds in the configuration determine which documents require manual post-processing. If the parameter validation_required = true is set, the document is held in the Parashift Platform and awaits user interaction for confirmation if at least one threshold is not met. If validation_required = false, no user interaction occurs, and the document is processed and completed directly in any case.
The upload_profile defines the workflow process, such as classification thresholds. By default, it is set to client.
The variable not_for_training indicates whether user interactions with a document are included in the training. When validation_required = false, it is recommended to set not_for_training = true
.
In the response of the request, the document_idis returned under \"data\".\"id\", e.g., 20117011. The initial status of a document is pending. The internal workflow then begins with the classification of the document, followed by the extraction of the relevant values.
The processing time of a document depends on its size and the load on the Parashift Platform. Additionally, it is influenced by whether user interactions are required or not.
\nIf webhooks are set up to notify about the completion of a document, it is still recommended to implement regular polling as a fallback in case a notification is lost. Depending on the use case, the polling interval should be adjusted, e.g., every minute for integrations that do not use webhooks.
\nThe request lists all documents that have been fully processed in the Parashift Platform, in this case, the document 20117011 with the external_id = EX0000001.
The document type can be retrieved from the document_type_identifier attribute and used to trigger the corresponding workflow in the external system.
The document data is attached in the included section. The result is a flat list of all document fields, identified by the fieldset_identifier, identifier, and item_index (relevant for repeatable fields: 0 = first row, 1 = second row, null = header field), including the corresponding value.
The format of the value depends on the data type of the field:
\nFloats are returned using a point as the decimal separator, e.g., \"123.4\".
Dates are returned in the format \"yyyy-mm-dd\", e.g., \"2025-03-13\".
If a value is not found in the document, the field is always present but with the value null.
In general, output_files can optionally be included in the included section by appending the following parameters to the request: ,output_files&extra_fields[files]=url. This will ensure that the included section contains an output file in PDF format generated by the Parashift Platform.
For displaying images in the external system and highlighting fields, it is recommended to use the images from the Parashift Platform, as they account for any rotations or distortions.
\nThis request lists the individual pages of the document, including a temporary download link that is valid for 30 minutes.
\nEnsure that only the document_index specifies the page number (zero-based). The meta-information includes the width and height of the image in pixels. The field value coordinates are given as percentages and can be calculated using the provided pixel dimensions.
After retrieving the fields and storing them in the appropriate fields within the external system, the process can be marked as exported in the Parashift Platform. This ensures that the document will no longer appear in request 2b).
The Parashift Platform trains on vectorized data, allowing documents to be easily deleted after processing without impacting recognition quality. However, for traceability and potential support case clarifications, it is recommended to retain documents in the Parashift Platform for 30 to 90 days.
\nTo minimize errors, the platform only supports deleting one document per request. Deletion removes all CID data, while the document cover is retained.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"e3e5aa0d-edbb-483c-9c09-2b191086abf8","name":"204 No Content","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456"},"_postman_previewlanguage":"","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"990216f8-79c9-4de6-8e18-c07e2b622179"}],"id":"18dc5859-c802-4bf4-8f83-645831fbd574","description":"A single document is processed by the Parashift Platform. It is classified into a document type and then relevant data points get extracted.
\nUpload a document into the Parashift Platform.
\n(optional) by API
\nby user interface
\nby email
\nGet finished documents
\n(optional) using Webhooks to receive ids of finished documents
\nRegularly poll for a list of finished documents
\nIterate over this list
\nFetch document & field values
\n(optional) receive document image as JPEG to highlight fields in external system
\nmark document as exported
\n(optional) delete document
\nThis step is required if the process starts in the external system rather than in the Parashift Platform. To improve batch identification, it is recommended to provide the external system's ID as external_id, e.g., \"EX0000001\".
The file(s) must be provided in Base64 encoding.
\nEach document created from the batch is initially assigned the same name and external_id. While the name can change over time, the external_id remains the same.
The following parameters determine the processing of each document of the batch.
\nIf the classification_scope is empty, the classification module considers all available document types to classify the documents. However, the classification_scope can also be restricted to a specific document type or a defined set of document types.
The classification and recognition in the Parashift Platform return a confidence value. Thresholds in the configuration determine which documents require manual post-processing. If the parameter validation_required = true is set, the documents is held in the Parashift Platform and awaits user interaction for confirmation if at least one threshold is not met. If validation_required = false, no user interaction occurs, and the documents are processed and completed directly in any case.
The upload_profile defines the workflow process, such as classification thresholds. By default, it is set to client.
In the response of the request, the batch_idis returned under \"data\".\"id\", e.g., 1007551546. The initial status of a batch is pending. The internal workflow then begins with the separation into single documents, the classification of each document, followed by the extraction of the relevant values.
The processing time of a document depends on its size and the load on the Parashift Platform. Additionally, it is influenced by whether user interactions are required or not.
\nIf webhooks are set up to notify about the completion of a document, it is still recommended to implement regular polling as a fallback in case a notification is lost. Depending on the use case, the polling interval should be adjusted, e.g., every minute for integrations that do not use webhooks.
\nThe request lists all documents that have been fully processed in the Parashift Platform, in this case, the document 20131850 of batch 1007551546 with the external_id = EX0000001.
If batch processing should only start once all documents in the batch are completed, the request must be adjusted to filter for all documents with the specified batch_id or external_id. Processing should only begin once all documents have the status done.
The document type can be retrieved from the document_type_identifier attribute and used to trigger the corresponding workflow in the external system.
The document data is attached in the included section. The result is a flat list of all document fields, identified by the fieldset_identifier, identifier, and item_index (relevant for repeatable fields: 0 = first row, 1 = second row, null = header field), including the corresponding value.
The format of the value depends on the data type of the field:
\nFloats are returned using a point as the decimal separator, e.g., \"123.4\".
Dates are returned in the format \"yyyy-mm-dd\", e.g., \"2025-03-13\".
If a value is not found in the document, the field is always present but with the value null.
In general, output_files can optionally be included in the included section by appending the following parameters to the request: ,output_files&extra_fields[files]=url. This will ensure that the included section contains an output file in PDF format generated by the Parashift Platform.
For displaying images in the external system and highlighting fields, it is recommended to use the images from the Parashift Platform, as they account for any rotations or distortions.
\nThis request lists the individual pages of the document, including a temporary download link that is valid for 30 minutes.
\nEnsure that only the document_index specifies the page number (zero-based). The meta-information includes the width and height of the image in pixels. The field value coordinates are given as percentages and can be calculated using the provided pixel dimensions.
After retrieving the fields and storing them in the appropriate fields within the external system, the process can be marked as exported in the Parashift Platform. This ensures that the document will no longer appear in request 2b).
The Parashift Platform trains on vectorized data, allowing documents to be easily deleted after processing without impacting recognition quality. However, for traceability and potential support case clarifications, it is recommended to retain documents in the Parashift Platform for 30 to 90 days.
\nIn general, deleting the last document of a batch also deletes the batch itself. If a batch is deleted, all associated documents are removed as well.
\nTo minimize errors, the platform only supports deleting one document/batch per request. Deletion removes all CID data, while the document/batch cover is retained.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"7fca34c1-0639-49d9-bb31-84e3326ec06d","name":"204 No Content delete document","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456"},"_postman_previewlanguage":"","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""},{"id":"0aadf35a-d6a0-411d-ba8c-3e465815989c","name":"204 No Content delete batch","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.parashift.io/v2/batches/1234567"},"_postman_previewlanguage":"","header":[{}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"cc84eaaa-7e46-4f90-b92c-c6ee87d6c5c4"}],"id":"ecdde256-f6aa-436f-93e9-83126c27c413","description":"A batch is processed by the Parashift Platform, which can contain multiple documents. It is separated into single documents. Each document gets classified into a document type and then relevant data points get extracted.
\nUpload a batch into the Parashift Platform.
\n(optional) by API
\nby user interface
\nby email
\nGet finished documents
\n(optional) using Webhooks to receive ids of finished documents
\nRegularly poll for a list of finished documents
\nIterate over this list
\nFetch document & field values and output_files
\n(optional) receive document image as JPEG to highlight fields in external system
\nmark document as exported
\n(optional) delete document/batch
\nThis request can be used to confirm the classification or as part of the feedback loop to improve the training of the classification model, please check the knowledge base article Feeback Loop.
\nNote: Reclassifying a document does not automatically remove the exported_at flag.
With this request, you can update values of existing fields, identified by its fieldset_identifier, identifier and item_index [null if non repeatable, 0 - n, if repeatable].
\nAs mentioned, you can only update existing fields here, not add new lines in position data, for example.
\nIt is important to send the coordinates [each attribute between 0 and 1, related to the page] and page_number [zero based].
\nThe format of the value depends on the data type of the field. Floats should be returned using the point as decimal separator, e.g. \"123.4\" and dates in format \"yyyy-mm-dd\", e.g. \"2025-03-13\".
\nBe careful as this can have a negative effect on the extraction models if the coordinates are not correct. The coordinates should be a little too small rather than too large, as otherwise incorrect fragments could end up in the field.
\nThis is part of the feedback loop to improve the training of the extraction model, please check the knowledge base article Feeback Loop.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456",""],"host":["api","parashift","io"],"query":[{"key":"include","value":"document_fields"}],"variable":[]}},"response":[{"id":"4a80c8d7-2b1f-4598-a8fb-5d82fdd135e7","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n\t\t\"id\": \"123456\",\r\n\t\t\"type\": \"documents\"\r\n\t},\r\n\t\"included\": [\r\n\t\t{\r\n\t\t\t\"type\": \"document_fields\",\r\n\t\t\t\"attributes\": {\r\n \"fieldset_identifier\": \"pp-sender-address\",\r\n \"identifier\": \"pp-sender-address-company-name\",\r\n \"item_index\": null,\r\n\t\t\t\t\"confirm_warnings\": true,\r\n\t\t\t\t\"external_value\": \"Pizza Züri\",\r\n\t\t\t\t\"page_number\": 0,\r\n\t\t\t\t\"coordinates\": {\r\n\t\t\t\t\t\"top\": 0.56,\r\n\t\t\t\t\t\"left\": 0.50,\r\n\t\t\t\t\t\"right\": 0.62,\r\n\t\t\t\t\t\"bottom\": 0.59\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t},\r\n {\r\n\t\t\t\"type\": \"document_fields\",\r\n\t\t\t\"attributes\": {\r\n \"fieldset_identifier\": null,\r\n \"identifier\": \"pp-document-date\",\r\n \"item_index\": null,\r\n\t\t\t\t\"confirm_warnings\": true,\r\n\t\t\t\t\"external_value\": \"2020-07-16\",\r\n\t\t\t\t\"page_number\": 0,\r\n\t\t\t\t\"coordinates\": {\r\n \"top\": 0.341,\r\n \"left\": 0.647,\r\n \"right\": 0.76,\r\n \"bottom\": 0.35\r\n }\r\n\t\t\t}\r\n\t\t}\r\n\t]\r\n\t\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.parashift.io/v2/documents/123456/?include=document_fields","protocol":"https","host":["api","parashift","io"],"path":["v2","documents","123456",""],"query":[{"key":"include","value":"document_fields"}]}},"_postman_previewlanguage":"json","header":[{},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"20073826\",\n \"type\": \"documents\",\n \"attributes\": {\n \"batch_id\": \"1007495019\",\n \"batch_index\": 0,\n \"classification_lower_threshold\": 0.0,\n \"classification_upper_threshold\": 0.9,\n \"created_at\": \"2025-03-12T12:12:34.535581Z\",\n \"custom_fields\": {\n \"SomeCustomField\": \"These custom fields cannot be queried.\",\n \"AnotherCustomField\": \"If you want to query for an external ID please use external_id.\",\n \"YetAnotherCustomField\": \"external_id can be queried and used for lookups to get your data back.\"\n },\n \"document_type_identifier\": \"pp-correspondence\",\n \"error_codes\": [],\n \"exported_at\": null,\n \"external_id\": \"EX1234567890\",\n \"language\": \"en\",\n \"language_confidence\": 0.9999939372619904,\n \"name\": \"It gets better and better\",\n \"not_for_training\": true,\n \"recognition_confidence\": 0.9698362122781529,\n \"sla_deadline\": \"2025-03-12T15:12:34.557918Z\",\n \"status\": \"done\",\n \"tags\": [\n \"Production\",\n \"New tag2\"\n ],\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:22:48.799621Z\",\n \"upload_configuration\": \"scan\",\n \"validation_required\": false,\n \"workflow_status\": \"done\",\n \"workflow_step\": \"qc\"\n },\n \"relationships\": {\n \"comments\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/comments?filter[document_id]=20073826\"\n }\n },\n \"document_fields\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/document_fields?filter[document_id]=20073826\"\n },\n \"data\": [\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061824\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061825\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061826\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061827\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061828\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061829\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061830\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061831\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061832\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061833\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061834\"\n },\n {\n \"type\": \"document_fields\",\n \"id\": \"1059061835\"\n }\n ]\n },\n \"output_files\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/files?filter[document_id]=20073826&filter[file_type]=output_file\"\n }\n },\n \"pages\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/pages?filter[document_id]=20073826\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"1059061824\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": null,\n \"coordinates\": {},\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": null,\n \"recognition_confidence\": null,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-company-name\",\n \"item_index\": null,\n \"page_number\": null,\n \"prediction_value\": null,\n \"prediction_confidence\": null,\n \"status\": \"pending\",\n \"validation_status\": \"pending\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-13T11:53:07.822887Z\",\n \"user_value\": null,\n \"value\": null\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061825\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.1954615781330583,\n \"right\": 0.3063434760185663,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Badenerstrasse\",\n \"recognition_confidence\": 0.99992,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-street\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Badenerstrasse\",\n \"prediction_confidence\": 0.99997,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.239118Z\",\n \"user_value\": null,\n \"value\": \"Badenerstrasse\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061826\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99937,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3862815884476534,\n \"right\": 0.4342444559051057,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Zürich,\",\n \"recognition_confidence\": 0.99937,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-city\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Zürich\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.252434Z\",\n \"user_value\": null,\n \"value\": \"Zürich\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061827\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9998,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3465703971119133,\n \"right\": 0.3821557503867973,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"8048\",\n \"recognition_confidence\": 0.9998,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-postal-code\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"8048\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.267558Z\",\n \"user_value\": null,\n \"value\": \"8048\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061828\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99992,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"left\": 0.3104693140794224,\n \"right\": 0.3408973697782362,\n \"bottom\": 0.1636726546906188\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"558,\",\n \"recognition_confidence\": 0.99993,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-house-number\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"558\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.282760Z\",\n \"user_value\": null,\n \"value\": \"558\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061829\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99896,\n \"coordinates\": {\n \"top\": 0.1712574850299401,\n \"left\": 0.1186178442496132,\n \"right\": 0.4223826714801444,\n \"bottom\": 0.1808383233532934\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"recognition_confidence\": 0.99917,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Ristorante & Pizzeria VESUVIO da Antonio\",\n \"prediction_confidence\": 0.99978,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.297010Z\",\n \"user_value\": null,\n \"value\": \"Ristorante & Pizzeria VESUVIO da Antonio\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061830\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99989,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.1181021144920062,\n \"right\": 0.2243424445590511,\n \"bottom\": 0.217564870259481\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Glatttalstrasse\",\n \"recognition_confidence\": 0.99991,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-street\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Glatttalstrasse\",\n \"prediction_confidence\": 0.99998,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.313704Z\",\n \"user_value\": null,\n \"value\": \"Glatttalstrasse\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061831\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99972,\n \"coordinates\": {\n \"top\": 0.2083832335329341,\n \"left\": 0.2264053635894791,\n \"right\": 0.2460030943785456,\n \"bottom\": 0.217564870259481\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"40\",\n \"recognition_confidence\": 0.99973,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-house-number\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"40\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.326626Z\",\n \"user_value\": null,\n \"value\": \"40\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061832\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99986,\n \"coordinates\": {\n \"top\": 0.2263473053892216,\n \"left\": 0.1181021144920062,\n \"right\": 0.1526560082516761,\n \"bottom\": 0.237125748502994\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"8052\",\n \"recognition_confidence\": 0.99987,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-postal-code\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"8052\",\n \"prediction_confidence\": 1.0,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.335607Z\",\n \"user_value\": null,\n \"value\": \"8052\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061833\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99897,\n \"coordinates\": {\n \"top\": 0.2259481037924152,\n \"left\": 0.1578133058277462,\n \"right\": 0.2068076328004126,\n \"bottom\": 0.2367265469061876\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Zürich,\",\n \"recognition_confidence\": 0.99898,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": \"pp-receiver-address\",\n \"identifier\": \"pp-receiver-address-city\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Zürich\",\n \"prediction_confidence\": 0.99999,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.343573Z\",\n \"user_value\": null,\n \"value\": \"Zürich\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061834\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.99322,\n \"coordinates\": {\n \"top\": 0.3377245508982036,\n \"left\": 0.1181021144920062,\n \"right\": 0.4657039711191336,\n \"bottom\": 0.3584830339321357\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Cancel Pizza selling agreement\",\n \"recognition_confidence\": 0.99991,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-subject\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"Cancel Pizza selling agreement\",\n \"prediction_confidence\": 0.99331,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.352534Z\",\n \"user_value\": null,\n \"value\": \"Cancel Pizza selling agreement\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n {\n \"id\": \"1059061835\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": 0.9988,\n \"coordinates\": {\n \"top\": 0.3405189620758483,\n \"left\": 0.6462093862815884,\n \"right\": 0.7663744198040227,\n \"bottom\": 0.3548902195608782\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"date\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"16.07.2020\",\n \"recognition_confidence\": 0.99961,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": null,\n \"fieldset_identifier\": null,\n \"identifier\": \"pp-document-date\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": \"2020-07-16\",\n \"prediction_confidence\": 0.99919,\n \"status\": \"done\",\n \"validation_status\": \"skipped\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-12T12:12:57.360322Z\",\n \"user_value\": null,\n \"value\": \"2020-07-16\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n }\n ],\n \"meta\": {}\n}"}],"_postman_id":"aed19659-9b7e-4a3f-a4e5-f299d500edfc"},{"name":"Patch field via field id","id":"bf881310-9155-4ab8-b45e-a303a1db4422","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"id\": \"123456789\",\r\n \"type\": \"document_fields\",\r\n \"attributes\": {\r\n \"coordinates\": {\r\n \"top\": 0.1528942115768463,\r\n \"left\": 0.1186178442496132,\r\n \"right\": 0.1897885507993811,\r\n \"bottom\": 0.1636726546906188\r\n },\r\n \"confirm_warnings\" : true,\r\n \"page_number\": 0,\r\n \"external_value\": \"Pizza Züri\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.parashift.io/v2/document_fields/123456789","description":"With this request, you can update the value of an existing field, identified by its id.
\nIt is important to send the coordinates [each attribute between 0 and 1, related to the page] and page_number [zero based].
\nThe format of the value depends on the data type of the field. Floats should be returned using the point as decimal separator, e.g. \"123.4\" and dates in format \"yyyy-mm-dd\", e.g. \"2025-03-13\".
\nBe careful as this can have a negative effect on the extraction models if the coordinates are not correct. The coordinates should be a little too small rather than too large, as otherwise incorrect fragments could end up in the field.
\nThis is part of the feedback loop to improve the training of the extraction model, please check the knowledge base article Feeback Loop.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","document_fields","123456789"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"0ffa6848-1b86-4687-bb40-b0b30340aca3","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"id\": \"123456789\",\r\n \"type\": \"document_fields\",\r\n \"attributes\": {\r\n \"coordinates\": {\r\n \"top\": 0.1528942115768463,\r\n \"left\": 0.1186178442496132,\r\n \"right\": 0.1897885507993811,\r\n \"bottom\": 0.1636726546906188\r\n },\r\n \"confirm_warnings\" : true,\r\n \"page_number\": 0,\r\n \"external_value\": \"Pizza Züri\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.parashift.io/v2/document_fields/123456789"},"_postman_previewlanguage":"json","header":[{},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"1059061824\",\n \"type\": \"document_fields\",\n \"attributes\": {\n \"confidence\": null,\n \"coordinates\": {\n \"top\": 0.1528942115768463,\n \"bottom\": 0.1636726546906188,\n \"left\": 0.1186178442496132,\n \"right\": 0.1897885507993811\n },\n \"created_at\": \"2025-03-12T12:12:49.619289Z\",\n \"discarded_at\": null,\n \"data_type\": \"string\",\n \"document_id\": \"20073826\",\n \"recognition_value\": \"Pizza Züri,\",\n \"recognition_confidence\": 0.97365,\n \"extraction_lower_threshold\": 0.3,\n \"extraction_upper_threshold\": 0.95,\n \"external_value\": \"Pizza Züri\",\n \"fieldset_identifier\": \"pp-sender-address\",\n \"identifier\": \"pp-sender-address-company-name\",\n \"item_index\": null,\n \"page_number\": 0,\n \"prediction_value\": null,\n \"prediction_confidence\": null,\n \"status\": \"in_progress\",\n \"validation_status\": \"done\",\n \"tenant_id\": \"1385\",\n \"updated_at\": \"2025-03-13T11:21:24.378770Z\",\n \"user_value\": null,\n \"value\": \"Pizza Züri\"\n },\n \"relationships\": {\n \"document\": {\n \"links\": {\n \"related\": \"https://api.parashift.io/v2/documents/20073826\"\n }\n }\n }\n },\n \"meta\": {}\n}"}],"_postman_id":"bf881310-9155-4ab8-b45e-a303a1db4422"},{"name":"Delete field value via identifiers","id":"ecbb27fe-609f-40a6-9498-5671f1d181d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456/document_fields/pp-sender-address/pp-sender-address-company-name","description":"With this request, you can delete the value of an existing field, identified by its item_index, fieldset_identifier and identifier.
\nThe URL is composed of /fieldset_identifier/item_index/identifier. If any of these values are null, they must be omitted.
This command can also be used to delete entire blocks by specifying only a partial path. For example, using /fieldset_identifier will delete all fields within the fieldset at once.
The field itself is not deleted, only the value and associated attributes such as coordinates, page number, confidences, ....
\nThis is part of the feedback loop to improve the training of the extraction model, please check the knowledge base article Feeback Loop.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","documents","123456","document_fields","pp-sender-address","pp-sender-address-company-name"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"dcaf29a2-a126-4428-826a-0fb687e99a9d","name":"204 No Content - Deletion of header field","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456/document_fields/pp-document-date"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:31:09 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1014"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"144777852ddd60e215758a3ce42477ad\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"4f994b9fe77dddb104ed63976a12e714"},{"key":"X-Runtime","value":"0.207110"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":""},{"id":"e656f4f8-6dfe-448b-b8db-d03249902efc","name":"204 No Content - Deletion of header field, part of a fieldset","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456/document_fields/pp-sender-address/pp-sender-address-company-name"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:31:09 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1014"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"144777852ddd60e215758a3ce42477ad\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"4f994b9fe77dddb104ed63976a12e714"},{"key":"X-Runtime","value":"0.207110"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":""},{"id":"cb765d8b-dc6e-4b2f-ae6b-fba6dd4eb7a0","name":"204 No Content - Deletion of all fields of a fieldset","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456/document_fields/pp-sender-address"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:31:09 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1014"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"144777852ddd60e215758a3ce42477ad\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"4f994b9fe77dddb104ed63976a12e714"},{"key":"X-Runtime","value":"0.207110"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":""},{"id":"c679e932-93a3-4e3c-ab70-12a41ed27115","name":"204 No Content - Deletion of repeatable fields","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.parashift.io/v2/documents/123456/document_fields/pp-p2p-line-items/0/pp-p2p-line-item-quantity"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:31:09 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1014"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"144777852ddd60e215758a3ce42477ad\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"4f994b9fe77dddb104ed63976a12e714"},{"key":"X-Runtime","value":"0.207110"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ecbb27fe-609f-40a6-9498-5671f1d181d5"},{"name":"Delete field value via field id","id":"d08f84ad-1755-4928-ab90-b9ada01f05f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"https://api.parashift.io/v2/document_fields/123456789","description":"With this request, you can delete the value of an existing field, identified by its id.
\nThe field itself is not deleted, only the value and associated attributes such as coordinates, page number, confidences, ....
\nThis is part of the feedback loop to improve the training of the extraction model, please check the knowledge base article Feeback Loop.
\n","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","document_fields","123456789"],"host":["api","parashift","io"],"query":[],"variable":[]}},"response":[{"id":"8da4117f-4907-4e41-8cfd-6653c970374a","name":"204 No Content","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.parashift.io/v2/document_fields/123456789"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Date","value":"Wed, 02 Oct 2024 09:31:09 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1014"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"144777852ddd60e215758a3ce42477ad\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'none'; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https:; style-src 'self' https: 'unsafe-inline'; connect-src 'self'; report-uri https://parashift.report-uri.com/r/d/csp/enforce"},{"key":"X-Request-Id","value":"4f994b9fe77dddb104ed63976a12e714"},{"key":"X-Runtime","value":"0.207110"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"vary","value":"Accept, Origin"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d08f84ad-1755-4928-ab90-b9ada01f05f8"}],"id":"fc2479a7-4b73-4417-b14b-661f7336ce7e","description":"The Parashift Platform offers API functions that allow writing back values after processing to improve the classification or extraction model.
\nParticularly when submitting extraction data, it is essential to ensure a correct implementation, especially when transmitting the correct coordinates, as inaccuracies can significantly impact recognition quality.
\nPlease check the knowledge base article Feeback Loop.
\n","_postman_id":"fc2479a7-4b73-4417-b14b-661f7336ce7e","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}}}],"id":"fd067efb-d80a-4186-9ac6-168ba0a3d904","description":"This chapter provides real-world integration scenarios and best practices to help you seamlessly incorporate our API into your workflows. Whether you're automating document processing, extracting fields, or integrating with third-party systems, these examples illustrate common use cases and efficient implementation strategies.
\nEach example includes step-by-step guidance, code snippets, and best practices to ensure a smooth and reliable integration experience. Use these as a reference to accelerate your development and optimize your processes.
\n","_postman_id":"fd067efb-d80a-4186-9ac6-168ba0a3d904","auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},"isInherited":true,"source":{"_postman_id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","id":"24903f28-3c81-4a22-a284-8f2c149ef6a0","name":"Parashift Platform API v2","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"token":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"}},"event":[{"listen":"prerequest","script":{"id":"d0509c3e-c970-4d5a-9810-373f0ab869a6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5cc9f6b2-d781-4468-b7e5-6dc9c4f2f228","type":"text/javascript","exec":[""]}}],"variable":[{"key":"token","value":"GetYourOwnApiKeyInTheParashiftPlatformUrlAppDotParasfhiftDotIoThenNavigateInTheLeftHandMenuToDeveloperToApiKey"},{"key":"document_id","value":"123456"},{"key":"document_field_id","value":"123456789"},{"key":"batch_id","value":"1234567","type":"string"},{"key":"page_id","value":"12345678","type":"string"},{"key":"file_id","value":"9876543","type":"string"},{"key":"comment_id","value":"26535","type":"string"},{"key":"document_type_id","value":"815","type":"string"}]}