v1

latestOpenAPI 3.0.02026-07-26167441.9 MB
Entity Onboarding (Banking Connectivity)

Update Entity Onboarding (Banking Connectivity)

patch/banking/entities/{entity_id}/onboardings/{onboarding_id}

Path parameters

entity_idstring required

The id of the entity obtained from Create Entity.

onboarding_idstring required

The id of the onboarding obtained from Create Entity Onboarding.

Request body

account_idstring required

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

Example request

{
  "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",
    "rca_status": {
      "risk_level": "LOW",
      "classified_at": "2026-02-01T10:05:00Z",
      "assessed_by": "Merchant Compliance Team"
    },
    "sanctions_screening": {
      "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"
    }
  ]
}

Response

idstring
entity_idstring
statusstring
provider_statusstring
requirementsobject[]
updated_atstring

Example response

{
  "id": "onb_990e8400-e29b-41d4-a716-446655440000",
  "entity_id": "ent_660e8400-e29b-41d4-a716-446655440000",
  "status": "PENDING",
  "provider_status": "verification_pending",
  "updated_at": "2026-02-01T10:05:00Z"
}