v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

External Accounts

Sync external accounts through a vendor, such as Plaid.

Sync external accounts for a customer through an existing access token. The token must be valid, and the information on the accounts returned by the vendor must correspond to the customer. A success response for this route may include failures if an account could not be added and deletions if the account is removed by the end user, so it's important that the caller checks the response body.

post/external_accounts/sync_vendor_accounts

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.

customer_type'BUSINESS' | 'PERSONAL' required

The type of customer in the external financial institution. Not necessarily the customer type on Synctera's platform: a business customer might link to the owner's personal account at an external financial institution.

vendor'FINICITY' | 'PLAID' required

The vendor selected for the operation.

vendor_access_tokenstring

The token provided to link external accounts. For Plaid, this is their access_token.

vendor_account_idsstring[]

The list of vendor account IDs that the customer chose to link. For Plaid, these are account_ids.

vendor_customer_idstring

The identifier provided by the vendor for the customer associated with this external account.

verify_ownerboolean

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",
  "vendor_access_token": "access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6",
  "vendor_account_ids": [
    "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo"
  ]
}

Response

Result of syncing accounts through the vendor.

Example response

{
  "added_accounts": [
    {
      "account_identifiers": {
        "iban": "LI4476584648937N59B00",
        "number": "78277121"
      },
      "account_owner_names": [
        "Jane Smith"
      ],
      "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "currency": "USD",
      "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "deletion_time": "2010-05-06T12:23:34.321Z",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "name": "Plaid Checking",
      "nickname": "Vacation savings",
      "routing_identifiers": {
        "ach_routing_number": "756392185",
        "bank_address": {
          "address_line_1": "100 Main St.",
          "address_line_2": "Suite 99",
          "address_type": "SHIPPING",
          "city": "New York",
          "country_code": "US",
          "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "is_registered_agent": true,
          "nickname": "Home",
          "postal_code": "28620",
          "state": "NY"
        },
        "bank_countries": [
          "US"
        ],
        "bank_name": "Chase",
        "correspondent_bank_details": [
          {
            "bank_address": {
              "address_line_1": "100 Main St.",
              "address_line_2": "Suite 99",
              "address_type": "SHIPPING",
              "city": "New York",
              "country_code": "US",
              "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
              "is_registered_agent": true,
              "nickname": "Home",
              "postal_code": "28620",
              "state": "NY"
            },
            "bank_name": "Bank of Greece",
            "swift_code": "BNGRGRAAXXX"
          }
        ],
        "eft_ca_routing_number": "02101140",
        "eft_routing_number": "02101140",
        "swift_code": "CHASUS3AXXX",
        "wire_routing_number": "756392185"
      },
      "tenant": "abcdef_ghijkl",
      "vendor_info": {
        "vendor": "SOCURE"
      },
      "verification": {
        "creation_time": "2010-05-06T12:23:34.321Z",
        "last_updated_time": "2010-05-06T12:23:34.321Z"
      }
    }
  ],
  "deleted_accounts": [
    {
      "account_identifiers": {
        "iban": "LI4476584648937N59B00",
        "number": "78277121"
      },
      "account_owner_names": [
        "Jane Smith"
      ],
      "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "currency": "USD",
      "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "deletion_time": "2010-05-06T12:23:34.321Z",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "name": "Plaid Checking",
      "nickname": "Vacation savings",
      "routing_identifiers": {
        "ach_routing_number": "756392185",
        "bank_address": {
          "address_line_1": "100 Main St.",
          "address_line_2": "Suite 99",
          "address_type": "SHIPPING",
          "city": "New York",
          "country_code": "US",
          "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "is_registered_agent": true,
          "nickname": "Home",
          "postal_code": "28620",
          "state": "NY"
        },
        "bank_countries": [
          "US"
        ],
        "bank_name": "Chase",
        "correspondent_bank_details": [
          {
            "bank_address": {
              "address_line_1": "100 Main St.",
              "address_line_2": "Suite 99",
              "address_type": "SHIPPING",
              "city": "New York",
              "country_code": "US",
              "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
              "is_registered_agent": true,
              "nickname": "Home",
              "postal_code": "28620",
              "state": "NY"
            },
            "bank_name": "Bank of Greece",
            "swift_code": "BNGRGRAAXXX"
          }
        ],
        "eft_ca_routing_number": "02101140",
        "eft_routing_number": "02101140",
        "swift_code": "CHASUS3AXXX",
        "wire_routing_number": "756392185"
      },
      "tenant": "abcdef_ghijkl",
      "vendor_info": {
        "vendor": "SOCURE"
      },
      "verification": {
        "creation_time": "2010-05-06T12:23:34.321Z",
        "last_updated_time": "2010-05-06T12:23:34.321Z"
      }
    }
  ],
  "failed_accounts": [
    {
      "vendor_account_id": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo"
    }
  ]
}