Archive document extraction

Archives an inbox document as the app's Archive does: the bank line picked as its payment is let go, its duplicate pairs are settled, and who archived it is recorded. All of it happens in one step: the answer is the document as archived, with its new version and ETag (use that ETag for a later call, such as documentExtraction.restore), and the change feed carries one document_extraction.archived naming archived_at and, when letting the line go put another payment_account_id on the document, that field too. documentExtraction.restore brings the line and the duplicate question back. A converted, merged or still-processing document answers 409 document_extraction_history_protected. Requires If-Match with the document ETag and an Idempotency-Key. Requires the document-extractions:write OAuth scope and the delete_document_extractions permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

string

Required. ETag from the latest representation; a stale value returns 412 precondition_failed. Send this header, not the standard If-Match: some HTTP intermediaries evaluate a standard If-Match themselves and can answer 412 even though the change was applied. Never send both; both with different ETags returns 400 conflicting_precondition_headers.

string
deprecated

Accepted with the same value and meaning as Cybooks-If-Match, but do not send it: an intermediary can answer 412 to it after the change was applied. Send Cybooks-If-Match instead.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*