| Info | ||
|---|---|---|
| ||
This documentation relates to Version 1, the current version of the greenID Business API. Version 1 became available to customers as of . |
Authentication
Details on authentication.
...
| Field Name | Description | Type | Example |
|---|---|---|---|
| address | A structure encoding the address of the entity | Address | - |
| children | The children of an entity. | ||
| dataSource | Details on the data source (e.g. a company register) used for getting information on a "business" entity. | DataSource | - |
| entityType | The type of the 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" |
| notes | A list of notes associated with this entity | Note | - |
| verification | A structure encoding verification details for the entity | Verification | - |
Address Object
| Field Name | Description | Type | Example |
|---|---|---|---|
| countryCode | The address country code i.e. a two digit code. | String | "AU" |
| countryName | The human-readable version of the country name. | String | "Australia" |
| fullAddress | The full address in a single String | String | "39 Lyons Avenue, Murrays Bay, Auckland, New Zealand" |
| id | The ID of this address structure | Integer | 789113 |
...