Authentication

Prior to using upSWOT API, ensure your Sandbox user email and password are ready.

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

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 that within the Sandbox environment, the access token is valid for 24 hours. After that, the token expires, and you will need to request a new one.

📘

Within the Production enviorments, the 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 in the Sandbox environment using the Get All Services endpoint:

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