Introduction

The Refersion API is organized around REST, which is easily accessible using most modern programming languages. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. In addition, valid JSON will be returned in all responses from the API, including errors.

This API is still in beta. We’re still working on updating this documentation as new endpoints are released.

Authentication

Most API endpoints require authentication, which is done using your public and private API keys. You can generate new API keys right from your account settings. Your public key may be used in client-side implementations, but your private key should be kept secure and never be visible to end users.

All API requests must be made over HTTPS.

The API keys used in examples in this documentation are not registered to your account and are inactive.