How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Synctera External Accounts API

The External Account resource is used for managing links to accountsthat operate outside of the Synctera ecosystem.

Synctera External Accounts API is one of 29 APIs that Synctera publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include External Accounts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 8 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 0.20.0.

Requests are made against 2 base URLs: https://api.synctera.com/v0, https://api-sandbox.synctera.com/v0.

11 operations 8 paths 35 schemas 1 DELETE4 GET1 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.20.0
Base URL
https://api.synctera.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Synctera External Accounts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (api_key) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 4 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

External Accounts 11

The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem.

GET
/external_accounts
List external accounts
listExternalAccounts 4 params → 200401403500
POST
/external_accounts
Add an external account
addExternalAccounts 1 param body → 201400401403409500
DELETE
/external_accounts/{external_account_id}
Delete an external account
deleteExternalAccount 1 param → 200401403404409422500
GET
/external_accounts/{external_account_id}
Get an external account
getExternalAccount 1 param → 200401403404500
PATCH
/external_accounts/{external_account_id}
Patch an external account
updateExternalAccount 2 params body → 200401403404409422500
GET
/external_accounts/{external_account_id}/balance
Get an external account balance
getExternalAccountBalance 2 params → 200401403404500
GET
/external_accounts/{external_account_id}/transactions
List transactions of a given external account
getExternalAccountTransactions 3 params → 200401403404422500
POST
/external_accounts/access_tokens
Create a permanent access token for an external account
createAccessToken 1 param body → 201400401403500
POST
/external_accounts/add_vendor_accounts
Add external accounts through a vendor, such as Plaid.
addVendorExternalAccounts 1 param body → 200400401403500
POST
/external_accounts/link_tokens
Create a link token to verify an external account
createVerificationLinkToken 1 param body → 201400401403500
POST
/external_accounts/sync_vendor_accounts
Sync external accounts through a vendor, such as Plaid.
syncVendorExternalAccounts 1 param body → 200400401403500

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are external_account (16 properties), external_account_link_token (15 properties), add_accounts_request (11 properties), external_account_transaction (11 properties). Each schema is shown below with its type and property counts.

add_vendor_accounts_response
object
3 properties 2 required
patch_external_account
object
6 properties
external_accounts_transaction_list
object
1 property 1 required
vendor_xml
object
3 properties 3 required
manual_account_verification
ext_account_customer_type
string
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 own…
add_accounts_request_routing_identifiers
object
4 properties 3 required
external_accounts_list
patch_accounts_request_account_identifiers
object
1 property
patch_accounts_request_routing_identifiers
object
2 properties
paginated_response
object
1 property
plaid_account_verification
error
object
4 properties
account_routing
object
6 properties 2 required
external_account_balance
object
4 properties 1 required
business_id2
string
Unique ID for the business. Exactly one of businessid or personid must be set.
external_account_link_token
object
15 properties 4 required
vendor_info
object
The information provided to Synctera from the vendor. Interpretation of this object is up to the client.
base_account_verification
object
4 properties 2 required
customer_id
string
external_account_vendor_values
string
The vendor selected for the operation.
external_account
object
16 properties 9 required
external_account_access_token
object
7 properties 2 required
add_accounts_request
object
11 properties 5 required
account_identifiers
object
2 properties 1 required
external_account_vendor_data
object
2 properties
vendor_json
object
3 properties 3 required
add_vendor_accounts_error_reason
string
A machine-readable code describing the reason for the failure.
add_vendor_accounts_request
object
8 properties 2 required
account_verification
objectnull
Information about the account verification process. If the account has not been verified, this will be null.
finicity_account_verification
add_vendor_account_failure
object
5 properties 3 required
delete_response
object
Deleted object information
2 properties
add_accounts_request_account_identifiers
object
1 property 1 required
external_account_transaction
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

synctera-external-accounts-api-openapi.yml Raw ↑

Other APIs Synctera publishes across the network.

Synctera Webhooks
Synctera Accounts API
Synctera ACH API
Synctera Applications API
Synctera Businesses API
Synctera Card Transaction Simulations API
Synctera Card Webhook Simulations API
Synctera Cards API
Synctera Customers API
Synctera Digital Wallet Tokens API
Synctera Disclosures API
Synctera Documents (alpha) API
Where this information came from

This is an independent, third-party profile of Synctera External Accounts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.