In This Section
In the Authentication section of the borderless™ documentation you will find:
- Definitions for Secret Key, Issuer ID, and JWT Token
- How to Authenticate borderless™ API Calls
- How to Generate Your JWT Token via API
- How to Generate Your JWT Token via Dashboard
- Generate Your JWT Token via Generator Button
- How to Authenticate Partner Requests for a Child Account
Definitions
| Term | Definition |
|---|---|
| Issuer ID | An Issuer ID is a 25 character alphanumeric string that is unique to your borderless™ Account and can be revealed in the Issuer ID column on the "Tokens" tab of your Developer Dashboard. An example would look like this: al2gyjp2bqqkm1598ekv9etfd |
| Secret Key | A Secret Key is a 36 character string that is unique to your borderless™ Account and is generated from the "Tokens" tab of your Developer Dashboard. It is distinct from the JWT. An example would look like this: 42f1828e-c705-11ec-9d64-0242ac120002 |
| Partner Key | A Secret Key is a 36 character string that is unique to a Partner Account. |
| JWT Token | A JWT Token is an open standard that defines a compact and self-contained way for securely transmitting information. A JWT Token is made of 3 parts: the Header, the Payload and the Signature. |
| Client-Id | A Client-Id is a unique identifier of a Child Account. A Client-Id must be provided in the header for Authentication. If a Client-Id is not provided in the header, all calls will be specific to the Partner Account. |
How To Authenticate borderless™ API Calls
borderless™ API Calls must be signed with your JWT Token for authentication. To use your JWT Token, enter it after “--header 'Authentication: Bearer” in an HTTP request or paste it into the "Bearer" field in the borderless™ Sandbox UI.
Pro TipThis token is valid for 15 minutes and needs to be regenerated after expiry.
How To Generate Your JWT Token via API
You can generate JWT token using our Authentication Endpoint.
How To Generate Your JWT Token via Dashboard
Generate Your JWT Token via Generator Button
A JWT Token Generator Button can be found in your Developer Dashboard. Click the "Generate Token" button and a JWT Token will automatically be created. This Token can be copied to your clipboard where you can then place that as the Bearer header in HTTP requests to Authenticate your API Calls.
Authenticating Requests as a Partner for a Child Account
- Provide Partner Key when generating token either via API using Authentication Endpoint or manually generating token.
Client-id Header Value
- Provide Client-Id to every request's header (except Authentication Endpoint) to have access to your Child accounts.
- To use Client-Id correctly, enter it in “--header 'Client-Id: {Client Id of Your Child account}” in an HTTP request.