| 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 |
|---|---|---|---|
| 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" |
| dataSource | Details on the data source (e.g. a company register) used for getting information on this entity. | DataSource | - |
| 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" |
...
| 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" |
| dataSource | Details on the data source (e.g. a company register) used for getting information on this entity. | DataSource | - |
| 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 | 1097 |
| 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" |