Using the API

Authentication

Authenticate requests to the Onboard REST API using your API key.

Onboard REST API uses header authentication.

Include the following header in your requests:

Authorization: Token YOUR_API_KEY

Replace YOUR_API_KEY with the API key from your account.

Security Notes

  • Never expose API keys in client-side or mobile code.
  • Rotate keys periodically.
  • Use separate keys per environment.

How is this guide?

On this page