Update a business's details

const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: JSON.stringify({ 'business.legal_name': 'Acme Corporation', 'business.domestic_legal_name': 'Acme Holdings LLC', 'business.dba_name': 'Acme Co', 'business.ein': '12-3456789', 'business.entity_type': 'llc', 'business.formation_date': '2020-05-15', 'business.formation_jurisdiction': 'US-DE', 'business.registration_jurisdiction': 'US-CA', 'business.registration_number': '0805123456', 'business.address_line_1': '123 Business Blvd', 'business.address_line_2': 'Suite 100', 'business.city': 'San Francisco', 'business.region': 'CA', 'business.postal_code': '94102', 'business.country': 'US', 'business.phone_number': '+15551234567', 'business.email': 'contact@acme.com', 'business.website': 'https://acme.com', 'business.naics_code': '541511' }) }; fetch('https://api.getpalm.com/v1/business/{business_id}/vault', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));

Authorizations

Authorization

string

header

required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Path Parameters

business_id

string<uuid>

required

Portfolio business ID

Example:

"987e6543-e21a-45b6-c789-012345678901"

Body

application/json

business.legal_name

string

Legal business name as registered with the Secretary of State

Example:

"Acme Corporation"

business.domestic_legal_name

string

Legal name of the business as registered in its domestic state. Set on a foreign registration whose name in this state may differ; it never changes once set.

Example:

"Acme Holdings LLC"

business.dba_name

string

Doing Business As (DBA) name

Example:

"Acme Co"

business.ein

string

Employer Identification Number (EIN) in format XX-XXXXXXX

Example:

"12-3456789"

business.entity_type

enum<string>

Type of business entity

Available options:

llc,

corporation,

lp,

llp,

nonprofit,

professional_llc,

professional_corporation,

other

Example:

"llc"

business.formation_date

string

Date the business was legally formed (YYYY-MM-DD)

Example:

"2020-05-15"

business.formation_jurisdiction

string

Jurisdiction where the business was originally formed (US-XX format)

Example:

"US-DE"

business.registration_jurisdiction

string

Jurisdiction where the business is registered to operate (US-XX format)

Example:

"US-CA"

business.registration_number

string

Registration or file number the registration jurisdiction assigned to the business. Written automatically when a Palm formation completes; set it yourself for a business Palm did not form.

Example:

"0805123456"

business.address_line_1

string

Business street address line 1

Example:

"123 Business Blvd"

business.address_line_2

string

Business street address line 2 (suite, floor, etc.)

Example:

"Suite 100"

business.city

string

Business city

Example:

"San Francisco"

business.region

string

Business state, province, or region code

Example:

"CA"

business.postal_code

string

Business postal or ZIP code

Example:

"94102"

business.country

string

Business country (ISO 3166-1 alpha-2 code)

Example:

"US"

business.phone_number

string

Business phone number (E.164 format recommended)

Example:

"+15551234567"

business.email

string

Business email address

Example:

"contact@acme.com"

business.website

string

Business website URL

Example:

"https://acme.com"

business.naics_code

string

NAICS code for business industry classification

Example:

"541511"

Response

The fields now set for the business

Every field now set, each mapped to true.

{key}

boolean

Palm Introduction

API Introduction

Endpoints

Update a business's details

Authorizations

Path Parameters

Body

Response