Skip to main content
POST
/
external_accounts
/
access_tokens
Create a permanent access token for an external account
curl --request POST \
  --url https://api.synctera.com/v2/external_accounts/access_tokens \
  --header 'Content-Type: application/json' \
  --data '{
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_institution_id": "<string>",
  "vendor_public_token": "<string>"
}'
{
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "request_id": "<string>",
  "vendor_access_token": "<string>",
  "vendor_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_institution_id": "<string>",
  "vendor_public_token": "<string>"
}

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 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 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

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

​
vendor_access_token
string

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

​
vendor_customer_id
string<uuid>

An alias for customer_id (deprecated).