Sign in

v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB
Documents

Get document details

get/v1/applications/{applicationId}/documents/{documentId}

Path parameters

applicationIdstring required
Example:application_tz4a98xxat96iws9zmbrgj3a
documentIdstring required
Example:doc_tz4a98xxat96iws9zmbrgj3a

Response

Success

_idstring required
_applicationstring required

The application that this document belongs to.

namestring required

The filename of this document.

status'pending' | 'processing' | 'completed' | 'failed' required

The status of a document:

  • pending The document record exists, but the file has not yet been fully uploaded.

  • processing Akahu Apply is extracting and enriching the data from this document.

  • completed This document has been successfully processed.

  • failed This document has not been successfully processed. See the failure_reason for more detail.

created_atstring date-time required

The date that this document was created.

updated_atstring date-time required

The date that this document was last updated at.

expires_atstring date-time

Expiry for the document, after which the record will be deleted. Expiry varies as the document progresses through its lifecycle:

  • While the document has a status of pending, expiry is short lived, ensuring that the record is cleaned up quickly if a file is never uploaded.

  • After the document upload has been received, a 1 year expiry is set, after which the document and all associated data will be permanently deleted.

Example response

{
  "_id": "doc_tz4a98xxat96iws9zmbrgj3a",
  "_application": "application_tz4a98xxat96iws9zmbrgj3a",
  "channel": {
    "_id": "sharing_request_tz4a98xxat96iws9zmbrgj3a"
  },
  "source": {
    "_id": "oneoff_ob_connection_tz4a98xxat96iws9zmbrgj3a"
  }
}