Uphold

Uphold Accounts API

Accounts.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.uphold.com/rest-apis/introduction
📖
APIReference
https://developer.uphold.com/rest-apis/core-api/concepts
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/authentication/uphold-authentication.yml
📖
Documentation
https://developer.uphold.com/widgets/introduction
📖
Documentation
https://developer.uphold.com/rest-apis/market-pulse-api/assets/get-asset-information
📖
Documentation
https://developer.uphold.com/rest-apis/kyc-connector-api/introduction
📖
Documentation
https://developer.uphold.com/rest-apis/topper-api/kyc-sharing/create-session

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/openapi/uphold-accounts-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/scopes/uphold-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/conventions/uphold-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/errors/uphold-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/data-model/uphold-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/asyncapi/uphold-core-webhooks.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/sandbox/uphold-sandbox.yml
🔗
Components
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/components/uphold-components.yml
🔗
ChangeLog
https://developer.uphold.com/widgets/changelog

OpenAPI Specification

uphold-accounts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 0.1.0
  title: Core Accounts API
  description: The Core API provides essential building blocks that empower businesses to embed financial services into their applications.
  contact:
    name: Uphold API Team
    email: developers@uphold.com
    url: https://developer.uphold.com
servers:
- url: https://api.enterprise.sandbox.uphold.com
  description: Sandbox
- url: https://api.enterprise.uphold.com
  description: Production
security:
- OAuth2: []
tags:
- name: Accounts
  description: Accounts.
