Skip to main content
PATCH
/
banking
/
entities
/
{entity_id}
/
onboardings
/
{onboarding_id}
Update Entity Onboarding (Banking Connectivity)
curl --request PATCH \
  --url https://api-sandbox.y.uno/v1/banking/entities/{entity_id}/onboardings/{onboarding_id} \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "account_id": "550e8400-e29b-41d4-a716-446655440000",
  "compliance_declaration": {
    "terms_of_service": {
      "accepted": true,
      "version": "1.2.0",
      "accepted_at": "2026-02-01T10:05:00Z",
      "accepted_ip": "192.168.1.1"
    },
    "privacy_policy": {
      "accepted": true,
      "version": "2.1.0",
      "accepted_at": "2026-02-01T10:05:00Z",
      "accepted_ip": "192.168.1.1"
    }
  },
  "risk_assessment": {
    "assessed_at": "2026-02-01T10:05:00Z",
    "pep_status": {
      "is_pep": false,
      "pep_level": null,
      "position": null,
      "country": null
    },
    "rca_status": {
      "risk_level": "LOW",
      "classified_at": "2026-02-01T10:05:00Z",
      "assessed_by": "Merchant Compliance Team"
    },
    "sanctions_screening": {
      "appears_on_sanctions_list": false,
      "sanctions_list_name": null,
      "screened_at": "2026-02-01T09:00:00Z"
    }
  },
  "source_of_funds": {
    "primary_source": "EMPLOYMENT_SALARY",
    "secondary_sources": [
      "INVESTMENTS"
    ],
    "description": "Primary income from full-time employment, supplemented by investment portfolio",
    "estimated_annual_income": {
      "amount": 175000,
      "currency": "USD"
    }
  },
  "documentation": [
    {
      "type": "BANK_STATEMENT",
      "bank_statement": {
        "bank_name": "Chase Bank",
        "account_number_last_4": "1234",
        "statement_period_start": "2025-12-01",
        "statement_period_end": "2025-12-31",
        "file": {
          "file_name": "bank_statement_dec_2025.pdf",
          "content_type": "application/pdf",
          "content": "base64_encoded_content"
        }
      }
    },
    {
      "type": "IDENTITY_DOCUMENT",
      "identity_document": {
        "subtype": "PASSPORT",
        "document_number": "X12345678",
        "issuing_country": "US",
        "issued_at": "2020-01-15",
        "expires_at": "2030-01-15",
        "front_image": {
          "file_name": "passport_front.jpg",
          "content_type": "image/jpeg",
          "content": "base64_encoded_content"
        }
      }
    }
  ]
}
'
{
  "id": "onb_990e8400-e29b-41d4-a716-446655440000",
  "entity_id": "ent_660e8400-e29b-41d4-a716-446655440000",
  "status": "PENDING",
  "provider_status": "verification_pending",
  "requirements": [],
  "updated_at": "2026-02-01T10:05:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.y.uno/llms.txt

Use this file to discover all available pages before exploring further.

Update an existing onboarding with new compliance declarations, risk assessment results, or additional documentation. Typically used when the onboarding is in PENDING_ADDITIONAL_DOCUMENTATION status.

Authorizations

​
public-api-key
string
header
required
​
private-secret-key
string
header
required

Path Parameters

​
entity_id
string
required

The id of the entity obtained from Create Entity.

​
onboarding_id
string
required

The id of the onboarding obtained from Create Entity Onboarding.

Body

application/json
​
account_id
string
required

The unique identifier of the merchant's Yuno account (UUID, 36 characters).

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
compliance_declaration
object

Updated legal agreements.

​
risk_assessment
object

Updated risk assessment results.

​
source_of_funds
object

Updated source of funds information.

​
documentation
object[]

Additional or updated KYC/KYB documents. Uses the same structure as Create Entity Onboarding.

Response

​
id
string
Example:

"onb_990e8400-e29b-41d4-a716-446655440000"

​
entity_id
string
Example:

"ent_660e8400-e29b-41d4-a716-446655440000"

​
status
string
Example:

"PENDING"

​
provider_status
string
Example:

"verification_pending"

​
requirements
object[]
​
updated_at
string
Example:

"2026-02-01T10:05:00Z"