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
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.
<<KS: Is the above sufficient for a developer to know how to use this?>>
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:
<<KS: I think we need to include details of what is validated and the status/error codes returned for each? See std API docs error handling: >>
- Not Found (404)
- Unauthorized (401)
- Internal Server Error (500)
Methods Available
The following webservice methods are available for the greenID Business API version 1:
Additional methods will be made available in future, for example a method to create a new business verification via the API.