> ## 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.
# Update profile
> Update the profile process for a user.
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}
)}
;
};
**Update profile** is the endpoint through which the user can update their basic information, such as name, date of birth and citizenship.
This process solely updates the user's basic information. It does **not** perform identity verification. For identity verification, refer to the [identity](./update-identity) process.
When calling [`GET /core/kyc?detailed=profile`](./get-overview), you will get a `hint` property which includes a [dynamic form](/developer-guides/resources/dynamic-forms/introduction) 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.
For more information about forms, refer to the [form-based processes](./introduction#form-based-processes) section.
## OpenAPI
````yaml _media/specs/core-openapi.mintlify.json patch /core/kyc/processes/profile
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/kyc/processes/profile:
patch:
tags:
- KYC
summary: Update profile
description: Update the profile process for a user.
operationId: core.update-kyc-profile
requestBody:
$ref: '#/components/requestBodies/update-kyc-profile-request-body'
responses:
'200':
$ref: '#/components/responses/update-kyc-profile-response'
'409':
$ref: '#/components/responses/update-kyc-profile-conflict-response'
security:
- OAuth2:
- core.kyc.profile:update
components:
requestBodies:
update-kyc-profile-request-body:
content:
application/json:
schema:
oneOf:
- title: Dynamic Form
description: >-
Dynamic form input following the [JSON
Forms](https://jsonforms.io/) specification, enabling
progressive disclosure of properties and anytime submissions
to keep profile details up to date.
type: object
properties:
input:
type: object
additionalProperties: true
minProperties: 1
maxProperties: 1
propertyNames:
not:
enum:
- fullName
- birthdate
- citizenshipCountry
required:
- input
- title: Legacy Input (deprecated)
description: Deprecated flat structure with direct top-level fields.
type: object
properties:
input:
type: object
additionalProperties: false
minProperties: 1
properties:
fullName:
allOf:
- $ref: >-
#/components/schemas/string-at-least-two-words-no-edge-spaces
- description: The full legal name.
type: string
minLength: 2
maxLength: 255
birthdate:
description: The date of birth.
type: string
format: date
citizenshipCountry:
allOf:
- $ref: '#/components/schemas/country-code-for-request'
- description: The citizenship country.
required:
- input
examples:
Update Process:
value:
input:
details:
fullName: John Doe
primaryCitizenship: GB
birthdate: '1987-01-01'
Update Process (Deprecated):
value:
input:
fullName: John Doe
birthdate: '1987-01-01'
citizenshipCountry: GB
responses:
update-kyc-profile-response:
description: KYC profile process updated.
content:
application/json:
schema:
type: object
properties:
profile:
$ref: '#/components/schemas/kyc-profile'
required:
- profile
examples:
Process Updated:
value:
profile:
code: profile
status: ok
verification:
model: uphold-verified
method: manual
dependencies: []
input:
details:
fullName: John Doe
primaryCitizenship: GB
birthdate: '1987-01-01'
hint:
type: form
schema:
type: object
additionalProperties: false
properties:
details:
title: Details
type: object
additionalProperties: false
properties:
fullName:
title: What is your full name?
type: string
pattern: ^\S+\s+\S+(\s+\S+)*$
minLength: 2
maxLength: 255
primaryCitizenship:
title: What is your primary citizenship?
type: string
pattern: ^[A-Z]{2}$
birthdate:
title: What is your date of birth?
type: string
format: date
required:
- fullName
- primaryCitizenship
- birthdate
uiSchema:
type: Categorization
elements:
- label: Details
type: Category
elements:
- label: Full name
type: Control
scope: '#/properties/details/properties/fullName'
- label: Primary citizenship
type: Control
scope: >-
#/properties/details/properties/primaryCitizenship
options:
data:
source: countries
exclude:
restrictions:
- scope: citizenship
- label: Date of birth
type: Control
scope: '#/properties/details/properties/birthdate'
options:
rules:
- rule: >-
difference-greater-than-or-equal-to-threshold
threshold:
limit: 18
unit: years
- rule: difference-less-than-or-equal-to-threshold
threshold:
limit: 100
unit: years
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
update-kyc-profile-conflict-response:
description: Business logic error.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Full Name Contains Invalid Characters:
value:
code: invalid_characters
message: The request has invalid characters
details:
context: body
property: input.details.fullName
User Underage:
value:
code: date_invalid
message: The date must be older than or equal to 18 years ago
details:
rule: difference-greater-than-or-equal-to-threshold
threshold:
limit: 18
unit: years
context: body
property: input.details.birthdate
User Overage:
value:
code: date_invalid
message: The date must be newer than or equal to 100 years from now
details:
rule: difference-less-than-or-equal-to-threshold
threshold:
limit: 100
unit: years
context: body
property: input.details.birthdate
Primary Citizenship Country Not Supported:
value:
code: country_not_supported
message: The country is not supported
details:
context: body
property: input.details.primaryCitizenship
Other Citizenships Country Not Supported:
value:
code: country_not_supported
message: The country is not supported
details:
context: body
property: input.details.otherCitizenships[0]
Place of Birth Country Not Supported:
value:
code: country_not_supported
message: The country is not supported
details:
context: body
property: input.details.birthplace.country
Citizenship Country Update Not Allowed (Deprecated):
value:
code: operation_not_allowed
message: >-
Partner-verified 'identity' is required to update citizenship
country
details:
reasons:
- citizenship-country-update-non-authoritative-identity
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:
string-at-least-two-words-no-edge-spaces:
type: string
pattern: ^\S+\s+\S+(\s+\S+)*$
country-code-for-request:
type: string
pattern: ^[A-Z]{2}$
kyc-profile:
description: The KYC profile object.
type: object
properties:
code:
description: The code of the KYC process.
type: string
status:
$ref: '#/components/schemas/kyc-process-status'
verification:
$ref: '#/components/schemas/kyc-process-verification'
input:
description: The declared profile details.
type: object
additionalProperties: true
minProperties: 1
hint:
$ref: '#/components/schemas/kyc-process-hint-form'
required:
- code
- status
error:
description: The error information.
type: object
properties:
code:
description: >-
A short string with a brief explanation about the error code
reported.
type: string
message:
description: A human-readable message providing more details about the error.
type: string
details:
description: Additional information about the error reported.
type: object
additionalProperties: true
required:
- code
- message
kyc-process-status:
description: Status of the KYC process.
type: string
enum:
- ok
- failed
- running
- pending
- exempt
kyc-process-verification:
description: Configuration of this process.
type: object
properties:
model:
description: The verification model to complete this process.
type: string
enum:
- partner-verified
- uphold-verified
method:
description: >-
Whether this process is verified automatically in the background or
requires user action.
type: string
enum:
- automatic
- manual
triggers:
description: >-
Other processes that, once updated, trigger this process to run
automatically. Only present when `method` is `automatic`.
type: array
items:
type: string
enum:
- profile
- identity
dependencies:
$ref: '#/components/schemas/kyc-process-dependencies'
required:
- model
- method
- dependencies
kyc-process-hint-form:
description: Hints for the KYC process.
type: object
properties:
type:
description: The type of the hint.
type: string
enum:
- form
formId:
description: The id of the form.
type: string
format: uuid
schema:
description: >-
The definition of the structure and validation rules for this KYC
process form.
It follows the [JSON Schema](https://json-schema.org/) specification
with the power of [JSON Forms](https://jsonforms.io/).
The schema is iterative, meaning that new questions and properties
can be added dynamically as the KYC process evolves. This allows for
a flexible and adaptive form structure that can accommodate changes
and new requirements over time.
type: object
additionalProperties: true
uiSchema:
description: >-
The `uiSchema` property defines the general layout and presentation
of the form by means of different UI schema elements.
It follows the [JSON Forms](https://jsonforms.io/) specification and
is used to customize the appearance and behavior of the form fields.
The `uiSchema` includes the following elements:
- `Layouts`: Used to structure the form layout. It includes
properties like `type` to define the layout type (e.g.,
`Categorization`) and `elements` to define the child elements.
- `Controls`: Used to define the form controls. It includes
properties like `scope` to point to the corresponding schema
property and `label` to define the control's label.
- `Rules`: Used to define conditional visibility rules for form
controls. It includes properties like `effect` to define the rule
effect (e.g., `SHOW`) and `condition` to define the rule condition.
The `uiSchema` is iterative, meaning that new controls and layout
elements can be added dynamically as the KYC process evolves. This
allows for a flexible and dynamic form layout, enhancing the user
experience by providing a structured and intuitive form design that
can adapt to new requirements and changes over time.
type: object
additionalProperties: true
required:
- type
- schema
- uiSchema
kyc-process-dependencies:
description: The processes that must be updated before you can update this one.
type: array
items:
type: string
enum:
- profile
- address
- email
- phone
- identity
- proof-of-address
- customer-due-diligence
- enhanced-due-diligence
- crypto-risk-assessment
- self-categorization-statement
- tax-details
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
````