Uphold

Uphold KYC API

Individual User's KYC.

GitHub OpenAPI
Business capability
KYC & Customer Due Diligence Management BC-1300.20

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /core/kyc Get a user's KYC status overview · Get overview #
Ask an LLM
“Where does this user stand in identity verification?”
“Which KYC steps are still outstanding for a user?”
Tell an agent
Show my KYC overview.
Get the KYC overview with details for {detailed}.
PATCH /core/kyc/processes/profile Submit a user's KYC profile details · Update profile #
Ask an LLM
“How do I submit a user's name and birth date for KYC?”
“Can I update the profile step of verification?”
Tell an agent
Submit KYC profile details {input}.
Update my verification profile with {input}.
PATCH /core/kyc/processes/address Submit a user's residential address for KYC · Update address #
Ask an LLM
“How do I provide a user's home address for verification?”
“Can I change the residential address submitted for KYC?”
Tell an agent
Submit residential address {input} for KYC.
Update my KYC home address to {input}.
PATCH /core/kyc/processes/email Submit a user's email for KYC · Update email #
Ask an LLM
“How do I verify a user's email address as part of onboarding?”
“Can I update the email used in the KYC process?”
Tell an agent
Submit email {input} for KYC verification.
Update the KYC email step with {input}.
PATCH /core/kyc/processes/phone Submit a user's phone number for KYC · Update phone #
Ask an LLM
“How do I add a phone number to a user's verification?”
“Can I update the phone step of KYC?”
Tell an agent
Submit phone number {input} for KYC.
Update my KYC phone verification with {input}.
PATCH /core/kyc/processes/identity Update the identity verification step · Update identity #
Ask an LLM
“How do I move a user's identity document check forward?”
“Can I update the identity process in KYC?”
Tell an agent
Update my KYC identity verification step.
Refresh the identity document check for this user.
PATCH /core/kyc/processes/proof-of-address Update the proof-of-address step · Update proof-of-address #
Ask an LLM
“How do I progress a user's proof-of-address check?”
“Can I update the proof-of-address process after uploading a document?”
Tell an agent
Update my KYC proof-of-address step.
Advance the proof-of-address check for this user.
PATCH /core/kyc/processes/customer-due-diligence Submit customer due diligence answers · Update customer due diligence #
Ask an LLM
“How do I submit customer due diligence answers like source of funds?”
“Can I update a user's CDD questionnaire?”
Tell an agent
Submit customer due diligence answers {input}.
Update my CDD questionnaire with {input}.
PATCH /core/kyc/processes/enhanced-due-diligence Submit enhanced due diligence answers · Update enhanced due diligence #
Ask an LLM
“How do I submit enhanced due diligence for a higher-risk user?”
“Can I update a user's EDD information?”
Tell an agent
Submit enhanced due diligence answers {input}.
Update my EDD details with {input}.
PATCH /core/kyc/processes/crypto-risk-assessment Submit a crypto risk assessment · Update crypto risk assessment #
Ask an LLM
“How do I complete the crypto risk assessment for a user?”
“Can I update a user's answers to the crypto risk questionnaire?”
Tell an agent
Submit crypto risk assessment answers {input}.
Update my crypto risk assessment with {input}.
PATCH /core/kyc/processes/self-categorization-statement Submit an investor self-categorization statement · Update self-categorization statement #
Ask an LLM
“How do I record a user's investor self-categorization statement?”
“Can a user update how they categorize themselves as an investor?”
Tell an agent
Submit self-categorization statement {input}.
Update my investor self-categorization to {input}.
PATCH /core/kyc/processes/tax-details Submit a user's tax details · Update tax details #
Ask an LLM
“How do I submit a user's tax residency and tax ID?”
“Can I update the tax details step of KYC?”
Tell an agent
Submit tax details {input}.
Update my KYC tax information with {input}.
POST /widgets/kyc/sessions Start a KYC widget session · Create session #
Ask an LLM
“How do I launch the embedded KYC widget for a user?”
“Is there a hosted widget for running identity verification?”
Tell an agent
Create a KYC widget session.
Start the embedded KYC widget for this user.

Documentation

📖
Documentation
https://developer.uphold.com/rest-apis/introduction
📖
APIReference
https://developer.uphold.com/rest-apis/core-api/concepts
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/authentication/uphold-authentication.yml
📖
Documentation
https://developer.uphold.com/widgets/introduction
📖
Documentation
https://developer.uphold.com/rest-apis/market-pulse-api/assets/get-asset-information
📖
Documentation
https://developer.uphold.com/rest-apis/kyc-connector-api/introduction
📖
Documentation
https://developer.uphold.com/rest-apis/topper-api/kyc-sharing/create-session

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/openapi/uphold-kyc-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/scopes/uphold-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/conventions/uphold-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/errors/uphold-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/data-model/uphold-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/asyncapi/uphold-core-webhooks.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/sandbox/uphold-sandbox.yml
🔗
Components
https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/components/uphold-components.yml
🔗
ChangeLog
https://developer.uphold.com/widgets/changelog

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/uphold:uphold-kyc-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

uphold-kyc-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Uphold KYC API
  version: 0.1.0
  description: 'Operations tagged KYC across 2 of this provider''s published API definitions: uphold-core-api-openapi.json, uphold-widgets-api-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.enterprise.sandbox.uphold.com
  description: Sandbox
- url: https://api.enterprise.uphold.com
  description: Production
security:
- OAuth2: []
tags:


# --- truncated at 32 KB (252 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/uphold/refs/heads/main/openapi/uphold-kyc-api-openapi.yml