Skip to main content
GET
List links
v1 · Base URL https://api.fintoc.com/v1
AccountsThe accounts field is null when you list links. To retrieve a link’s accounts, send a request to the Get link endpoint using the link_token returned when you exchanged the link.
PaginationThe API paginates links and returns 30 links per page by default. See Pagination for details. Increment the page query parameter to retrieve the remaining links.

Authorizations

Authorization
string
header
required

Query Parameters

status
enum<string>

If present, Fintoc returns only links with this status.

Available options:
active,
inactive,
login_required
page
integer<int32>

Page number to retrieve. Starts at 1.

per_page
string

Number of links per page. Defaults to 30. The maximum is 300.

Response

Paginated list of links. The Link and X-Total-Count headers carry the pagination information.

id
string
required

Unique identifier of the link.

Example:

"link_nMNejK7BT8oGbvO4"

object
any
required

Type of the object. Always link.

accounts
object[] | null
required

Bank accounts of the link. Included when retrieving or exchanging a single link; null when listing or updating links.

active
boolean
required

Whether the link is active. Fintoc does not refresh inactive links. Deactivating a link stops refreshes but does not revoke the link_token's access to already-collected data.

Example:

true

created_at
string<date-time>
required

ISO 8601 timestamp of when the link was created.

Example:

"2020-04-22T21:10:19.254Z"

holder_id
string
required

Tax identifier of the account holder, without dots or hyphens (RUT in Chile, RFC in Mexico).

Example:

"111111111"

holder_type
enum<string>
required

Whether the account holder is an individual or a business.

Available options:
individual,
business
Example:

"individual"

institution
object
required
last_time_refreshed
string<date-time> | null
required

ISO 8601 timestamp of the link's last refresh. null if Fintoc has never refreshed the link.

Example:

"2020-11-18T18:43:54.591Z"

Token used to authenticate requests for the link's resources. Only returned when the link is exchanged; null in every other response.

Example:

"link_nMNejK7BT8oGbvO4_token_sjnNsMyXKJEXAMPLETOKENrnNL1tA8"

mode
enum<string>
required

Mode of the object. live objects use real institution data, test objects use fake data for integration testing.

Available options:
test,
live
Example:

"live"

refresh_status
enum<string> | null
required

Refresh status of the link's accounts. idle means no refresh is in progress, refreshing means every account is refreshing, partially_refreshing means only some accounts are refreshing, and interrupted means no account is currently refreshing.

Available options:
idle,
refreshing,
interrupted,
partially_refreshing,
null
Example:

"idle"

status
enum<string>
required

Status of the link. login_required means the institution rejected the stored credentials and you must reconnect the link.

Available options:
active,
inactive,
login_required
Example:

"active"

username
string
required

Username used to log in at the institution, without dots or hyphens.

Example:

"111111111"

subscription_id
string

Identifier of the subscription associated to the link. Only present when the link is returned from a subscription exchange.

Example:

"sub_nMNejK7BT8oGbvO4"