API Versions
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.
Exceptions and Error Handling
Details on this.
Methods Available
getVerification
In Version 1 of the API a single RESTful endpoint is available for getting back information on a given verification. The URL to call will be something like:
http://au.vixverify.com/vixbiz/api/v1/getVerification/<verification_reference_id>
Input Parameters
| Name | Type | Required | Restrictions |
|---|---|---|---|
| verification_reference_id | String | Yes | Must be got from the interactive version of the system |
Output
The output from the getVerification call will be in JSON format, and contains three main sections:
- Summary
- Entities
- Relationships
An entity could be an individual or business, and relationships are the connections between different entities. Each of these will have a unique ID.
Top-Level Entity Fields
| 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 |
DataSource Object
| Field Name | Description | Type | Example |
|---|---|---|---|
| name | The human-readable name of this data source | String | "the New Zealand Business Number Register" |
| type | The type of the business returned | String | "company (nzco)" |
Note Object
| Field Name | Description | Type | Example |
|---|---|---|---|
| author | The author of a note | String | john.doe@example.com |
| context | The context that the note is associated with e.g. exempting an item from verification etc. | String | exemptFromVerification |
| creationTime | A timestamp for when this note was created | String | 2018-08-08 00:00:09.217+0000 |
| id | The ID of this note structure | Integer | 810489 |
| text | The note text | String | "A note" |
Verification Object
| 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. |