POST
/
external_accounts
/
link_tokens
Create a link token to verify an external account
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/external_accounts/link_tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "client_name": "<string>",
  "country_codes": [
    "CA"
  ],
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "language": "DE",
  "link_customization_name": "<string>",
  "redirect_uri": "<string>",
  "sdk_type": "WEB",
  "type": "CREDIT",
  "vendor_access_token": "<string>",
  "vendor_institution_id": "<string>",
  "verify_owner": false
}'
{
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "client_name": "<string>",
  "country_codes": [
    "CA"
  ],
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "expiration": "2023-11-07T05:31:56Z",
  "language": "DE",
  "link_customization_name": "<string>",
  "link_token": "<string>",
  "redirect_uri": "<string>",
  "request_id": "<string>",
  "sdk_type": "WEB",
  "type": "CREDIT",
  "vendor_access_token": "<string>",
  "vendor_institution_id": "<string>",
  "verify_owner": false
}

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
​
client_name
string
required

The name of your application, as it should be displayed in Link. Maximum length of 30 characters.

​
country_codes
enum<string>[]
required

Country codes in the ISO-3166-1 alpha-2 country code standard.

Minimum length: 1
​
language
enum<string>
required

The language that corresponds to the link token. For Plaid, see their documentation for a list of allowed values.

Available options:
DE,
EN,
ES,
FR,
NL
​
type
enum<string>
required

The type of the link token. DEPOSITORY for checking and savings accounts, CREDIT for credit card type accounts, INVESTMENT for investment accounts, and MICRO_DEPOSIT for depository accounts with support for micro-deposits verification.

Available options:
CREDIT,
DEPOSITORY,
INVESTMENT,
MICRO_DEPOSIT
​
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.

Example:

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

​
link_customization_name
string

The name of the Link customization from the Plaid Dashboard to be applied to Link. If not specified, the default customization will be used. When using a Link customization, the language in the customization must match the language selected via the language parameter, and the countries in the customization should match the country codes selected via country_codes.

​
redirect_uri
string

A URI indicating the destination where a user should be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview.

​
sdk_type
enum<string>
default:WEB

Describes the environment of the client code running a vendor-supplied SDK

Available options:
ANDROID,
IOS,
WEB
​
vendor_access_token
string

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

​
vendor_institution_id
string

The ID of the institution the access token is requested for. If present the link token will be created in an update mode.

Minimum length: 1
​
verify_owner
boolean
default:false

If true, Synctera will attempt to verify that the external account owner is the same as the customer by comparing external account data to customer data. At least 2 of the following fields must match: name, phone number, email, address. Verification is disabled by default.

Response

New verification link token

​
client_name
string
required

The name of your application, as it should be displayed in Link. Maximum length of 30 characters.

​
country_codes
enum<string>[]
required

Country codes in the ISO-3166-1 alpha-2 country code standard.

Minimum length: 1
​
language
enum<string>
required

The language that corresponds to the link token. For Plaid, see their documentation for a list of allowed values.

Available options:
DE,
EN,
ES,
FR,
NL
​
type
enum<string>
required

The type of the link token. DEPOSITORY for checking and savings accounts, CREDIT for credit card type accounts, INVESTMENT for investment accounts, and MICRO_DEPOSIT for depository accounts with support for micro-deposits verification.

Available options:
CREDIT,
DEPOSITORY,
INVESTMENT,
MICRO_DEPOSIT
​
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.

Example:

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

​
expiration
string<date-time>

The expiration date for the link_token. Expires in 4 hours.

​
link_customization_name
string

The name of the Link customization from the Plaid Dashboard to be applied to Link. If not specified, the default customization will be used. When using a Link customization, the language in the customization must match the language selected via the language parameter, and the countries in the customization should match the country codes selected via country_codes.

​
link_token
string

A link_token, which can be supplied to Link in order to initialize it and receive a public_token, which can be exchanged for an access_token.

​
redirect_uri
string

A URI indicating the destination where a user should be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview.

​
request_id
string

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

​
sdk_type
enum<string>
default:WEB

Describes the environment of the client code running a vendor-supplied SDK

Available options:
ANDROID,
IOS,
WEB
​
vendor_access_token
string

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

​
vendor_institution_id
string

The ID of the institution the access token is requested for. If present the link token will be created in an update mode.

Minimum length: 1
​
verify_owner
boolean
default:false

If true, Synctera will attempt to verify that the external account owner is the same as the customer by comparing external account data to customer data. At least 2 of the following fields must match: name, phone number, email, address. Verification is disabled by default.