Update Onboarding

patch

https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}

Updates an existing onboarding for a recipient. Only specified fields will be updated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint updates an existing onboarding for a recipient, allowing you to modify onboarding details after initial creation. Use this when you need to update provider information, documentation, banking details, or other onboarding parameters for existing recipients in the split payments marketplace.

Prerequisites

This endpoint requires an existing onboarding created via Create Onboarding

Path Params

recipient_id

string

required

ID of the recipient whose onboarding will be updated

onboarding_id

string

required

ID of the onboarding to be updated

Body Params

account_id

string

Unique id of the account in Yuno

type

string

enum

Type of onboarding flow. PREVIOUSLY_ONBOARDED for pre-existing accounts, ONE_STEP_ONBOARDING for account creation + KYC in one step, TWO_STEP_ONBOARDING for account creation first then KYC later

Allowed:

workflow

string

enum

Workflow of the onboarding

Allowed:

callback_url

uri

URL in case to redirect your customer after the onboarding process with the provider, if needed.

provider

object

documentation

array of objects

Specifies the documentation object.

documentation

withdrawal_methods

object

Specifies the withdrawal methods object.

legal_representatives

array of objects

Object to indicate the owners of the organization. Adyen, Stripe and dlocal have fields related to that.

legal_representatives

terms_of_service

object

Object describing terms of service.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Prerequisites

200Updated

400Bad Request

401Unauthorized

403Forbidden