Skip to main content
GET
/
v3
/
{customerId}
/
partnerdata
/
{LoginId}
/
{AccountId}
Get Partner Data
curl --request GET \
  --url https://{instance}-api.private.fin.ag/v3/{customerId}/partnerdata/{LoginId}/{AccountId}
{
  "RequestId": "565c7b7a-fc01-45a1-aa7d-baaaa703a51b",
  "AccessToken": "6087f84c-15ba-4113-82aa-a9d22ea6caac",
  "Date": "2023-04-11T15:04:43.3464411Z",
  "ExpirationDate": "2023-05-12T19:09:02.9650245Z"
}
Use the /PartnerData 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 Access Token that’s associated with a specific user. It’s created based on the user’s loginId and the accountId. Your partner uses this Access Token to retrieve data for that specific user. Access tokens are valid for 30 days from the time they are created. To extend an Access Token by 30 days, call this endpoint again and provide the same information that you provided in the previous call. Depending on your processes, your partner may need to provide information in addition to an Access Token. For example, if you are using a payments processor, you will likely attach the Access Token when creating a user. Let your partner know if there is additional information that they require for a successful API call.

Deleting Cards If you call the

/DeleteCard endpoint to delete data for a specific user, Access Tokens that are associated with that user will immediately become invalid and no data will be available for the partner to retrieve.

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 toolbox environment key.

​
LoginId
string
required

Unique identifier that represents a specific user. This value is available after successfully calling the /Authorize endpoint.

​
AccountId
string
required

Unique identifier that represents a specific user account.

Response

Response Body

​
RequestId
string

Unique identifier for this request.

​
AccessToken
string

The unique Access Token that your partner can use to retrieve data for the specific user.

​
Date
string

Timestamp when the Access Token was created.

​
ExpirationDate
string

Timestamp when the Access Token expires (30 days from creation).