> ## 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 financial institution
> Update the financial institution process for a business user. This process is required when the business operates in the `financial-institutions-and-money-services` industry sector.
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}
)}
;
};
This endpoint is currently available in **Sandbox** only. It is not yet available in **Production**.
**Update financial institution** collects the regulatory information required from businesses that are themselves regulated entities.
This process only applies when the business declares the `financial-institutions-and-money-services` sector in its [profile](./update-profile). For every other sector the process is `exempt` and there is nothing to submit.
## Fields
The process combines free-text declarations with supporting documents:
* `regulatorsAndLicenses`: who the business is regulated by, and what licenses it holds.
* `moneyTransmitterLicenses`: the business's money transmitter license numbers and issuers. Relevant for US money transmitters.
* `compliancePolicies`: the file evidencing the business's compliance policies.
* `amlAudit`: the file evidencing the business's most recent AML audit.
* `mlroDocumentation`: the file evidencing the appointment and responsibilities of the business's Money Laundering Reporting Officer.
The endpoint is partial — fields you omit keep their current value.
Documents are created and uploaded using the [Create file](../files/create-file) endpoint with the `document` category. To detach one, send `null` for its field.
## OpenAPI
````yaml _media/specs/core-openapi.mintlify.json patch /core/kyb/processes/financial-institution
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/kyb/processes/financial-institution:
patch:
tags:
- KYB
summary: Update financial institution
description: >-
Update the financial institution process for a business user. This
process is required when the business operates in the
`financial-institutions-and-money-services` industry sector.
operationId: core.update-kyb-financial-institution
requestBody:
$ref: >-
#/components/requestBodies/update-kyb-financial-institution-request-body
responses:
'200':
$ref: '#/components/responses/update-kyb-financial-institution-response'
'404':
$ref: >-
#/components/responses/update-kyb-financial-institution-not-found-response
'409':
$ref: >-
#/components/responses/update-kyb-financial-institution-conflict-response
security:
- OAuth2:
- core.kyb.financial-institution:update
components:
requestBodies:
update-kyb-financial-institution-request-body:
content:
application/json:
schema:
type: object
additionalProperties: false
minProperties: 1
properties:
input:
description: Input of the KYB financial institution process.
type: object
additionalProperties: false
minProperties: 1
properties:
regulatorsAndLicenses:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: >-
Details about who the business is regulated by, and
what licenses they have.
type: string
maxLength: 1000
type: string
moneyTransmitterLicenses:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: >-
Details about who the business is regulated by, and
what licenses they have.
type: string
maxLength: 1000
compliancePolicies:
anyOf:
- $ref: '#/components/schemas/kyb-document'
- type: 'null'
description: The compliance policies document.
amlAudit:
anyOf:
- $ref: '#/components/schemas/kyb-document'
- type: 'null'
description: The AML audit document.
mlroDocumentation:
anyOf:
- $ref: '#/components/schemas/kyb-document'
- type: 'null'
description: The MLRO documentation document.
required:
- input
examples:
Update Financial Institution Process:
value:
input:
regulatorsAndLicenses: >-
Regulated by the Financial Conduct Authority (FCA) under
registration number 123456. Licensed for electronic money
issuance and payment services.
compliancePolicies:
fileId: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d
amlAudit:
fileId: b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e
mlroDocumentation:
fileId: c3d4e5f6-a7b8-4c9d-0e1f-2a3b4c5d6e7f
Update Financial Institution Process (US Money Transmitter):
value:
input:
regulatorsAndLicenses: >-
Regulated by FinCEN and various state regulators. Maintains
money services business (MSB) registration.
moneyTransmitterLicenses: >-
License #MT-123456 issued by New York State Department of
Financial Services (NYSDFS). Additional licenses in CA, TX,
and FL.
compliancePolicies:
fileId: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d
amlAudit:
fileId: b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e
mlroDocumentation:
fileId: c3d4e5f6-a7b8-4c9d-0e1f-2a3b4c5d6e7f
responses:
update-kyb-financial-institution-response:
description: KYB financial institution process updated.
content:
application/json:
schema:
type: object
properties:
financialInstitution:
$ref: '#/components/schemas/kyb-financial-institution'
required:
- financialInstitution
examples:
Process Updated (Non-US):
value:
financialInstitution:
code: financial-institution
status: ok
input:
regulatorsAndLicenses: >-
Regulated by the Financial Conduct Authority (FCA) under
registration number 123456. Licensed for electronic money
issuance and payment services.
compliancePolicies:
fileId: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d
amlAudit:
fileId: b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e
mlroDocumentation:
fileId: c3d4e5f6-a7b8-4c9d-0e1f-2a3b4c5d6e7f
Process Updated (US Money Transmitter):
value:
financialInstitution:
code: financial-institution
status: ok
input:
regulatorsAndLicenses: >-
Regulated by FinCEN and various state regulators.
Maintains money services business (MSB) registration.
moneyTransmitterLicenses: >-
License #MT-123456 issued by New York State Department of
Financial Services (NYSDFS). Additional licenses in CA,
TX, and FL.
compliancePolicies:
fileId: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d
amlAudit:
fileId: b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e
mlroDocumentation:
fileId: c3d4e5f6-a7b8-4c9d-0e1f-2a3b4c5d6e7f
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-kyb-financial-institution-not-found-response:
description: Resource not found.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
File Not Found:
value:
code: entity_not_found
message: A file specified in the request cannot be found
details:
context: body
entity: file
property: input.compliancePolicies.fileId
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-kyb-financial-institution-conflict-response:
description: Business logic error.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
File Invalid:
value:
code: file_invalid
message: A file specified in the request has not been uploaded
details:
context: body
property: input.compliancePolicies.fileId
Process Updates Not Allowed:
value:
code: operation_not_allowed
message: The current status of the process does not allow updates
details:
reasons:
- kyb-process-update-not-allowed
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-no-edge-spaces:
type: string
pattern: ^\S.*\S$|^\S$
kyb-document:
type: object
additionalProperties: false
properties:
fileId:
description: The id of the file.
type: string
format: uuid
required:
- fileId
kyb-financial-institution:
description: The KYB financial institution object.
type: object
properties:
code:
description: The code of the KYB process.
type: string
const: financial-institution
status:
$ref: '#/components/schemas/kyb-process-status'
input:
description: Input of the KYB process.
type: object
properties:
regulatorsAndLicenses:
description: >-
Details about who the business is regulated by, and what
licenses they have.
type: string
moneyTransmitterLicenses:
description: Details about their money transmitter license (number / issuer).
type: string
compliancePolicies:
$ref: '#/components/schemas/kyb-document'
amlAudit:
$ref: '#/components/schemas/kyb-document'
mlroDocumentation:
$ref: '#/components/schemas/kyb-document'
required:
- code
- status
error:
description: The error information.
allOf:
- $ref: '#/components/schemas/feedback'
kyb-process-status:
description: Status of the KYB process.
type: string
enum:
- ok
- failed
- running
- pending
- exempt
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
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.kyb:read: Grants access to view KYB processes
core.kyb.profile:update: Grants access to update profile KYB process
core.kyb.documents:update: Grants access to update documents KYB process
core.kyb.financial-institution:update: Grants access to update financial institution KYB process
core.kyb.associated-persons:create: Grants access to create KYB associated persons
core.kyb.associated-persons:read: Grants access to view KYB associated persons
core.kyb.associated-persons:delete: Grants access to delete KYB associated persons
core.kyb.associated-persons.profile:update: Grants access to update profile KYB associated person process
core.kyb.associated-persons.identity:update: Grants access to update identity KYB associated person process
core.kyb.associated-persons.proof-of-address:update: >-
Grants access to update proof-of-address KYB associated person
process
core.kyb.attestation:trigger: Grants access to trigger the attestation 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
````