Update Onboarding
Update the data or documentation of an existing recipient onboarding
Prerequisites
This endpoint requires an existing onboarding created via Create OnboardingUpdating a bank account
For Zoop and Pagar.me onboardings with a provider recipient ID, an explicitwithdrawal_methods.bank update waits for the provider result. It updates only the selected onboarding; the recipient default and other onboardings remain unchanged.
Only a confirmed account is saved for the onboarding. Bank-update results do not change its lifecycle status. Send a complete account when the onboarding shows no bank account. See bank errors and retries for partial outcomes, 400 responses and 409 reconciliation guidance.
For these supported provider-bound onboardings, non-bank fields other than documentation are saved in Yuno without a separate provider profile update. Sending a description or metadata does not resend the saved bank account. In a mixed request, the bank is processed first; other fields are saved only after it succeeds. Previously onboarded recipients retain the existing status notification for non-bank updates without documentation.
For example, changing only a store’s description leaves its confirmed payout account and onboarding status unchanged. To change the payout account, include withdrawal_methods.bank explicitly.
Updating documentation
For Zoop onboardings with a provider recipient ID, a request withdocumentation sends the documents in that request to Zoop and waits for the result. This includes previously onboarded recipients. Only the document categories in the request are sent, and the bank account is not resent.
- If Zoop accepts the documents, the onboarding takes the status and requirements that Zoop reports, and the usual onboarding webhook is sent.
- If Zoop rejects the documents, or the delivery or the resulting status cannot be confirmed, the response is
400with codePROVIDER_OPERATION_FAILED. The documents are saved in Yuno, and the onboarding keeps its previous status and requirements. Resend onlydocumentation. - In a request that also updates the bank account, the bank update is processed first. If the documents then fail, the
400also reports the bank result. A bank change reported asAPPLIEDstays applied, so resend onlydocumentation.
CANCELLED, BLOCKED, INACTIVE or TRANSFERRED status reject updates with 400 INVALID_STATE, except previously onboarded recipients: their update saves documentation in Yuno without sending it to the provider. A TERMINATED onboarding always returns 400 INVALID_STATE.Authorizations
Path Parameters
ID of the recipient whose onboarding will be updated
ID of the onboarding to be updated
Body
Unique id of the account in Yuno
"9104911d-5df9-429e-8488-ad41abea1a4b"
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
PREVIOUSLY_ONBOARDED, ONE_STEP_ONBOARDING, TWO_STEP_ONBOARDING "PREVIOUSLY_ONBOARDED"
Workflow of the onboarding
HOSTED_BY_PROVIDER, HOSTED_BY_YUNO, DIRECT "HOSTED_BY_PROVIDER"
URL in case to redirect your customer after the onboarding process with the provider, if needed.
"https://www.google.com"
Specifies the documentation object.
Specifies the withdrawal methods object.
Object to indicate the owners of the organization. Adyen, Stripe and dlocal have fields related to that.
Object describing terms of service.
Response
Updated
The unique identifier of the recipient.
"3aaa4d82-11e8-48ce-8ef5-04eee3a10802"
The account identifier associated with this recipient.
"fe14c7c6-c75e-43b7-bdbe-4c87ad52c482"
Unique identifier of the recipient defined by the merchant.
"MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6"
Beneficiary's national entity type.
"INDIVIDUAL"
Beneficiary's type of organization.
"PRIVATE"
Beneficiary's name.
"Juan"
Beneficiary's last name.
"Perez"
Beneficiary's legal name.
null
The Beneficiary's email.
"juan.perez@example.com"
Beneficiary's date of birth.
"1990-01-15"
The Beneficiary's country.
"CO"
The seller's website URL.
"https://juanperez.com"
The seller's industry.
"Technology"
The merchant category code (MCC) (MAX 235; MIN 1).
"5734"
Rules for automatic split calculation at the recipient level.
Recipient creation date (ISO 8601 MAX 27; MIN 27).
"2025-08-27T15:41:19.497413Z"
Last Recipient updated date (ISO 8601 MAX 27; MIN 27).
"2025-08-27T15:41:19.497425Z"