Skip to main content
POST
/
v3
/
{customerId}
/
insight
/
login
/
{loginId}
/
attributes
/
{requestId}
Attributes
curl --request POST \
  --url https://{instance}-api.private.fin.ag/v3/{customerId}/insight/login/{loginId}/attributes/{requestId} \
  --header 'Content-Type: <content-type>' \
  --data '{}'
{
  "Card": {},
  "Login": {},
  "RequestId": "<string>",
  "AttributeDetails": {}
}
Use the /Attributes endpoint to tell us the data points in your attributes package you want to retrieve.

​
Request Parameters

NAMETYPEDESCRIPTION
customerId (mandatory)stringGUID representing your customer ID (provided by Flinks).
loginId (mandatory)stringGUID representing end user’s login ID. You get this value after a successful Authorize request.
requestId (mandatory)stringGUID representing an authorized request to the API. You get this value after a successful Authorize request.
Attributes (mandatory)objectLists of desired Attributes broken-down by Attribute level (card is currently the only supported attribute level).
FiltersobjectFilters to apply to transactions for which attributes will be calculated. Supported values: accountCategory: List of account categories (Operations is currently the only supported value).
AccountFilterobjectFilters to apply to transactions for which attributes will be calculated, differs from the general Filter parameter above, as this targets specific accounts. Supported values: AccountID: List of accountID’s to be used in the Attributes calculation (AccountID is taken from the GetAccountsDetail response). Multiple accountID’s can be used.
AttributesDetailobjectActs the same as the Attributes parameter, but can be used to return underlying transactions from the Attributes calculation. Include lists of desired Attributes (must also be present at the card level above). Supported values: AttributesDetail: List of Attributes that underlying transactions need to be returned from.
limitDaysobjectOptional Parameter to include in the header of any Attributes request that will limit the amount of days of transactions used to calculate all Attributes to the days option passed in this parameter. Supports between 1 and 365 days. Supported values: limitDays: Any integer value from 1-365 that defines the amount of days of transactions used in the Attributes calculation (Supported on any GET or POST request to Attributes).

Note on ‘Filters’ and ‘AccountFilter’

The parameter AccountFilter can only be used in conjunction with Filter. You must have both present if you need to filter by specific accounts.

Note on ‘AttributesDetail’

Only Attributes that are ‘Sum’ or ‘Count’ are allowed here. ‘Average’ or other types of Attributes are not supported here. Any Attribute name that is included here must also be included in the mandatory Attributes parameter above.

​
Response Fields

NAMETYPEDESCRIPTION
CardobjectObject containing an id field (end user’s LoginId) and all the requested attributes (name: value)
LoginobjectObject representing some end user’s technical information such as the LoginId. See Authorize endpoint documentation for this object details.
RequestIdstringGUID representing an authorized request to the API. You get this value after a successful Authorize request.
AttributeDetails (Optional)objectObject containing the fields TransactionId, AccountId, Date, Description, Debit, Credit per Attribute.

Note on Custom Attributes

If you are utilizing the Attributes Builder feature to create custom Attributes within the Client Dashboard, then you are able to include your created Attribute Names under the card object alongside any other pre-created Attributes.

Headers

​
Content-Type
enum<string>
default:application/json
required

Content type of the request.

Available options:
application/json
Example:

"application/json"

Path Parameters

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

Unique GUID provided by Flinks that grants you access to the environment specified in the instance field.

​
loginId
string
required

GUID representing end user's login ID.

​
requestId
string
required

GUID representing an authorized request to the API.

Query Parameters

​
limitDays
string
default:365

(Optional) Includes an integer from 1 to 365 that will limit the range of transactions that will be used to calculate Attributes.

Body

application/json
​
Attributes
string

Key-value pairs of attributes to retrieve (JSON object).

​
Filters
string[]

(Optional) List of account categories (Operations is currently the only supported value).

​
AccountFilter
string[]

(Optional) List of desired AccountId's to use in the Attribute Calculation.

​
AttributesDetail
string[]

(Optional) List of Attributes that you require the underlying transactions to be returned from.

​
MostRecentCached
boolean

(Optional) When set to true, returns the most recently cached attribute calculation.

Response

Result

​
Card
object

Object containing an id field (end user's LoginId) and all the requested attributes (name: value)

​
Login
object

Object representing end user's technical information.

​
RequestId
string

GUID representing an authorized request to the API.

​
AttributeDetails
object

Object containing the fields for underlying transactions.