Create a Business API application and generate your credentials

To start using the Soldo Business API in your production account, you’ll need to create an application in the Soldo web app. This process will generate the credentials your system will use to authenticate securely with the API.

Important: This setup gives access to real data. If you’re testing or building an integration, we recommend starting in sandbox mode first.

Create an application

Log in to the Soldo web app.
From the main navigation menu, go to Integrations > Business API.
Select Create application.
Enter a name for your application.

Tip: This should reflect the integration or tool it’s linked to.

Enter a public key. You’ll need to generate a valid RSA 2048-bit key pair in PEM format.

What is a key pair?

Public key: Shared with Soldo. Think of it like a username — it identifies your application.
Private key: Kept secret. It’s used to securely sign your API requests.

You can find instructions for creating a key pair using openssl during the setup flow.

Select Next.

Select the scopes your application needs and then click Continue. You can edit these later if needed.

Tip: Scopes define which parts of your Soldo account the application can access. You can choose to give read-only or full access for each area.

WC_BusinessAPI_ScopesSelectAnnotated_202512_Surface_EN.png

Review your settings and acknowledge the terms and conditions.
Select Create application

WC_BusinessAPI_TermsAgreeAnnotated_202512_Surface_EN.png

Once created, your credentials will be shown in a popup:

Client ID – identifies your application
Client secret – used for standard authentication
Fingerprint token – used for advanced authentication or downloading attachments

Important: These credentials are only shown once. Make sure you copy and store them safely before closing the popup.

WC_BusinessAPI_CredentialsAnnotated_202512_Surface_EN.png

What happens if I lose my API credentials?

You can regenerate them at any time. Go to Integrations > Business API, select the application, and click Regenerate credentials. This will generate a new Client secret and Fingerprint token. Your Client ID will stay the same.

Next steps

Once you've created your application in the web app and generated your credentials, you're ready to get started with the Soldo Business API.

Full API documentation can be found in our Business API Developer Portal.

Availability

Who: Super admins

Pricing plan(s): Unlimited

0 people voted. Sum of votes: 0