Archive User

Use /archiveUser to archive a user. A user can only be archived if all their associated accounts are one of the following statuses:

  • Close_with_refund
  • Close_without_refund
  • Close_charged_off

To fetch all associated accounts for a user, use Get User and Accounts.


⚠️ Warning: This action cannot be undone. If a user is archived, they must reapply to open another account.

Path Params
string
required

Pass in the Spidr user ID

Body Params

PATCH /v1/user/:id/archiveUser 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