> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rebelfi.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Archive Recipient

> POST /v1/ramp/recipients/{id}/archive — Archive a recipient

<Note>
  **Endpoint:** `POST https://api.rebelfi.io/v1/ramp/recipients/{id}/archive`
</Note>

Archive a recipient. Archived recipients can no longer be used for new ramping operations.

### Path Parameters

| Field | Type      | Required | Description          |
| ----- | --------- | -------- | -------------------- |
| `id`  | `integer` | Yes      | Recipient identifier |

### Example Request

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://api.rebelfi.io/v1/ramp/recipients/1/archive" \
    -H "x-api-key: your_api_key"
  ```

  ```typescript SDK theme={null}
  const recipient = await client.ramp.archiveRecipient(1);
  ```
</CodeGroup>

### Example Response

```json theme={null}
{
  "id": 1,
  "name": "OnEdge",
  "type": "business",
  "external_id": "ref-123",
  "kyb_status": "approved",
  "address": {
    "street1": "123 Main St",
    "street2": null,
    "city": "New York",
    "region": "NY",
    "postal_code": "10001",
    "country": "US"
  },
  "bank_accounts": [
    {
      "id": 10,
      "account_number": "****1234",
      "routing_number": "021000021",
      "bank_name": "Chase",
      "capabilities": ["onramp", "offramp"],
      "status": "active",
      "destination_asset": "USDC",
      "network_id": "base"
    }
  ],
  "onramp_account_count": 1,
  "offramp_account_count": 2,
  "total_volume_usd": "150000.00",
  "transaction_count": 45,
  "created_at": "2025-06-01T12:00:00.000Z",
  "archived_at": "2025-07-15T09:30:00.000Z"
}
```

### Response Fields

| Field                   | Type      | Description                   |
| ----------------------- | --------- | ----------------------------- |
| `id`                    | `number`  | Recipient identifier          |
| `name`                  | `string`  | Recipient name                |
| `type`                  | `string`  | Recipient type                |
| `external_id`           | `string?` | Your external reference ID    |
| `kyb_status`            | `string`  | KYB verification status       |
| `address`               | `object?` | Recipient address             |
| `bank_accounts`         | `array`   | List of linked bank accounts  |
| `onramp_account_count`  | `number`  | Number of on-ramp accounts    |
| `offramp_account_count` | `number`  | Number of off-ramp accounts   |
| `total_volume_usd`      | `string`  | Total volume in USD           |
| `transaction_count`     | `number`  | Total number of transactions  |
| `created_at`            | `string`  | Creation timestamp (ISO 8601) |
| `archived_at`           | `string`  | Archive timestamp (ISO 8601)  |

<Info>
  Archiving is a soft delete. The recipient and its data are preserved but the recipient cannot be used for new operations.
</Info>