| 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 your greenID customer account ID that you use for greenID Business, and the password is your greenID web services password for that account.
...
| Field Name | Description | Type | Example |
|---|---|---|---|
| address | A structure encoding the address of the entity | Address | - |
| dataSource | Details of the data source (e.g. a company register) from which this entity's details were retrieved. <<KS: I can't see that a 'Datasource' structure is being returned. Has this changed? 'dataSource' seems to just have the description of the data source now - no 'type'>> | <<??>> | - |
| dob | Date of birth for this individual | String | "25/05/1947" |
| entityType | The type of this entity. (Possible values are 'individual' and 'business') | String | "individual" |
| fromDataSource | Whether or not this entity was retrieved from a data source (e.g. a lookup of on a company business register). (Note: the individual's details retrieved may have subsequently been edited by a user) | Boolean | "true" or "false" |
| givenName | The given name of this individual | String | "John" |
| id | The unique ID of this entity | Integer | 789112 |
| middleNames | Middle name(s) for this individual | String | "Clive" |
| notes | A list of notes associated with this entity. | List of Notes | - |
| surname | The surname of this individual | String | "Smith" |
| verification | A structure encoding verification details for the entity | Verification | - |
| verificationNeverRequired | Whether or not verification is required for this entity. If 'true', then this entity does not need to be verified within any relationship within the business structure in order for the overall business verification to be 'verified'. | Boolean | "true" or "false" |
...
| Field Name | Description | Type | Example | |
|---|---|---|---|---|
| address | A structure encoding the address of the entity | Address | - | |
| businessNumber | The business number for this entity. This will be the business number for the business as registered on the stated 'dataSource'. Example: if the business was retrieved from the NZBN Register, then the business number will be the NZBN. | String | "111307361" | |
| businessStatus | The status of the business as returned from a business register. (Possible values will differ dependent on the business register) | String | "Registered" | |
| businessSubtype | The business subtype | String | "AU Limited Company" | |
| businessType | The type of business | String | "company" | |
| countryOfRegistration | The country where the business is registered, in the form of a two-letter country code. This will only be populated if the business is registered on the stated business register (see dataSource). | String | "AU" | |
| dataSource | Details on of the data source (e.g. a company register) used for getting information on from which this entity's details were retrieved. | DataSource | -String | "the New Zealand Business Number Register" |
| documents | A list of documents associated with this entity | List of Documents | - | |
| entityType | The type of this entity | String | "business" | |
| existenceVerified | Whether or not the existence of this entity has been verified or not | Boolean | "true" or "false" | |
| foundInRegister | Whether or not this entity was found in a company register | Boolean | "true" or "false" | |
| fromDataSource | Whether or not this entity came from a data source (e.g. a lookup of a company register). | Boolean | "true" or "false" | |
| id | The ID of this entity | Integer | 1096 | |
| name | The name of this business | String | "Acme Pty Ltd" | |
| notes | A list of notes associated with this entity | List of Notes | - | |
| verification | A structure encoding verification details for the entity | Verification | - | |
| verificationNeverRequired | Whether or not verification is required for this entity | Boolean | "true" or "false" |
...
| 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" |
...