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

# Update documents

`PATCH /core/kyb/processes/documents`

## Request

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

Update the documents process for a business user.

## 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: The input of the KYB process.
    - `incorporation` KybDocument
      - `fileId` string, uuid, required: The id of the file.
    - `ownership` KybDocument
      - `fileId` string, uuid, required: The id of the file.
    - `control` KybDocument
      - `fileId` string, uuid, required: The id of the file.
    - `standing` KybDocument
      - `fileId` string, uuid, required: The id of the file.
    - `taxIdentity` KybDocument
      - `fileId` string, uuid, required: The id of the file.

## Response `200`

KYB documents process updated.

- object
  - `documents` KybDocuments, required: The KYB documents object.
    - `code` 'documents', 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.
      - `incorporation` object: The document evidencing the incorporation of the business.
        - `fileId` string, uuid, required: The id of the file.
      - `ownership` object: The document evidencing the ownership of the business, such as the beneficial owners.
        - `fileId` string, uuid, required: The id of the file.
      - `control` object: The document evidencing who controls the business, such as directors and/or officers.
        - `fileId` string, uuid, required: The id of the file.
      - `standing` object: The document evidencing that the business is still active.
        - `fileId` string, uuid, required: The id of the file.
      - `taxIdentity` object: The document evidencing the tax identity of the business.
        - `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)