Get capability
Core API
- Concepts
- Authentication
- Countries
- Users
- KYC
- Capabilities
- Terms of Service
- Files
- Assets
- Accounts
- External Accounts
- Transactions
- Webhooks
Widgets API
- Payment
Get capability
Retrieve a user capability by code.
GET
/
core
/
capabilities
/
{capability}
curl --request GET \
--url https://api.enterprise.sandbox.uphold.com/core/capabilities/{capability} \
--header 'Authorization: Bearer <token>'
{
"capability": {
"code": "trades",
"name": "Trades",
"enabled": true,
"requirements": [
"user-must-submit-identity",
"user-must-submit-proof-of-address"
],
"restrictions": []
}
}
Authorizations
OAuth 2.0 authentication.
Path Parameters
The capability code.
Available options:
crypto-withdrawals
, card-withdrawals
, bank-withdrawals
, deposits
, receives
, sends
, trades
Response
200 - application/json
Capability retrieved.
The code of the capability.
Available options:
crypto-withdrawals
, card-withdrawals
, bank-withdrawals
, deposits
, receives
, sends
, trades
The name of the capability.
Whether the capability is enabled. If this is false, then there's at least one restrictions active.
The missing requirements for this capability to be fulfilled.
Available options:
user-must-submit-crypto-risk-assessment-form
, user-must-submit-self-categorization-form
, user-must-accept-virtual-account-number-terms-of-services
, 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-phone-number
, user-must-submit-proof-of-address
, user-must-submit-tax-identification-number
, user-must-submit-w9-form
The restrictions that are causing this capability to be disabled.
Available options:
crypto-risk-assessment-form-not-valid
, financial-promotion-cooldown-running
, phone-country-not-supported
, self-categorization-statement-form-not-valid
, temporarily-disabled
, user-account-frozen
, 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
curl --request GET \
--url https://api.enterprise.sandbox.uphold.com/core/capabilities/{capability} \
--header 'Authorization: Bearer <token>'
{
"capability": {
"code": "trades",
"name": "Trades",
"enabled": true,
"requirements": [
"user-must-submit-identity",
"user-must-submit-proof-of-address"
],
"restrictions": []
}
}