PUT
/
v1
/
businesses
/
{businessId}
/
archive

Authorizations

Authorization
string
headerrequired

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 archive

Response

200 - application/json
id
string

Unique identifier for the business.

type
string

Resource type. Value will be “Business”.

externalId
string

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

legalName
string

Legal name of the business as it has been registered.

entityType
enum<string>

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

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

Phone number used for SMS based categorization.

naicsCode
string

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

plaidItems
object[]

Plaid items linked to this account.

plaidProcessorTokens
object[]

Plaid processor tokens linked to this account

tin
string | null
importedAt
string

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

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
unitAccounts
object[]

List of unit accounts associated with this business.

sms_enabled
boolean

Whether SMS is enabled for this business

sms_stopped
boolean

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