Core Aggregation Resources-Links

List all links Register a new link Complete a links request Get a link's details Update a link’s credentials Modify a link's data retrieval Delete a link

Core Aggregation Resources-Institutions

List all institutions Get an institution's details

Banking Aggregation-Accounts

List all accounts Retrieve accounts for a link Complete an accounts request Get an account's details Delete an account

Banking Aggregation-Transactions

List all transactions Retrieve transactions for a link Complete a transaction request Get a transaction's details Delete a transaction

Banking Aggregation-Owners

List all owners Retrieve owners for a link Complete an owners request Get an owner's details Delete an owner

Banking Aggregation-Bills

List all bills Retrieve bills for a link Get a bill's details Delete a bill

Enrichment-Incomes

List all incomes Retrieve incomes for a link Complete an incomes request Get an income's details Delete an income

Enrichment-Recurring Expenses

List all recurring expenses Retrieve recurring expenses for a link Complete a recurring expense request Get a recurring expense's details Delete a recurring expense

Enrichment-Risk Insights

List all risk insights Retrieve risk insights Resume a risk insights session Get a risk insight's details Delete a risk insight

Enrichment-Employment Metrics

List all employment metrics Retrieve employment metrics Get an employment metric's details Delete an employment metric

Enrich Your Own Data (EYOD)-Categorization (EYOD)

Categorize transactions

Enrich Your Own Data (EYOD)-Income Verification (EYOD)

Enrich Your Own Data (EYOD)-Risk Insights (EYOD)

Retrieve Risk Insights (EYOD)

Enrich Your Own Data (EYOD)-Recurring Expenses (EYOD)

Retrieve Recurring Expenses (EYOD)

Fiscal Aggregation-Financial Statements

List all financial statements Retrieve financial statements for a link Get a financial statements's details Delete a financial statements

Fiscal Aggregation-Invoices

List all invoices Retrieve invoices for a link Get an invoice's details Delete an invoice

Fiscal Aggregation-Tax returns

List all tax returns Retrieve tax returns for a link Get a tax return's details Delete a tax return

Fiscal Aggregation-Tax status

List all tax statuses Retrieve tax statuses for a link Get a tax status's details Delete a tax status

Fiscal Aggregation-Tax compliance status

List all tax compliance statuses Retrieve tax compliance statuses for a link Get a tax compliance status's details Delete a tax compliance status

Fiscal Aggregation-Tax retentions

Retrieve tax retentions for a link List all tax retentions Get a tax retention's details Delete a tax retention

Fiscal Aggregation-Tax Declarations

List all tax declarations Retrieve tax declarations for a link Get a tax declaration's details Delete a tax declaration

Employment Aggregation-Employment Records Mexico

List all employment records Retrieve employment record details Get an employment record's details Delete an employment record

Employment Aggregation-Employments Brazil

List all employments Retrieve employments for a link Get an employment's details Delete an employment

Employment Aggregation-Employments Colombia

List all employments Retrieve employments for a link Get an employment's details Delete an employment

Get insights into your user's employment history

Create an employment link Retrieve owner information for employment link Retrieve employment record information for a link Retrieve employment metrics for a link

Single Link Flow (MFA)

Register a new link Complete a links request Retrieve accounts for a link Retrieve owners for a link Retrieve transactions for a link

Single Link Flow (No MFA)

Register a new link Retrieve owners for a link Retrieve accounts for a link Retrieve transactions for a link

Single Link Flow (with Enrichment)

Register a new link Retrieve accounts for a link Retrieve owners for a link Retrieve transactions for a link Retrieve incomes for a link Retrieve recurring expenses for a link Retrieve risk insights for a link

Widget access_token generation

Generate access_token (OFDA)

🏦 Verify your user's fiscal ID

Register a new fiscal link Retrieve tax statuses for a link

🔍 Verify your user's personal and banking information

Create a new link Retrieve owners for a link Retrieve accounts for a link

Core Aggregation Resources-Links

List all links Register a new link Complete a links request Get a link's details Update a link’s credentials Modify a link's data retrieval Delete a link

