Sign in

v1

latestOpenAPI 3.0.32026-07-13347237.5 KB
Enrich

Attributes

Use the /Attributes endpoint to tell us the data points in your attributes package you want to retrieve.

post/v3/{customerId}/insight/login/{loginId}/attributes/{requestId}

Path parameters

customerIdstring required

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

loginIdstring required

GUID representing end user's login ID.

requestIdstring required

GUID representing an authorized request to the API.

Query parameters

limitDaysstring

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

Headers

Content-Type'application/json' required
Example:application/json

Content type of the request.

Request body

Example request

{
  "Attributes": {
    "Card": [
      "account_age_days",
      "active_days_trend",
      "auto_loan_payment_frequency",
      "average_closing_balance_day_after_employer_income",
      "average_closing_balance_day_after_government_income",
      "average_closing_balance_day_after_income",
      "average_closing_balance_day_of_employer_income",
      "average_closing_balance_day_of_government_income",
      "count_telecom_payments_current_month"
    ]
  },
  "Filters": {
    "AccountCategory": [
      "Operations"
    ]
  },
  "Options": {
    "OriginCountry": "ca",
    "AccountFilter": [
      "32a25824-d43a-46f1-8980-22fd6aa95d24"
    ],
    "AccountType": "Personal",
    "AttributesDetail": [
      "account_age_days",
      "active_days_trend",
      "auto_loan_payment_frequency",
      "average_closing_balance_day_after_employer_income",
      "average_closing_balance_day_after_government_income",
      "average_closing_balance_day_after_income",
      "average_closing_balance_day_of_employer_income",
      "average_closing_balance_day_of_government_income",
      "count_telecom_payments_current_month"
    ]
  }
}

Response

Result

MostRecentTransactionDatestring

Date of the most recent transaction used in the calculation (MM/DD/YYYY).

FlinksAttributesProcessIdstring

GUID identifying the attributes calculation process.

HttpStatusCodeinteger

HTTP status code of the response.

ProcessIdstring

GUID identifying the request process.

RequestIdstring

GUID representing an authorized request to the API.