Recipients for Marketplace
Create Onboarding
Start a new onboarding to register a recipient with a payment provider for split payouts
POST
/
recipients
/
{recipient_id}
/
onboardings
Create Onboarding
curl --request POST \
--url https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings \
--header 'Content-Type: application/json' \
--header 'private-secret-key: <api-key>' \
--header 'public-api-key: <api-key>' \
--data '
{
"account_id": "{{account-code}}",
"type": "PREVIOUSLY_ONBOARDED",
"workflow": "DIRECT",
"callback_url": "https://merchant.example.com/webhook/onboarding",
"provider": {
"id": "VR",
"connection_id": "d2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4",
"recipient_id": "test01",
"recipient_type": "MULTI_BENEFITS"
},
"documentation": [
{
"file_name": "onboarding.pdf",
"content_type": "application/pdf",
"content_category": "IDENTIFICATION_DOCUMENT",
"content": "VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA=="
}
],
"withdrawal_methods": {
"bank": {
"code": "002",
"branch": "002",
"account": "9876543210",
"account_type": "CHECKINGS",
"country": "US",
"currency": "USD",
"routing": "021000022"
}
},
"terms_of_service": {
"acceptance": true,
"date": "2025-07-21T20:43:54.786342Z",
"ip": "129.21.111.11"
}
}
'import requests
url = "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings"
payload = {
"account_id": "{{account-code}}",
"type": "PREVIOUSLY_ONBOARDED",
"workflow": "DIRECT",
"callback_url": "https://merchant.example.com/webhook/onboarding",
"provider": {
"id": "VR",
"connection_id": "d2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4",
"recipient_id": "test01",
"recipient_type": "MULTI_BENEFITS"
},
"documentation": [
{
"file_name": "onboarding.pdf",
"content_type": "application/pdf",
"content_category": "IDENTIFICATION_DOCUMENT",
"content": "VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA=="
}
],
"withdrawal_methods": { "bank": {
"code": "002",
"branch": "002",
"account": "9876543210",
"account_type": "CHECKINGS",
"country": "US",
"currency": "USD",
"routing": "021000022"
} },
"terms_of_service": {
"acceptance": True,
"date": "2025-07-21T20:43:54.786342Z",
"ip": "129.21.111.11"
}
}
headers = {
"public-api-key": "<api-key>",
"private-secret-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'public-api-key': '<api-key>',
'private-secret-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
account_id: '{{account-code}}',
type: 'PREVIOUSLY_ONBOARDED',
workflow: 'DIRECT',
callback_url: 'https://merchant.example.com/webhook/onboarding',
provider: {
id: 'VR',
connection_id: 'd2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4',
recipient_id: 'test01',
recipient_type: 'MULTI_BENEFITS'
},
documentation: [
{
file_name: 'onboarding.pdf',
content_type: 'application/pdf',
content_category: 'IDENTIFICATION_DOCUMENT',
content: 'VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA=='
}
],
withdrawal_methods: {
bank: {
code: '002',
branch: '002',
account: '9876543210',
account_type: 'CHECKINGS',
country: 'US',
currency: 'USD',
routing: '021000022'
}
},
terms_of_service: {acceptance: true, date: '2025-07-21T20:43:54.786342Z', ip: '129.21.111.11'}
})
};
fetch('https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'account_id' => '{{account-code}}',
'type' => 'PREVIOUSLY_ONBOARDED',
'workflow' => 'DIRECT',
'callback_url' => 'https://merchant.example.com/webhook/onboarding',
'provider' => [
'id' => 'VR',
'connection_id' => 'd2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4',
'recipient_id' => 'test01',
'recipient_type' => 'MULTI_BENEFITS'
],
'documentation' => [
[
'file_name' => 'onboarding.pdf',
'content_type' => 'application/pdf',
'content_category' => 'IDENTIFICATION_DOCUMENT',
'content' => 'VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA=='
]
],
'withdrawal_methods' => [
'bank' => [
'code' => '002',
'branch' => '002',
'account' => '9876543210',
'account_type' => 'CHECKINGS',
'country' => 'US',
'currency' => 'USD',
'routing' => '021000022'
]
],
'terms_of_service' => [
'acceptance' => true,
'date' => '2025-07-21T20:43:54.786342Z',
'ip' => '129.21.111.11'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"private-secret-key: <api-key>",
"public-api-key: <api-key>"
],
]);
$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"
payload := strings.NewReader("{\n \"account_id\": \"{{account-code}}\",\n \"type\": \"PREVIOUSLY_ONBOARDED\",\n \"workflow\": \"DIRECT\",\n \"callback_url\": \"https://merchant.example.com/webhook/onboarding\",\n \"provider\": {\n \"id\": \"VR\",\n \"connection_id\": \"d2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4\",\n \"recipient_id\": \"test01\",\n \"recipient_type\": \"MULTI_BENEFITS\"\n },\n \"documentation\": [\n {\n \"file_name\": \"onboarding.pdf\",\n \"content_type\": \"application/pdf\",\n \"content_category\": \"IDENTIFICATION_DOCUMENT\",\n \"content\": \"VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA==\"\n }\n ],\n \"withdrawal_methods\": {\n \"bank\": {\n \"code\": \"002\",\n \"branch\": \"002\",\n \"account\": \"9876543210\",\n \"account_type\": \"CHECKINGS\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"routing\": \"021000022\"\n }\n },\n \"terms_of_service\": {\n \"acceptance\": true,\n \"date\": \"2025-07-21T20:43:54.786342Z\",\n \"ip\": \"129.21.111.11\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("public-api-key", "<api-key>")
req.Header.Add("private-secret-key", "<api-key>")
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.post("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings")
.header("public-api-key", "<api-key>")
.header("private-secret-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"{{account-code}}\",\n \"type\": \"PREVIOUSLY_ONBOARDED\",\n \"workflow\": \"DIRECT\",\n \"callback_url\": \"https://merchant.example.com/webhook/onboarding\",\n \"provider\": {\n \"id\": \"VR\",\n \"connection_id\": \"d2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4\",\n \"recipient_id\": \"test01\",\n \"recipient_type\": \"MULTI_BENEFITS\"\n },\n \"documentation\": [\n {\n \"file_name\": \"onboarding.pdf\",\n \"content_type\": \"application/pdf\",\n \"content_category\": \"IDENTIFICATION_DOCUMENT\",\n \"content\": \"VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA==\"\n }\n ],\n \"withdrawal_methods\": {\n \"bank\": {\n \"code\": \"002\",\n \"branch\": \"002\",\n \"account\": \"9876543210\",\n \"account_type\": \"CHECKINGS\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"routing\": \"021000022\"\n }\n },\n \"terms_of_service\": {\n \"acceptance\": true,\n \"date\": \"2025-07-21T20:43:54.786342Z\",\n \"ip\": \"129.21.111.11\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"{{account-code}}\",\n \"type\": \"PREVIOUSLY_ONBOARDED\",\n \"workflow\": \"DIRECT\",\n \"callback_url\": \"https://merchant.example.com/webhook/onboarding\",\n \"provider\": {\n \"id\": \"VR\",\n \"connection_id\": \"d2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4\",\n \"recipient_id\": \"test01\",\n \"recipient_type\": \"MULTI_BENEFITS\"\n },\n \"documentation\": [\n {\n \"file_name\": \"onboarding.pdf\",\n \"content_type\": \"application/pdf\",\n \"content_category\": \"IDENTIFICATION_DOCUMENT\",\n \"content\": \"VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA==\"\n }\n ],\n \"withdrawal_methods\": {\n \"bank\": {\n \"code\": \"002\",\n \"branch\": \"002\",\n \"account\": \"9876543210\",\n \"account_type\": \"CHECKINGS\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"routing\": \"021000022\"\n }\n },\n \"terms_of_service\": {\n \"acceptance\": true,\n \"date\": \"2025-07-21T20:43:54.786342Z\",\n \"ip\": \"129.21.111.11\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "61df26d9-3750-4206-baab-f2e20683f35b",
"type": "PREVIOUSLY_ONBOARDED",
"workflow": "DIRECT",
"status": "SUCCEEDED",
"callback_url": "https://merchant.example.com/webhook/onboarding",
"provider": {
"id": "STRIPE",
"connection_id": "8fee3cc6-f3cb-455d-b139-973866111a03",
"recipient_id": "acct_1RvpogA4Jk50vKRE",
"redirect_url": null,
"onboarding_url": null,
"legal_entity": null
},
"documentation": [
{
"file_name": "recipient.pdf",
"content_type": "application/pdf",
"content_category": "IDENTIFICATION_DOCUMENT",
"content": "recipient.pdf-20ac42c2-ef01-4a0c-80dd-0f9f71c9cde7"
}
],
"legal_representatives": [
{
"merchant_reference": "ONB_001",
"first_name": "Tatiana",
"last_name": "González",
"email": "tatiana.gonzalez@example.com",
"date_of_birth": "1985-05-20",
"country": "BR",
"nationality": "BR",
"title": "CEO",
"publicly_exposed_person": false,
"ultimate_beneficial_owner": true,
"document": {
"document_type": "CC",
"document_number": "0987654321"
},
"phone": {
"number": "3109876543",
"country_code": "+57"
},
"address": {
"address_line_1": "Calle 26 # 13-19",
"address_line_2": null,
"country": "CO",
"state": "Cundinamarca",
"city": "Bogotá",
"zip_code": "110311"
}
}
],
"requirements": [],
"withdrawal_methods": {
"bank": {
"code": "003",
"branch": "003",
"branch_digit": null,
"account": "9876543210",
"account_digit": null,
"account_type": "CHECKINGS",
"routing": "021000022",
"country": "US",
"currency": "USD"
}
},
"terms_of_service": {
"acceptance": true,
"date": "2025-07-21T20:43:54.786342Z",
"ip": "129.21.111.11"
},
"recipient": {
"id": "5a37f0c0-7689-4065-8348-4b5ff5bf9cc7",
"account_id": "c24d6c92-99a7-40bb-bc7b-efc40337f9f4",
"merchant_recipient_id": "MERCHANT_85ac5f5d-a169-46b3-bd87-80c0df2e6591",
"national_entity": "INDIVIDUAL",
"entity_type": "PRIVATE",
"first_name": "Stebann",
"last_name": "Castro",
"legal_name": "Steban Castro",
"email": "juan.perez@example.com",
"date_of_birth": "1992-01-21",
"country": "CO",
"website": "https://juanperez.com",
"industry": "Technology",
"merchant_category_code": "5740",
"document": {
"document_number": "09082160000100",
"document_type": "CNPJ"
},
"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": {
"number": "3109876543",
"country_code": "+57"
},
"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": "recipient.pdf",
"content_type": "application/pdf",
"content_category": "IDENTIFICATION_DOCUMENT",
"content": "recipient.pdf-2bf73b44-33e3-49c7-b777-34a5178cfb45"
}
],
"created_at": "2025-08-22T17:54:05.711545Z",
"updated_at": "2025-08-22T17:54:05.711561Z"
},
"history": {
"id": "61df26d9-3750-4206-baab-f2e20683f35b",
"type": "PREVIOUSLY_ONBOARDED",
"workflow": "DIRECT",
"status": "SUCCEEDED",
"callback_url": "https://merchant.example.com/webhook/onboarding",
"provider": {
"id": "STRIPE",
"connection_id": "8fee3cc6-f3cb-455d-b139-973866111a03",
"recipient_id": "acct_1RvpogA4Jk50vKRE",
"redirect_url": null
},
"documentation": [
{
"file_name": "recipient.pdf",
"content_type": "application/pdf",
"content_category": "IDENTIFICATION_DOCUMENT",
"content": "recipient.pdf-20ac42c2-ef01-4a0c-80dd-0f9f71c9cde7"
}
],
"legal_representatives": [
{
"merchant_reference": "ONB_001",
"first_name": "Tatiana",
"last_name": "González",
"email": "tatiana.gonzalez@example.com",
"date_of_birth": "1985-05-20",
"country": "BR",
"nationality": "BR",
"title": "CEO",
"publicly_exposed_person": false,
"ultimate_beneficial_owner": true,
"document": {
"document_type": "CC",
"document_number": "0987654321"
},
"phone": {
"number": "3109876543",
"country_code": "+57"
},
"address": {
"address_line_1": "Calle 26 # 13-19",
"address_line_2": null,
"country": "CO",
"state": "Cundinamarca",
"city": "Bogotá",
"zip_code": "110311"
}
}
],
"requirements": [],
"withdrawal_methods": {
"bank": {
"code": "003",
"branch": "003",
"branch_digit": null,
"account": "9876543210",
"account_digit": null,
"account_type": "CHECKINGS",
"routing": "021000022",
"country": "US",
"currency": "USD"
}
},
"terms_of_service": {
"acceptance": true,
"date": "2025-07-21T20:43:54.786342Z",
"ip": "129.21.111.11"
},
"recipient": {
"id": "5a37f0c0-7689-4065-8348-4b5ff5bf9cc7",
"account_id": "c24d6c92-99a7-40bb-bc7b-efc40337f9f4",
"merchant_recipient_id": "MERCHANT_85ac5f5d-a169-46b3-bd87-80c0df2e6591",
"national_entity": "INDIVIDUAL",
"entity_type": "PRIVATE",
"first_name": "Stebann",
"last_name": "Castro",
"legal_name": "Steban Castro",
"email": "juan.perez@example.com",
"date_of_birth": "1992-01-21",
"country": "CO",
"website": "https://juanperez.com",
"industry": "Technology",
"merchant_category_code": "5740",
"document": {
"document_number": "09082160000100",
"document_type": "CNPJ"
},
"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": {
"number": "3109876543",
"country_code": "+57"
},
"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": "recipient.pdf",
"content_type": "application/pdf",
"content_category": "IDENTIFICATION_DOCUMENT",
"content": "recipient.pdf-2bf73b44-33e3-49c7-b777-34a5178cfb45"
}
],
"created_at": "2025-08-22T17:54:05.711545Z",
"updated_at": "2025-08-22T17:54:05.711561Z"
},
"created_at": "2025-08-22T17:57:58.460711Z",
"updated_at": "2025-08-22T17:57:58.460724Z"
},
"created_at": "2025-08-22T17:57:58.460711Z",
"updated_at": "2025-08-22T17:57:58.460724Z"
}
Creates an onboarding for a recipient.
This endpoint creates an onboarding for a recipient, enabling submerchants to be integrated with payment providers for split payment scenarios. Use this to register new submerchants or set up recipients before they can receive split payments.
Overview
Onboarding is the first step in the split payments marketplace workflow. Each recipient (submerchant) must be onboarded with payment providers before they can receive split payments. The onboarding process supports two flows:- Pre-onboarded accounts: For submerchants already registered with providers. Use
type: "PREVIOUSLY_ONBOARDED". - Dynamic onboarding: For new submerchant registration including KYC/KYB (Know Your Customer/Know Your Business) validation. Use
type: "ONE_STEP_ONBOARDING"ortype: "TWO_STEP_ONBOARDING"(previouslytype: "ONBOARD_ONTO_PROVIDER").
Two-Step OnboardingFor
type: "TWO_STEP_ONBOARDING" flows, use the Continue Onboarding endpoint to complete the KYC process after account creation.Authorizations
Path Parameters
ID of the new recipient to whom the onboarding will be transferred
Body
application/json
Unique id of the account in Yuno
Example:
"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
Available options:
PREVIOUSLY_ONBOARDED, ONE_STEP_ONBOARDING, TWO_STEP_ONBOARDING Example:
"PREVIOUSLY_ONBOARDED"
Workflow of the onboarding
Available options:
HOSTED_BY_PROVIDER, DIRECT Example:
"HOSTED_BY_PROVIDER"
Show child attributes
Show child attributes
Optional description of the onboarding (MAX 255; MIN 3).
Required string length:
3 - 255URL in case to redirect your customer after the onboarding process with the provider, if needed.
Example:
"https://www.google.com"
Specifies the documentation object.
Show child attributes
Show child attributes
Specifies the withdrawal methods object.
Show child attributes
Show child attributes
Object to indicate the owners of the organization. Adyen, Stripe and dlocal have fields related to that.
Show child attributes
Show child attributes
Object describing terms of service.
Show child attributes
Show child attributes
Response
Created
The unique identifier of the recipient.
Example:
"3aaa4d82-11e8-48ce-8ef5-04eee3a10802"
The account identifier associated with this recipient.
Example:
"fe14c7c6-c75e-43b7-bdbe-4c87ad52c482"
Unique identifier of the recipient defined by the merchant.
Example:
"MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6"
Beneficiary's national entity type.
Example:
"INDIVIDUAL"
Beneficiary's type of organization.
Example:
"PRIVATE"
Beneficiary's name.
Example:
"Juan"
Beneficiary's last name.
Example:
"Perez"
Beneficiary's legal name.
Example:
null
The Beneficiary's email.
Example:
"juan.perez@example.com"
Beneficiary's date of birth.
Example:
"1990-01-15"
The Beneficiary's country.
Example:
"CO"
The seller's website URL.
Example:
"https://juanperez.com"
The seller's industry.
Example:
"Technology"
The merchant category code (MCC) (MAX 235; MIN 1).
Example:
"5734"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Rules for automatic split calculation at the recipient level.
Show child attributes
Show child attributes
Recipient creation date (ISO 8601 MAX 27; MIN 27).
Example:
"2025-08-27T15:41:19.497413Z"
Last Recipient updated date (ISO 8601 MAX 27; MIN 27).
Example:
"2025-08-27T15:41:19.497425Z"
Was this page helpful?
Previous
Get OnboardingRetrieve the current status and details of a specific recipient onboarding
Next
⌘I
Create Onboarding
curl --request POST \
--url https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings \
--header 'Content-Type: application/json' \
--header 'private-secret-key: <api-key>' \
--header 'public-api-key: <api-key>' \
--data '
{
"account_id": "{{account-code}}",
"type": "PREVIOUSLY_ONBOARDED",
"workflow": "DIRECT",
"callback_url": "https://merchant.example.com/webhook/onboarding",
"provider": {
"id": "VR",
"connection_id": "d2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4",
"recipient_id": "test01",
"recipient_type": "MULTI_BENEFITS"
},
"documentation": [
{
"file_name": "onboarding.pdf",
"content_type": "application/pdf",
"content_category": "IDENTIFICATION_DOCUMENT",
"content": "VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA=="
}
],
"withdrawal_methods": {
"bank": {
"code": "002",
"branch": "002",
"account": "9876543210",
"account_type": "CHECKINGS",
"country": "US",
"currency": "USD",
"routing": "021000022"
}
},
"terms_of_service": {
"acceptance": true,
"date": "2025-07-21T20:43:54.786342Z",
"ip": "129.21.111.11"
}
}
'import requests
url = "https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings"
payload = {
"account_id": "{{account-code}}",
"type": "PREVIOUSLY_ONBOARDED",
"workflow": "DIRECT",
"callback_url": "https://merchant.example.com/webhook/onboarding",
"provider": {
"id": "VR",
"connection_id": "d2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4",
"recipient_id": "test01",
"recipient_type": "MULTI_BENEFITS"
},
"documentation": [
{
"file_name": "onboarding.pdf",
"content_type": "application/pdf",
"content_category": "IDENTIFICATION_DOCUMENT",
"content": "VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA=="
}
],
"withdrawal_methods": { "bank": {
"code": "002",
"branch": "002",
"account": "9876543210",
"account_type": "CHECKINGS",
"country": "US",
"currency": "USD",
"routing": "021000022"
} },
"terms_of_service": {
"acceptance": True,
"date": "2025-07-21T20:43:54.786342Z",
"ip": "129.21.111.11"
}
}
headers = {
"public-api-key": "<api-key>",
"private-secret-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'public-api-key': '<api-key>',
'private-secret-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
account_id: '{{account-code}}',
type: 'PREVIOUSLY_ONBOARDED',
workflow: 'DIRECT',
callback_url: 'https://merchant.example.com/webhook/onboarding',
provider: {
id: 'VR',
connection_id: 'd2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4',
recipient_id: 'test01',
recipient_type: 'MULTI_BENEFITS'
},
documentation: [
{
file_name: 'onboarding.pdf',
content_type: 'application/pdf',
content_category: 'IDENTIFICATION_DOCUMENT',
content: 'VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA=='
}
],
withdrawal_methods: {
bank: {
code: '002',
branch: '002',
account: '9876543210',
account_type: 'CHECKINGS',
country: 'US',
currency: 'USD',
routing: '021000022'
}
},
terms_of_service: {acceptance: true, date: '2025-07-21T20:43:54.786342Z', ip: '129.21.111.11'}
})
};
fetch('https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'account_id' => '{{account-code}}',
'type' => 'PREVIOUSLY_ONBOARDED',
'workflow' => 'DIRECT',
'callback_url' => 'https://merchant.example.com/webhook/onboarding',
'provider' => [
'id' => 'VR',
'connection_id' => 'd2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4',
'recipient_id' => 'test01',
'recipient_type' => 'MULTI_BENEFITS'
],
'documentation' => [
[
'file_name' => 'onboarding.pdf',
'content_type' => 'application/pdf',
'content_category' => 'IDENTIFICATION_DOCUMENT',
'content' => 'VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA=='
]
],
'withdrawal_methods' => [
'bank' => [
'code' => '002',
'branch' => '002',
'account' => '9876543210',
'account_type' => 'CHECKINGS',
'country' => 'US',
'currency' => 'USD',
'routing' => '021000022'
]
],
'terms_of_service' => [
'acceptance' => true,
'date' => '2025-07-21T20:43:54.786342Z',
'ip' => '129.21.111.11'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"private-secret-key: <api-key>",
"public-api-key: <api-key>"
],
]);
$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"
payload := strings.NewReader("{\n \"account_id\": \"{{account-code}}\",\n \"type\": \"PREVIOUSLY_ONBOARDED\",\n \"workflow\": \"DIRECT\",\n \"callback_url\": \"https://merchant.example.com/webhook/onboarding\",\n \"provider\": {\n \"id\": \"VR\",\n \"connection_id\": \"d2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4\",\n \"recipient_id\": \"test01\",\n \"recipient_type\": \"MULTI_BENEFITS\"\n },\n \"documentation\": [\n {\n \"file_name\": \"onboarding.pdf\",\n \"content_type\": \"application/pdf\",\n \"content_category\": \"IDENTIFICATION_DOCUMENT\",\n \"content\": \"VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA==\"\n }\n ],\n \"withdrawal_methods\": {\n \"bank\": {\n \"code\": \"002\",\n \"branch\": \"002\",\n \"account\": \"9876543210\",\n \"account_type\": \"CHECKINGS\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"routing\": \"021000022\"\n }\n },\n \"terms_of_service\": {\n \"acceptance\": true,\n \"date\": \"2025-07-21T20:43:54.786342Z\",\n \"ip\": \"129.21.111.11\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("public-api-key", "<api-key>")
req.Header.Add("private-secret-key", "<api-key>")
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.post("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings")
.header("public-api-key", "<api-key>")
.header("private-secret-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"{{account-code}}\",\n \"type\": \"PREVIOUSLY_ONBOARDED\",\n \"workflow\": \"DIRECT\",\n \"callback_url\": \"https://merchant.example.com/webhook/onboarding\",\n \"provider\": {\n \"id\": \"VR\",\n \"connection_id\": \"d2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4\",\n \"recipient_id\": \"test01\",\n \"recipient_type\": \"MULTI_BENEFITS\"\n },\n \"documentation\": [\n {\n \"file_name\": \"onboarding.pdf\",\n \"content_type\": \"application/pdf\",\n \"content_category\": \"IDENTIFICATION_DOCUMENT\",\n \"content\": \"VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA==\"\n }\n ],\n \"withdrawal_methods\": {\n \"bank\": {\n \"code\": \"002\",\n \"branch\": \"002\",\n \"account\": \"9876543210\",\n \"account_type\": \"CHECKINGS\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"routing\": \"021000022\"\n }\n },\n \"terms_of_service\": {\n \"acceptance\": true,\n \"date\": \"2025-07-21T20:43:54.786342Z\",\n \"ip\": \"129.21.111.11\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.y.uno/v1/recipients/{recipient_id}/onboardings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"{{account-code}}\",\n \"type\": \"PREVIOUSLY_ONBOARDED\",\n \"workflow\": \"DIRECT\",\n \"callback_url\": \"https://merchant.example.com/webhook/onboarding\",\n \"provider\": {\n \"id\": \"VR\",\n \"connection_id\": \"d2c1f0e9-8a90-432a-ab7c-fdee4c7d58e4\",\n \"recipient_id\": \"test01\",\n \"recipient_type\": \"MULTI_BENEFITS\"\n },\n \"documentation\": [\n {\n \"file_name\": \"onboarding.pdf\",\n \"content_type\": \"application/pdf\",\n \"content_category\": \"IDENTIFICATION_DOCUMENT\",\n \"content\": \"VGV4dG8gZGUgZWplbXBsbyBwYXJhIEJhc2U2NA==\"\n }\n ],\n \"withdrawal_methods\": {\n \"bank\": {\n \"code\": \"002\",\n \"branch\": \"002\",\n \"account\": \"9876543210\",\n \"account_type\": \"CHECKINGS\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"routing\": \"021000022\"\n }\n },\n \"terms_of_service\": {\n \"acceptance\": true,\n \"date\": \"2025-07-21T20:43:54.786342Z\",\n \"ip\": \"129.21.111.11\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "61df26d9-3750-4206-baab-f2e20683f35b",
"type": "PREVIOUSLY_ONBOARDED",
"workflow": "DIRECT",
"status": "SUCCEEDED",
"callback_url": "https://merchant.example.com/webhook/onboarding",
"provider": {
"id": "STRIPE",
"connection_id": "8fee3cc6-f3cb-455d-b139-973866111a03",
"recipient_id": "acct_1RvpogA4Jk50vKRE",
"redirect_url": null,
"onboarding_url": null,
"legal_entity": null
},
"documentation": [
{
"file_name": "recipient.pdf",
"content_type": "application/pdf",
"content_category": "IDENTIFICATION_DOCUMENT",
"content": "recipient.pdf-20ac42c2-ef01-4a0c-80dd-0f9f71c9cde7"
}
],
"legal_representatives": [
{
"merchant_reference": "ONB_001",
"first_name": "Tatiana",
"last_name": "González",
"email": "tatiana.gonzalez@example.com",
"date_of_birth": "1985-05-20",
"country": "BR",
"nationality": "BR",
"title": "CEO",
"publicly_exposed_person": false,
"ultimate_beneficial_owner": true,
"document": {
"document_type": "CC",
"document_number": "0987654321"
},
"phone": {
"number": "3109876543",
"country_code": "+57"
},
"address": {
"address_line_1": "Calle 26 # 13-19",
"address_line_2": null,
"country": "CO",
"state": "Cundinamarca",
"city": "Bogotá",
"zip_code": "110311"
}
}
],
"requirements": [],
"withdrawal_methods": {
"bank": {
"code": "003",
"branch": "003",
"branch_digit": null,
"account": "9876543210",
"account_digit": null,
"account_type": "CHECKINGS",
"routing": "021000022",
"country": "US",
"currency": "USD"
}
},
"terms_of_service": {
"acceptance": true,
"date": "2025-07-21T20:43:54.786342Z",
"ip": "129.21.111.11"
},
"recipient": {
"id": "5a37f0c0-7689-4065-8348-4b5ff5bf9cc7",
"account_id": "c24d6c92-99a7-40bb-bc7b-efc40337f9f4",
"merchant_recipient_id": "MERCHANT_85ac5f5d-a169-46b3-bd87-80c0df2e6591",
"national_entity": "INDIVIDUAL",
"entity_type": "PRIVATE",
"first_name": "Stebann",
"last_name": "Castro",
"legal_name": "Steban Castro",
"email": "juan.perez@example.com",
"date_of_birth": "1992-01-21",
"country": "CO",
"website": "https://juanperez.com",
"industry": "Technology",
"merchant_category_code": "5740",
"document": {
"document_number": "09082160000100",
"document_type": "CNPJ"
},
"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": {
"number": "3109876543",
"country_code": "+57"
},
"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": "recipient.pdf",
"content_type": "application/pdf",
"content_category": "IDENTIFICATION_DOCUMENT",
"content": "recipient.pdf-2bf73b44-33e3-49c7-b777-34a5178cfb45"
}
],
"created_at": "2025-08-22T17:54:05.711545Z",
"updated_at": "2025-08-22T17:54:05.711561Z"
},
"history": {
"id": "61df26d9-3750-4206-baab-f2e20683f35b",
"type": "PREVIOUSLY_ONBOARDED",
"workflow": "DIRECT",
"status": "SUCCEEDED",
"callback_url": "https://merchant.example.com/webhook/onboarding",
"provider": {
"id": "STRIPE",
"connection_id": "8fee3cc6-f3cb-455d-b139-973866111a03",
"recipient_id": "acct_1RvpogA4Jk50vKRE",
"redirect_url": null
},
"documentation": [
{
"file_name": "recipient.pdf",
"content_type": "application/pdf",
"content_category": "IDENTIFICATION_DOCUMENT",
"content": "recipient.pdf-20ac42c2-ef01-4a0c-80dd-0f9f71c9cde7"
}
],
"legal_representatives": [
{
"merchant_reference": "ONB_001",
"first_name": "Tatiana",
"last_name": "González",
"email": "tatiana.gonzalez@example.com",
"date_of_birth": "1985-05-20",
"country": "BR",
"nationality": "BR",
"title": "CEO",
"publicly_exposed_person": false,
"ultimate_beneficial_owner": true,
"document": {
"document_type": "CC",
"document_number": "0987654321"
},
"phone": {
"number": "3109876543",
"country_code": "+57"
},
"address": {
"address_line_1": "Calle 26 # 13-19",
"address_line_2": null,
"country": "CO",
"state": "Cundinamarca",
"city": "Bogotá",
"zip_code": "110311"
}
}
],
"requirements": [],
"withdrawal_methods": {
"bank": {
"code": "003",
"branch": "003",
"branch_digit": null,
"account": "9876543210",
"account_digit": null,
"account_type": "CHECKINGS",
"routing": "021000022",
"country": "US",
"currency": "USD"
}
},
"terms_of_service": {
"acceptance": true,
"date": "2025-07-21T20:43:54.786342Z",
"ip": "129.21.111.11"
},
"recipient": {
"id": "5a37f0c0-7689-4065-8348-4b5ff5bf9cc7",
"account_id": "c24d6c92-99a7-40bb-bc7b-efc40337f9f4",
"merchant_recipient_id": "MERCHANT_85ac5f5d-a169-46b3-bd87-80c0df2e6591",
"national_entity": "INDIVIDUAL",
"entity_type": "PRIVATE",
"first_name": "Stebann",
"last_name": "Castro",
"legal_name": "Steban Castro",
"email": "juan.perez@example.com",
"date_of_birth": "1992-01-21",
"country": "CO",
"website": "https://juanperez.com",
"industry": "Technology",
"merchant_category_code": "5740",
"document": {
"document_number": "09082160000100",
"document_type": "CNPJ"
},
"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": {
"number": "3109876543",
"country_code": "+57"
},
"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": "recipient.pdf",
"content_type": "application/pdf",
"content_category": "IDENTIFICATION_DOCUMENT",
"content": "recipient.pdf-2bf73b44-33e3-49c7-b777-34a5178cfb45"
}
],
"created_at": "2025-08-22T17:54:05.711545Z",
"updated_at": "2025-08-22T17:54:05.711561Z"
},
"created_at": "2025-08-22T17:57:58.460711Z",
"updated_at": "2025-08-22T17:57:58.460724Z"
},
"created_at": "2025-08-22T17:57:58.460711Z",
"updated_at": "2025-08-22T17:57:58.460724Z"
}