How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Uphold KYC API

Individual User's KYC.

Uphold KYC API is one of 25 APIs that Uphold publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include KYC. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and a changelog.

This API exposes 13 operations across 13 paths, and defines 48 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against 2 base URLs: https://api.enterprise.sandbox.uphold.com, https://api.enterprise.uphold.com.

13 operations 13 paths 48 schemas 1 GET11 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.enterprise.uphold.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Uphold KYC API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 49 scopes. By default, every request must be authenticated.

  • OAuth2 — OAuth 2.0 authentication.

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 1 GET, 11 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

KYC 13

Individual User's KYC.

GET
/core/kyc
Get overview
core.get-kyc-overview 9 params → 200401403409429
PATCH
/core/kyc/processes/profile
Update profile
core.update-kyc-profile 7 params body → 200400401403409429
PATCH
/core/kyc/processes/addressdeprecated
Update address
core.update-kyc-address 7 params body → 200400401403409429
PATCH
/core/kyc/processes/email
Update email
core.update-kyc-email 7 params body → 200400401403409429
PATCH
/core/kyc/processes/phone
Update phone
core.update-kyc-phone 7 params body → 200400401403409429
PATCH
/core/kyc/processes/identity
Update identity
core.update-kyc-identity 7 params body → 200400401403404409429
PATCH
/core/kyc/processes/proof-of-address
Update proof-of-address
core.update-kyc-proof-of-address 7 params body → 200400401403404409429
PATCH
/core/kyc/processes/customer-due-diligence
Update customer due diligence
core.update-kyc-customer-due-diligence 8 params body → 200400401403404409429
PATCH
/core/kyc/processes/enhanced-due-diligence
Update enhanced due diligence
core.update-kyc-enhanced-due-diligence 7 params body → 200400401403404409429
PATCH
/core/kyc/processes/crypto-risk-assessment
Update crypto risk assessment
core.update-kyc-crypto-risk-assessment 8 params body → 200400401403404409429
PATCH
/core/kyc/processes/self-categorization-statement
Update self-categorization statement
core.update-kyc-self-categorization-statement 8 params body → 200400401403404409429
PATCH
/core/kyc/processes/tax-details
Update tax details
core.update-kyc-tax-details 2 params body → 200400401403409429
POST
/widgets/kyc/sessions
Create session
widgets.create-kyc-widget-session 7 params body → 201400401403409429

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are address-for-request (6 properties), kyc-identity-electronic-verification (6 properties), kyc-customer-due-diligence (6 properties), address (6 properties). Each schema is shown below with its type and property counts.

update-kyc-identity-electronic-verification
object
3 properties 2 required
kyc-crypto-risk-assessment
object
6 properties 2 required
kyc-customer-due-diligence
object
6 properties 2 required
kyc-identity-electronic-verification
object
6 properties 3 required
kyc-screening
object
4 properties 2 required
string-no-edge-spaces
string
kyc-email
object
The KYC email object.
5 properties 2 required
kyc-identity-none
object
4 properties 2 required
update-kyc-proof-of-address-electronic-verification
object
3 properties 2 required
kyc-identity
kyc-process-input-form
object
Input of the KYC process.
2 properties 1 required
kyc-risk
object
4 properties 2 required
update-kyc-identity-document-submission
object
3 properties 2 required
kyc-process-input-form-for-request
object
Input of the KYC process.
2 properties 1 required
warning
The warning information.
kyc-identity-document-submission
object
6 properties 3 required
address-for-request
object
The address information.
6 properties
subdivision-code-for-request
string
country-code-for-request
string
kyc-proof-of-address-none
object
4 properties 2 required
update-kyc-tax-details-request-body-output
object
Output of the KYC process.
2 properties 2 required
feedback
object
A feedback message with a code and human-readable description.
3 properties 2 required
kyc-process-verification
object
Configuration of this process.
4 properties 3 required
process-verification-rule
object
The process verification rule.
2 properties 2 required
address
object
The address information.
6 properties
kyc-profile
object
5 properties 2 required
kyc-process-dependencies
array
The processes that must be updated before you can update this one.
kyc-webhook-event
error
The error information.
kyc-process-status
string
Status of the KYC process.
process-warnings
object
The warnings generated during a process update.
kyc-proof-of-address-document-submission
object
6 properties 3 required
kyc-self-categorization-statement
object
6 properties 2 required
update-kyc-proof-of-address-document-submission
object
3 properties 2 required
webhook-event
object
The webhook event information.
4 properties 4 required
kyc-proof-of-address
kyc-proof-of-address-from-identity
object
5 properties 3 required
create-kyc-widget-session-verify-flow
object
2 properties 1 required
kyc-process-hint-form
object
Hints for the KYC process.
4 properties 3 required
kyc-tax-details
object
6 properties 2 required
kyc-widget-session
object
4 properties 4 required
kyc-proof-of-address-electronic-verification
object
6 properties 3 required
kyc-overview
object
The KYC overview object.
2 properties 2 required
kyc-enhanced-due-diligence
object
5 properties 2 required
kyc-address
object
4 properties 2 required
kyc-phone
object
The KYC phone object.
5 properties 2 required
string-at-least-two-words-no-edge-spaces
string
null-or-string-no-edge-spaces
nullstring

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

uphold-kyc-api-openapi.yml Raw ↑

Other APIs Uphold publishes across the network.

Uphold Public API (v0)
Uphold Documentation MCP Server
Uphold Accounts API
Uphold Assets API
Uphold Authentication API
Uphold Capabilities API
Uphold Countries API
Uphold External accounts API
Uphold Files API
Uphold General API
Uphold Ingestions API
Uphold KYB API
Where this information came from

This is an independent, third-party profile of Uphold KYC API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.