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. 

Exceptions and Error Handling

We return an error response in JSON format if an exception occurs. An example of this is as follows:

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

Example errors include:

• Not Found (404)
• Unauthorized (401)
• Internal Server Error (500)

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/businessVerification/<verification_reference_id>

Input Parameters

Output

The output from the getVerification call will be in JSON format, and contains four main sections:

1. businessVerificationReference
2. Entities
3. Relationships
4. rootBusiness

An entity could be an individual or business, and relationships are the connections between different entities. Each of these will have a unique ID.

businessVerificationReference

Entities

The following section gives details on the fields in each entity structure.

Entity Object (individual)

Entity Object (Business)

Address Object

DataSource Object

Document Object

Note Object

Verification Object

Relationships

The following section gives details on the fields in each relationship structure.

Relationship Object

Field Object

rootBusiness Object

This object gives details on the root business that was originally searched for.