Version 6 greenID API (RESTful)

This documentation relates to Version 6, the current version of the greenID RESTful API. Version 6 became available to customers as of Aug 4, 2025.

Getting Started

In order to start using the API, there are several key requirements:

A greenID account must be established. This includes specifying the rules to be used, the data sources that will be available, and a range of other configuration options.
The greenID RESTful API V6 uses OAuth style authentication, using API tokens, instead of the "web service password" used by the SOAP / XML greenID API V5. Details on how to set this up are available here: Authentication for greenID RESTful API.

Testing and Integrating the API

Test and Prod Environment

GreenID offers two separate environments: test and production. Customers start out in test, where they may carry out their development activities, performing as many test verifications as they like. Once the customer is satisfied with their integration, their account can be activated in the production environment.

API Specification

To help our customers get going, greenID provides an Open API spec that can be used for integration. Customers can use this to understand and test the API.

Web Service Endpoints

For details on the web service endpoints, please refer to Web Service Endpoints.