Search…
⌃K

Get Started

Get your API key + connect to Nerve.
Getting Started

Request access to the API on our Discord server!

​​
​
​
Plus integration support, troubleshooting, product discussion, and more.
​

Get an API Key

Don't Forget —

Your API keys are extremely sensitive. Anyone who gains access to your keys will be able to impersonate your organization and could take money out of your account. Never expose your API keys in any publicly accessible areas, including GitHub, client-side code, or even a plain HTTP request. If you are ever in doubt that your API keys may have been exposed, contact us immediately!

Use Postman

​​
Run in Postman
​
​
Use the button above to jump right into sandbox using Postman.
​

Authentication

Now that you have an API key, you can authorize requests in the Nerve Enterprise API on behalf of your organization. Authentication is performed via HTTP Basic Auth; provide your API key as the basic auth username value. You do not need to provide a password. For example:
const buff = Buffer.from('YOUR_API_KEY:'); //don't forget trailing colon!
const encoded = buff.toString('base64');
const headers = {
'Content-Type': 'application/json',
'Authorization': 'Basic ' + encoded,
};
​

Environments

There is both a production environment, and a sandbox environment. Requests made to the sandbox environment will never hit banking networks, meaning they can't affect your account balances and will never incur costs.
Your developer account will have different API keys for each environment. Each environment has its own URL endpoint to avoid any confusion.
Production: https://api.nerve.fm/enterprise/v1
Sandbox: https://sandbox.nerve.fm/enterprise/v1
​
Next, get your enterprise's info to test your integration.