---
title: "Update financial institution"
method: PATCH
path: "/core/kyb/processes/financial-institution"
tags: ["KYB"]
---

# Update financial institution

`PATCH /core/kyb/processes/financial-institution`

## Request

- Base URL: `https://api.enterprise.sandbox.uphold.com`
- URL: `https://api.enterprise.sandbox.uphold.com/core/kyb/processes/financial-institution`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/core/oauth2/token` scopes: `core.kyb.financial-institution:update`
- TypeScript: <https://skmtc.dev/uphold/apis/core-api/docs/core/kyb/processes/financial-institution/patch.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Headers

- `X-On-Behalf-Of` string
- `X-Uphold-User-Ip` union
  - string, ipv4
  - string, ipv6
- `X-Uphold-User-Agent` string
- `X-Uphold-User-Origin` string
- `X-Uphold-User-Country` string
- `X-Uphold-User-Subdivision` string
- `X-Uphold-User-City` string

## Request body

- object
  - `input` object, required: Input of the KYB financial institution process.
    - `regulatorsAndLicenses` string: Details about who the business is regulated by, and what licenses they have.
    - `moneyTransmitterLicenses` string: Details about who the business is regulated by, and what licenses they have.
    - `compliancePolicies` KybDocument
      - `fileId` string, uuid, required: The id of the file.
    - `amlAudit` KybDocument
      - `fileId` string, uuid, required: The id of the file.
    - `mlroDocumentation` KybDocument
      - `fileId` string, uuid, required: The id of the file.

## Response `200`

KYB financial institution process updated.

- object
  - `financialInstitution` KybFinancialInstitution, required: The KYB financial institution object.
    - `code` 'financial-institution', required: The code of the KYB process.
    - `status` 'ok' | 'failed' | 'running' | 'pending' | 'exempt', required: Status of the KYB process.
    - `input` object: Input of the KYB process.
      - `regulatorsAndLicenses` string: Details about who the business is regulated by, and what licenses they have.
      - `moneyTransmitterLicenses` string: Details about their money transmitter license (number / issuer).
      - `compliancePolicies` KybDocument
        - `fileId` string, uuid, required: The id of the file.
      - `amlAudit` KybDocument
        - `fileId` string, uuid, required: The id of the file.
      - `mlroDocumentation` KybDocument
        - `fileId` string, uuid, required: The id of the file.

## Other responses

- `400`: Bad Request.
- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Resource not found.
- `409`: Business logic error.
- `429`: Too Many Requests.

---

[API](https://skmtc.dev/uphold/apis/core-api.md) - [All operations](https://skmtc.dev/uphold/apis/core-api/llms.txt) - [OpenAPI document](https://skmtc.dev/uphold/apis/core-api/revisions/6c663575c57a?raw)
