| 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 |
|---|
| activeRelatedEntity | The ID of the active related entity in this relationship | Integer | 789558 |
| exemptionReason | If present this will detail why this relationship exempts the associated entity | String | "Ownership percentage is below threshold of 25" |
| fields | A list of fields associated with this relationship | List of Fields | - |
| id | The ID of this relationship | Integer | 789557 |
| passiveRelatedEntity | The ID of the passive related entity in this relationship | Integer | 789587 |
| type | The type of this relationship | String | "Company office holder", "Shareholder" etc. |
| verificationNotRequired | Whether or not this relationship means that verification is not required for the associated entity | Boolean | "true" or "false" |
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" |