paths:
  /core/accounts:
    get:
      operationId: core.list-accounts
      summary: List accounts
      description: List accounts owned by a user.
      tags:
      - Accounts
      x-uphold:
        security:
          OAuth2:
            subjects:
            - user:business
            - user:individual
      security:
      - OAuth2:
        - core.accounts:read
      parameters:
      - $ref: '#/components/parameters/list-accounts-asset-code-filter'
      - $ref: '#/components/parameters/pagination-per-page'
      - $ref: '#/components/parameters/x-on-behalf-of'
      - $ref: '#/components/parameters/x-uphold-user-ip'
      - $ref: '#/components/parameters/x-uphold-user-agent'
      - $ref: '#/components/parameters/x-uphold-user-origin'
      - $ref: '#/components/parameters/x-uphold-user-country'
      - $ref: '#/components/parameters/x-uphold-user-subdivision'
      - $ref: '#/components/parameters/x-uphold-user-city'
      responses:
        '200':
          $ref: '#/components/responses/list-accounts-response'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
    post:
      operationId: core.create-account
      summary: Create account
      description: Create a new account.
      tags:
      - Accounts
      x-uphold:
        security:
          OAuth2:
            subjects:
            - user:business
            - user:individual
      security:
      - OAuth2:
        - core.accounts:create
      parameters:
      - $ref: '#/components/parameters/x-on-behalf-of'
      - $ref: '#/components/parameters/x-uphold-user-ip'
      - $ref: '#/components/parameters/x-uphold-user-agent'
      - $ref: '#/components/parameters/x-uphold-user-origin'
      - $ref: '#/components/parameters/x-uphold-user-country'
      - $ref: '#/components/parameters/x-uphold-user-subdivision'
      - $ref: '#/components/parameters/x-uphold-user-city'
      requestBody:
        $ref: '#/components/requestBodies/create-account-request-body'
      responses:
        '201':
          $ref: '#/components/responses/create-account-response'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/asset-not-found-response'
        '409':
          $ref: '#/components/responses/create-account-conflict-response'
        '429':
          $ref: '#/components/responses/too-many-requests'
  /core/accounts/defaults:
    get:
      operationId: core.list-default-accounts
      summary: List default accounts
      description: List the default account for each asset owned by a user.
      tags:
      - Accounts
      x-uphold:
        security:
          OAuth2:
            subjects:
            - user:business
            - user:individual
      security:
      - OAuth2:
        - core.accounts:read
      parameters:
      - $ref: '#/components/parameters/list-default-accounts-asset-code-filter'
      - $ref: '#/components/parameters/x-on-behalf-of'
      - $ref: '#/components/parameters/x-uphold-user-ip'
      - $ref: '#/components/parameters/x-uphold-user-agent'
      - $ref: '#/components/parameters/x-uphold-user-origin'
      - $ref: '#/components/parameters/x-uphold-user-country'
      - $ref: '#/components/parameters/x-uphold-user-subdivision'
      - $ref: '#/components/parameters/x-uphold-user-city'
      responses:
        '200':
          $ref: '#/components/responses/list-default-accounts-response'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '429':
          $ref: '#/components/responses/too-many-requests'
  /core/accounts/{accountId}:
    get:
      operationId: core.get-account
      summary: Get account
      description: Retrieve an existing account by id.
      tags:
      - Accounts
      x-uphold:
        security:
          OAuth2:
            subjects:
            - user:business
            - user:individual
      security:
      - OAuth2:
        - core.accounts:read
      parameters:
      - $ref: '#/components/parameters/account-id'
      - $ref: '#/components/parameters/x-on-behalf-of'
      - $ref: '#/components/parameters/x-uphold-user-ip'
      - $ref: '#/components/parameters/x-uphold-user-agent'
      - $ref: '#/components/parameters/x-uphold-user-origin'
      - $ref: '#/components/parameters/x-uphold-user-country'
      - $ref: '#/components/parameters/x-uphold-user-subdivision'
      - $ref: '#/components/parameters/x-uphold-user-city'
      responses:
        '200':
          $ref: '#/components/responses/get-account-response'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/get-account-not-found-response'
        '429':
          $ref: '#/components/responses/too-many-requests'
    patch:
      operationId: core.update-account
      summary: Update account
      description: Update an existing account.
      tags:
      - Accounts
      x-uphold:
        security:
          OAuth2:
            subjects:
            - user:business
            - user:individual
      security:
      - OAuth2:
        - core.accounts:update
      parameters:
      - $ref: '#/components/parameters/account-id'
      - $ref: '#/components/parameters/x-on-behalf-of'
      - $ref: '#/components/parameters/x-uphold-user-ip'
      - $ref: '#/components/parameters/x-uphold-user-agent'
      - $ref: '#/components/parameters/x-uphold-user-origin'
      - $ref: '#/components/parameters/x-uphold-user-country'
      - $ref: '#/components/parameters/x-uphold-user-subdivision'
      - $ref: '#/components/parameters/x-uphold-user-city'
      requestBody:
        $ref: '#/components/requestBodies/update-account-request-body'
      responses:
        '200':
          $ref: '#/components/responses/update-account-response'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/update-account-not-found-response'
        '429':
          $ref: '#/components/responses/too-many-requests'
    delete:
      operationId: core.archive-account
      summary: Archive account
      description: Archive an existing account.
      tags:
      - Accounts
      x-uphold:
        security:
          OAuth2:
            subjects:
            - user:business
            - user:individual
      security:
      - OAuth2:
        - core.accounts:archive
      parameters:
      - $ref: '#/components/parameters/account-id'
      - $ref: '#/components/parameters/x-on-behalf-of'
      - $ref: '#/components/parameters/x-uphold-user-ip'
      - $ref: '#/components/parameters/x-uphold-user-agent'
      - $ref: '#/components/parameters/x-uphold-user-origin'
      - $ref: '#/components/parameters/x-uphold-user-country'
      - $ref: '#/components/parameters/x-uphold-user-subdivision'
      - $ref: '#/components/parameters/x-uphold-user-city'
      responses:
        '204':
          $ref: '#/components/responses/archive-account-response'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/archive-account-not-found-response'
        '409':
          $ref: '#/components/responses/archive-account-conflict-response'
        '429':
          $ref: '#/components/responses/too-many-requests'
  /core/accounts/{accountId}/deposit-method:
    get:
      operationId: core.get-account-deposit-method
      summary: Get account deposit method
      description: Gets deposit method for depositing into an account externally.
      tags:
      - Accounts
      x-uphold:
        security:
          OAuth2:
            subjects:
            - user:business
            - user:individual
      security:
      - OAuth2:
        - core.accounts:deposit-method
      parameters:
      - $ref: '#/components/parameters/account-id'
      - $ref: '#/components/parameters/account-deposit-method-type'
      - $ref: '#/components/parameters/account-deposit-method-asset'
      - $ref: '#/components/parameters/account-deposit-method-network'
      - $ref: '#/components/parameters/x-on-behalf-of'
      - $ref: '#/components/parameters/x-uphold-user-ip'
      - $ref: '#/components/parameters/x-uphold-user-agent'
      - $ref: '#/components/parameters/x-uphold-user-origin'
      - $ref: '#/components/parameters/x-uphold-user-country'
      - $ref: '#/components/parameters/x-uphold-user-subdivision'
      - $ref: '#/components/parameters/x-uphold-user-city'
      responses:
        '200':
          $ref: '#/components/responses/get-account-deposit-method-response'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/get-account-deposit-method-account-not-found-response'
        '409':
          $ref: '#/components/responses/get-account-deposit-method-conflict-response'
        '429':
          $ref: '#/components/responses/too-many-requests'
    put:
      operationId: core.setup-account-deposit-method
      summary: Set up account deposit method
      description: Sets up a deposit method for depositing into an account externally.
      tags:
      - Accounts
      x-uphold:
        security:
          OAuth2:
            subjects:
            - user:business
            - user:individual
      security:
      - OAuth2:
        - core.accounts:deposit-method
      parameters:
      - $ref: '#/components/parameters/account-id'
      - $ref: '#/components/parameters/account-deposit-method-type'
      - $ref: '#/components/parameters/account-deposit-method-asset'
      - $ref: '#/components/parameters/account-deposit-method-network'
      - $ref: '#/components/parameters/x-on-behalf-of'
      - $ref: '#/components/parameters/x-uphold-user-ip'
      - $ref: '#/components/parameters/x-uphold-user-agent'
      - $ref: '#/components/parameters/x-uphold-user-origin'
      - $ref: '#/components/parameters/x-uphold-user-country'
      - $ref: '#/components/parameters/x-uphold-user-subdivision'
      - $ref: '#/components/parameters/x-uphold-user-city'
      responses:
        '200':
          $ref: '#/components/responses/setup-account-deposit-method-response'
        '201':
          $ref: '#/components/responses/setup-account-deposit-method-response'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/setup-account-deposit-method-account-not-found-response'
        '409':
          $ref: '#/components/responses/setup-account-deposit-method-conflict-response'
        '429':
          $ref: '#/components/responses/too-many-requests'
  /core/accounts/test-helpers/bank-deposits:
    post:
      operationId: core.simulate-bank-deposit
      summary: Simulate bank deposit
      description: Simulate an incoming bank deposit for testing purposes.
      tags:
      - Accounts
      security:
      - OAuth2:
        - core.accounts:use-test-helpers
      x-uphold:
        operation:
          notImplementedIn:
          - production
        security:
          OAuth2:
            subjects:
            - user:business
            - user:individual
      parameters:
      - $ref: '#/components/parameters/x-on-behalf-of'
      - $ref: '#/components/parameters/x-uphold-user-ip'
      - $ref: '#/components/parameters/x-uphold-user-agent'
      - $ref: '#/components/parameters/x-uphold-user-origin'
      - $ref: '#/components/parameters/x-uphold-user-country'
      - $ref: '#/components/parameters/x-uphold-user-subdivision'
      - $ref: '#/components/parameters/x-uphold-user-city'
      requestBody:
        $ref: '#/components/requestBodies/simulate-bank-deposit-request-body'
      responses:
        '202':
          $ref: '#/components/responses/simulate-bank-deposit-response'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/simulate-bank-deposit-not-found-response'
        '409':
          $ref: '#/components/responses/simulate-bank-deposit-conflict-response'
        '429':
          $ref: '#/components/responses/too-many-requests'
  /core/accounts/test-helpers/crypto-deposits:
    post:
      operationId: core.simulate-crypto-deposit
      summary: Simulate crypto deposit
      description: Simulate an incoming crypto deposit for testing purposes.
      tags:
      - Accounts
      security:
      - OAuth2:
        - core.accounts:use-test-helpers
      x-uphold:
        operation:
          notImplementedIn:
          - production
        security:
          OAuth2:
            subjects:
            - user:business
            - user:individual
      parameters:
      - $ref: '#/components/parameters/x-on-behalf-of'
      - $ref: '#/components/parameters/x-uphold-user-ip'
      - $ref: '#/components/parameters/x-uphold-user-agent'
      - $ref: '#/components/parameters/x-uphold-user-origin'
      - $ref: '#/components/parameters/x-uphold-user-country'
      - $ref: '#/components/parameters/x-uphold-user-subdivision'
      - $ref: '#/components/parameters/x-uphold-user-city'
      requestBody:
        $ref: '#/components/requestBodies/simulate-crypto-deposit-request-body'
      responses:
        '202':
          $ref: '#/components/responses/simulate-crypto-deposit-response'
        '400':
          $ref: '#/components/responses/bad-request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/simulate-crypto-deposit-not-found-response'
        '409':
          $ref: '#/components/responses/simulate-crypto-deposit-conflict-response'
        '429':
          $ref: '#/components/responses/too-many-requests'
