Authentication

HTTP basic authentication is used for accessing the endpoint. The username is your greenID customer account ID that you use for greenID Business, and the password is your greenID web services password for that account. 

Exceptions and Error Handling

If an error or exception is encountered, the HTTP response header will contain details of the error. In most cases, we will also return an error response in JSON format. An example of this error response is as follows:

{
  "error": "Not found",
  "message": "No verification with ID: 1775",
  "status": 404
}

The following errors may be returned when the API is invoked with either a 'GET' or 'POST' command. Please refer to the pages detailing the 'GET' and 'POST' functionality for additional errors specific to each function which may also be returned:

Endpoints

The greenID Business API is a RESTful web service offering the following endpoints:

businessVerification 

https://au.vixverify.com/vixbiz/api/v1/businessVerification/<input parameters>

This 'businessVerification' endpoint is accessed using HTTP GET and POST commands which provide the following capability:

• GET (To retrieve a business verification)

The greenID Business API 'businessVerification' endpoint, when accessed via an HTTP 'GET' command, allows you to extract the current details of a business verification, including its verification status. Given a greenID Business reference number, the API call returns information about the business to be verified (i.e. the 'top level' or 'root business'), its sub-businesses (for example shareholder businesses), and all associated individuals (including their verification status).

• POST (To create a business verification)

The greenID Business API 'businessVerification' endpoint, when accessed via an HTTP 'POST' command, allows you to programatically create a verification in the greenID Business system.

Contents