> ## 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 phone
> Update the phone 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 phone** is the endpoint through which the user can enter a verified phone number.
## OpenAPI
````yaml _media/specs/core-openapi.mintlify.json patch /core/kyc/processes/phone
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/phone:
patch:
tags:
- KYC
summary: Update phone
description: Update the phone process for a user.
operationId: core.update-kyc-phone
requestBody:
$ref: '#/components/requestBodies/update-kyc-phone-request-body'
responses:
'200':
$ref: '#/components/responses/update-kyc-phone-response'
'409':
$ref: '#/components/responses/update-kyc-phone-conflict-response'
security:
- OAuth2:
- core.kyc.phone:update
components:
requestBodies:
update-kyc-phone-request-body:
content:
application/json:
schema:
type: object
properties:
input:
description: Input of the KYC process.
type: object
properties:
phone:
description: The E.164 formatted phone number to be verified.
type: string
pattern: ^\+[0-9]{1,15}$
country:
allOf:
- $ref: '#/components/schemas/country-code-for-request'
- description: >-
The country code of the phone number.
It must be a ISO alpha-2 code that is used to
disambiguate phone numbers with the same dialing code.
required:
- phone
- country
output:
description: Output of the KYC process.
type: object
properties:
verifiedAt:
description: The date and time of the verification.
type: string
format: date-time
required:
- verifiedAt
required:
- input
examples:
Update Process - Partner-verified:
value:
input:
phone: '+447400123456'
country: GB
output:
verifiedAt: '2020-01-01T00:00:00.000Z'
Update Process - Uphold-verified:
value:
input:
phone: '+447400123456'
country: GB
responses:
update-kyc-phone-response:
description: KYC phone process updated.
content:
application/json:
schema:
type: object
properties:
phone:
$ref: '#/components/schemas/kyc-phone'
required:
- phone
examples:
Process Updated - Partner-verified:
value:
phone:
code: phone
status: ok
verification:
model: partner-verified
method: manual
dependencies: []
input:
phone: '+447400123456'
country: GB
output:
verifiedAt: '2020-01-01T00:00:00.000Z'
Process Updated - Uphold-verified:
value:
phone:
code: phone
status: pending
verification:
model: uphold-verified
method: manual
dependencies: []
input:
phone: '+447400123456'
country: GB
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-phone-conflict-response:
description: Business logic error.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Phone Already Exists:
value:
code: phone_already_exists
message: The provided phone is already in use by another user
Phone Already Verified:
value:
code: operation_not_allowed
message: Phone already verified
details:
reasons:
- phone-already-verified
Phone Invalid:
value:
code: phone_invalid
message: The phone number is invalid
Country Not Supported:
value:
code: country_not_supported
message: The country is not supported
details:
context: body
property: input.country
Verified Date Invalid:
value:
code: date_invalid
message: The date must be in the past
details:
rule: difference-greater-than-threshold
threshold:
limit: 0
unit: milliseconds
context: body
property: output.verifiedAt
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:
country-code-for-request:
type: string
pattern: ^[A-Z]{2}$
kyc-phone:
description: The KYC phone 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: Input of the KYC process.
type: object
properties:
phone:
description: The E.164 formatted phone number that was verified.
type: string
country:
description: The country code of the phone number.
type: string
required:
- phone
- country
output:
description: Output of the KYC process.
type: object
properties:
verifiedAt:
description: The date and time of the verification.
type: string
format: date-time
required:
- verifiedAt
required:
- code
- status
error:
description: The error information.
allOf:
- $ref: '#/components/schemas/feedback'
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:
- none
- 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
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
kyc-process-dependencies:
description: The processes that must be updated before you can update this one.
type: array
items:
type: string
enum:
- profile
- 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
````