Recipients & Transfers
Update Onboarding
Update an existing onboarding process for a recipient.
PATCH
/
v1
/
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' \
--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": [
{}
]
}
'import requests
url = "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}"
payload = {
"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": [{}]
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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: [{}]
})
};
fetch('https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}"
payload := strings.NewReader("{\n \"type\": \"<string>\",\n \"workflow\": \"<string>\",\n \"callback_url\": \"<string>\",\n \"provider\": {\n \"id\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"recipient_id\": \"<string>\",\n \"recipient_type\": \"<string>\"\n },\n \"documentation\": [\n {\n \"file_name\": \"<string>\",\n \"content_type\": \"<string>\",\n \"content_category\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"withdrawal_methods\": [\n {}\n ],\n \"legal_representatives\": [\n {}\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"<string>\",\n \"workflow\": \"<string>\",\n \"callback_url\": \"<string>\",\n \"provider\": {\n \"id\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"recipient_id\": \"<string>\",\n \"recipient_type\": \"<string>\"\n },\n \"documentation\": [\n {\n \"file_name\": \"<string>\",\n \"content_type\": \"<string>\",\n \"content_category\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"withdrawal_methods\": [\n {}\n ],\n \"legal_representatives\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"<string>\",\n \"workflow\": \"<string>\",\n \"callback_url\": \"<string>\",\n \"provider\": {\n \"id\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"recipient_id\": \"<string>\",\n \"recipient_type\": \"<string>\"\n },\n \"documentation\": [\n {\n \"file_name\": \"<string>\",\n \"content_type\": \"<string>\",\n \"content_category\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"withdrawal_methods\": [\n {}\n ],\n \"legal_representatives\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_bodyUpdates an existing onboarding process. Use this to modify provider details, upload additional documentation, update withdrawal methods, or add legal representative information.
Path Parameters
string
required
The unique identifier of the recipient.
string
required
The unique identifier of the onboarding process.
Request Body
All fields are optional. Include only the fields you want to update.string
Onboarding type.Values:
PREVIOUSLY_ONBOARDED, ONBOARD_ONTO_THE_PROVIDERstring
Workflow type.Values:
HOSTED_BY_PROVIDER, DIRECTstring
URL to redirect the recipient after provider-hosted onboarding.
object
array
array
Updated bank account details for payouts.
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
⌘I
Update Onboarding
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": [
{}
]
}
'import requests
url = "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}"
payload = {
"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": [{}]
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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: [{}]
})
};
fetch('https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}"
payload := strings.NewReader("{\n \"type\": \"<string>\",\n \"workflow\": \"<string>\",\n \"callback_url\": \"<string>\",\n \"provider\": {\n \"id\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"recipient_id\": \"<string>\",\n \"recipient_type\": \"<string>\"\n },\n \"documentation\": [\n {\n \"file_name\": \"<string>\",\n \"content_type\": \"<string>\",\n \"content_category\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"withdrawal_methods\": [\n {}\n ],\n \"legal_representatives\": [\n {}\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"<string>\",\n \"workflow\": \"<string>\",\n \"callback_url\": \"<string>\",\n \"provider\": {\n \"id\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"recipient_id\": \"<string>\",\n \"recipient_type\": \"<string>\"\n },\n \"documentation\": [\n {\n \"file_name\": \"<string>\",\n \"content_type\": \"<string>\",\n \"content_category\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"withdrawal_methods\": [\n {}\n ],\n \"legal_representatives\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings/{onboarding_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"<string>\",\n \"workflow\": \"<string>\",\n \"callback_url\": \"<string>\",\n \"provider\": {\n \"id\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"recipient_id\": \"<string>\",\n \"recipient_type\": \"<string>\"\n },\n \"documentation\": [\n {\n \"file_name\": \"<string>\",\n \"content_type\": \"<string>\",\n \"content_category\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"withdrawal_methods\": [\n {}\n ],\n \"legal_representatives\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body