| 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 |
|---|---|---|---|
| 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 | relatedEntity|
|---|---|---|---|---|
| businessRelatedTo | The ID of the | active relatedbusiness entity in this relationship. An example would be a business that is owned by a shareholder in a shareholding relationship. | Integer | 789558 |
| exemptionReason | If present this will detail why this relationship exempts the associated entity | String | "Ownership percentage is below threshold of 25" | |
| 789587 | ||||
| fields | A list of fields associated with this relationship | List of Fields | - | |
| id | The ID of this relationship | Integer | 789557 | |
| businessRelatedTorelatedEntity | The ID of the passive related entity in this relationshipentity which is related to the business specified in the "businessRelatedTo" field. An example would be the shareholder in a shareholding relationship. A related entity can be a business or an individual. | Integer | 789587789558 | |
| type | The type of this relationship | String | "Company office holder", "Shareholder", "Ultimate Holding Company" etc. | |
| verificationNotRequired | Whether or not this relationship means that verification is not required for the associated entity | Boolean | "true" or "false" | |
| verificationNotRequiredReason | If present this will detail why this relationship exempts the associated entity | String | "Ownership percentage is below threshold of 25" |
Field Object
| Field Name | Description | Type | Example | id | The ID of this field | Integer | 789561|
|---|---|---|---|---|---|---|---|
| name | The name of this field | String | "controllerType", "additionalInformation", "allocationNumber", "shareAllocation", "totalSharesInCapitalGroup", "allocationNumber", "ownershipPercentage" etc. | ||||
| value | If present, gives the value of this field | String | "Director" | ||||
| verificationThreshold | If present, gives the percentage verification threshold for this field | String | "25" |
...