greenID Business API
Prerequisites
These documents contain the technical details of the greenID Business API.
The reader is assumed to have knowledge of the following:
- how the interactive version of greenID Business works
- a general understanding of programming, and
- RESTful Web Services and how to consume them
- HTTP Basic Authentication
Purpose of the API
The greenID Business API allows customers to programatically interact with the greenID Business system.
The current version of the API 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 be 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 perform all required actions to verify the business - such as verifying individuals and uploading supporting documentation
API Versions
| Current Version | Legacy Versions |
|---|---|
| Version 1 greenID Business API | N/A |
Home | greenID API | greenID Web | greenID Mobile | greenID Business | greenID Additional Services | Notification of Verification | Admin Panel Guide
If you can't find what you need here, email us at customer.support@gbgplc.com or log a ticket via our portal