Skip to main content
PATCH
/
recipients
/
{recipient_id}
/
onboardings
/
{onboarding_id}
Update onboarding
curl --request PATCH \
  --url https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id} \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "account_id": "{{account_id}}",
  "provider": {
    "id": "YUNO_TEST_PAYMENT_GW",
    "connection_id": "{{connection_id}}",
    "recipient_type": "MULTI_BENEFITS"
  }
}
'
{
  "id": "3aaa4d82-11e8-48ce-8ef5-04eee3a10802",
  "account_id": "fe14c7c6-c75e-43b7-bdbe-4c87ad52c482",
  "merchant_recipient_id": "MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6",
  "national_entity": "INDIVIDUAL",
  "entity_type": "PRIVATE",
  "first_name": "Juan",
  "last_name": "Pérez",
  "legal_name": null,
  "email": "juan.perez@example.com",
  "date_of_birth": "1990-01-15",
  "country": "CO",
  "website": "https://juanperez.com",
  "industry": "Technology",
  "merchant_category_code": "5734",
  "document": {
    "document_number": "1234567890",
    "document_type": "CC"
  },
  "phone": {
    "country_code": "57",
    "number": "3001234567"
  },
  "address": {
    "address_line_1": "Carrera 7 # 32-16",
    "address_line_2": "Oficina 201",
    "city": "Bogotá",
    "country": "CO",
    "state": "Cundinamarca",
    "zip_code": "110311",
    "neighborhood": "Centro"
  },
  "legal_representatives": [
    {
      "merchant_reference": "REP_001",
      "first_name": "María",
      "last_name": "González",
      "email": "maria.gonzalez@example.com",
      "date_of_birth": "1985-05-20",
      "country": "CO",
      "nationality": "CO",
      "title": "CEO",
      "publicly_exposed_person": false,
      "ultimate_beneficial_owner": true,
      "document": {
        "document_type": "CC",
        "document_number": "0987654321"
      },
      "phone": {
        "country_code": "57",
        "number": "3109876543"
      },
      "address": {
        "address_line_1": "Calle 26 # 13-19",
        "address_line_2": null,
        "country": "CO",
        "state": "Cundinamarca",
        "city": "Bogotá",
        "zip_code": "110311"
      }
    }
  ],
  "withdrawal_methods": {
    "bank": {
      "code": "001",
      "branch": "004",
      "branch_digit": "123",
      "account": "1234567890",
      "account_digit": "123",
      "account_type": "SAVINGS",
      "routing": "021000021",
      "country": "CO",
      "currency": "COP"
    }
  },
  "documentation": [
    {
      "file_name": "cc-front.pdf",
      "content_type": "application/pdf",
      "content_category": "IDENTIFICATION",
      "content": "JVBERi0xLjQKJ..."
    }
  ],
  "onboardings": [
    {
      "id": "84c42684-dbe5-4e0f-bd17-4d094e19762d",
      "type": "ONBOARD_ONTO_THE_PROVIDER",
      "workflow": "DIRECT",
      "status": "PENDING",
      "callback_url": "https://merchant.example.com/webhook/onboarding",
      "provider": {
        "id": "ALELO",
        "connection_id": "cc389b51-53a1-4a29-af40-c8cee26c3399",
        "recipient_id": null,
        "redirect_url": null,
        "onboarding_url": null,
        "legal_entity": null,
        "balance_account_id": null,
        "legal_entity_id": null
      },
      "documentation": [
        {
          "file_name": "utility-bill.pdf",
          "content_type": "application/pdf",
          "content_category": "ADDRESS_PROOF",
          "content": "JVBERi0xLjQKJ..."
        }
      ],
      "legal_representatives": [],
      "requirements": [
        {
          "field": "document.cc",
          "message": "Provide CC document image",
          "status": "PENDING"
        }
      ],
      "withdrawal_methods": {
        "bank": {
          "code": "002",
          "branch": "002",
          "branch_digit": null,
          "account": "9876543210",
          "account_digit": null,
          "account_type": "SAVINGS",
          "routing": "021000022",
          "country": "CO",
          "currency": "COP"
        }
      },
      "terms_of_service": {
        "acceptance": true,
        "date": "2025-07-21T20:43:54Z",
        "ip": "129.21.111.11"
      },
      "created_at": "2025-08-27T15:41:19.516982Z",
      "updated_at": "2025-08-27T15:41:19.516989Z"
    }
  ],
  "created_at": "2025-08-27T15:41:19.497413Z",
  "updated_at": "2025-08-27T15:41:19.497425Z"
}
Updates an existing onboarding for a recipient. Only specified fields will be updated. 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

Authorizations

​
public-api-key
string
header
default:<Your public-api-key>
required
​
private-secret-key
string
header
default:<Your private-secret-key>
required

Path Parameters

​
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

application/json
​
account_id
string

Unique id of the account in Yuno

Example:

"9104911d-5df9-429e-8488-ad41abea1a4b"

​
type
enum<string>

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

Available options:
PREVIOUSLY_ONBOARDED,
ONE_STEP_ONBOARDING,
TWO_STEP_ONBOARDING
Example:

"PREVIOUSLY_ONBOARDED"

​
workflow
enum<string>

Workflow of the onboarding

Available options:
HOSTED_BY_PROVIDER,
HOSTED_BY_YUNO,
DIRECT
Example:

"HOSTED_BY_PROVIDER"

​
callback_url
string<uri>

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

Example:

"https://www.google.com"

​
provider
object
​
documentation
object[]

Specifies the documentation object.

​
withdrawal_methods
object

Specifies the withdrawal methods object.

​
legal_representatives
object[]

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

​
terms_of_service
object

Object describing terms of service.

Response

Updated

​
id
string

The unique identifier of the recipient.

Example:

"3aaa4d82-11e8-48ce-8ef5-04eee3a10802"

​
account_id
string

The account identifier associated with this recipient.

Example:

"fe14c7c6-c75e-43b7-bdbe-4c87ad52c482"

​
merchant_recipient_id
string

Unique identifier of the recipient defined by the merchant.

Example:

"MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6"

​
national_entity
string

Beneficiary's national entity type.

Example:

"INDIVIDUAL"

​
entity_type
string

Beneficiary's type of organization.

Example:

"PRIVATE"

​
first_name
string

Beneficiary's name.

Example:

"Juan"

​
last_name
string

Beneficiary's last name.

Example:

"Pérez"

​
legal_name
string | null

Beneficiary's legal name.

Example:

null

​
email
string

The Beneficiary's email.

Example:

"juan.perez@example.com"

​
date_of_birth
string

Beneficiary's date of birth.

Example:

"1990-01-15"

​
country
string

The Beneficiary's country.

Example:

"CO"

​
website
string

The seller's website URL.

Example:

"https://juanperez.com"

​
industry
string

The seller's industry.

Example:

"Technology"

​
merchant_category_code
string

The merchant category code (MCC) (MAX 235; MIN 1).

Example:

"5734"

​
document
object
​
phone
object
​
address
object
​
legal_representatives
object[]
​
withdrawal_methods
object
​
documentation
object[]
​
onboardings
object[]
​
created_at
string<date-time>

Recipient creation date (ISO 8601 MAX 27; MIN 27).

Example:

"2025-08-27T15:41:19.497413Z"

​
updated_at
string<date-time>

Last Recipient updated date (ISO 8601 MAX 27; MIN 27).

Example:

"2025-08-27T15:41:19.497425Z"