| 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 |
|---|---|---|---|
| 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) Only applicable to New Zealand addresses | String | "NELSON" |
| suburb | The suburb of the address (only available if address has been validated) | String | "PAPAMOA BEACH" |
| state | The abbreviation for the state (only available if address has been validated) Only applicable to Australian addresses | String | "NSW" |
...
This object provides details about the 'root business' that this overall business verification pertains to. This would be the business that you are aiming to verify and originally searched for or manually created.
...
Please note that this business is also contained within the 'entities' section of the results. It is has been extracted to this 'rootBusiness' section for ease of reference if you simply require the summary details for the business you are aiming to verify (i.e. the root business or top level business).
| Field Name | Description | Type | Example | ||
|---|---|---|---|---|---|
| address | A structure encoding the address of the entity. Only the country details will be populated. | Address | - | ||
| businessNumber | The business number for this entity. If the business was manually created or does not have a business number registered within the relevant country then this will not be provided. 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" | ||
| businessType | The type of business | String | "company" | ||
| businessSubtype | The business subtype | String | "AU Limited Company" | ||
| countryOfRegistration | The country where the business is registered, in the form of a two -letter country code-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 (i.e. g. a company business register) used for getting information on from which this entity's details were retrieved. | DataSource | - | ||
| documents | A list of documents associated with this entity | List of Documents | - | ||
| entityType | The type of this entity - this will always be "business" | String | "business" | existenceVerified | Whether or not the existence of this entity has been verified or not |
| existenceVerified | Whether or not the existence of this entity has been verified. Existence is verified either by the business being found on a business register (see foundInRegister), or by the upload and verification of supporting documents. | Boolean | "true" or "false" | ||
| foundInRegister | Whether or not this entity was found in a company registerbusiness was found on a business register (i.e. this will be 'true' if a lookup was performed against a business register using the business number, the business was successfully found and it's details retrieved) | Boolean | "true" or "false" | ||
| fromDataSource | Whether or not details about this entity camewere obtained from a data sourcebusiness register ( e.g. a lookup of a company register)i.e. this will be 'true' if:
| Boolean | "true" or "false" | ||
| id | The unique ID of this entity (i.e. the legal entity name) | 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. This will provide the overall verification status for this 'business verification' (i.e. for the root business) | Verification | - | ||
| verificationNeverRequired | Whether or not verification is required for this entity. This will always be "false" for the root business. | Boolean | "true" or "false" |