# Q2 External Account API

**Canonical:** https://apis.io/apis/q2/q2-external-account-api/  
**Provider:** Q2 — https://apis.io/providers/q2/  
**Base URL:** https://api.helix.q2.com  
**Documentation:** https://docs.helix.q2.com

Q2 External Account API is one of 28 APIs that [Q2](https://apis.io/providers/q2/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include External Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a quickstart, authentication docs, rate-limit docs, and 6 JSON Schemas.

Endpoints for the externalAccount object

## Operations (11)

| Method | Path | Summary |
|---|---|---|
| POST | `/externalAccount/archive` | Archive an external account |
| POST | `/externalAccount/create` | Create an external account |
| GET | `/externalAccount/get/{customerId}/{externalAccountId}` | Get an external account |
| GET | `/externalAccount/getByTag/{customerId}/{tag}` | Get an external account via tag |
| POST | `/externalAccount/initiate` | Initiate an external account |
| GET | `/externalAccount/list/{customerId}` | List external accounts |
| POST | `/externalAccount/lock` | Lock an external account |
| POST | `/externalAccount/resendVerification` | Resend verification deposits |
| POST | `/externalAccount/unlock` | Unlock an external account |
| POST | `/externalAccount/update` | Update an external account |
| POST | `/externalAccount/verify` | Verify an external account |

## Machine-readable artifacts (21)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/openapi/q2-external-account-api-openapi.yml
- **Documentation** — https://docs.helix.q2.com
- **APIReference** — https://docs.helix.q2.com/reference
- **Quickstart** — https://docs.helix.q2.com/reference/quickstart
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/authentication/q2-authentication.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/rate-limits/q2-rate-limits.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/errors/q2-error-codes.yml
- **Sandbox** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/sandbox/q2-sandbox.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/conventions/q2-conventions.yml
- **Lifecycle** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/lifecycle/q2-lifecycle.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/data-model/q2-data-model.yml
- **Conformance** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/conformance/q2-conformance.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/asyncapi/q2-events-webhooks.yml
- **X-MCPServerCandidate** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/mcp/q2-mcp.yml
- **LLMsTxt** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/llms/q2-llms.txt
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/json-schema/q2-customer-object200-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/json-schema/q2-program-get200-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/json-schema/q2-card-object200-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/json-schema/q2-account-object200-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/json-schema/q2-transaction-object200-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/q2/refs/heads/main/json-schema/q2-customer-no-business-fields-array200-response-schema.json

## Other Q2 APIs (12)

- [Q2 Account API](https://apis.io/apis/q2/q2-account-api/)
- [Q2 Account Beneficiary API](https://apis.io/apis/q2/q2-account-beneficiary-api/)
- [Q2 Account - Entitlement API](https://apis.io/apis/q2/q2-account-entitlement-api/)
- [Q2 Account - Hold API](https://apis.io/apis/q2/q2-account-hold-api/)
- [Q2 Account - Limit API](https://apis.io/apis/q2/q2-account-limit-api/)
- [Q2 Account - Stop Pay API](https://apis.io/apis/q2/q2-account-stop-pay-api/)
- [Q2 Bank Document API](https://apis.io/apis/q2/q2-bank-document-api/)
- [Q2 Card API](https://apis.io/apis/q2/q2-card-api/)
- [Q2 Card Control API](https://apis.io/apis/q2/q2-card-control-api/)
- [Q2 Card - Fraud Text Alert API](https://apis.io/apis/q2/q2-card-fraud-text-alert-api/)
- [Q2 Card - Limit API](https://apis.io/apis/q2/q2-card-limit-api/)
- [Q2 Card - Mock API](https://apis.io/apis/q2/q2-card-mock-api/)

## Tags

External Account

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/q2/q2-external-account-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/q2/.