Introduction

---

Definitions

• Bundle Key: the key used to identify the bundle and it's activated services

• Access Token: an authentication token used to access Valify's Service APIs

• Transaction ID: a record of each attempt to use one of Valify's services

• Trials: the limit by which the same token can be used to access a Service API. (3 trials by default)

Authentication

All Valify Service APIs are authenticated using OAuth 2.0 access tokens. Tokens are generated using our OAuth Token API and must be provided with each service request.

Click here for details.

Service APIs

The Valify Service APIs are built using RESTful API standards and can be easily integrated within any system using an HTTP Client. Our APIs accept and returns data in JSON format (content-type: application/json).

All API calls must be made over HTTPS, and must be authenticated using OAuth 2.0, as described in the Authentication section.

A Service API response often includes a Transaction ID and the number of trials remaining for this service, indicating that a record of the attempt was created.

For each service API, a sample Python code snippet and postman collection are provided.

Click here for details.

To generate OAuth access tokens and use Valify's service APIs, you need to be provided with API credentials. Please contact [e-mail] for more information.

You should never share your API credentials with other parties. If this happens, please contact [e-mail] to disable them and generate a new set of credentials.

Error Codes

This section covers all the HTTP codes returned by the Service APIs, as well as custom error codes specified by Valify, their meanings and recommended actions.

Click here for details.