Versions Compared
| Version | Old Version 80 | New Version 81 |
|---|---|---|
| Changes made by | ||
| Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| 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 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:
| Code Block |
|---|
{
"error": "Not found",
"message": "No verification with ID: 1775",
"status": 404
} |
The following errors may be returned:
HTTP status code | error | error message | Conditions |
|---|---|---|---|
| 401 | unauthorised | "Failed to authenticate <account id> with given password | Invalid credentials provided for your account to access the API Note: if you do not provide any credentials, then you will receive a 401 status in the HTTP header but no JSON error response will be provided |
| 404 | Not found | "No verification with id <verification_reference_id> | A business verification was not found on your account for the input verification reference number |
| 400 | Bad request | "Invalid number used as id" | The input verification reference number was not a numeric value |
| 500 | Internal server error | "<Message from the exception"> | An unexpected exception occurred within the system when processing your request. The message will be dependent on the exception encountered. |
Endpoints
The greenID Business API is a RESTful web service offering the following endpoints:
businessVerification
| Code Block |
|---|
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:
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
- POST
NOT CURRENTLY SUPPORTED.
In future, this will allow you to create a new business verification via the API.
Contents
| Child pages (Children Display) |
|---|
| Include Page | ||||
|---|---|---|---|---|
|
| Div | ||
|---|---|---|
| ||
On this page |
| Table of Contents | ||
|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|