Skip to main content
GET
/
v3
/
{customerId}
/
partnerdata
/
authsecret
/
{nameofpartner}
Generate Auth Secret
curl --request GET \
  --url https://{instance}-api.private.fin.ag/v3/{customerId}/partnerdata/authsecret/{nameofpartner}
{
  "RequestId": "403cf9b2-9fda-441e-ac8b-b8346eb319ff",
  "PermissionId": "058cb857-777e-4e68-96a8-33f7f2e09465",
  "AuthSecret": "e17778dc-a592-409e-a752-ee276b106f4c",
  "Message": "The partner authorization secret was generated successfully."
}
Use the /AuthSecret endpoint if you are a client of Flinks and want to grant access for a partner to retrieve data that is processed by Flinks. This endpoint generates a unique authorization token that your partner can use to securely access Flinks APIs. Each partner only needs one unique authorization token for the duration of the time they are accessing data through Flinks. Call this endpoint once for each partner you are providing access to. In addition to /AuthSecret, this endpoint also returns a PermissionId that revokes access to Flinks APIs by disabling the unique authorization token. Save the PermissionId on your side. For more information about revoking access to Flinks APIs, see the /AuthSecret/Disable endpoint.

Headers

​
Authorization
string
default:Bearer {API Secret}

Contains the Bearer Token (the API secret key that Flinks provides you with).

Path Parameters

​
customerId
string
default:43387ca6-0391-4c82-857d-70d95f087ecb
required

Key that grants access to the environment specified in the instance field. By default, the value is set to the Sandbox environment key.

​
nameofpartner
string
default:PartnerTest
required

Name that you want to assign to this partner. If this field is left empty, the default value is PartnerTest.

Response

Response Body

​
RequestId
string

Unique identifier for this request.

​
PermissionId
string

Unique identifier used to revoke access to Flinks APIs by disabling the authorization token. Save this value.

​
AuthSecret
string

The unique authorization token that your partner can use to securely access Flinks APIs.

​
Message
string

Success message confirming the token was generated.