Skip to main content

Authentication

Only users with the right permissions can use the API, this is part of the setup process. If you do not have this setup yet, please contact our support team and ask for an API trial.

Required Credentials

As soon as your setup is done, you should have a sandbox account, and two pieces of information that are necessary to authenticate in our API:

  • Email (with API permission)
  • Token

In all requests through our API, it is mandatory that you have this authentication information, ensuring security throughout the process. If you are getting authentication errors, please contact us to confirm the right email and token.

Important Note

For security reasons, once a user becomes an automation user, this access must be used specifically for setting up the automated process. It will not be able to access the web platform.

Authentication Headers

All API requests must include the following headers:

HeaderRequiredDescription
Emailrequiredstring(50) - The API user with specific permission to create documents and get information about your own documents into a company. Example: api@magnifinance.com
TokenrequiredThe token of the subscription in which the document will be generated.

Example Request

curl --location --request POST 'https://bo.magnifinance.com/api/v1.1/document' \
--header 'email: api@example.com' \
--header 'token: YOUR_TOKEN_HERE' \
--header 'Content-Type: application/json' \
--data-raw '{
// your request body
}'

Authentication Errors

If you receive an authentication error (Error Code 01 - AuthenticationError), verify that:

  1. Your email has API permissions enabled
  2. Your token is correct and active
  3. The headers are properly formatted

See the Error Codes page for more information on handling errors.