Skip to main content
POST
Create a permanent access token for an external account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json
vendor_institution_id
string
required

The ID of the institution the access token is requested for

Minimum string length: 1
vendor_public_token
string
required

The user's public token obtained from successful link login.

business_id
string<uuid>

The identifier for the business customer associated with this external account. Exactly one of business_id or customer_id must be specified.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

customer_id
string<uuid>

The identifier for the personal customer associated with this external account. Exactly one of customer_id or business_id must be specified.

vendor_customer_id
string<uuid>

An alias for customer_id (deprecated).

Response

New verification link token

vendor_institution_id
string
required

The ID of the institution the access token is requested for

Minimum string length: 1
vendor_public_token
string
required

The user's public token obtained from successful link login.

business_id
string<uuid>

The identifier for the business customer associated with this external account. Exactly one of business_id or customer_id must be specified.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

customer_id
string<uuid>

The identifier for the personal customer associated with this external account. Exactly one of customer_id or business_id must be specified.

request_id
string
read-only

A unique identifier for the request, which can be used for troubleshooting

vendor_access_token
string
read-only

The access token associated with the Item data is being requested for.

vendor_customer_id
string<uuid>

An alias for customer_id (deprecated).