| Info | ||
|---|---|---|
| ||
This documentation relates to Version 1, the current version of the greenID Business API. Version 1 became available to customers as of . |
Authentication
HTTP basic authentication is used for accessing the endpoint. The username is a customer account ID, and the password is a customer's GreenID web services password.
...
| 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 (only available if address has been validated) | String | "7010" |
| streetName | The address street name (only available if address has been validated) | String | "HAVEN" |
| streetNumber | The street number (only available if address has been validated) | String | "67" |
| streetType | The type of street (only available if address has been validated) | String | "ROAD" |
| townCity | The town or city of the address (only available if address has been validated) | String | "NELSON" |
...
| Field Name | Description | Type | Example |
|---|---|---|---|
| creationTime | The time when this document was created (uploaded) | String | "2018-08-15 06:18:19.929+0000" |
| documentURL | A URL where this document can be downloaded | String | "https://au.vixverify.com/vixbiz/api/v1/document/1854" |
| evidenceType | The type of evidence that this document is | String | "Statutory declaration" |
| fileSize | The size of the document file, in bytes. | Integer | 297054 |
| name | The original document filename | String | "file.pdf" |
| verification | The verification associated with this document | Verification | - |
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 |
| text | The note text | String | "A note" |
...