Documents

Update document metadata or values

patch/api/v1/documents/{document_id}

Request

  • Base URL: https://www.ifillpdf.com
  • URL: https://www.ifillpdf.com/api/v1/documents/{document_id}
  • Auth: HTTP bearer

Path parameters

document_idstring uuid required

Request body

namestring
descriptionstring nullable
valuesDocumentValues

Example request

{
  "suggested_entities": [
    {
      "id": "declarant",
      "label": "Declarant",
      "color": "#6D7BFF"
    }
  ]
}

Response

Updated document.

document_idstring uuid required
namestring required
status'analyzing' | 'completed' | 'failed' required
statestring required
errorstring nullable
page_countinteger required
page_images_countinteger
preview_image_urlstring nullable
document_typestring nullable
analysis_started_atstring date-time nullable
analysis_completed_atstring date-time nullable
created_atstring date-time
updated_atstring date-time
valuesDocumentValues

Changes

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