Authentication

Before using the Business Health API, ensure your email and password are ready.

The access token is a string that encodes your credentials and permissions to access a given resource (like company information, connection status, or a service connection link) or SMB data (such as banking accounts, e-commerce refunds, or business credit scores).

To use the access token, add the following header to your API call:

HEADER PARAMETERDESCRIPTION
AuthorizationValid access token following the format: Bearer <Access Token>

Note: The access token is valid for 24 hours, after which you'll need to request a new one.

📘

In Production environments, token lifespan can be adjusted.


Example

Use the Get Token method to get your Bearer Access Token.

The following example shows how to retrieve information about available services using the Get All Services endpoint:

curl --request GET \
     --url https://app.upswot.com/admin/api/v1/normalized-data/services \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJhbGciOiJ...'