| Info | ||
|---|---|---|
| ||
This documentation relates to Version 1, the current version of the greenID Business API. Version 1 became available to customers as of . |
Authentication
HTTP basic authentication is used for accessing the endpoint. The username is a customer account ID, and the password is a customer's GreenID web services password.
...
| Field Name | Description | Type | Example |
|---|---|---|---|
| countryCode | The address country code i.e. a two digit code. | String | "NZ" |
| countryName | The human-readable version of the country name. | String | "New Zealand" |
| fullAddress | The full address in a single String | String | "67 HAVEN ROAD, NELSON 7010, NEW ZEALAND" |
| postcode | The address postcode (only available if address has been validated) | String | "7010" |
| streetName | The address street name (only available if address has been validated) | String | "HAVEN" |
| streetNumber | The street number (only available if address has been validated) | String | "67" |
| streetType | The type of street (only available if address has been validated) | String | "ROAD" |
| townCity | The town or city of the address (only available if address has been validated) | String | "NELSON" |
...
| Field Name | Description | Type | Example |
|---|---|---|---|
| name | The name of this field | String | "controllerType", "additionalInformation", "allocationNumber", "shareAllocation", "totalSharesInCapitalGroup", "ownershipPercentage" etc. |
| value | If present, gives the value of this field | String | "Director" |
| verificationThreshold | If present, gives the percentage verification threshold for this field | String | "25" |
rootBusiness Object
This object gives details on the root business that was originally searched for.
| Field Name | Description | Type | Example |
|---|---|---|---|
| address | A structure encoding the address of the entity | Address | - |
| businessNumber | The business number for this entity | String | "111307361" |
| businessStatus | The status of the business as returned from a business register | String | "Registered" |
| businessType | The type of business | String | "company" |
| countryOfRegistration | The country where the business is registered, in the form of a two-letter country code | String | "AU" |