| Info | ||
|---|---|---|
| ||
This documentation relates to Version 1, the current version of the greenID Business API. Version 1 became available to customers as of . |
Authentication
Details on authentication.
...
| Field Name | Description | Type | Example |
|---|---|---|---|
| countryCode | The address country code i.e. a two digit code. | String | "AUNZ" |
| countryName | The human-readable version of the country name. | String | "AustraliaNew Zealand" |
| fullAddress | The full address in a single String | String | "39 Lyons Avenue, Murrays Bay, Auckland, New Zealand67 HAVEN ROAD, NELSON 7010, NEW ZEALAND" |
| id | The ID of this address structure | Integer | 789113 |
| postcode | The address postcode | String | "7010" |
| streetName | The address street name | String | "HAVEN" |
| streetNumber | The street number | String | "67" |
| streetType | The type of street | String | "ROAD" |
| townCity | The town or city of the address | String | "NELSON" |
DataSource Object
| Field Name | Description | Type | Example |
|---|---|---|---|
| name | The human-readable name of this data source | String | "the New Zealand Business Number Register" |
| type | The type of the business returned | String | "company (nzco)" |
...