| 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.
...
<<KS: I think we need to include details of what is validated and the status/error codes returned for each? Check See std API docs>>docs error handling: >>
- Not Found (404)
- Unauthorized (401)
- Internal Server Error (500)
...
- businessVerificationReference: This is the reference number of the business verification you returned. This should match the reference number you requested.
- Entities: This contains details of the businesses and individuals that exist within the business structure. Each of these will have a unique ID.
- Relationships: This contains details of the relationships between the entities within the business structure e.g. Individual A is a shareholder of Business X
- rootBusiness: This contains the summary 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. If you simply require the summary details for the business you are aiming to verify (i.e. the root business or top level business), and do not require full details of the business structure, then this is the section to refer to.
businessVerificationReference
...
| Field Name | Description | Type | Example |
|---|---|---|---|
| address | A structure encoding the address of the entity For a business entity, only the country will be provided. If however the 'countryOfRegistration' is populated, then no address details will be populated. <<KS: Clarify this... is this working as intended? Why isn't country always populated?>> | 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 of the data source (i.e. business register) from which this entity's details were retrieved. | String | "the New Zealand Business Number Register" |
| documents | A list of documents associated with this business | List of Documents | - |
| entityType | The type of this entity | String | "business" |
| existenceVerified | Whether or not the existence of this business 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 business 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 were obtained from a business register (i.e. this will be 'true' if:
| Boolean | "true" or "false" |
| id | The unique ID of this entity | Integer | 1096 |
| name | The name of this business (i.e. the legal entity name) | 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 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 |
|---|---|---|---|
| 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" |
...