Authentication & security

You'll need to authenticate your requests to access any of the endpoints in the OnRamp API. In this guide, we'll look at how authentication works. The OnRamp uses an API key as an Authentication: bearer for every request made.

Tenant URL

Each user that registers at OnRamp gets their own environment, also called a tenant. This means, that they also get their own URL, which is used for validation URL's, payment pages but also the API. It can be found in the address bar of the browser, or on the dashboard's company widget.

An example on how to set it in the SDK;

$onramp = new \Onramp\Identity\OnrampIdentityApiClient();
$onramp->setApiUrl('TENANT_URL');

API key

All the OnRamp api's use the API key as an authentication header. Here's how to authenticate using cURL:

$onramp = new \Onramp\Identity\OnrampIdentityApiClient();
$onramp->setApiKey('API_KEY');