---
title: "Update Entity Onboarding (Banking Connectivity)"
method: PATCH
path: "/banking/entities/{entity_id}/onboardings/{onboarding_id}"
tags: ["Entity Onboarding (Banking Connectivity)"]
---

# Update Entity Onboarding (Banking Connectivity)

`PATCH /banking/entities/{entity_id}/onboardings/{onboarding_id}`

## Request

- Base URL: `https://api-sandbox.y.uno/v1`
- URL: `https://api-sandbox.y.uno/v1/banking/entities/{entity_id}/onboardings/{onboarding_id}`
- Auth: API key in header `PUBLIC-API-KEY` and API key in header `PRIVATE-SECRET-KEY`
- TypeScript: <https://skmtc.dev/y/apis/ai-caller/docs/banking/entities/:entity_id/onboardings/:onboarding_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `entity_id` string, required
- `onboarding_id` string, required

## Request body

- object
  - `account_id` string, required: The unique identifier of the merchant's Yuno account (UUID, 36 characters).
  - `compliance_declaration` object: Updated legal agreements.
    - `terms_of_service` object
      - `accepted` boolean
      - `version` string
      - `accepted_at` string
      - `accepted_ip` string
    - `privacy_policy` object
      - `accepted` boolean
      - `version` string
      - `accepted_at` string
      - `accepted_ip` string
  - `risk_assessment` object: Updated risk assessment results.
    - `assessed_at` string
    - `pep_status` object
      - `is_pep` boolean
      - `pep_level` string, nullable
      - `position` string, nullable
      - `country` string, nullable
    - `rca_status` object
      - `risk_level` 'LOW' | 'MEDIUM' | 'HIGH'
      - `classified_at` string
      - `assessed_by` string
    - `sanctions_screening` object
      - `appears_on_sanctions_list` boolean
      - `sanctions_list_name` string, nullable
      - `screened_at` string
  - `source_of_funds` object: Updated source of funds information.
    - `primary_source` 'EMPLOYMENT_SALARY' | 'BUSINESS_INCOME' | 'INVESTMENTS' | 'RENTAL_INCOME' | 'PENSION' | 'GOVERNMENT_BENEFITS' | 'INHERITANCE' | 'FAMILY_SUPPORT' | 'SAVINGS' | 'LOTTERY_GAMBLING' | 'SALE_OF_ASSETS' | 'CRYPTOCURRENCY' | 'FREELANCE_CONSULTING' | 'OTHER'
    - `secondary_sources` string[]
    - `description` string
    - `estimated_annual_income` object
      - `amount` number
      - `currency` string
  - `documentation` object[]: Additional or updated KYC/KYB documents. Uses the same structure as [Create Entity Onboarding](https://temp-yuno-docs.readme.io/reference/create-entity-onboarding).
    - `type` 'IDENTITY_DOCUMENT' | 'PROOF_OF_ADDRESS' | 'BANK_STATEMENT' | 'BUSINESS_DOCUMENT' | 'TAX_INFORMATION' | 'FINANCIAL_DOCUMENT' | 'BIOMETRIC_VERIFICATION' | 'EMPLOYMENT_INFORMATION', required

## Response `200`

- object
  - `id` string
  - `entity_id` string
  - `status` string
  - `provider_status` string
  - `requirements` object[]
  - `updated_at` string

## Other responses

- `400`: Bad Request
- `404`: Not Found

---

[API](https://skmtc.dev/y/apis/ai-caller.md) - [All operations](https://skmtc.dev/y/apis/ai-caller/llms.txt) - [OpenAPI document](https://skmtc.dev/y/apis/ai-caller/revisions/05b629819b49?raw)
