> ## Documentation Index > Fetch the complete documentation index at: https://v2.docs.conduit.financial/llms.txt > Use this file to discover all available pages before exploring further. # Get a virtual account > Retrieves one customer virtual account with client-safe deposit instructions. Requires the virtual account feature to be active. ## OpenAPI ````yaml https://api.sandbox.conduit.financial/v2/api-docs/openapi.json get /customers/{customerId}/virtual-accounts/{virtualAccountId} openapi: 3.0.0 info: title: Conduit Sandbox API description: >- **Sandbox API** — clients integrate against this surface to exercise happy and unhappy paths without consuming real KYC/PSP credits or moving real money. Customer KYC, banking partners, and crypto custody are stubbed; org-level KYB runs against real providers. Simulation endpoints under `/v2/sandbox/*` drive specific scenarios. Internal and portal endpoints are excluded from this spec. version: '2.0' contact: {} servers: - url: https://api.sandbox.conduit.financial/v2 description: Sandbox - url: https://api.conduit.financial/v2 description: Production security: - api-key: [] tags: - name: Customers - name: Registered Addresses - name: Wallets - name: Wallet Signers - name: Signing Quorum - name: Virtual Accounts - name: Applications - name: Documents - name: Verifications - name: Signing Requests - name: Transactions - name: Payouts - name: Whitelist Recipients - name: Orders - name: RFIs - name: Webhook Endpoints - name: Webhook Deliveries - name: Webhook Event Types - name: Features - name: Customer Onboarding - name: Sandbox paths: /customers/{customerId}/virtual-accounts/{virtualAccountId}: get: tags: - Virtual Accounts summary: Get a virtual account description: >- Retrieves one customer virtual account with client-safe deposit instructions. Requires the virtual account feature to be active. operationId: VirtualAccountsController_get_v2 parameters: - name: customerId required: true in: path schema: type: string - name: virtualAccountId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/VirtualAccountResponseClass' '400': description: >- **INVALID_OID_FORMAT**: A path or query parameter expected a valid object identifier but received a value that does not match the expected format. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorDto' example: type: INVALID_OID_FORMAT title: Invalid Object ID Format status: 400 detail: >- A path or query parameter expected a valid object identifier but received a value that does not match the expected format. resolution: >- Verify that all IDs in the request URL and query parameters are correctly formatted. IDs are typically prefixed strings like 'cus_...', 'app_...', or 'doc_...'. docs: https://conduit-v2.mintlify.app/errors#invalid-oid-format instance: /v2/... correlationId: req_a1b2c3d4 timestamp: '2026-01-15T09:30:00.000Z' '401': description: >- **API_KEY_MISSING**: The request did not include an API key. All API requests must be authenticated. **API_KEY_INVALID**: The provided API key is not recognized or has been revoked. content: application/json: schema: $ref: '#/components/schemas/ProblemDetailDto' example: type: API_KEY_MISSING title: API Key Missing status: 401 detail: >- The request did not include an API key. All API requests must be authenticated. resolution: >- Include your API key in the 'x-api-key' header with every request. docs: https://conduit-v2.mintlify.app/errors#api-key-missing instance: /v2/... correlationId: req_a1b2c3d4 timestamp: '2026-01-15T09:30:00.000Z' '403': description: >- **FEATURE_NOT_ENABLED**: Your account does not have access to this feature. Features are enabled on a per-account basis. content: application/json: schema: $ref: '#/components/schemas/ProblemDetailDto' example: type: FEATURE_NOT_ENABLED title: Feature Not Enabled status: 403 detail: >- Your account does not have access to this feature. Features are enabled on a per-account basis. resolution: >- Contact support to request access to this feature, or check your account settings to verify which features are enabled. docs: https://conduit-v2.mintlify.app/errors#feature-not-enabled instance: /v2/... correlationId: req_a1b2c3d4 timestamp: '2026-01-15T09:30:00.000Z' '404': description: >- **CUSTOMER_NOT_FOUND**: No customer exists with the specified ID, or the customer belongs to a different organization. **VIRTUAL_ACCOUNT_NOT_FOUND**: No virtual account exists for the requested customer and asset, or the virtual account belongs to a different organization. content: application/json: schema: $ref: '#/components/schemas/ProblemDetailDto' example: type: CUSTOMER_NOT_FOUND title: Customer Not Found status: 404 detail: >- No customer exists with the specified ID, or the customer belongs to a different organization. resolution: >- Verify the customer ID is correct. Use the list customers endpoint to find valid customer IDs for your organization. docs: https://conduit-v2.mintlify.app/errors#customer-not-found instance: /v2/... correlationId: req_a1b2c3d4 timestamp: '2026-01-15T09:30:00.000Z' '429': description: >- **RATE_LIMITED**: Too many requests. This error is returned by three independent checks: the per-organization bucket applied to every authenticated API request; the per-IP bucket applied to unauthenticated traffic before an API key is validated; and the per-IP bucket applied when repeated invalid API keys are submitted from the same address. Honor the Retry-After header (also exposed as retryAfterSeconds in the body) before retrying. Current limits and remaining budget are visible in X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset on rate-limited route responses. content: application/json: schema: $ref: '#/components/schemas/RateLimitedErrorDto' example: type: RATE_LIMITED title: Rate Limited status: 429 detail: >- Too many requests. This error is returned by three independent checks: the per-organization bucket applied to every authenticated API request; the per-IP bucket applied to unauthenticated traffic before an API key is validated; and the per-IP bucket applied when repeated invalid API keys are submitted from the same address. Honor the Retry-After header (also exposed as retryAfterSeconds in the body) before retrying. Current limits and remaining budget are visible in X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset on rate-limited route responses. resolution: >- Sleep until Retry-After seconds have elapsed, then retry. For sustained workloads exceeding the per-organization defaults, request a rate-limit increase through your support contact. docs: https://conduit-v2.mintlify.app/errors#rate-limited instance: /v2/... correlationId: req_a1b2c3d4 timestamp: '2026-01-15T09:30:00.000Z' retryAfterSeconds: 3 '500': description: >- **INTERNAL_ERROR**: An unexpected error occurred while processing your request. content: application/json: schema: $ref: '#/components/schemas/ProblemDetailDto' example: type: INTERNAL_ERROR title: Internal Error status: 500 detail: An unexpected error occurred while processing your request. resolution: >- Retry the request after a brief delay. If the error persists, contact support and include the correlationId from the error response for investigation. docs: https://conduit-v2.mintlify.app/errors#internal-error instance: /v2/... correlationId: req_a1b2c3d4 timestamp: '2026-01-15T09:30:00.000Z' components: schemas: VirtualAccountResponseClass: type: object properties: id: type: string pattern: ^vac_[0-9A-Za-z]{22}$ status: type: string enum: - pending_activation - active - disabled asset: type: object properties: code: type: string enum: - USD - EUR - GBP - CHF - JPY - CAD - AUD - NZD - SGD - HKD - CNY - KRW - INR - BRL - MXN - ARS - CLP - COP - PEN - ZAR - NGN - KES - GHS - EGP - AED - SAR - ILS - TRY - PLN - CZK - HUF - SEK - NOK - DKK - THB - IDR - MYR - PHP - VND - TWD - USDC - USDT - DAI - EURC - PYUSD - BTC - ETH - SOL - TRX description: Asset code identifier example: USD chain: type: string enum: - ethereum - base - solana - polygon - arbitrum - optimism - avalanche - tron - stellar - bsc - bitcoin description: Blockchain network. `null`/omitted for fiat assets. nullable: true required: - code balances: type: array items: type: object properties: available: type: object properties: code: type: string enum: - USD - EUR - GBP - CHF - JPY - CAD - AUD - NZD - SGD - HKD - CNY - KRW - INR - BRL - MXN - ARS - CLP - COP - PEN - ZAR - NGN - KES - GHS - EGP - AED - SAR - ILS - TRY - PLN - CZK - HUF - SEK - NOK - DKK - THB - IDR - MYR - PHP - VND - TWD - USDC - USDT - DAI - EURC - PYUSD - BTC - ETH - SOL - TRX description: Asset code (USDC, USD, etc.) chain: description: Chain when the asset is on-chain; omitted for fiat. type: string enum: - ethereum - base - solana - polygon - arbitrum - optimism - avalanche - tron - stellar - bsc - bitcoin amount: type: string description: Decimal string, asset-precision rounded required: - code - amount additionalProperties: false pending: type: object properties: code: type: string enum: - USD - EUR - GBP - CHF - JPY - CAD - AUD - NZD - SGD - HKD - CNY - KRW - INR - BRL - MXN - ARS - CLP - COP - PEN - ZAR - NGN - KES - GHS - EGP - AED - SAR - ILS - TRY - PLN - CZK - HUF - SEK - NOK - DKK - THB - IDR - MYR - PHP - VND - TWD - USDC - USDT - DAI - EURC - PYUSD - BTC - ETH - SOL - TRX description: Asset code (USDC, USD, etc.) chain: description: Chain when the asset is on-chain; omitted for fiat. type: string enum: - ethereum - base - solana - polygon - arbitrum - optimism - avalanche - tron - stellar - bsc - bitcoin amount: type: string description: Decimal string, asset-precision rounded required: - code - amount additionalProperties: false frozen: type: object properties: code: type: string enum: - USD - EUR - GBP - CHF - JPY - CAD - AUD - NZD - SGD - HKD - CNY - KRW - INR - BRL - MXN - ARS - CLP - COP - PEN - ZAR - NGN - KES - GHS - EGP - AED - SAR - ILS - TRY - PLN - CZK - HUF - SEK - NOK - DKK - THB - IDR - MYR - PHP - VND - TWD - USDC - USDT - DAI - EURC - PYUSD - BTC - ETH - SOL - TRX description: Asset code (USDC, USD, etc.) chain: description: Chain when the asset is on-chain; omitted for fiat. type: string enum: - ethereum - base - solana - polygon - arbitrum - optimism - avalanche - tron - stellar - bsc - bitcoin amount: type: string description: Decimal string, asset-precision rounded required: - code - amount additionalProperties: false required: - available - pending - frozen description: >- Balance for one asset on an account: available, pending, and frozen buckets all in the same asset. depositInstructions: type: array items: oneOf: - type: object properties: type: type: string enum: - domestic_usd accountNumber: type: string beneficiaryName: type: string beneficiaryAddress: type: string bank: type: object properties: legalName: type: string address: type: string bic: type: string required: - legalName - address paymentReference: type: string rails: minItems: 1 type: array items: type: object properties: rail: anyOf: - type: string enum: - ach - type: string enum: - fedwire - type: string enum: - rtp routingNumber: type: string sameDayEligible: type: boolean networks: type: array items: type: string enum: - tch - fednow fednowCap: type: string required: - rail - routingNumber required: - type - accountNumber - beneficiaryName - rails - type: object properties: type: type: string enum: - swift_usd accountNumber: type: string iban: type: string beneficiaryName: type: string beneficiaryAddress: type: string bank: type: object properties: legalName: type: string address: type: string bic: type: string required: - legalName - address correspondent: type: object properties: name: type: string minLength: 1 maxLength: 255 address: type: string minLength: 1 maxLength: 512 bic: type: string pattern: ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$ accountNumber: type: string minLength: 1 maxLength: 64 required: - name - address - bic paymentReference: type: string rails: minItems: 1 maxItems: 1 type: array items: type: object properties: rail: type: string enum: - swift required: - rail required: - type - beneficiaryName - rails activatedAt: type: string format: date-time description: ISO 8601 timestamp example: '2026-01-15T09:30:00.000Z' nullable: true createdAt: type: string format: date-time description: ISO 8601 timestamp example: '2026-01-15T09:30:00.000Z' updatedAt: type: string format: date-time description: ISO 8601 timestamp example: '2026-01-15T09:30:00.000Z' required: - id - status - asset - balances - depositInstructions - activatedAt - createdAt - updatedAt ValidationErrorDto: type: object properties: type: type: string description: Machine-readable error code example: CUSTOMER_NOT_FOUND title: type: string description: Human-readable error type label example: Customer Not Found status: type: number description: HTTP status code example: 404 detail: type: string description: Human-readable explanation of this occurrence example: Customer with id cus_abc123 not found resolution: type: string description: What the developer should do to resolve this error example: >- Verify the customer ID. Check you are using the correct API key for this organization. docs: type: string description: URL to error documentation example: https://conduit-v2.mintlify.app/errors#customer-not-found instance: type: string description: Request path that produced the error example: /v2/customers/cus_abc123 correlationId: description: Request correlation ID example: req_a1b2c3d4 type: string timestamp: type: string description: ISO 8601 UTC timestamp example: '2026-04-27T20:00:00.000Z' details: description: >- Additional structured data for domain-specific errors (e.g. missing field lists, pair info) errors: type: array items: type: object properties: pointer: type: string description: JSON pointer to the invalid field example: /email detail: type: string description: What is wrong with this field example: Invalid email format allowedValues: description: The values this field accepts, when it is a closed set example: - ach - fedwire - rtp type: array items: type: string category: description: >- Class of blocker (requirements-validator output only). 'field' = form-field gap, 'document' = missing or insufficient document (including per-UBO document slots), 'individual' = required person missing. example: field type: string enum: - field - document - individual required: - pointer - detail required: - type - title - status - detail - resolution - docs - instance - timestamp ProblemDetailDto: type: object properties: type: type: string description: Machine-readable error code example: CUSTOMER_NOT_FOUND title: type: string description: Human-readable error type label example: Customer Not Found status: type: number description: HTTP status code example: 404 detail: type: string description: Human-readable explanation of this occurrence example: Customer with id cus_abc123 not found resolution: type: string description: What the developer should do to resolve this error example: >- Verify the customer ID. Check you are using the correct API key for this organization. docs: type: string description: URL to error documentation example: https://conduit-v2.mintlify.app/errors#customer-not-found instance: type: string description: Request path that produced the error example: /v2/customers/cus_abc123 correlationId: description: Request correlation ID example: req_a1b2c3d4 type: string timestamp: type: string description: ISO 8601 UTC timestamp example: '2026-04-27T20:00:00.000Z' details: description: >- Additional structured data for domain-specific errors (e.g. missing field lists, pair info) required: - type - title - status - detail - resolution - docs - instance - timestamp RateLimitedErrorDto: type: object properties: type: type: string description: Machine-readable error code example: CUSTOMER_NOT_FOUND title: type: string description: Human-readable error type label example: Customer Not Found status: type: number description: HTTP status code example: 404 detail: type: string description: Human-readable explanation of this occurrence example: Customer with id cus_abc123 not found resolution: type: string description: What the developer should do to resolve this error example: >- Verify the customer ID. Check you are using the correct API key for this organization. docs: type: string description: URL to error documentation example: https://conduit-v2.mintlify.app/errors#customer-not-found instance: type: string description: Request path that produced the error example: /v2/customers/cus_abc123 correlationId: description: Request correlation ID example: req_a1b2c3d4 type: string timestamp: type: string description: ISO 8601 UTC timestamp example: '2026-04-27T20:00:00.000Z' details: description: >- Additional structured data for domain-specific errors (e.g. missing field lists, pair info) retryAfterSeconds: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 description: Seconds to wait before retrying example: 3 required: - type - title - status - detail - resolution - docs - instance - timestamp - retryAfterSeconds securitySchemes: api-key: type: apiKey in: header name: x-api-key ````