Skip to main content
POST
Create a link intent
v1 · Base URL https://api.fintoc.com/v1

Authorizations

Authorization
string
header
required

Body

application/json
country
enum<string>
required

ISO 3166-1 alpha-2 code of the country of the institution to connect.

Available options:
cl
Example:

"cl"

holder_type
enum<string>
required

Whether the credentials to connect belong to an individual or a business.

Available options:
individual,
business
Example:

"business"

product
enum<string>
required

Fintoc product that the resulting link will be used for.

Available options:
movements
Example:

"movements"

Response

Link intent created. The widget_token is only returned in this response.

id
string
required

Unique identifier of the link intent.

Example:

"li_a6WUojQ2SjSSeFjH"

object
any
required

Type of the object. Always link_intent.

country
enum<string>
required

ISO 3166-1 alpha-2 code of the country of the institution to connect.

Available options:
cl
Example:

"cl"

created_at
string<date-time>
required

ISO 8601 timestamp of when the link intent was created.

Example:

"2022-12-01T01:50:12Z"

exchange_token
string | null
required

Token used to retrieve the resulting link from your backend once the link intent succeeds. Only returned by the widget when the connection succeeds; null in every other response.

Example:

"li_a6WUojQ2SjSSeFjH_exc_Q802GD8ZLmMuK0Atl4ucJuLp"

exchange_token_expires_at
string<date-time> | null
required

ISO 8601 timestamp of when the exchange_token expires. null if no exchange token has been issued.

Example:

"2022-12-01T02:50:12Z"

holder_type
enum<string>
required

Whether the credentials to connect belong to an individual or a business.

Available options:
individual,
business
Example:

"individual"

mode
enum<string>
required

Mode of the link intent. live connects to real institutions, test connects to the test institution with fake data.

Available options:
live,
test
Example:

"live"

product
enum<string>
required

Fintoc product the resulting link will be used for.

Available options:
movements
Example:

"movements"

status
enum<string>
required

Status of the link intent. rejected means the institution rejected the credentials, failed means an error kept the connection from completing.

Available options:
created,
in_progress,
succeeded,
failed,
rejected
Example:

"created"

widget_token
string | null
required

Token used to initialize the Fintoc widget for this link intent. Only returned when the link intent is created; null in every other response.

Example:

"li_a6WUojQ2SjSSeFjH_sec_Q802GD8ZLmMuK0Atl4ucJuLp"