POST
/
external_accounts
Add an external account
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/external_accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_identifiers": {
    "iban": "LI4476584648937N59B00",
    "number": "78277121"
  },
  "account_owner_names": [
    "Jane Smith"
  ],
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "currency": "USD",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_type": "BUSINESS",
  "metadata": {},
  "nickname": "Vacation savings",
  "routing_identifiers": {
    "ach_routing_number": "756392185",
    "bank_countries": [
      "US"
    ],
    "bank_name": "Chase",
    "eft_ca_routing_number": "02101140",
    "international_wire_details": {
      "bank_address": {
        "address_line_1": "100 Main St.",
        "address_line_2": "Suite 99",
        "city": "New York",
        "country_code": "US",
        "nickname": "Home",
        "postal_code": "28620",
        "state": "NY"
      },
      "correspondent_banks_details": [
        {
          "bank_address": {
            "address_line_1": "100 Main St.",
            "address_line_2": "Suite 99",
            "city": "New York",
            "country_code": "US",
            "nickname": "Home",
            "postal_code": "28620",
            "state": "NY"
          },
          "bank_name": "Bank of Greece",
          "swift_code": "BNGRGRAAXXX"
        }
      ],
      "swift_code": "CHASUS3AXXX"
    },
    "wire_routing_number": "915075033"
  },
  "tenant": "abcdef_ghijkl",
  "type": "CHECKING",
  "vendor_account_id": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",
  "verification": {
    "creation_time": "2010-05-06T12:23:34.321Z",
    "last_updated_time": "2010-05-06T12:23:34.321Z",
    "status": "UNVERIFIED",
    "vendor": "FINICITY"
  }
}'
{
  "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"
  }
}

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
​
account_identifiers
object
required

The identifiers for the account. At least one of number or iban must be specified. Account number or IBAN can be specified for international accounts. For domestic accounts, only account number is required.

​
account_owner_names
string[]
required

The names of the account owners.

Minimum length: 1
​
customer_type
enum<string>
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.

Available options:
BUSINESS,
PERSONAL
​
routing_identifiers
object
required
​
type
enum<string>
required

The type of the account

Available options:
CHECKING,
SAVINGS
​
business_id
string<uuid>

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

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
currency
string

ISO 4217 alphabetic currency code

Example:

"USD"

​
customer_id
string<uuid>

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

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
metadata
object

User-supplied metadata

​
nickname
string

A user-meaningful name for the account

Minimum length: 1
Example:

"Vacation savings"

​
tenant
string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

​
vendor_account_id
string

The ID of the vendor account, will be empty for MANUAL vendor

Minimum length: 1
Example:

"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo"

​
verification
object

Information about the account verification process. If the account has not been verified, this will be null.

Response

The external account added.

​
account_identifiers
object
required
​
account_owner_names
string[]
required

The names of the account owners. Values may be masked, in which case the array will be empty.

​
creation_time
string<date-time>
required
Example:

"2010-05-06T12:23:34.321Z"

​
id
string<uuid>
required

External account unique identifier

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
last_updated_time
string<date-time>
required
Example:

"2010-05-06T12:23:34.321Z"

​
routing_identifiers
object
required
​
status
enum<string>
required

The current state of the account

Available options:
ACTIVE,
CLOSED,
DELETED
​
type
enum<string>
required

The type of the account

Available options:
CHECKING,
CREDIT_CARD,
INVESTMENT_529,
MONEY_MARKET,
OTHER,
SAVINGS
​
verification
object
required

Information about the account verification process. If the account has not been verified, this will be null.

​
business_id
string<uuid>

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

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
currency
string

ISO 4217 alphabetic currency code

Example:

"USD"

​
customer_id
string<uuid>

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

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
deletion_time
string<date-time>
Example:

"2010-05-06T12:23:34.321Z"

​
metadata
object

User-supplied JSON format metadata.

​
name
string

The official name of the account

Example:

"Plaid Checking"

​
nickname
string | null

A user-meaningful name for the account

Example:

"Vacation savings"

​
tenant
string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

​
vendor_data
object
​
vendor_info
object

The information provided to Synctera from the vendor. Interpretation of this object is up to the client.