Entities (Banking Connectivity)
Update Entity (Banking Connectivity)
Update the details of an existing individual or business entity
PATCH
/
banking
/
entities
/
{entity_id}
Update Entity (Banking Connectivity)
curl --request PATCH \
--url https://api-sandbox.y.uno/v1/banking/entities/{entity_id} \
--header 'Content-Type: application/json' \
--header 'private-secret-key: <api-key>' \
--header 'public-api-key: <api-key>' \
--data '
{
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"phone": {
"country_code": "+1",
"number": "2025559999"
},
"address": {
"address_line_1": "456 Oak Ave",
"address_line_2": "Suite 100",
"building_number_1": "456",
"building_number_2": null,
"city": "San Francisco",
"state": "CA",
"zip_code": "94105",
"country": "US"
},
"entity_detail": {
"individual": {
"email": "john.new@example.com"
}
}
}
'import requests
url = "https://api-sandbox.y.uno/v1/banking/entities/{entity_id}"
payload = {
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"phone": {
"country_code": "+1",
"number": "2025559999"
},
"address": {
"address_line_1": "456 Oak Ave",
"address_line_2": "Suite 100",
"building_number_1": "456",
"building_number_2": None,
"city": "San Francisco",
"state": "CA",
"zip_code": "94105",
"country": "US"
},
"entity_detail": { "individual": { "email": "john.new@example.com" } }
}
headers = {
"public-api-key": "<api-key>",
"private-secret-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'public-api-key': '<api-key>',
'private-secret-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
account_id: '550e8400-e29b-41d4-a716-446655440000',
phone: {country_code: '+1', number: '2025559999'},
address: {
address_line_1: '456 Oak Ave',
address_line_2: 'Suite 100',
building_number_1: '456',
building_number_2: null,
city: 'San Francisco',
state: 'CA',
zip_code: '94105',
country: 'US'
},
entity_detail: {individual: {email: 'john.new@example.com'}}
})
};
fetch('https://api-sandbox.y.uno/v1/banking/entities/{entity_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/banking/entities/{entity_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([
'account_id' => '550e8400-e29b-41d4-a716-446655440000',
'phone' => [
'country_code' => '+1',
'number' => '2025559999'
],
'address' => [
'address_line_1' => '456 Oak Ave',
'address_line_2' => 'Suite 100',
'building_number_1' => '456',
'building_number_2' => null,
'city' => 'San Francisco',
'state' => 'CA',
'zip_code' => '94105',
'country' => 'US'
],
'entity_detail' => [
'individual' => [
'email' => 'john.new@example.com'
]
]
]),
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/banking/entities/{entity_id}"
payload := strings.NewReader("{\n \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"phone\": {\n \"country_code\": \"+1\",\n \"number\": \"2025559999\"\n },\n \"address\": {\n \"address_line_1\": \"456 Oak Ave\",\n \"address_line_2\": \"Suite 100\",\n \"building_number_1\": \"456\",\n \"building_number_2\": null,\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip_code\": \"94105\",\n \"country\": \"US\"\n },\n \"entity_detail\": {\n \"individual\": {\n \"email\": \"john.new@example.com\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api-sandbox.y.uno/v1/banking/entities/{entity_id}")
.header("public-api-key", "<api-key>")
.header("private-secret-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"phone\": {\n \"country_code\": \"+1\",\n \"number\": \"2025559999\"\n },\n \"address\": {\n \"address_line_1\": \"456 Oak Ave\",\n \"address_line_2\": \"Suite 100\",\n \"building_number_1\": \"456\",\n \"building_number_2\": null,\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip_code\": \"94105\",\n \"country\": \"US\"\n },\n \"entity_detail\": {\n \"individual\": {\n \"email\": \"john.new@example.com\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.y.uno/v1/banking/entities/{entity_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"phone\": {\n \"country_code\": \"+1\",\n \"number\": \"2025559999\"\n },\n \"address\": {\n \"address_line_1\": \"456 Oak Ave\",\n \"address_line_2\": \"Suite 100\",\n \"building_number_1\": \"456\",\n \"building_number_2\": null,\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip_code\": \"94105\",\n \"country\": \"US\"\n },\n \"entity_detail\": {\n \"individual\": {\n \"email\": \"john.new@example.com\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "ent_660e8400-e29b-41d4-a716-446655440000",
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"merchant_entity_id": "merchant_user_12345",
"national_entity": "INDIVIDUAL",
"phone": {
"country_code": "+1",
"number": "2025559999"
},
"address": {
"address_line_1": "456 Oak Ave",
"address_line_2": "Suite 100",
"building_number_1": "456",
"building_number_2": null,
"city": "San Francisco",
"state": "CA",
"zip_code": "94105",
"country": "US"
},
"entity_detail": {
"individual": {
"first_name": "John",
"last_name": "Doe",
"email": "john.new@example.com",
"date_of_birth": "1990-01-15",
"gender": "M",
"country_of_residence": "US",
"tax_information": [
{
"country": "US",
"tax_id_last_4": "6789",
"tax_id_type": "SSN",
"is_primary": true
}
],
"document": {
"document_type": "SSN",
"document_number_last_4": "6789",
"issuing_country": "US",
"issued_at": "2010-01-15",
"expires_at": "2030-01-15"
}
},
"entity": null
},
"created_at": "2026-02-01T10:00:00Z",
"updated_at": "2026-02-01T12:00:00Z"
}{
"code": "VALIDATION_ERROR",
"messages": [
"national_entity type cannot be changed after creation"
],
"http_code": 400
}{
"code": "ENTITY_NOT_FOUND",
"messages": [
"Entity not found"
],
"http_code": 404
}Update an existing entity’s information. Only include the fields you want to change. The
national_entity type cannot be changed after creation.Path Parameters
The id of the entity obtained from Create Entity.
Body
application/json
The unique identifier of the merchant's Yuno account (UUID, 36 characters).
Example:
"550e8400-e29b-41d4-a716-446655440000"
The merchant's own identifier for this entity.
Example:
"merchant_user_12345"
Updated phone number.
Show child attributes
Show child attributes
Updated address. Only include fields that need to change.
Show child attributes
Show child attributes
Updated entity details. Only include fields that need to change.
Show child attributes
Show child attributes
Response
OK
The unique identifier of the entity (prefixed ent_).
Example:
"ent_660e8400-e29b-41d4-a716-446655440000"
The merchant's Yuno account identifier.
Example:
"550e8400-e29b-41d4-a716-446655440000"
The merchant's own identifier for this entity.
Example:
"merchant_user_12345"
The type of entity.
Available options:
INDIVIDUAL, ENTITY Example:
"INDIVIDUAL"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The timestamp when the entity was created (ISO 8601).
Example:
"2026-02-01T10:00:00Z"
The timestamp when the entity was last updated (ISO 8601).
Example:
"2026-02-01T12:00:00Z"
Was this page helpful?
Previous
Create Entity Onboarding (Banking Connectivity)Onboard an existing entity with a banking connectivity provider using KYC or KYB documentation
Next
⌘I
Update Entity (Banking Connectivity)
curl --request PATCH \
--url https://api-sandbox.y.uno/v1/banking/entities/{entity_id} \
--header 'Content-Type: application/json' \
--header 'private-secret-key: <api-key>' \
--header 'public-api-key: <api-key>' \
--data '
{
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"phone": {
"country_code": "+1",
"number": "2025559999"
},
"address": {
"address_line_1": "456 Oak Ave",
"address_line_2": "Suite 100",
"building_number_1": "456",
"building_number_2": null,
"city": "San Francisco",
"state": "CA",
"zip_code": "94105",
"country": "US"
},
"entity_detail": {
"individual": {
"email": "john.new@example.com"
}
}
}
'import requests
url = "https://api-sandbox.y.uno/v1/banking/entities/{entity_id}"
payload = {
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"phone": {
"country_code": "+1",
"number": "2025559999"
},
"address": {
"address_line_1": "456 Oak Ave",
"address_line_2": "Suite 100",
"building_number_1": "456",
"building_number_2": None,
"city": "San Francisco",
"state": "CA",
"zip_code": "94105",
"country": "US"
},
"entity_detail": { "individual": { "email": "john.new@example.com" } }
}
headers = {
"public-api-key": "<api-key>",
"private-secret-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'public-api-key': '<api-key>',
'private-secret-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
account_id: '550e8400-e29b-41d4-a716-446655440000',
phone: {country_code: '+1', number: '2025559999'},
address: {
address_line_1: '456 Oak Ave',
address_line_2: 'Suite 100',
building_number_1: '456',
building_number_2: null,
city: 'San Francisco',
state: 'CA',
zip_code: '94105',
country: 'US'
},
entity_detail: {individual: {email: 'john.new@example.com'}}
})
};
fetch('https://api-sandbox.y.uno/v1/banking/entities/{entity_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/banking/entities/{entity_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([
'account_id' => '550e8400-e29b-41d4-a716-446655440000',
'phone' => [
'country_code' => '+1',
'number' => '2025559999'
],
'address' => [
'address_line_1' => '456 Oak Ave',
'address_line_2' => 'Suite 100',
'building_number_1' => '456',
'building_number_2' => null,
'city' => 'San Francisco',
'state' => 'CA',
'zip_code' => '94105',
'country' => 'US'
],
'entity_detail' => [
'individual' => [
'email' => 'john.new@example.com'
]
]
]),
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/banking/entities/{entity_id}"
payload := strings.NewReader("{\n \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"phone\": {\n \"country_code\": \"+1\",\n \"number\": \"2025559999\"\n },\n \"address\": {\n \"address_line_1\": \"456 Oak Ave\",\n \"address_line_2\": \"Suite 100\",\n \"building_number_1\": \"456\",\n \"building_number_2\": null,\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip_code\": \"94105\",\n \"country\": \"US\"\n },\n \"entity_detail\": {\n \"individual\": {\n \"email\": \"john.new@example.com\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api-sandbox.y.uno/v1/banking/entities/{entity_id}")
.header("public-api-key", "<api-key>")
.header("private-secret-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"phone\": {\n \"country_code\": \"+1\",\n \"number\": \"2025559999\"\n },\n \"address\": {\n \"address_line_1\": \"456 Oak Ave\",\n \"address_line_2\": \"Suite 100\",\n \"building_number_1\": \"456\",\n \"building_number_2\": null,\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip_code\": \"94105\",\n \"country\": \"US\"\n },\n \"entity_detail\": {\n \"individual\": {\n \"email\": \"john.new@example.com\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.y.uno/v1/banking/entities/{entity_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"phone\": {\n \"country_code\": \"+1\",\n \"number\": \"2025559999\"\n },\n \"address\": {\n \"address_line_1\": \"456 Oak Ave\",\n \"address_line_2\": \"Suite 100\",\n \"building_number_1\": \"456\",\n \"building_number_2\": null,\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip_code\": \"94105\",\n \"country\": \"US\"\n },\n \"entity_detail\": {\n \"individual\": {\n \"email\": \"john.new@example.com\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "ent_660e8400-e29b-41d4-a716-446655440000",
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"merchant_entity_id": "merchant_user_12345",
"national_entity": "INDIVIDUAL",
"phone": {
"country_code": "+1",
"number": "2025559999"
},
"address": {
"address_line_1": "456 Oak Ave",
"address_line_2": "Suite 100",
"building_number_1": "456",
"building_number_2": null,
"city": "San Francisco",
"state": "CA",
"zip_code": "94105",
"country": "US"
},
"entity_detail": {
"individual": {
"first_name": "John",
"last_name": "Doe",
"email": "john.new@example.com",
"date_of_birth": "1990-01-15",
"gender": "M",
"country_of_residence": "US",
"tax_information": [
{
"country": "US",
"tax_id_last_4": "6789",
"tax_id_type": "SSN",
"is_primary": true
}
],
"document": {
"document_type": "SSN",
"document_number_last_4": "6789",
"issuing_country": "US",
"issued_at": "2010-01-15",
"expires_at": "2030-01-15"
}
},
"entity": null
},
"created_at": "2026-02-01T10:00:00Z",
"updated_at": "2026-02-01T12:00:00Z"
}{
"code": "VALIDATION_ERROR",
"messages": [
"national_entity type cannot be changed after creation"
],
"http_code": 400
}{
"code": "ENTITY_NOT_FOUND",
"messages": [
"Entity not found"
],
"http_code": 404
}