Purpose of the API

The greenID Business API allows customers to programatically interact with the greenID Business system.

The current version of the API provides an endpoint which returns available information on a given verification in the greenID Business system. This enables customers to extract the details and results of a verification into their own CRM systems, by providing the verification id of the verification they wish to extract. 

The API also enables customers to create a new business verification within the greenID Business system, either via a business register lookup or by manually providing the details.

Future versions of the API will provide additional functionality, such as the ability to create a new verification via the APIbe notified when certain events occur in the system, for example when the status of a verification changes.

System Prerequisites

In order to make use of the greenID Business API, the following pre-requisites apply:

• The customer must have a greenID account which is enabled for greenID Business
• The customer must be provided with their web service password, this is required for authentication purposes when accessing the API
• The customer must use the greenID Business system via the Admin Panel to create business verifications for the businesses they wish to verify. All perform all required actions to verify the business must also be performed within the greenID Business system. - such as verifying individuals and uploading supporting documentation

API Versions