webhooks:
  core.account.created:
    post:
      operationId: core.account-created
      summary: Account Created
      description: An account has been created.
      tags:
      - Accounts
      parameters:
      - $ref: '#/components/parameters/webhook-id'
      - $ref: '#/components/parameters/webhook-timestamp'
      - $ref: '#/components/parameters/webhook-signature'
      requestBody:
        description: Account created event.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/account-webhook-event'
            examples:
              Account Created:
                value:
                  id: 123e4567-e89b-12d3-a456-426614174000
                  type: core.account.created
                  createdAt: '2021-01-01T00:00:00.000Z'
                  data:
                    account:
                      id: 555a99a1-620d-4431-a0ac-b43e1aad2bdc
                      ownerId: 1e32fca3-23f7-40ed-bc1b-de10c790182d
                      label: My BTC account
                      asset: BTC
                      balance:
                        total: '0'
                        available: '0'
                      createdAt: '2024-06-01T00:00:00.000Z'
                      updatedAt: '2024-07-15T00:00:00.000Z'
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
  core.account.balance-changed:
    post:
      operationId: core.account-balance-changed
      summary: Account Balance Changed
      description: The balance of an account has changed.
      tags:
      - Accounts
      parameters:
      - $ref: '#/components/parameters/webhook-id'
      - $ref: '#/components/parameters/webhook-timestamp'
      - $ref: '#/components/parameters/webhook-signature'
      requestBody:
        description: Account balance changed event.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/account-webhook-event'
            examples:
              Account Balance Changed:
                value:
                  id: 123e4567-e89b-12d3-a456-426614174000
                  type: core.account.balance.changed
                  createdAt: '2021-01-01T00:00:00.000Z'
                  data:
                    account:
                      id: 555a99a1-620d-4431-a0ac-b43e1aad2bdc
                      ownerId: 1e32fca3-23f7-40ed-bc1b-de10c790182d
                      label: My BTC account
                      asset: BTC
                      balance:
                        total: '0.5'
                        available: '0.3'
                      createdAt: '2024-06-01T00:00:00.000Z'
                      updatedAt: '2024-07-15T00:00:00.000Z'
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
  core.account.archived:
    post:
      operationId: core.account-archived
      summary: Account archived
      description: An account has been archived.
      tags:
      - Accounts
      parameters:
      - $ref: '#/components/parameters/webhook-id'
      - $ref: '#/components/parameters/webhook-timestamp'
      - $ref: '#/components/parameters/webhook-signature'
      requestBody:
        description: Account archived event.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/account-webhook-event'
            examples:
              Account Archived:
                value:
                  id: 123e4567-e89b-12d3-a456-426614174000
                  type: core.account.archived
                  createdAt: '2021-01-01T00:00:00.000Z'
                  data:
                    account:
                      id: 555a99a1-620d-4431-a0ac-b43e1aad2bdc
                      ownerId: 1e32fca3-23f7-40ed-bc1b-de10c790182d
                      label: My BTC account
                      asset: BTC
                      balance:
                        total: '0'
                        available: '0'
                      createdAt: '2024-06-01T00:00:00.000Z'
                      updatedAt: '2024-07-15T00:00:00.000Z'
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
  core.account.unarchived:
    post:
      operationId: core.account-unarchived
      summary: Account unarchived
      description: An account has been unarchived.
      tags:
      - Accounts
      parameters:
      - $ref: '#/components/parameters/webhook-id'
      - $ref: '#/components/parameters/webhook-timestamp'
      - $ref: '#/components/parameters/webhook-signature'
      requestBody:
        description: Account unarchived event.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/account-webhook-event'
            examples:
              Account Unarchived:
                value:
                  id: 123e4567-e89b-12d3-a456-426614174000
                  type: core.account.unarchived
                  createdAt: '2021-01-01T00:00:00.000Z'
                  data:
                    account:
                      id: 555a99a1-620d-4431-a0ac-b43e1aad2bdc
                      ownerId: 1e32fca3-23f7-40ed-bc1b-de10c790182d
                      label: My BTC account
                      asset: BTC
                      balance:
                        total: '0'
                        available: '0'
                      createdAt: '2024-06-01T00:00:00.000Z'
                      updatedAt: '2024-07-15T00:00:00.000Z'
      responses:
        '200':
          description: Return a 200 status to indicate that the data was received successfully.
