> ## Documentation Index
> Fetch the complete documentation index at: https://developer.uphold.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Update external account
> Update an existing external account.
export const RestEndpointSubjects = ({subjects = []}) => {
const subjectToIconMap = {
'client': 'browser',
'user:individual': 'user',
'user:business': 'briefcase'
};
if (subjects.length === 0) {
return null;
}
return <>
{subjects.map(subject =>
{subject}
)}
;
};
## OpenAPI
````yaml _media/specs/core-openapi.mintlify.json patch /core/external-accounts/{externalAccountId}
openapi: 3.1.0
info:
version: 0.1.0
title: Core 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: Authentication
description: Authentication.
- name: Countries
description: Countries.
- name: Users
description: Users.
- name: KYC
description: Individual User's KYC.
- name: KYB
description: Business User's KYB.
- name: Capabilities
description: User capabilities.
- name: Terms of service
description: User terms of service.
- name: Files
description: Files.
- name: Assets
description: Assets, networks and rails.
- name: Accounts
description: Accounts.
- name: External accounts
description: External accounts.
- name: Transactions
description: Transactions.
- name: Portfolio
description: Portfolio.
- name: Statements
description: Statements.
- name: Metadata
description: Metadata.
- name: Webhooks
description: Webhooks.
paths:
/core/external-accounts/{externalAccountId}:
patch:
tags:
- External accounts
summary: Update external account
description: Update an existing external account.
operationId: core.update-external-account
parameters:
- $ref: '#/components/parameters/external-account-id'
requestBody:
$ref: '#/components/requestBodies/update-external-account-request-body'
responses:
'200':
$ref: '#/components/responses/update-external-account-response'
'404':
$ref: '#/components/responses/update-external-account-not-found-response'
security:
- OAuth2:
- core.external-accounts:update
components:
parameters:
external-account-id:
name: externalAccountId
description: The external account identifier.
in: path
required: true
schema:
type: string
format: uuid
examples:
External Account Identifier:
value: be37b37c-4c1f-4b87-b2eb-86a1ff469470
requestBodies:
update-external-account-request-body:
content:
application/json:
schema:
type: object
additionalProperties: false
minProperties: 1
properties:
label:
$ref: '#/components/schemas/external-account-label-for-request'
examples:
Update Account:
value:
label: My new VISA card
responses:
update-external-account-response:
description: External account updated.
content:
application/json:
schema:
type: object
properties:
externalAccount:
$ref: '#/components/schemas/external-account'
required:
- externalAccount
examples:
External Account Updated:
value:
externalAccount:
id: aa6e6efa-8d73-497c-8278-0347f459bd68
ownerId: 1e32fca3-23f7-40ed-bc1b-de10c790182d
type: card
status: ok
label: My new VISA card
asset: GBP
network: visa
features:
- deposit
- withdraw
details:
type: debit
last4Digits: '1519'
expiryDate:
month: 12
year: 2030
octSupport: supported
createdAt: '2024-06-01T00:00:00.000Z'
updatedAt: '2024-07-15T00:00:00.000Z'
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
update-external-account-not-found-response:
description: Resource not found.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
External Account Not Found:
value:
code: entity_not_found
message: The external account cannot be found
details:
entity: external-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
schemas:
external-account-label-for-request:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- type: string
description: The label of the external account.
maxLength: 140
external-account:
type: object
properties:
id:
description: The unique identifier of the external account.
type: string
format: uuid
ownerId:
description: The unique identifier of the user that owns the account.
type: string
format: uuid
type:
description: The type of the external account.
type: string
enum:
- card
- bank
status:
description: The status of the external account.
type: string
enum:
- processing
- ok
- expired
- failed
- restricted
- blocked
statusDetails:
description: The details of the status of the external account.
type: object
properties:
reason:
$ref: '#/components/schemas/external-account-status-reason'
required:
- reason
label:
description: The label of the external account.
type: string
asset:
description: The asset in which the external account is denominated.
type: string
network:
description: The network that the external account corresponds to.
type: string
features:
description: The features of the external account.
type: array
items:
type: string
enum:
- withdraw
- deposit
details:
description: The details of the external account based on the type and network.
oneOf:
- $ref: '#/components/schemas/external-account-details-card'
title: Card
- $ref: '#/components/schemas/external-account-details-bank-ach'
title: Bank (ACH)
- $ref: '#/components/schemas/external-account-details-bank-fps'
title: Bank (FPS)
- $ref: '#/components/schemas/external-account-details-bank-sepa'
title: Bank (SEPA)
createdAt:
description: The time at which the external account was created.
type: string
format: date-time
updatedAt:
description: The last time at which the external account was updated.
type: string
format: date-time
required:
- id
- ownerId
- type
- status
- label
- asset
- features
- details
- createdAt
- updatedAt
error:
description: The error information.
type: object
properties:
code:
description: >-
A short string with a brief explanation about the error code
reported.
type: string
message:
description: A human-readable message providing more details about the error.
type: string
details:
description: Additional information about the error reported.
type: object
additionalProperties: true
required:
- code
- message
string-no-edge-spaces:
type: string
pattern: ^\S.*\S$|^\S$
external-account-status-reason:
description: The reason why the external account is in its current status.
type: string
enum:
- card-data-invalid
- card-declined-by-bank
- card-expired
- card-permanently-declined-by-bank
- card-unauthorized
- card-unsupported
- bank-account-holder-name-mismatch
- velocity
- under-review
- unspecified-error
external-account-details-card:
type: object
properties:
type:
description: The type of the card, available if card was recognized.
type: string
enum:
- credit
- debit
last4Digits:
description: The last 4 digits of the card number.
type: string
pattern: ^[0-9]{4}$
expiryDate:
description: The expiry date of the card.
type: object
properties:
month:
type: integer
description: The expiry month of the card.
year:
type: integer
description: The expiry year of the card.
required:
- month
- year
octSupport:
description: The support for Open Credit Transfer (withdrawals) for the card.
type: string
enum:
- unknown
- supported
- unsupported
required:
- last4Digits
- expiryDate
- octSupport
external-account-details-bank-ach:
type: object
properties:
address:
$ref: '#/components/schemas/address'
routingNumber:
description: The routing number of the bank account (ABA).
type: string
accountNumber:
description: The account number of the bank account.
type: string
accountType:
description: The type of the bank account.
type: string
secondaryNetworks:
description: >-
The secondary networks that the external account can be used with,
grouped by operation.
type: object
properties:
deposit:
type: array
items:
type: string
withdraw:
type: array
items:
type: string
required:
- address
- routingNumber
- accountNumber
- accountType
external-account-details-bank-fps:
type: object
properties:
accountNumber:
description: The account number of the bank account.
type: string
sortCode:
description: The sort code of the bank account.
type: string
required:
- accountNumber
- sortCode
external-account-details-bank-sepa:
type: object
properties:
bic:
description: The bank account's BIC.
type: string
iban:
description: The IBAN.
type: string
required:
- bic
- iban
address:
description: The address information.
type: object
properties:
country:
description: The country of the address.
type: string
subdivision:
description: The subdivision of the address.
type: string
city:
description: The city of the address.
type: string
line1:
description: The first line of the address.
type: string
line2:
description: The second line of the address.
type: string
postalCode:
description: The postal code of the address.
type: string
securitySchemes:
OAuth2:
type: oauth2
description: OAuth 2.0 authentication.
flows:
clientCredentials:
tokenUrl: /core/oauth2/token
scopes:
core.users:act-on-behalf-of: Grants access to act on behalf of a user
core.users:create: Grants access to create users
core.users:read: Grants access to view users
core.users:delete: Grants access to delete users
core.users.metadata:read: Grants access to view user metadata
core.users.metadata:write: Grants access to modify user metadata
core.kyc:read: Grants access to view KYC processes
core.kyc.profile:update: Grants access to update profile KYC process
core.kyc.address:update: Grants access to update address KYC process
core.kyc.email:update: Grants access to update email KYC process
core.kyc.phone:update: Grants access to update phone KYC process
core.kyc.identity:update: Grants access to update identity KYC process
core.kyc.proof-of-address:update: Grants access to update proof-of-address KYC process
core.kyc.customer-due-diligence:update: Grants access to update customer due diligence KYC process
core.kyc.enhanced-due-diligence:update: Grants access to update enhanced due diligence KYC process
core.kyc.crypto-risk-assessment:update: Grants access to update crypto risk assessment KYC process
core.kyc.self-categorization-statement:update: Grants access to update self-categorization statement KYC process
core.kyc.tax-details:update: Grants access to update tax details KYC process
core.capabilities:read: Grants access to view user capabilities
core.terms-of-service:read: Grants access to view terms of service
core.terms-of-service:accept: Grants access to accept terms of service
core.files:create: Grants access to create files
core.files:read: Grants access to view files
core.files.metadata:read: Grants access to view files metadata
core.files.metadata:write: Grants access to modify files metadata
core.accounts:create: Grants access to create accounts
core.accounts:read: Grants access to view accounts
core.accounts:update: Grants access to update accounts
core.accounts:archive: Grants access to archive accounts
core.accounts:deposit-method: >-
Grants access to deposit method needed for depositing into
accounts
core.accounts:use-test-helpers: Grants access to test helpers of accounts
core.accounts.metadata:read: Grants access to view accounts metadata
core.accounts.metadata:write: Grants access to modify accounts metadata
core.assets:use-test-helpers: Grants access to test helpers of assets
core.external-accounts:create: Grants access to create external accounts
core.external-accounts:read: Grants access to view external accounts
core.external-accounts:update: Grants access to update external accounts
core.external-accounts:delete: Grants access to delete external accounts
core.external-accounts.metadata:read: Grants access to view external accounts metadata
core.external-accounts.metadata:write: Grants access to modify external accounts metadata
core.transactions:create: Grants access to commit quotes
core.transactions:read: Grants access to view transactions
core.transactions.metadata:read: Grants access to view transactions metadata
core.transactions.metadata:write: Grants access to modify transactions metadata
core.transactions.requests-for-information:read: Grants access to view transactions requests for information
core.transactions.requests-for-information:update: Grants access to update transactions requests for information
core.portfolio:read: >-
Grants access to view portfolio overview, performance, and
historical balance
core.statements:read: Grants access to read statements
core.webhooks:management-link: Grants access to create webhook management links
````