Skip to content
API

Get Vendor JWT

GET
/v1/modal-service/auth/vendors/{vendor-id}

Provides a JWT token that allows to do operations on behalf of a vendor.

Authentication

Topsort’s APIs are authenticated via bearer tokens. Requests must include an authorization header containing your private API key.

Don't have an API key yet? Learn how to generate one.

Authorization
required
string

The header containing a private API key. Format this header as follows:

Authorization: Bearer <YOUR-API-KEY>

Path Parameters

object
vendor-id
required

The ID of the vendor for which an external token will be retrieved.

string
>= 1 characters

The ID of the vendor for which an external token will be retrieved.

Responses

Successful Response

The result for a vendor validation.

application/json
object
authToken

A JWT that can be used as authentication for the Topsort Modal API.

string
authorized
required

Indicates if a vendor is authorized to use the Topsort Modal API.

boolean