Update an entity
curl --request PATCH \
--url https://api.plane.com/v1/entities/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"country": "<string>",
"address": {},
"dba": "<string>",
"description": "<string>",
"email": "<string>",
"phone": "<string>",
"website": "<string>",
"structure": "<string>",
"formation": {},
"tax_id": {},
"metadata": {}
}
'import requests
url = "https://api.plane.com/v1/entities/{id}"
payload = {
"name": "<string>",
"country": "<string>",
"address": {},
"dba": "<string>",
"description": "<string>",
"email": "<string>",
"phone": "<string>",
"website": "<string>",
"structure": "<string>",
"formation": {},
"tax_id": {},
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
country: '<string>',
address: {},
dba: '<string>',
description: '<string>',
email: '<string>',
phone: '<string>',
website: '<string>',
structure: '<string>',
formation: {},
tax_id: {},
metadata: {}
})
};
fetch('https://api.plane.com/v1/entities/{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.plane.com/v1/entities/{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([
'name' => '<string>',
'country' => '<string>',
'address' => [
],
'dba' => '<string>',
'description' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'website' => '<string>',
'structure' => '<string>',
'formation' => [
],
'tax_id' => [
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.plane.com/v1/entities/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"address\": {},\n \"dba\": \"<string>\",\n \"description\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"structure\": \"<string>\",\n \"formation\": {},\n \"tax_id\": {},\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.plane.com/v1/entities/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"address\": {},\n \"dba\": \"<string>\",\n \"description\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"structure\": \"<string>\",\n \"formation\": {},\n \"tax_id\": {},\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/entities/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"address\": {},\n \"dba\": \"<string>\",\n \"description\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"structure\": \"<string>\",\n \"formation\": {},\n \"tax_id\": {},\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "ent_kP9r2NqW6mT4s1Bc",
"object": "entity",
"name": "Acme Labs LLC",
"country": "US",
"address": {
"line1": "548 Market Street",
"line2": null,
"city": "San Francisco",
"state": "CA",
"postal_code": "94104",
"country": "US"
},
"status": "unverified",
"dba": "Acme Labs",
"description": null,
"email": "labs@acmecorp.com",
"phone": null,
"website": null,
"structure": "llc",
"formation": {
"country": "US",
"state": "DE",
"date": "2025-11-03"
},
"metadata": {},
"created": "2026-05-27T12:00:00Z",
"updated": "2026-05-28T09:30:00Z"
}
Entities
Update an entity
Update the business details of an existing legal entity.
PATCH
/
v1
/
entities
/
{id}
Update an entity
curl --request PATCH \
--url https://api.plane.com/v1/entities/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"country": "<string>",
"address": {},
"dba": "<string>",
"description": "<string>",
"email": "<string>",
"phone": "<string>",
"website": "<string>",
"structure": "<string>",
"formation": {},
"tax_id": {},
"metadata": {}
}
'import requests
url = "https://api.plane.com/v1/entities/{id}"
payload = {
"name": "<string>",
"country": "<string>",
"address": {},
"dba": "<string>",
"description": "<string>",
"email": "<string>",
"phone": "<string>",
"website": "<string>",
"structure": "<string>",
"formation": {},
"tax_id": {},
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
country: '<string>',
address: {},
dba: '<string>',
description: '<string>',
email: '<string>',
phone: '<string>',
website: '<string>',
structure: '<string>',
formation: {},
tax_id: {},
metadata: {}
})
};
fetch('https://api.plane.com/v1/entities/{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.plane.com/v1/entities/{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([
'name' => '<string>',
'country' => '<string>',
'address' => [
],
'dba' => '<string>',
'description' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'website' => '<string>',
'structure' => '<string>',
'formation' => [
],
'tax_id' => [
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.plane.com/v1/entities/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"address\": {},\n \"dba\": \"<string>\",\n \"description\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"structure\": \"<string>\",\n \"formation\": {},\n \"tax_id\": {},\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.plane.com/v1/entities/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"address\": {},\n \"dba\": \"<string>\",\n \"description\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"structure\": \"<string>\",\n \"formation\": {},\n \"tax_id\": {},\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/entities/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"address\": {},\n \"dba\": \"<string>\",\n \"description\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"structure\": \"<string>\",\n \"formation\": {},\n \"tax_id\": {},\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "ent_kP9r2NqW6mT4s1Bc",
"object": "entity",
"name": "Acme Labs LLC",
"country": "US",
"address": {
"line1": "548 Market Street",
"line2": null,
"city": "San Francisco",
"state": "CA",
"postal_code": "94104",
"country": "US"
},
"status": "unverified",
"dba": "Acme Labs",
"description": null,
"email": "labs@acmecorp.com",
"phone": null,
"website": null,
"structure": "llc",
"formation": {
"country": "US",
"state": "DE",
"date": "2025-11-03"
},
"metadata": {},
"created": "2026-05-27T12:00:00Z",
"updated": "2026-05-28T09:30:00Z"
}
Use this endpoint to complete or correct an entity’s business details before
they are submitted for verification. Once an entity’s details have been
submitted, only the contact details (
phone, website, description) and
the business address remain updatable; the other fields are locked. Contact
Plane support to change a verified entity’s legal details.
Parameters
string
required
The ID of the entity to update.
string
The legal name of the entity as registered with government authorities.
string
Two-letter ISO country code (ISO 3166-1 alpha-2) where the entity is legally domiciled.
object
The primary business address of the entity.
Show child attributes
Show child attributes
string
required
Address line1 (e.g. street or company name).
string
Address line2 (e.g. apartment, suite, unit or building). Pass
null to clear it.string
required
City, district, suburb, town, or village.
string
required
State, county, province, or region.
string
required
ZIP or postal code.
string
required
Two-letter country code (ISO 3166-1 alpha-2).
string
“Doing Business As” name - the trade name used by the entity if different from the legal name.
string
A brief description of the entity’s business activities or purpose.
string
Primary contact email address for the entity.
string
Primary contact phone number for the entity.
string
The entity’s primary website URL.
string
The legal structure of the entity. Allowed values are
corporation, llc, or partnership.object
object
object
Arbitrary key-value data to attach to the entity.
Returns
Returns the updated Entity object.{
"id": "ent_kP9r2NqW6mT4s1Bc",
"object": "entity",
"name": "Acme Labs LLC",
"country": "US",
"address": {
"line1": "548 Market Street",
"line2": null,
"city": "San Francisco",
"state": "CA",
"postal_code": "94104",
"country": "US"
},
"status": "unverified",
"dba": "Acme Labs",
"description": null,
"email": "labs@acmecorp.com",
"phone": null,
"website": null,
"structure": "llc",
"formation": {
"country": "US",
"state": "DE",
"date": "2025-11-03"
},
"metadata": {},
"created": "2026-05-27T12:00:00Z",
"updated": "2026-05-28T09:30:00Z"
}
Was this page helpful?
⌘I