Update Onboarding

Update an existing onboarding process for a recipient.

PATCH /v1/recipients/{recipient_id}/onboardings/{onboarding_id}

Update Onboarding

cURL

curl --request PATCH \
  --url https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "workflow": "<string>",
  "callback_url": "<string>",
  "provider": {
    "id": "<string>",
    "connection_id": "<string>",
    "recipient_id": "<string>",
    "recipient_type": "<string>"
  },
  "documentation": [
    {
      "file_name": "<string>",
      "content_type": "<string>",
      "content_category": "<string>",
      "content": "<string>"
    }
  ],
  "withdrawal_methods": [
    {}
  ],
  "legal_representatives": [
    {}
  ]
}
'

Updates an existing onboarding process. Use this to modify provider details, upload additional documentation, update withdrawal methods, or add legal representative information.

Path Parameters

recipient_id · string · required

The unique identifier of the recipient.

onboarding_id · string · required

The unique identifier of the onboarding process.

Request Body

All fields are optional. Include only the fields you want to update.

type · string

Onboarding type.

Values: PREVIOUSLY_ONBOARDED, ONBOARD_ONTO_THE_PROVIDER

workflow · string

Workflow type.

Values: HOSTED_BY_PROVIDER, DIRECT

callback_url · string

URL to redirect the recipient after provider-hosted onboarding.

provider · object

Updated provider details.

Show provider

id · string

Provider identifier (e.g., PAGARME, STRIPE, ADYEN).

connection_id · string

Yuno connection identifier.

recipient_id · string

Provider’s recipient identifier.

recipient_type · string

Values: MEAL, FOOD, MULTI_BENEFITS, FLEET

documentation · array

Updated or additional supporting documents.

Show documentation item

file_name · string

Document filename.

content_type · string

Document classification.

content_category · string

Category (e.g., INVOICE, ID_PROOF).

content · string

Base64-encoded file content. Max 1 MB.

withdrawal_methods · array

Updated bank account details for payouts.

legal_representatives · array

Organization owners or beneficial owners information.

Related Pages

• Get Onboarding. Retrieve current onboarding state
• Onboarding Statuses. Status lifecycle reference
• Continue Onboarding. Resume after updating