Edit Entity

Use /entity/:id (PATCH) to update an existing entity's information. You can update the entity's name, contact information, address, and entity-specific details.


📘 Note: Beneficial owners cannot be modified through this endpoint. Use the dedicated beneficial owner endpoints to manage ownership information.


Editable Fields:

  • entityName - The legal name of the entity/business
  • email - The entity's email address
  • phoneNumber - The entity's phone number
  • address - The entity's physical address
  • clientUserId - Your internal identifier for the entity
  • locale - The entity's locale preference
  • entityDetails - Additional entity information (website, categories, legal structure, etc.)

Things to Note:

  • The entity's EIN/ID number cannot be changed after creation.
  • Beneficial owners are managed through separate endpoints.
  • Changes are tracked in the change history for audit purposes.
Path Params
string
required

Pass in the Spidr entity ID

Body Params

PATCH /v1/entity/:id Request body

string | null

Optional custom data stored by Spidr for the user. The value can contain up to 50 characters.

string
length between 1 and 255

The legal name of the entity

string
length between 3 and 63

The entity user's email address

string

The user's phone number. Prefer E.164 (+country code) for international numbers; national-format numbers are parsed with default region US.

address
object
string
enum

The entity user's language and localization preference

Allowed:
string

Unique ID that identifies the entity user in your system. This is your own ID for a given entity user if you also store/maintain entity information.

entityDetails
object

Additional details about the entity

string

The session key for the user. Created via Create ZTM Session and used for ZTM checks if your program is configured for ZTM.

boolean

Indicates whether to bypass the ZTM checks if your program is configured for ZTM.

boolean

When true and address is provided, also updates the shipping address on all active (non-archived, non-closed) accounts for this entity.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json