POST
/
external_accounts
/
add_vendor_accounts
Add external accounts through a vendor, such as Plaid.
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_type": "BUSINESS",
  "vendor": "FINICITY",
  "vendor_access_token": "access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6",
  "vendor_account_ids": [
    "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo"
  ],
  "vendor_customer_id": 123,
  "verify_owner": false
}'
{
  "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",
      "metadata": {},
      "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",
          "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",
              "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"
      },
      "status": "ACTIVE",
      "tenant": "abcdef_ghijkl",
      "type": "CHECKING",
      "vendor_data": {
        "account_number_mask": "<string>",
        "institution_id": "<string>"
      },
      "vendor_info": {
        "content_type": "application/json",
        "json": {},
        "vendor": "SOCURE"
      },
      "verification": {
        "creation_time": "2010-05-06T12:23:34.321Z",
        "last_updated_time": "2010-05-06T12:23:34.321Z",
        "status": "UNVERIFIED",
        "vendor": "FINICITY"
      }
    }
  ],
  "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",
      "metadata": {},
      "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",
          "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",
              "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"
      },
      "status": "ACTIVE",
      "tenant": "abcdef_ghijkl",
      "type": "CHECKING",
      "vendor_data": {
        "account_number_mask": "<string>",
        "institution_id": "<string>"
      },
      "vendor_info": {
        "content_type": "application/json",
        "json": {},
        "vendor": "SOCURE"
      },
      "verification": {
        "creation_time": "2010-05-06T12:23:34.321Z",
        "last_updated_time": "2010-05-06T12:23:34.321Z",
        "status": "UNVERIFIED",
        "vendor": "FINICITY"
      }
    }
  ],
  "failed_accounts": [
    {
      "reason": "ACCOUNT_NOT_FOUND",
      "reason_description": "<string>",
      "vendor_account_id": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",
      "vendor_error_message": "<string>",
      "vendor_request_id": "<string>"
    }
  ]
}

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

Response

200
application/json

Result of adding accounts through the vendor.

The response is of type object.