Archive Entity

Use /entity/:id/archiveEntity to archive an entity. An entity can only be archived if all their associated accounts are closed.


📘 Note: This action cannot be undone. If an entity is archived, they must reapply to open another account.


Things to Note:

  • All accounts associated with the entity must be closed before archiving.
  • Beneficial owners linked to the entity will retain their linkage records, but the entity will be marked as archived.
  • If the entity is enrolled in watchlist screening, the watchlist program will be set to dormant.
Path Params
string
required

Pass in the Spidr entity ID

Body Params

PATCH /v1/entity/:id/archiveEntity Request body

string
enum
required

The reason for archiving the user

Allowed:
Responses

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