| 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.
...
An entity could be an individual or business, and relationships are the connections between different entities. Each of these will have a unique ID.
Entities
The following section gives details on the fields in each entity structure.
...
Entity
...
Object
| 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" |
| id | The ID of this entity | Integer | 789112 |
| notes | A list of notes associated with this entity | Note | - |
| verification | A structure encoding verification details for the entity | Verification | - |
...
| Field Name | Description | Type | Example |
|---|---|---|---|
| dateDue | The due date for this verification | String | 2018-08-08 00:00:09.217+0000 |
| dateNominated | The date that this verification was nominated (created) | String | 2018-08-07 23:16:47.065+0000 |
| id | The ID of this verification structure | Integer | 810290 |
| status | The status of this verification | String | "Not yet verified", "verified" etc. |
Relationships
The following section gives details on the fields in each relationship structure.
Relationship Object
| Field Name | Description | Type | Example |
|---|---|---|---|
| activeRelatedEntity | The ID of the active related entity in this relationship | Integer | |