Core API
- Concepts
- Authentication
- Countries
- Users
- KYC
- Introduction
- GETGet overview
- PATCHUpdate email
- PATCHUpdate phone
- PATCHUpdate profile
- PATCHUpdate address
- PATCHUpdate identity
- PATCHUpdate proof of address
- PATCHUpdate customer due diligence
- PATCHUpdate enhanced due diligence
- PATCHUpdate crypto risk assessment
- PATCHUpdate self-categorization statement
- PATCHUpdate tax details
- Webhooks
- Capabilities
- Terms of Service
- Files
- Assets
- Accounts
- External Accounts
- Transactions
- Webhooks
Widgets API
- Payment
Update customer due diligence
Update the customer due diligence process for a user.
PATCH
/
core
/
kyc
/
processes
/
customer-due-diligence
curl --request PATCH \
--url https://api.enterprise.sandbox.uphold.com/core/kyc/processes/customer-due-diligence \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"input": {
"formId": "ae80271a-a3f0-453b-8dc6-36b777817217",
"answers": {
"intent": {
"expected-activities": [
"cryptocurrency_investing",
"deposit_withdraw_crypto"
]
}
}
}
}'
{
"customerDueDiligence": {
"status": "pending",
"input": {
"formId": "ae80271a-a3f0-453b-8dc6-36b777817217",
"answers": {
"intent": {
"expected-activities": [
"cryptocurrency_investing",
"deposit_withdraw_crypto"
]
}
}
},
"hint": {
"type": "form",
"formId": "ae80271a-a3f0-453b-8dc6-36b777817217",
"schema": {
"type": "object",
"properties": {
"intent": {
"type": "object",
"title": "How will you use Uphold?",
"description": "Please be careful with your selection to avoid unnecessary account opening delays",
"properties": {
"expected-activities": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"maxItems": 5,
"items": {
"type": "string",
"oneOf": [
{
"const": "cryptocurrency_investing",
"title": "Trade cryptocurrencies"
},
{
"const": "metals_or_commodities_investing",
"title": "Metals or Commodities investing"
},
{
"const": "foreign_exchange_trading",
"title": "Currency conversion"
},
{
"const": "deposit_withdraw_crypto",
"title": "Deposit or withdraw cryptocurrencies"
},
{
"const": "international_payments_transfers",
"title": "Transfers between users"
}
]
}
}
},
"required": [
"expected-activities"
]
},
"financial-information": {
"type": "object",
"title": "Financial Information",
"properties": {
"source-of-funds": {
"title": "Source of income",
"type": "string",
"oneOf": [
{
"const": "salary",
"title": "Salary"
},
{
"const": "profits_own_business",
"title": "Profits from owned business"
},
{
"const": "inheritance",
"title": "Inheritance"
},
{
"const": "other",
"title": "Other"
}
]
},
"annual-income-range": {
"title": "Annual income",
"type": "string",
"oneOf": [
{
"const": "0-20000",
"title": "< $ 20,000"
},
{
"const": "20000-30000",
"title": "$ 20,000 - $ 30,000"
},
{
"const": "30000-40000",
"title": "$ 30,000 - $ 40,000"
},
{
"const": "40000-60000",
"title": "$ 40,000 - $ 60,000"
},
{
"const": "60000-80000",
"title": "$ 60,000 - $ 80,000"
},
{
"const": "80000-130000",
"title": "$ 80,000 - $ 130,000"
},
{
"const": "130000-210000",
"title": "$ 130,000 - $ 210,000"
},
{
"const": "210000-or-more",
"title": "$ 210,000 or more"
}
]
},
"expected-annual-deposits-range": {
"title": "Expected annual deposits",
"type": "string",
"oneOf": [
{
"const": "0-8000",
"title": "< $ 8,000"
},
{
"const": "8000-15000",
"title": "$ 8,000 - $ 15,000"
},
{
"const": "15000-25000",
"title": "$ 15,000 - $ 25,000"
},
{
"const": "25000-50000",
"title": "$ 25,000 - $ 50,000"
},
{
"const": "50000-100000",
"title": "$ 50,000 - $ 100,000"
},
{
"const": "100000-120000",
"title": "$ 100,000 - $ 120,000"
},
{
"const": "120000-or-more",
"title": "$ 120,000 or more"
}
]
}
},
"required": [
"source-of-funds",
"annual-income-range",
"expected-annual-deposits-range"
],
"allOf": [
{
"if": {
"properties": {
"source-of-funds": {
"const": "other"
}
},
"required": [
"source-of-funds"
]
},
"then": {
"properties": {
"other-source-of-funds": {
"maxLength": 50,
"minLength": 1,
"title": "Enter your other source of income",
"type": "string"
}
},
"required": [
"other-source-of-funds"
]
}
}
]
}
}
},
"uiSchema": {
"type": "Categorization",
"elements": [
{
"type": "Category",
"label": "How will you use Uphold?",
"elements": [
{
"type": "Control",
"scope": "#/properties/intent/properties/expected-activities"
}
]
},
{
"type": "Category",
"label": "Financial Information",
"elements": [
{
"type": "Control",
"scope": "#/properties/financial-information/properties/source-of-funds"
},
{
"type": "Control",
"scope": "#/properties/financial-information/properties/other-source-of-funds",
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/financial-information/properties/source-of-funds",
"schema": {
"const": "other"
}
}
}
},
{
"type": "Control",
"scope": "#/properties/financial-information/properties/anual-income-range"
},
{
"type": "Control",
"scope": "#/properties/financial-information/properties/expected-annual-deposits-range"
}
]
}
]
}
}
}
}
The customer-due-diligence is a form based KYC process composed of questions used to collect financial information and to determine a user’s risk level.
When calling GET /core/kyc?detailed=customerDueDiligence
, you will get a hint
property which includes a JSON form schema and UI schema.
The hint
property will also be available in responses of this endpoint, in case there are still questions to be answered.
Please read more about forms in the Introduction page.
Authorizations
OAuth 2.0 authentication.
Headers
The natural language and locale that the client prefers.
Body
application/json
Response
200
application/json
KYC customer due diligence process updated.
The response is of type object
.
curl --request PATCH \
--url https://api.enterprise.sandbox.uphold.com/core/kyc/processes/customer-due-diligence \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"input": {
"formId": "ae80271a-a3f0-453b-8dc6-36b777817217",
"answers": {
"intent": {
"expected-activities": [
"cryptocurrency_investing",
"deposit_withdraw_crypto"
]
}
}
}
}'
{
"customerDueDiligence": {
"status": "pending",
"input": {
"formId": "ae80271a-a3f0-453b-8dc6-36b777817217",
"answers": {
"intent": {
"expected-activities": [
"cryptocurrency_investing",
"deposit_withdraw_crypto"
]
}
}
},
"hint": {
"type": "form",
"formId": "ae80271a-a3f0-453b-8dc6-36b777817217",
"schema": {
"type": "object",
"properties": {
"intent": {
"type": "object",
"title": "How will you use Uphold?",
"description": "Please be careful with your selection to avoid unnecessary account opening delays",
"properties": {
"expected-activities": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"maxItems": 5,
"items": {
"type": "string",
"oneOf": [
{
"const": "cryptocurrency_investing",
"title": "Trade cryptocurrencies"
},
{
"const": "metals_or_commodities_investing",
"title": "Metals or Commodities investing"
},
{
"const": "foreign_exchange_trading",
"title": "Currency conversion"
},
{
"const": "deposit_withdraw_crypto",
"title": "Deposit or withdraw cryptocurrencies"
},
{
"const": "international_payments_transfers",
"title": "Transfers between users"
}
]
}
}
},
"required": [
"expected-activities"
]
},
"financial-information": {
"type": "object",
"title": "Financial Information",
"properties": {
"source-of-funds": {
"title": "Source of income",
"type": "string",
"oneOf": [
{
"const": "salary",
"title": "Salary"
},
{
"const": "profits_own_business",
"title": "Profits from owned business"
},
{
"const": "inheritance",
"title": "Inheritance"
},
{
"const": "other",
"title": "Other"
}
]
},
"annual-income-range": {
"title": "Annual income",
"type": "string",
"oneOf": [
{
"const": "0-20000",
"title": "< $ 20,000"
},
{
"const": "20000-30000",
"title": "$ 20,000 - $ 30,000"
},
{
"const": "30000-40000",
"title": "$ 30,000 - $ 40,000"
},
{
"const": "40000-60000",
"title": "$ 40,000 - $ 60,000"
},
{
"const": "60000-80000",
"title": "$ 60,000 - $ 80,000"
},
{
"const": "80000-130000",
"title": "$ 80,000 - $ 130,000"
},
{
"const": "130000-210000",
"title": "$ 130,000 - $ 210,000"
},
{
"const": "210000-or-more",
"title": "$ 210,000 or more"
}
]
},
"expected-annual-deposits-range": {
"title": "Expected annual deposits",
"type": "string",
"oneOf": [
{
"const": "0-8000",
"title": "< $ 8,000"
},
{
"const": "8000-15000",
"title": "$ 8,000 - $ 15,000"
},
{
"const": "15000-25000",
"title": "$ 15,000 - $ 25,000"
},
{
"const": "25000-50000",
"title": "$ 25,000 - $ 50,000"
},
{
"const": "50000-100000",
"title": "$ 50,000 - $ 100,000"
},
{
"const": "100000-120000",
"title": "$ 100,000 - $ 120,000"
},
{
"const": "120000-or-more",
"title": "$ 120,000 or more"
}
]
}
},
"required": [
"source-of-funds",
"annual-income-range",
"expected-annual-deposits-range"
],
"allOf": [
{
"if": {
"properties": {
"source-of-funds": {
"const": "other"
}
},
"required": [
"source-of-funds"
]
},
"then": {
"properties": {
"other-source-of-funds": {
"maxLength": 50,
"minLength": 1,
"title": "Enter your other source of income",
"type": "string"
}
},
"required": [
"other-source-of-funds"
]
}
}
]
}
}
},
"uiSchema": {
"type": "Categorization",
"elements": [
{
"type": "Category",
"label": "How will you use Uphold?",
"elements": [
{
"type": "Control",
"scope": "#/properties/intent/properties/expected-activities"
}
]
},
{
"type": "Category",
"label": "Financial Information",
"elements": [
{
"type": "Control",
"scope": "#/properties/financial-information/properties/source-of-funds"
},
{
"type": "Control",
"scope": "#/properties/financial-information/properties/other-source-of-funds",
"rule": {
"effect": "SHOW",
"condition": {
"scope": "#/properties/financial-information/properties/source-of-funds",
"schema": {
"const": "other"
}
}
}
},
{
"type": "Control",
"scope": "#/properties/financial-information/properties/anual-income-range"
},
{
"type": "Control",
"scope": "#/properties/financial-information/properties/expected-annual-deposits-range"
}
]
}
]
}
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.