Document Details
GET {{baseUrl}}/companies/:companyId/documents/:documentId
Returns Document Details Including All Attachments for a Company.
Response Body
Key | Datatype | Mandatory | Constraints |
---|---|---|---|
traceNumber | String | Yes | |
name | String | Yes | |
documentDate | String | Yes | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
asicDocNumber | String | No | |
attachments | List of Objects | Yes | Can be empty |
attachments objects
Key | Datatype | Mandatory | Constraints |
---|---|---|---|
id | Number | Yes | |
name | String | Yes | |
creationDate | String | Yes | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
status objects
Key | Datatype | Mandatory | Constraints |
---|---|---|---|
id | Number | Yes | |
createdBy | String | Yes | |
type | String | Yes | Descriptive name of Status |
typeId | Number | Yes | |
effectiveDate | String | Yes | Created Date of status |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"id":1007308,"traceNumber":"384995","asicDocNumber":null,"name":"Form - 484 CHANGE TO COMPANY DETAILS","documentDate":"2019-06-27","attachments":[{"id":"F871915","name":"Register of Officers.pdf","creationDate":"2019-06-27"},{"id":"UA17516","name":"User Uploaded Document.pdf","creationDate":"2020-01-15"}],"status":{"id":925386,"createdBy":"Jeremiah Noah","type":"DOCUMENT PREPARED","typeId":2,"effectiveDate":"2019-06-27"}}