> ## 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.
# List rails
> List rails supported by the platform.
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}
)}
;
};
If the [subject](../../authentication#subjects) calling the endpoint is a user, the response will be contextualized accordingly.
As an example, the `features` field will indicate the available features for the user.
## OpenAPI
````yaml _media/specs/core-openapi.mintlify.json get /core/rails
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/rails:
get:
tags:
- Assets
summary: List rails
description: List rails supported by the platform.
operationId: core.list-rails
parameters:
- $ref: '#/components/parameters/list-rails-type-filter'
- $ref: '#/components/parameters/list-rails-network-code-filter'
- $ref: '#/components/parameters/list-rails-method-filter'
- $ref: '#/components/parameters/list-rails-asset-code-filter'
responses:
'200':
$ref: '#/components/responses/list-rails-response'
components:
parameters:
list-rails-type-filter:
name: type
description: Filter rails by type.
in: query
explode: false
required: false
schema:
type: array
maxItems: 25
uniqueItems: true
items:
$ref: '#/components/schemas/rail-type'
examples:
Crypto Rail Type:
value:
- crypto
list-rails-network-code-filter:
name: network
description: Filter rails by network code.
in: query
explode: false
required: false
schema:
type: array
maxItems: 25
uniqueItems: true
items:
type: string
minLength: 1
examples:
Bitcoin Network:
value:
- bitcoin
list-rails-method-filter:
name: method
description: Filter rails by method.
in: query
style: form
explode: false
required: false
schema:
type: array
maxItems: 25
uniqueItems: true
items:
$ref: '#/components/schemas/rail-method'
examples:
Debit Card Method:
value:
- debit-card
list-rails-asset-code-filter:
name: asset
description: Filter rails by asset code.
in: query
style: form
explode: false
required: false
schema:
type: array
maxItems: 100
uniqueItems: true
items:
type: string
minLength: 1
examples:
BTC Asset:
value:
- BTC
responses:
list-rails-response:
description: Rails retrieved.
content:
application/json:
schema:
type: object
properties:
rails:
type: array
items:
$ref: '#/components/schemas/rail'
examples:
Rails Retrieved:
value:
rails:
- type: crypto
network: bitcoin
method: crypto-transaction
asset: BTC
decimals: 8
features:
- deposit
- withdraw
- type: crypto
network: ethereum
method: crypto-transaction
asset: USDC
decimals: 6
features:
- deposit
- withdraw
contractAddress: '0xd6d663b601D63a0d1A651D61847Ec8134Eb3a3CF'
- type: card
network: visa
method: debit-card
asset: USD
decimals: 2
features:
- deposit
- withdraw
- type: bank
network: ach
method: bank-transfer
asset: USD
decimals: 2
features:
- deposit
- withdraw
constraints:
- rule: allowed-deposit-accounts
allowed: default-only
- type: bank
network: fps
method: bank-transfer
asset: GBP
decimals: 2
features:
- deposit
- withdraw
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:
rail-type:
type: string
enum:
- crypto
- card
- bank
rail-method:
type: string
enum:
- crypto-transaction
- credit-card
- debit-card
- bank-transfer
rail:
type: object
discriminator:
propertyName: type
mapping:
crypto:
$ref: '#/components/schemas/rail-crypto'
card:
$ref: '#/components/schemas/rail-card'
bank:
$ref: '#/components/schemas/rail-bank'
oneOf:
- $ref: '#/components/schemas/rail-crypto'
title: Crypto
- $ref: '#/components/schemas/rail-card'
title: Card
- $ref: '#/components/schemas/rail-bank'
title: Bank
rail-crypto:
type: object
allOf:
- $ref: '#/components/schemas/rail-base'
- type: object
properties:
type:
enum:
- crypto
method:
enum:
- crypto-transaction
contractAddress:
description: The contract address for the asset within the network.
type: string
rail-card:
type: object
allOf:
- $ref: '#/components/schemas/rail-base'
- type: object
properties:
type:
enum:
- card
method:
enum:
- credit-card
- debit-card
rail-bank:
type: object
allOf:
- $ref: '#/components/schemas/rail-base'
- type: object
properties:
type:
enum:
- bank
method:
enum:
- bank-transfer
constraints:
description: The constraints for the rail.
type: array
items:
$ref: '#/components/schemas/rail-bank-constraint'
rail-base:
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/rail-type'
- description: The type of the rail.
network:
description: The network code of the rail.
type: string
method:
allOf:
- $ref: '#/components/schemas/rail-method'
- description: >-
The method through which operations are carried over the
network.
asset:
description: The asset code of the rail.
type: string
decimals:
description: The number of decimal places for the asset within the network.
type: integer
minimum: 0
features:
description: The features of the asset within the network.
type: array
items:
type: string
enum:
- withdraw
- deposit
required:
- type
- network
- method
- asset
- decimals
- features
rail-bank-constraint:
oneOf:
- $ref: '#/components/schemas/rail-bank-constraint-allowed-deposit-accounts'
discriminator:
propertyName: rule
mapping:
allowed-deposit-accounts:
$ref: '#/components/schemas/rail-bank-constraint-allowed-deposit-accounts'
rail-bank-constraint-allowed-deposit-accounts:
type: object
properties:
rule:
type: string
enum:
- allowed-deposit-accounts
allowed:
type: string
enum:
- default-only
required:
- rule
- allowed
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
````