API Authentication

Our API endpoints are protected and require API Keys.

In order to start using the Pyas API, you are required to create API keys.

To authenticate, you will need to pass your API key in the request headers as x-api-key .

Note: API Keys are app based. When generating API keys, you generate them for an app. whenever you use your API key, accounts you connect will be associated with the app that the API key belongs to.

Generate API Keys

  1. Login to your Pyas account.

  2. Click on the Apps tab to open the Apps page.

  3. Select the Pyas App that you want to generate API keys for. If you don't have any apps yet, click on the + New App button to create a new one.

  4. Click on the Settings tab.

  5. Then, click on the API Keys tab

  1. Click on Generate New API Key

  2. Add a name for your API key

  3. Select an expiration for your API key

  4. Select scopes

  5. Click Generate API Key

Your API Key is generated, and you can now use it to authenticate by passing it in the x-api-key request header.

Last updated