Core Aggregation Resources-Institutions

List all institutions Get an institution's details

Banking Aggregation-Accounts

List all accounts Retrieve accounts for a link Complete an accounts request Get an account's details Delete an account

Banking Aggregation-Transactions

List all transactions Retrieve transactions for a link Complete a transaction request Get a transaction's details Delete a transaction

Banking Aggregation-Owners

List all owners Retrieve owners for a link Complete an owners request Get an owner's details Delete an owner

Banking Aggregation-Bills

List all bills Retrieve bills for a link Get a bill's details Delete a bill

Enrichment-Incomes

List all incomes Retrieve incomes for a link Complete an incomes request Get an income's details Delete an income

Enrichment-Recurring Expenses

List all recurring expenses Retrieve recurring expenses for a link Complete a recurring expense request Get a recurring expense's details Delete a recurring expense

Enrichment-Risk Insights

List all risk insights Retrieve risk insights Resume a risk insights session Get a risk insight's details Delete a risk insight

Enrichment-Employment Metrics

List all employment metrics Retrieve employment metrics Get an employment metric's details Delete an employment metric

Enrich Your Own Data (EYOD)-Categorization (EYOD)

Categorize transactions

Enrich Your Own Data (EYOD)-Income Verification (EYOD)

Enrich Your Own Data (EYOD)-Risk Insights (EYOD)

Retrieve Risk Insights (EYOD)

Enrich Your Own Data (EYOD)-Recurring Expenses (EYOD)

Retrieve Recurring Expenses (EYOD)

Fiscal Aggregation-Financial Statements

List all financial statements Retrieve financial statements for a link Get a financial statements's details Delete a financial statements

Fiscal Aggregation-Invoices

List all invoices Retrieve invoices for a link Get an invoice's details Delete an invoice

Fiscal Aggregation-Tax returns

List all tax returns Retrieve tax returns for a link Get a tax return's details Delete a tax return

Fiscal Aggregation-Tax status

List all tax statuses Retrieve tax statuses for a link Get a tax status's details Delete a tax status

Fiscal Aggregation-Tax compliance status

List all tax compliance statuses Retrieve tax compliance statuses for a link Get a tax compliance status's details Delete a tax compliance status

Fiscal Aggregation-Tax retentions

Retrieve tax retentions for a link List all tax retentions Get a tax retention's details Delete a tax retention

Fiscal Aggregation-Tax Declarations

List all tax declarations Retrieve tax declarations for a link Get a tax declaration's details Delete a tax declaration

Employment Aggregation-Employment Records Mexico

List all employment records Retrieve employment record details Get an employment record's details Delete an employment record

Employment Aggregation-Employments Brazil

List all employments Retrieve employments for a link Get an employment's details Delete an employment

Employment Aggregation-Employments Colombia

List all employments Retrieve employments for a link Get an employment's details Delete an employment

Get insights into your user's employment history

Create an employment link Retrieve owner information for employment link Retrieve employment record information for a link Retrieve employment metrics for a link

Single Link Flow (MFA)

Register a new link Complete a links request Retrieve accounts for a link Retrieve owners for a link Retrieve transactions for a link

Single Link Flow (No MFA)

Register a new link Retrieve owners for a link Retrieve accounts for a link Retrieve transactions for a link

Single Link Flow (with Enrichment)

Register a new link Retrieve accounts for a link Retrieve owners for a link Retrieve transactions for a link Retrieve incomes for a link Retrieve recurring expenses for a link Retrieve risk insights for a link

Widget access_token generation

Generate access_token (OFDA)

🏦 Verify your user's fiscal ID

Register a new fiscal link Retrieve tax statuses for a link

🔍 Verify your user's personal and banking information

Create a new link Retrieve owners for a link Retrieve accounts for a link

Home Single Link Flow (with Enrichment)Retrieve incomes for a link

Retrieve incomes for a link

POST {{baseUrl}}/api/incomes/

Request Body

{"link"=>"{{link_id_enrichmentFlow}}"}

Retrieve transactions for a link

Retrieve recurring expenses for a link