PUT
/
v1
/
businesses
/
{businessId}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type
string

Content-Type must be set to application/json

Path Parameters

businessId
string
required

The UUID of the business to update

Body

application/json
activationAt
string | null
archivedAt
string | null
country
enum<string>

Which country the business is incorporated in.

Available options:
AF,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
KH,
CM,
CA,
CV,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CD,
CK,
CR,
CI,
HR,
CU,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IL,
IT,
JM,
JP,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MK,
MG,
MW,
MY,
MV,
ML,
MT,
ME,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RS,
RW,
SH,
KN,
LC,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
SC,
SL,
SG,
SK,
SI,
SB,
SO,
ZA,
GS,
ES,
LK,
SD,
SR,
SJ,
SZ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
US,
UM,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW
entityType
enum<string>

Type of the business.

Available options:
SOLE_PROP,
C_CORP,
LLC,
S_CORP,
PARTNERSHIP
internalBankAccountIds
object[] | null
phoneNumber
string | null
plaidItems
object[] | null
smsCategorizationStartDate
string | null
smsEnabled
boolean | null
stripeConnectAccounts
object[] | null
tin
string | null
unitIds
object[] | null
usState
enum<string>

Which United States state the business is incorporated in.

Available options:
ALABAMA,
ALASKA,
ARIZONA,
ARKANSAS,
CALIFORNIA,
COLORADO,
CONNECTICUT,
DELAWARE,
DISTRICT_OF_COLUMBIA,
FLORIDA,
GEORGIA,
HAWAII,
IDAHO,
ILLINOIS,
INDIANA,
IOWA,
KANSAS,
KENTUCKY,
LOUISIANA,
MAINE,
MARYLAND,
MASSACHUSETTS,
MICHIGAN,
MINNESOTA,
MISSISSIPPI,
MISSOURI,
MONTANA,
NEBRASKA,
NEVADA,
NEW_HAMPSHIRE,
NEW_JERSEY,
NEW_MEXICO,
NEW_YORK,
NORTH_CAROLINA,
NORTH_DAKOTA,
OHIO,
OKLAHOMA,
OREGON,
PENNSYLVANIA,
RHODE_ISLAND,
SOUTH_CAROLINA,
SOUTH_DAKOTA,
TENNESSEE,
TEXAS,
UTAH,
VERMONT,
VIRGINIA,
WASHINGTON,
WEST_VIRGINIA,
WISCONSIN,
WYOMING,
PUERTO_RICO

Response

200 - application/json
country
enum<string>

2 letter ISO country code representing the country this business is incorporated in. Defaults to US.

Available options:
AF,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
KH,
CM,
CA,
CV,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CD,
CK,
CR,
CI,
HR,
CU,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IL,
IT,
JM,
JP,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MK,
MG,
MW,
MY,
MV,
ML,
MT,
ME,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RS,
RW,
SH,
KN,
LC,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
SC,
SL,
SG,
SK,
SI,
SB,
SO,
ZA,
GS,
ES,
LK,
SD,
SR,
SJ,
SZ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
US,
UM,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW
entityType
enum<string>

Entity type of the business. Used to determine tax filing status.

Available options:
SOLE_PROP,
C_CORP,
LLC,
S_CORP,
PARTNERSHIP
externalId
string

Unique ID of the business in your system for linking purposes. Idempotency key.

id
string

Unique identifier for the business.

importedAt
string

Time when the business entity was created in Layer. Eligible sort key.

Legal name of the business as it has been registered.

naicsCode
string

6-digit NAICS code used to identify the business’s industry.

phoneNumber
string

Phone number used for SMS based categorization.

plaidItems
object[]

Plaid items linked to this account.

plaidProcessorTokens
object[]

Plaid processor tokens linked to this account

sms_enabled
boolean

Whether SMS is enabled for this business

sms_stopped
boolean

Whether this business has responded to Layer's SMS with "STOP"

tin
string | null
type
string

Resource type. Value will be “Business”.

unitAccounts
object[]

List of unit accounts associated with this business.

updatedAt
string

Time when the business’s information was last updated in Layer. Eligible sort key.

usState
enum<string>

The state this business is incorporated in

Available options:
ALABAMA,
ALASKA,
ARIZONA,
ARKANSAS,
CALIFORNIA,
COLORADO,
CONNECTICUT,
DELAWARE,
DISTRICT_OF_COLUMBIA,
FLORIDA,
GEORGIA,
HAWAII,
IDAHO,
ILLINOIS,
INDIANA,
IOWA,
KANSAS,
KENTUCKY,
LOUISIANA,
MAINE,
MARYLAND,
MASSACHUSETTS,
MICHIGAN,
MINNESOTA,
MISSISSIPPI,
MISSOURI,
MONTANA,
NEBRASKA,
NEVADA,
NEW_HAMPSHIRE,
NEW_JERSEY,
NEW_MEXICO,
NEW_YORK,
NORTH_CAROLINA,
NORTH_DAKOTA,
OHIO,
OKLAHOMA,
OREGON,
PENNSYLVANIA,
RHODE_ISLAND,
SOUTH_CAROLINA,
SOUTH_DAKOTA,
TENNESSEE,
TEXAS,
UTAH,
VERMONT,
VIRGINIA,
WASHINGTON,
WEST_VIRGINIA,
WISCONSIN,
WYOMING,
PUERTO_RICO