components:
  responses:
    update-account-not-found-response:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            Account Not Found:
              value:
                code: entity_not_found
                message: The account cannot be found
                details:
                  entity: account
      headers:
        x-uphold-request-id:
          description: A unique identifier for the request that can be shared with Uphold for troubleshooting purposes.
          required: true
          schema:
            type: string
            format: uuid
          examples:
            Request ID:
              value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
    too-many-requests:
      description: Too Many Requests.
      headers:
        Retry-After:
          description: The number of seconds to wait before making a new request.
          schema:
            type: integer
            format: int32
          examples:
            Retry After:
              value: 60
        x-uphold-request-id:
          description: A unique identifier for the request that can be shared with Uphold for troubleshooting purposes.
          required: true
          schema:
            type: string
            format: uuid
          examples:
            Request ID:
              value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            Too Many Requests:
              value:
                code: too_many_requests
                message: Try again later
    simulate-bank-deposit-response:
      description: Bank deposit simulated.
      content:
        application/json:
          schema:
            type: object
            properties:
              bankDeposit:
                type: object
                discriminator:
                  propertyName: network
                  mapping:
                    fps: '#/components/schemas/simulate-bank-deposit-fps'
                    sepa: '#/components/schemas/simulate-bank-deposit-sepa'
                    ach: '#/components/schemas/simulate-bank-deposit-ach'
                    fednow: '#/components/schemas/simulate-bank-deposit-fednow'
                    rtp: '#/components/schemas/simulate-bank-deposit-rtp'
                    wire: '#/components/schemas/simulate-bank-deposit-wire'
                oneOf:
                - title: FPS
                  $ref: '#/components/schemas/simulate-bank-deposit-fps'
                - title: SEPA
                  $ref: '#/components/schemas/simulate-bank-deposit-sepa'
                - title: ACH
                  $ref: '#/components/schemas/simulate-bank-deposit-ach'
                - title: FedNow
                  $ref: '#/components/schemas/simulate-bank-deposit-fednow'
                - title: RTP
                  $ref: '#/components/schemas/simulate-bank-deposit-rtp'
                - title: Wire
                  $ref: '#/components/schemas/simulate-bank-deposit-wire'
            required:
            - bankDeposit
          examples:
            FPS Bank Deposit Accepted:
              value:
                bankDeposit:
                  network: fps
                  sortCode: '123456'
                  accountNumber: '12345678'
                  reference: UH12345678
                  asset: GBP
                  amount: '100'
                  remitter:
                    name: John Doe
                    sortCode: '654321'
                    accountNumber: '87654321'
            SEPA Bank Deposit Accepted:
              value:
                bankDeposit:
                  network: sepa
                  iban: AT487954841229809844
                  reference: UH12345678
                  asset: EUR
                  amount: '100'
                  remitter:
                    name: John Doe
                    bic: LHVBEE22
                    iban: DE89370400440532013000
            ACH Bank Deposit Accepted:
              value:
                bankDeposit:
                  network: ach
                  accountNumber: '378928485630'
                  routingNumber: 021214891
                  asset: USD
                  amount: '123'
                  remitter:
                    name: John Doe
                    accountNumber: '987654321'
                    routingNumber: 021214891
                    secCode: CCD
                    transactionType: Push
                    serviceType: SameDay
            FedNow Bank Deposit Accepted:
              value:
                bankDeposit:
                  network: fednow
                  accountNumber: '378928485630'
                  asset: USD
                  amount: '150'
                  remitter:
                    name: John Doe
                    accountNumber: '1234567890'
                    routingNumber: 026009593
            RTP Bank Deposit Accepted:
              value:
                bankDeposit:
                  network: rtp
                  accountNumber: '378928485630'
                  asset: USD
                  amount: '150'
                  remitter:
                    name: John Doe
                    accountNumber: '1234567890'
                    routingNumber: 026009593
            Wire Bank Deposit Accepted:
              value:
                bankDeposit:
                  network: wire
                  accountNumber: '378928485630'
                  amount: '200'
                  asset: USD
                  remitter:
                    name: John Doe
      headers:
        x-uphold-request-id:
          description: A unique identifier for the request that can be shared with Uphold for troubleshooting purposes.
          required: true
          schema:
            type: string
            format: uuid
          examples:
            Request ID:
              value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
    create-account-response:
      description: Account created.
      content:
        application/json:
          schema:
            type: object
            properties:
              account:
                $ref: '#/components/schemas/account'
              errors:
                description: Additional contextual errors that occurred while processing the request.
                type: object
                properties:
                  metadata:
                    allOf:
                    - $ref: '#/components/schemas/error'
                    - description: Error related to metadata processing.
            required:
            - account
          examples:
            Account Created:
              value:
                account:
                  id: 555a99a1-620d-4431-a0ac-b43e1aad2bdc
                  ownerId: 1e32fca3-23f7-40ed-bc1b-de10c790182d
                  label: My BTC account
                  asset: BTC
                  balance:
                    total: '0'
                    available: '0'
                  createdAt: '2024-06-01T00:00:00.000Z'
                  updatedAt: '2024-07-15T00:00:00.000Z'
            Account Created With Metadata Error:
              value:
                account:
                  id: 555a99a1-620d-4431-a0ac-b43e1aad2bdc
                  ownerId: 1e32fca3-23f7-40ed-bc1b-de10c790182d
                  label: My BTC account
                  asset: BTC
                  balance:
                    total: '0'
                    available: '0'
                  createdAt: '2024-06-01T00:00:00.000Z'
                  updatedAt: '2024-07-15T00:00:00.000Z'
                errors:
                  metadata:
                    code: content_too_large
                    message: The entity metadata size is greater than maximum size limit
                    details:
                      threshold:
                        unit: characters
                        limit: 1024
      headers:
        x-uphold-request-id:
          description: A unique identifier for the request that can be shared with Uphold for troubleshooting purposes.
          required: true
          schema:
            type: string
            format: uuid
          examples:
            Request ID:
              value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
    get-account-deposit-method-response:
      description: Deposit method retrieved.
      content:
        application/json:
          schema:
            type: object
            properties:
              depositMethod:
                $ref: '#/components/schemas/account-deposit-method'
            required:
            - depositMethod
          examples:
            Bitcoin Crypto Deposit Method:
              value:
                depositMethod:
                  type: crypto
                  status: ok
                  details:
                    asset: BTC
                    network: bitcoin
                    address: tb1qktapuxvq6u39n7tc4sfkp9q8vwecrqza7xeqhn
                    addressFormats:
                    - format: native-segwit
                      value: tb1qktapuxvq6u39n7tc4sfkp9q8vwecrqza7xeqhn
                    - format: wrapped-segwit
                      value: 2MzJXEZeyJV4jMHxkeGY7x88DPpF15p78ks
            Stellar Crypto Deposit Method:
              value:
                depositMethod:
                  type: crypto
                  status: ok
                  details:
                    asset: XLM
                    network: stellar
                    address: GC3ZSJ3K2HKSN7MKK2SXNFBELR5Y5WE5HMVDO7UG6SQE55DEJY55BYWK
                    addressFormats:
                    - format: pubkey-hash
                      value: GC3ZSJ3K2HKSN7MKK2SXNFBELR5Y5WE5HMVDO7UG6SQE55DEJY55BYWK
                    reference: 0123456789
            FPS Bank Deposit Method:
              value:
                depositMethod:
                  type: bank
                  status: ok
                  details:
                    network: fps
                    asset: GBP
                    beneficiary: John Doe
                    bankName: Example Bank
                    bankAddress:
                      line1: 123 Bank Street
                      line2: London, United Kingdom
                    sortCode: '123456'
                    accountNumber: '12345678'
                    reference: UH12345678
            SEPA Bank Deposit Method:
              value:
                depositMethod:
                  type: bank
                  status: ok
                  details:
                    network: sepa
                    asset: EUR
                    beneficiary: John Doe
                    bankName: Example Bank
                    bankAddress:
                      line1: 123 Bank Street
                      line2: Vienna, Austria
                    bic: EXAAAT2K
                    iban: AT487954841229809844
                    reference: UH12345678
            ACH Bank Deposit Method:
              value:
                depositMethod:
                  type: bank
                  status: ok
                  details:
                    network: ach
                    asset: USD
                    beneficiary: John Doe
                    bankName: Cross River Bank
                    bankAddress:
                      line1: 2 Riverview Dr
                      line2: Fort Lee, NJ 07024
                    routingNumber: 021214891
                    accountNumber: '377876871270'
                    accountType: checking
           

# --- truncated at 32 KB (115 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/openapi/uphold-accounts-api-openapi.yml