The flinks-doc Developer Hub

Welcome to the flinks-doc developer hub. You'll find comprehensive guides and documentation to help you start working with flinks-doc as quickly as possible, as well as support if you get stuck. Let's jump right in!

List of Attributes Use-Cases

Let's dive deeper into what Attributes are included in the endpoints we just went over

So you now have everything set up and ready to rock and roll – but using Attributes is no fun when you don't know the data that you'll be seeing. This section will walk through what specific Attributes are contained within each of our use-cases. If you have not had a conversation with Flinks as of yet, this is where you need to reach out to our Product Manager to select a tiered package of ‘Attributes’ that works for you.

If you have already selected a Package

  • You can go ahead and just set up the call to the specific Use-Case Endpoint as detailed in the previous section. Please see below for the list of Attributes (and Categorized Transactions) included in each of those packages.

If you haven't selected your Package yet

  • Please reach out to our team and we'll get this sorted with you. We'd love to hear from you, and more than happy to work with you to determine what is the most appropriate package for your use-case! You can also see the contents of each Use-Case/Package below!

*Note: A (star) next to an Attribute indicates that we also return all Transactions (where available) for that Attribute Category.

/GetIncomeAttributes - Income Verification - List of Attributes (91 Total)

Employer Income

  • Employer Name
  • Average Monthly Employer Income
  • Employer Income Trend
  • Sum of Employer Income (Per Month, last 12 months - 13 Attributes) *
  • Count of Employer Income (Per Month, last 12 months - 13 Attributes) *

Non-Employer Income

  • Average Monthly Non-Employer Income

Government Income

  • Average Monthly Government Income
  • Sum of Government Income (Per Month, last 12 months - 13 Attributes) *
  • Count of Government Income (Per Month, last 12 months - 13 Attributes) *
  • Sum of Employment Insurance Income (90 Days) *
  • Sum of Social Assistance Income (90 Days) *
  • Sum of WSIB Income (90 Days) *
  • Sum of Pension Income (90 Days) *
  • Sum of Child Support Income - Government (90 Days) *
  • Sum of Other Government Income (90 Days) *

Others

  • Sum of Total Income (Per Month, last 12 months - 13 Attributes) *
  • Sum of Total Credits (Per Month, last 12 month - 13 Attributes) *
  • Account Age in Days
  • Average Monthly Free Cash Flow

/GetCreditRiskAttributes - Credit Risk Use-Case - List of Attributes (49 Total)

Account Overview

  • Minimum Balance Detected (Last 90 Days)
  • Days with a Negative Balance
  • Average Monthly Free Cash Flow
  • Balance Trend

Employer Income Overview

  • Employer Name
  • Average Monthly Employer Income
  • Employer Income Trend
  • Sum of Employer Income (Per Month, last 12 months - 13 Attributes) *
  • Count of Employer Income (Per Month, last 12 months - 13 Attributes) *

Non-Employer Income Overview

  • Average Monthly Non-Employer Income
  • Average Monthly Government Income
  • Total Deposits Trend

Loan Payments Breakdown

  • Average Monthly Auto-Loan Payments
  • Average Monthly Mortgage Payments
  • Average Monthly Micro-Loan Payments
  • Average Monthly Student Loan Payments
  • Average Monthly Other Loan Payments

Committed Bill Payments Breakdown

  • Average Monthly Utility Payments
  • Average Monthly Telecom Payments

Additional Risk Analysis

  • Count of NSF Fees (Last 90 Days) *
  • Count of Stop-Payment Fees (Last 90 Days) *
  • Average Monthly Micro-Loan Payments
  • Micro-Lender Name
  • Average Monthly Expenditure
  • Account Age in Days

/GetUserAnalysisAttributes - Overall Use-Case - List of Attributes (113 Total)

Employer Income

  • Employer Name
  • Average Monthly Employer Income
  • Employer Income Trend
  • Sum of Employer Income (Per Month, last 12 months - 13 Attributes) *
  • Count of Employer Income (Per Month, last 12 months - 13 Attributes) *

Non-Employer Income

  • Average Monthly Non-Employer Income

Government Income

  • Average Monthly Government Income
  • Sum of Government Income (Per Month, last 12 months - 13 Attributes) *
  • Count of Government Income (Per Month, last 12 months - 13 Attributes) *
  • Sum of Employment Insurance Income (90 Days) *
  • Sum of Social Assistance Income (90 Days) *
  • Sum of WSIB Income (90 Days) *
  • Sum of Pension Income (90 Days) *
  • Sum of Child Support Income - Government (90 Days) *
  • Sum of Other Government Income (90 Days) *

Other Income Attributes

  • Sum of Total Income (Per Month, last 12 months - 13 Attributes) *
  • Sum of Total Credits (Per Month, last 12 month - 13 Attributes) *

Account Risk Overview

  • Minimum Balance Detected (Last 90 Days)
  • Days with a Negative Balance
  • Average Monthly Free Cash Flow
  • Balance Trend

Loan Payments Breakdown

  • Average Monthly Auto-Loan Payments
  • Average Monthly Mortgage Payments
  • Average Monthly Micro-Loan Payments
  • Average Monthly Student Loan Payments
  • Average Monthly Other Loan Payments

Committed Bill Payments Breakdown

  • Average Monthly Utility Payments
  • Average Monthly Telecom Payments

Additional Risk Analysis

  • Count of NSF Fees (Last 90 Days) *
  • Count of Stop-Payment Fees (Last 90 Days) *
  • Average Monthly Micro-Loan Payments
  • Micro-Lender Name
  • Average Monthly Expenditure

Fraud Detection Attributes

  • Account Age in Days
  • Active Days in the Account (Last 90 Days)
  • Balance Trend
  • Overall Activity Trend
  • Debit Activity Trend
  • Credit Activity Trend
  • Is Employer Income Detected?
  • Average Monthly Recurring Payments

/GetAllAttributes - All Attributes

The /GetAllAttributes endpoint provides a list of all available Attributes that Flinks currently provides, as well as all related transactions to those Attributes. We currently have 537 Individual Attributes across 38 Categories.

To obtain the full updated list, please reach out to our team.

🚧

Attribute Names + Production Packages

  • If you require a custom Attributes call and don't have access to your Attribute Names to include, please send a message to [email protected] and we'll get them sent over to you.
  • In order to proceed to the next steps and go to production, a package has to be selected and a contract must be in place.

👍

Checklist

Before moving on, let's review what we just did:

  • Chose the package of ‘Attributes’ that is most suited for your use-case
  • Changed the Attributes within the existing set up to the required names

Updated 8 months ago


List of Attributes Use-Cases


Let's dive deeper into what Attributes are included in the endpoints we just went over

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.