> ## 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.
# Get capability
> Retrieve a user capability by code.
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 get /core/capabilities/{capability}
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/capabilities/{capability}:
get:
tags:
- Capabilities
summary: Get capability
description: Retrieve a user capability by code.
operationId: core.get-capability
parameters:
- $ref: '#/components/parameters/capability-code'
responses:
'200':
$ref: '#/components/responses/get-capability-response'
security:
- OAuth2:
- core.capabilities:read
components:
parameters:
capability-code:
name: capability
description: The capability code.
in: path
required: true
schema:
$ref: '#/components/schemas/capability-code'
examples:
Trades:
value: trades
responses:
get-capability-response:
description: Capability retrieved.
content:
application/json:
schema:
type: object
properties:
capability:
$ref: '#/components/schemas/capability'
required:
- capability
examples:
Capability Retrieved:
value:
capability:
code: trades
name: Trades
enabled: true
requirements:
- user-must-submit-identity
- user-must-submit-proof-of-address
restrictions: []
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:
capability-code:
description: The code of the capability.
type: string
enum:
- crypto-withdrawals
- card-withdrawals
- bank-withdrawals
- crypto-deposits
- bank-deposits
- deposits
- receives
- sends
- trades
- cards
- unique-account-number-viban
capability:
type: object
properties:
code:
$ref: '#/components/schemas/capability-code'
name:
description: The name of the capability.
type: string
enabled:
description: >-
Whether the capability is enabled. If this is false, then there's at
least one restrictions active.
type: boolean
requirements:
description: The missing requirements for this capability to be fulfilled.
type: array
items:
type: string
enum:
- user-must-submit-crypto-risk-assessment-form
- user-must-submit-self-categorization-form
- user-must-submit-residential-address
- user-must-submit-customer-due-diligence
- user-must-submit-enhanced-due-diligence
- user-must-wait-for-the-email-cooldown-period-to-expire
- user-must-submit-full-name
- user-must-submit-identity
- user-must-submit-identity-via-physical-document
- user-must-submit-phone-number
- user-must-submit-proof-of-address
- user-must-submit-tax-details
- user-must-submit-tax-identification-number
- user-must-submit-w9-form
- user-must-accept-unique-account-number-viban-terms-of-service
- user-must-delete-card
restrictions:
description: The restrictions that are causing this capability to be disabled.
type: array
items:
type: string
enum:
- crypto-risk-assessment-form-not-valid
- financial-promotion-cooldown-running
- phone-country-not-supported
- self-categorization-statement-form-not-valid
- temporarily-disabled
- user-residential-address-not-valid
- user-cannot-receive-funds
- user-country-not-supported
- user-enhanced-due-diligence-not-valid
- user-identity-not-valid
- user-proof-of-address-not-valid
- user-screening-running
- user-state-not-supported
- user-status-not-valid
- user-w9-form-not-valid
- user-unique-card-limit-reached
required:
- code
- name
- enabled
- requirements
- restrictions
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
````