Company Details
GET {{baseUrl}}/cas/companies/:companyId?details=true
Get details for a single company.
Response Body
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| id | String | Yes | |
| name | String | Yes | |
| number | String | No | This will return an ACN for Australian Companies and the NZCN (not NZBN) for New Zealand Companies. |
| agentId | Number | No | |
| incorporationDate | String | No | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
| annualReviewDate | String | No | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
| businessNumber | Number | No | ABN / NZBN |
| registrationState | String | No | Must be one of 'ACT'/'NSW'/'VIC'/'QLD'/'SA'/'WA'/'TAS'/'NT' |
| jurisdiction | String | Yes | Currently only 'Australia' is allowed |
| type | Object | No | See table below |
| registered | boolean | Yes | false companies will show up in company registrations |
type object
Note: Within Australia, only certain combinations of companyType, companyClass and companySubClass are valid
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| companyType | String | Yes | Must be one of 'Small Proprietary'/'Large Proprietary'/'Public Company' |
| companyClass | String | Yes | Must be one of 'Limited by Shares'/'Limited by Guarantee'/'Limited by Shares and Guarantee'/'Unlimited'/'No Liability' |
| companySubClass | String | Yes | Must be one of 'None'/'Superannuation Trustee Company'/'Non Profit Company'/'Home Unit Company'/'Listed'/'Unlisted'/'Section 150 License'/'Unlisted Non Profit |
details object (Optional Paramter)
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| abn | No | No | |
| asicAgentNumber | String | No | |
| annualReviewStatus | String | Yes | |
| annualReviewStatusDate | String | No | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
| clientNumber | No | No | |
| labels | String[] | No | Name of labels associated with the company |
| superFundContactIds | No | If company is linked as Corporate Trustee of an SMSF, the ContactId will be returned |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
details | boolean | [example = 'true']Enabling this option will display Annual Review Date, Annual Review Status, Annual Review Status Date, ASIC agent number and labels for the company. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"agentId":null,"annualReviewDate":"2020-06-29","businessNumber":null,"details":{"abn":null,"annualReviewStatus":"UPCOMING","annualReviewStatusDate":"2020-06-29","asicAgentNumber":null,"clientNumber":null,"labels":[],"superFundContactIds":[1062973]},"id":"889ff4b7-766f-4b30-b33e-c2cdce97ff03","incorporationDate":"2007-06-29","jurisdiction":"Australia","name":"My Super Trustee","number":"002999993","registered":true,"registrationState":"ACT","type":{"companyClass":"Limited by Shares","companySubClass":"None","companyType":"Small Proprietary"}}