SYsynctera
External Accounts

Create a permanent access token for an external account

post/external_accounts/access_tokens

Request

  • Base URL
    https://api-sandbox.synctera.com/v0
  • URL
    https://api-sandbox.synctera.com/v0/external_accounts/access_tokens
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

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

business_idstring uuid

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

customer_idstring uuid

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

request_idstring

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

vendor_access_tokenstring

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

vendor_customer_idstring uuid

An alias for customer_id (deprecated).

vendor_institution_idstring required

The ID of the institution the access token is requested for

vendor_public_tokenstring required

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

Example request

{
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}

Response

New verification link token

business_idstring uuid

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

customer_idstring uuid

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

request_idstring

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

vendor_access_tokenstring

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

vendor_customer_idstring uuid

An alias for customer_id (deprecated).

vendor_institution_idstring required

The ID of the institution the access token is requested for

vendor_public_tokenstring required

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

Example response

{
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}

Changes

No recorded changes to this operation across all 11 revisions of this API.