All API requests to Finix are authenticated with your API Keys. You can not make API request into Finix without API Credentials.
Login to the dashboard and navigate to Developers > API Key.
This screen shows you your API Keys. Click on "Create an API Key" and follow the steps to create an API Key
Now copy the username and password and store them securely.
Finix uses basic authentication (RFC7617) to authenticate your requests.
All your requests will need to include the Authentication header. which is calculated by the API key's username and password.
The Libraries and SDKs will handle the authentication for you. Most language's HTTP clients have built in mechanisms to perform basic authentication, including curl.
A Basic Authentication header looks like:
Authorization: Basic [calculated credentials]
These are the instruction if you want to create the Authentication header manually. This example uses an API key with username of
USsRhsHYZGBPnQw8CByJyEQW and password of
Combine the username and the password with a colon.
Base64 encode the resulting string.
Add this value to the Authorization header and the
Authorization: Basic VVNzUmhzSFlaR0JQblF3OENCeUp5RVFXOjhhMTRjMmY5LWQ5NGItNGM3Mi04ZjVjLWE2MjkwOGU1YjMwZQo=
The Finix Keys are explicitly tied to the environment they are created. Sandbox Keys can not be used in Live environments and vice versa
Finix only shares the API Key credentials with you once. You are not able to query their value after creation.
The API Keys are sensitive data and must be treated like they are passwords. Store them securely and only let need-to-know people access their raw values.
When you sign up for Finix, you get a pair of credentials that you use to set up your Finix Dashboard and/or create requests with Finix's API. Due to the sensitive nature of these credentials, access is tightly controlled.
Users have three potential roles in Finix, which provide different levels of access:
ROLE_PLATFORM credentials have the highest levels of access and offer the most customization. However, more developer work is involved, and
ROLE_PLATFORM users are held liable for more responsibilities like approving
- Finix Flex customers receive ROLE_PARTNER credentials.
- Finix Core customers receive ROLE_PLATFORM credentials.
If you have any questions about the credentials you receive, reach out to your Finix point of contact or Finix Support.