List external accounts

Returns a list of all external accounts assigned to customers.

GET /external_accounts

List external accounts

cURL

curl --request GET \
  --url https://api.synctera.com/v2/external_accounts \
  --header 'Authorization: Bearer <token>'

200

{
  "external_accounts": [
    {
      "account_identifiers": {
        "number": "78277121",
        "iban": "LI4476584648937N59B00"
      },
      "account_owner_names": [
        "Jane Smith"
      ],
      "creation_time": "2010-05-06T12:23:34.321Z",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "routing_identifiers": {
        "bank_countries": [
          "US"
        ],
        "bank_name": "Chase",
        "ach_routing_number": "756392185",
        "bank_address": {
          "address_line_1": "100 Main St.",
          "city": "New York",
          "country_code": "US",
          "postal_code": "49633",
          "state": "NY",
          "address_line_2": "Suite 99"
        },
        "correspondent_bank_details": [
          {
            "bank_address": {
              "address_line_1": "100 Main St.",
              "city": "New York",
              "country_code": "US",
              "postal_code": "49633",
              "state": "NY",
              "address_line_2": "Suite 99"
            },
            "bank_name": "Bank of Greece",
            "swift_code": "BNGRGRAAXXX"
          }
        ],
        "eft_ca_routing_number": "02101140",
        "eft_routing_number": "02101140",
        "swift_code": "CHASUS3AXXX",
        "wire_routing_number": "756392185"
      },
      "verification": {
        "creation_time": "2010-05-06T12:23:34.321Z",
        "last_updated_time": "2010-05-06T12:23:34.321Z"
      },
      "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "currency": "USD",
      "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "deletion_time": "2010-05-06T12:23:34.321Z",
      "metadata": {},
      "name": "Plaid Checking",
      "nickname": "Vacation savings",
      "status_reason": "<string>",
      "tenant": "abcdef_ghijkl",
      "vendor_data": {
        "account_number_mask": "<string>",
        "institution_id": "<string>"
      },
      "vendor_info": {
        "json": {},
        "vendor": "SOCURE"
      }
    }
  ],
  "next_page_token": "a8937a0d"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customer_id · string<uuid>[]

A list of customer unique identifiers, with a comma separating any values.

The unique identifier of a customer

business_id · string<uuid>[]

A list of business unique identifiers, with a comma separating any values. Returns applications that are linked to the specified Business IDs.

Unique ID for the business. Exactly one of business_id or person_id must be set.

limit · integer · default: 100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1

Example:

100

page_token · string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

include_history · boolean · default: false

If true, include old risk scores in the response

id · string<uuid>[]

External account ID(s). Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

nickname · string

A user-meaningful name for the account.

account_number · string

bank_routing · string

Response

200

application/json

List of external accounts

external_accounts · External account · object[] · required

Array of external accounts

Show child attributes

next_page_token · string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"