| 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.
Basic HTTP authentication is used for accessing the endpoint.
Exceptions and Error Handling
Details on this.
Methods Available
...
| Code Block |
|---|
http://au.vixverify.com/vixbiz/api/v1/getVerificationverification/<verification_reference_id> |
...
| 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 | String | "7010" |
| streetName | The address street name | String | "HAVEN" |
| streetNumber | The street number | String | "67" |
| streetType | The type of street | String | "ROAD" |
| townCity | The town or city of the address | String | "NELSON" |
...
| 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", "Ultimate Holding Company" etc. |
| verificationNotRequired | Whether or not this relationship means that verification is not required for the associated entity | Boolean | "true" or "false" |
...