---
title: "Archive a bank account user"
method: POST
path: "/v3/funding-accounts/banks/users/{bankAccountUserId}/archive"
tags: ["funding-accounts"]
---

# Archive a bank account user

`POST /v3/funding-accounts/banks/users/{bankAccountUserId}/archive`

## Request

- Base URL: `https://gateway.stage.bill.com/connect`
- URL: `https://gateway.stage.bill.com/connect/v3/funding-accounts/banks/users/{bankAccountUserId}/archive`
- Auth: none declared

Archive an existing bank account user. In the response, the `archived` field is set as `true` and the bank account user `verificationStatus` is set as `UNVERIFIED`.

## Path parameters

- `bankAccountUserId` string, required: BILL-generated ID of the bank account user. The value begins with `bau`.

## Headers

- `sessionId` string, nullable: API session ID generated with `/v3/login`
- `devKey` string, nullable: Developer key generated with your BILL developer account

## Response `200`

Archive a bank account user response

- OrganizationBankAccountUserResponseDto: Bank account user response.
  - `id` string: BILL-generated ID of the bank account user. The value begins with `bau`.
  - `bankAccountId` string: BILL-generated ID of the bank account. The value begins with `bac`.
  - `userId` string: BILL-generated ID of the user. The value begins with `006`.
  - `archived` boolean: Set as `true` if the bank account user is archived
  - `verificationStatus` 'UNVERIFIED' | 'NOMINATED' | 'VERIFIED' | 'UNDEFINED': Bank account user verification status.
  - `createdTime` string, date-time: Created date and time
  - `updatedTime` string, date-time: Updated date and time

## Other responses

- `4XX`: List of errors.
- `5XX`: List of errors.

---

[API](https://skmtc.dev/bill/apis/bill-v3-api.md) - [All operations](https://skmtc.dev/bill/apis/bill-v3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bill/apis/bill-v3-api/revisions/54edddceb0a5?raw)