List of company addresses
GET {{baseUrl}}/companies/:companyId/addresses?offset={{offset}}&limit={{limit}}
Returns a list of company addresses for a given company
Query Parameters
| Form Parameter | type | Mandatory | Description |
|---|
| offset | number | Required | Example = 0 |
| limit | number | Required | Example = 500 |
Response Body
| Key | Datatype | Mandatory | Constraints/Comments |
|---|
| companyId | Number | | |
| addressId | Number | | |
| effectiveDate | String | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601. | |
| id | Number | Yes | |
| officeOccupier | String | Only valid for Registered Office Address | |
| type | String | Must be one of 'Registered Office Address'/'Business Address'/'Postal Address'’/’Meeting Address’ | |
| prepareForm | Boolean | Change to be notified to ASIC within 28 days on a Form 484 Change to Company Details. | |
shareType object
| Key | Datatype | Mandatory | Constraints |
|---|
| paid | Float | Yes | Can be an integer or floating point number. Example: 10, 255, 3.14159 |
| unpaid | Float | Yes | Can be an integer or floating point number. Example: 10, 255, 3.14159 |
| currency | String | Yes | an ISO currency code https://en.wikipedia.org/wiki/ISO_4217 |
| description | String | No | |
| shareClass | Object | Yes | See table below |
shareClass object
| Key | Datatype | Mandatory | Constraints |
|---|
| descriptions | String | Yes | |
| cCode | String | Yes | |
Additional keys
| Key | Datatype | Mandatory | Constraints |
|---|
| offset | Number | Yes | |
| limit | Number | Yes | |
| total | Number | Yes | |
Request Params
| Key | Datatype | Required | Description |
|---|
offset | string | | number |
limit | string | | number |
| Key | Datatype | Required | Description |
|---|
Authorization | string | | |
RESPONSES
status: OK
{"companyId":"7d9f84cc-4801-40ce-aeb5-42e29e91b807","companyAddresses":[{"addressId":1460,"effectiveDate":"2021-01-29","id":11057,"officeOccupier":null,"prepareForm":true,"type":"Registered Office Address"},{"addressId":1460,"effectiveDate":"2021-01-29","id":11058,"officeOccupier":null,"prepareForm":true,"type":"Business Address"},{"addressId":1460,"effectiveDate":"2021-01-29","id":11059,"officeOccupier":null,"prepareForm":false,"type":"Postal Address"},{"addressId":1460,"effectiveDate":"2021-01-29","id":11060,"officeOccupier":null,"prepareForm":false,"type":"Meeting Address"},{"addressId":1460,"effectiveDate":"2021-01-29","id":11061,"officeOccupier":null,"prepareForm":false,"type":"Members Register Address"},{"addressId":1460,"effectiveDate":"2021-01-29","id":11062,"officeOccupier":null,"prepareForm":false,"type":"Debentures Register Address"},{"addressId":1460,"effectiveDate":"2021-01-29","id":11063,"officeOccupier":null,"prepareForm":false,"type":"Directors Shareholdings Address"},{"addressId":1460,"effectiveDate":"2021-01-29","id":11064,"officeOccupier":null,"prepareForm":false,"type":"Registers Address"}],"limit":500,"offset":0,"total":8}