Create a link token to verify an external account
Headers
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.
Request body
The identifier for the business customer associated with this external account. Exactly one of business_id or customer_id must be specified.
The name of your application, as it should be displayed in Link. Maximum length of 30 characters.
Country codes in the ISO-3166-1 alpha-2 country code standard.
The identifier for the personal customer associated with this external account. Exactly one of customer_id or business_id must be specified.
The expiration date for the link_token. Expires in 4 hours.
The language that corresponds to the link token. For Plaid, see their documentation for a list of allowed values.
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.
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.
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.
A unique identifier for the request, which can be used for troubleshooting.
Describes the environment of the client code running a vendor-supplied SDK
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.
The access token associated with the Item data is being requested for.
The ID of the institution the access token is requested for. If present the link token will be created in an update mode.
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.
Example request
{
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}Response
New verification link token
The identifier for the business customer associated with this external account. Exactly one of business_id or customer_id must be specified.
The name of your application, as it should be displayed in Link. Maximum length of 30 characters.
Country codes in the ISO-3166-1 alpha-2 country code standard.
The identifier for the personal customer associated with this external account. Exactly one of customer_id or business_id must be specified.
The expiration date for the link_token. Expires in 4 hours.
The language that corresponds to the link token. For Plaid, see their documentation for a list of allowed values.
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.
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.
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.
A unique identifier for the request, which can be used for troubleshooting.
Describes the environment of the client code running a vendor-supplied SDK
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.
The access token associated with the Item data is being requested for.
The ID of the institution the access token is requested for. If present the link token will be created in an update mode.
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.
Example response
{
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}