Add an external account

Add an external account for a customer. The account will be created in an unverified state.

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

account_owner_namesstring[] required

The names of the account owners.

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.

currencystring

ISO 4217 alphabetic currency code

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.

metadataobject

User-supplied metadata

nicknamestring

A user-meaningful name for the account

tenantstring

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

type'CHECKING' | 'CRYPTO_WALLET' | 'OTHER_BANK_ACCOUNT' | 'SAVINGS' | 'WALLET' required

The type of the account

vendor_account_idstring

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

Example request

{
  "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",
  "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",
        "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"
      },
      "correspondent_banks_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"
        }
      ],
      "swift_code": "CHASUS3AXXX"
    },
    "wire_routing_number": "915075033"
  },
  "tenant": "abcdef_ghijkl",
  "vendor_account_id": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",
  "verification": {
    "creation_time": "2010-05-06T12:23:34.321Z",
    "last_updated_time": "2010-05-06T12:23:34.321Z"
  }
}

Response

The external account added.

account_owner_namesstring[] required

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

business_idstring uuid

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

creation_timestring date-time required

currencystring

ISO 4217 alphabetic currency code

customer_idstring uuid

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

deletion_timestring date-time

idstring uuid required

External account unique identifier

last_updated_timestring date-time required

metadataobject

User-supplied JSON format metadata.

namestring

The official name of the account

nicknamestring nullable

A user-meaningful name for the account

status'ACTIVE' | 'CLOSED' | 'DELETED' | 'INACTIVE' required

The current state of the account

status_reasonstring

The reason for the status for the external account.