External
Document Platform

Get document processing status

Retrieve the processing status and metadata for a specific document

get/v1/building_owners/{buildingOwnerId}/buildings/{buildingId}/documents/{documentId}/status

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/v1/building_owners/{buildingOwnerId}/buildings/{buildingId}/documents/{documentId}/status
  • Auth: API key in header x-api-key

Path parameters

buildingOwnerIdstring required

ID of the building owner

buildingIdstring required

ID of the building

documentIdstring required

ID of the document

Response

Default Response

extracted_textboolean
extracted_fileboolean
uncompressed_packageboolean
valid_fileboolean
invalid_fileboolean
categorisedboolean
skip_extract_fileboolean
text_extraction_errorboolean
document_idstring
filenamestring
building_idstring
building_categorystring nullable
corruptboolean
sizeinteger

Changes

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