| 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.
...
The output from the getVerification call will be in JSON format, and contains three main sections:
- Summary (rootVerification)
- Entities
- Relationships
- rootBusiness
An entity could be an individual or business, and relationships are the connections between different entities. Each of these will have a unique ID.
...
The following section gives details on the fields in each entity structure.
Entity Object (individual)
| Field Name | Description | Type | Example |
|---|---|---|---|
| address | A structure encoding the address of the entity | Address | - |
| dataSource | Details on the data source (e.g. a company register) used for getting information on a "business" this entity. | DataSource | - |
| dob | Date of birth for this individual | String | "25/05/1947" |
| entityType | The type of the this entity | String | "business" or "individual" |
| fromDataSource | Whether or not this entity came from a data source (e.g. a lookup of a company register). | Boolean | "true" or "false" |
| givenName | The given name of this individual | String | "John" |
| id | The 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 | Boolean | "true" or "false" |
Address Object
| 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" |
| id | The ID of this address structure | Integer | 789113 |
| postcode | The address postcode (only available if address has been validated) | String | "7010" |
| streetName | The address street namename (only available if address has been validated) | String | "HAVEN" |
| streetNumber | The street numbernumber (only available if address has been validated) | String | "67" |
| streetType | The type of streetstreet (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" |
DataSource Object
...