> ## 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.
# Set up crypto external account verification
> Sets up a single-level verification process for a crypto 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}
)}
;
};
**Set up crypto external account verification** initiates a verification for a `crypto` external account at the given `level`, or returns the existing one.
## OpenAPI
````yaml _media/specs/core-openapi.mintlify.json put /core/external-accounts/{externalAccountId}/verifications/{level}
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: Requests for information
description: Requests for information.
- name: Portfolio
description: Portfolio.
- name: Statements
description: Statements.
- name: Metadata
description: Metadata.
- name: Webhooks
description: Webhooks.
paths:
/core/external-accounts/{externalAccountId}/verifications/{level}:
put:
tags:
- External accounts
summary: Set up crypto external account verification
description: >-
Sets up a single-level verification process for a crypto external
account.
operationId: core.setup-external-account-verification
parameters:
- $ref: '#/components/parameters/external-account-id'
- $ref: '#/components/parameters/external-account-verification-level'
responses:
'200':
$ref: '#/components/responses/setup-external-account-verification-response'
'201':
$ref: '#/components/responses/setup-external-account-verification-response'
'404':
$ref: >-
#/components/responses/setup-external-account-verification-not-found-response
'409':
$ref: >-
#/components/responses/setup-external-account-verification-conflict-response
security:
- OAuth2:
- core.external-accounts:update
- core.requests-for-information:read
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
external-account-verification-level:
name: level
description: The level of the verification.
in: path
required: true
schema:
type: string
enum:
- declared
examples:
Declared:
value: declared
responses:
setup-external-account-verification-response:
description: Verification set up or initiated.
content:
application/json:
schema:
type: object
properties:
verification:
allOf:
- $ref: '#/components/schemas/external-account-verification'
- type: object
properties:
requestForInformation:
$ref: '#/components/schemas/request-for-information'
required:
- requestForInformation
required:
- verification
examples:
Verification Set Up:
value:
verification:
via: request-for-information
level: declared
status: pending
requestForInformation:
id: 19ca55fb-fc52-4209-b765-e3dbdc327231
type: crypto-address-travel-rule
status: pending
context:
network: bitcoin
addresses:
- mmLpwJCSnw3SEiN1un8GACvwx4f1ddB6SV
proofOptions:
selfDeclaration:
schema:
type: object
required:
- isVASP
- isSelfHostedWallet
- isSelfOwnedCryptoAddress
properties:
isVASP:
type: boolean
isSelfHostedWallet:
type: boolean
isSelfOwnedCryptoAddress:
type: boolean
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
setup-external-account-verification-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
setup-external-account-verification-conflict-response:
description: Business logic error.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Stronger Verification Already Completed:
value:
code: operation_not_allowed
message: A stronger verification is already completed for this address
details:
reasons:
- stronger-verification-already-completed
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-verification:
type: object
properties:
via:
type: string
enum:
- request-for-information
description: The method through which the verification is tracked.
level:
type: string
enum:
- declared
- verified
description: The level of the verification.
status:
type: string
enum:
- pending
- completed
- failed
description: The status of the verification.
completedAt:
type: string
format: date-time
description: The time at which the verification was completed.
required:
- via
- level
- status
request-for-information:
discriminator:
propertyName: type
mapping:
travel-rule:
$ref: '#/components/schemas/request-for-information-travel-rule'
crypto-address-travel-rule:
$ref: >-
#/components/schemas/request-for-information-crypto-address-travel-rule
crypto-address-verification:
$ref: >-
#/components/schemas/request-for-information-crypto-address-verification
oneOf:
- $ref: '#/components/schemas/request-for-information-travel-rule'
title: Travel rule
- $ref: >-
#/components/schemas/request-for-information-crypto-address-travel-rule
title: Crypto address travel rule
- $ref: >-
#/components/schemas/request-for-information-crypto-address-verification
title: Crypto address verification
error:
description: The error information.
allOf:
- $ref: '#/components/schemas/feedback'
request-for-information-travel-rule:
allOf:
- $ref: '#/components/schemas/request-for-information-base'
- type: object
description: >-
The request for information to obtain travel rule details when they
are missing or insufficient.
properties:
proof:
type: object
additionalProperties: true
description: The provided travel rule information.
properties:
originatorProof:
oneOf:
- $ref: >-
#/components/schemas/request-for-information-self-declaration-proof
- $ref: >-
#/components/schemas/request-for-information-message-signing-proof
- $ref: >-
#/components/schemas/request-for-information-satoshi-test-proof
beneficiaryProof:
oneOf:
- $ref: >-
#/components/schemas/request-for-information-self-declaration-proof
- $ref: >-
#/components/schemas/request-for-information-message-signing-proof
- $ref: >-
#/components/schemas/request-for-information-satoshi-test-proof
request-for-information-crypto-address-travel-rule:
allOf:
- $ref: '#/components/schemas/request-for-information-base'
- type: object
description: >-
The request for information to obtain basic self-declaration for an
external account's crypto address.
properties:
proof:
type: object
additionalProperties: true
description: The provided basic self-declaration.
properties:
isVASP:
type: boolean
isSelfHostedWallet:
type: boolean
isSelfOwnedCryptoAddress:
type: boolean
isBusiness:
type: boolean
name:
type: object
additionalProperties: true
required:
- isVASP
- isSelfHostedWallet
- isSelfOwnedCryptoAddress
request-for-information-crypto-address-verification:
allOf:
- $ref: '#/components/schemas/request-for-information-base'
- type: object
description: >-
The request for information to obtain proof of ownership for an
external account's crypto address.
properties:
proof:
oneOf:
- $ref: >-
#/components/schemas/request-for-information-message-signing-proof
- $ref: >-
#/components/schemas/request-for-information-satoshi-test-proof
feedback:
description: A feedback message with a code and human-readable description.
type: object
properties:
code:
description: A short string with a brief explanation about the code reported.
type: string
message:
description: A human-readable message providing more details.
type: string
details:
description: Additional information about the feedback reported.
type: object
additionalProperties: true
required:
- code
- message
request-for-information-base:
type: object
properties:
id:
type: string
description: The id of the RFI.
type:
description: The type of the RFI.
type: string
enum:
- travel-rule
- crypto-address-travel-rule
- crypto-address-verification
status:
description: The status of the RFI.
type: string
enum:
- ok
- pending
- expired
- failed
expiresAt:
description: The date and time when the RFI expires.
type: string
format: date-time
context:
type: object
description: The context of this RFI.
properties:
network:
type: string
addresses:
type: array
items:
type: string
required:
- network
- addresses
proofOptions:
type: object
description: The proof mechanisms available to resolve this RFI.
properties:
selfDeclaration:
type: object
description: The self-declaration proof requirements.
properties:
schema:
type: object
additionalProperties: true
description: The JSON Schema describing which fields are required.
messageSigning:
type: object
description: The message signing proof requirements.
properties:
schema:
type: object
additionalProperties: true
description: The JSON Schema describing which fields are required.
message:
type: string
description: The exact message to sign.
satoshiTest:
type: object
description: The Satoshi test proof requirements.
properties:
address:
type: string
description: The address to send the deposit to.
asset:
type: string
description: The asset to send.
amount:
type: string
description: >-
The exact amount to send, in the asset's standard
denomination.
amountSubunits:
type: string
description: The exact amount to send, in the asset's smallest subunit.
decimals:
type: integer
description: >-
The number of decimal places used to convert between
`amount` and `amountSubunits`.
reference:
type: string
description: An optional destination tag/memo required by some networks.
required:
- address
- asset
- amount
- amountSubunits
required:
- id
- type
- status
- context
- proofOptions
request-for-information-self-declaration-proof:
type: object
additionalProperties: true
description: The provided self-declaration proof.
properties:
type:
type: string
enum:
- self-declaration
attestation:
type: string
required:
- type
- attestation
request-for-information-message-signing-proof:
type: object
additionalProperties: true
description: The provided message signing proof.
properties:
type:
type: string
enum:
- message-signing
scheme:
type: string
description: The specific signing scheme used.
enum:
- bip-137
- bip-322
- cip-8
- concordium
- cosmos-ecdsa
- ed25519
- eip-1271
- eip-191
- eip-712
- siwe
- siwx
- sol-siwx
- sr25519
- tip-191
- xlm-ed25519
- xpub
- xrp-ed25519
address:
type: string
attestation:
type: string
proof:
type: string
required:
- type
- scheme
request-for-information-satoshi-test-proof:
type: object
additionalProperties: true
description: The provided Satoshi test proof.
properties:
type:
type: string
enum:
- satoshi-test
proof:
type: string
required:
- type
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.kyb:read: Grants access to view KYB processes
core.kyb.profile:update: Grants access to update profile KYB process
core.kyb.documents:update: Grants access to update documents KYB process
core.kyb.financial-institution:update: Grants access to update financial institution KYB process
core.kyb.associated-persons:create: Grants access to create KYB associated persons
core.kyb.associated-persons:read: Grants access to view KYB associated persons
core.kyb.associated-persons:delete: Grants access to delete KYB associated persons
core.kyb.associated-persons.profile:update: Grants access to update profile KYB associated person process
core.kyb.associated-persons.identity:update: Grants access to update identity KYB associated person process
core.kyb.associated-persons.proof-of-address:update: >-
Grants access to update proof-of-address KYB associated person
process
core.kyb.attestation:trigger: Grants access to trigger the attestation 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.requests-for-information:read: Grants access to view requests for information
core.requests-for-information:update: Grants access to update 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
````