# POST /api/v1/withdrawal-addresses

Save an address ahead of time (session; confirmed by email link)

Operation: `addWithdrawalAddress`.

Save an address ahead of time (session; confirmed by email link)

2FA accounts also send their authenticator `code`. Needed before API-key withdrawals to a new address. Wallet-only accounts and API keys cannot add addresses.

## Endpoint

`POST https://amplerun-api.spiry.org/api/v1/withdrawal-addresses`

## Authentication

Use the credential and scope required by this operation. For programmatic renter/host calls: `Authorization: Bearer $AMPLERUN_API_KEY`. A host-agent signature or other specialized proof is required where the description specifies it.

## Parameters

| Name | Location | Presence | Type | Description |
| --- | --- | --- | --- | --- |
| `Idempotency-Key` | header | Required | UUID | UUID scoped to authenticated principal, route and canonical request hash. |

## Request body

Required body. 

### `application/json`

| Field | Type | Presence | Description |
| --- | --- | --- | --- |
| `network` | "base" | Optional |  |
| `address` | EvmAddress | Required |  |
| `label` | string | Optional |  |
| `code` | string | Optional |  |

```json
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "address"
  ],
  "properties": {
    "network": {
      "type": "string",
      "enum": [
        "base"
      ]
    },
    "address": {
      "$ref": "#/components/schemas/EvmAddress"
    },
    "label": {
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "code": {
      "type": "string",
      "pattern": "^[0-9]{6}$"
    }
  }
}
```

## Responses

### `202`

Link sent (or already saved).

`application/json`
| Field | Type | Presence | Description |
| --- | --- | --- | --- |
| `state` | "AWAITING_EMAIL_CONFIRMATION" / "SAVED" | Required |  |
| `address_id` | UUID | Required |  |
| `confirmation_id` | UUID | Optional |  |
| `expires_at` | Rfc3339Utc | Optional |  |

```json
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "state",
    "address_id"
  ],
  "properties": {
    "state": {
      "type": "string",
      "enum": [
        "AWAITING_EMAIL_CONFIRMATION",
        "SAVED"
      ]
    },
    "address_id": {
      "$ref": "#/components/schemas/UUID"
    },
    "confirmation_id": {
      "$ref": "#/components/schemas/UUID"
    },
    "expires_at": {
      "$ref": "#/components/schemas/Rfc3339Utc"
    }
  }
}
```

### `default`

Error envelope. 401 unauthenticated, 403/404 forbidden, 409 conflict, 422 invalid input, 429 rate limited (code UNAVAILABLE, retryable:true, no Retry-After header), 503 unavailable money/provider state with retryable:true.

`application/json`
| Field | Type | Presence | Description |
| --- | --- | --- | --- |
| `error` | object | Required |  |

```json
{
  "$ref": "#/components/schemas/ErrorEnvelope"
}
```

## Static request outline

Replace path/query placeholders and provide the required JSON body, headers and credential from the sections above. This is a request outline, not a command that chooses an amount or starts a rental for you.

```sh
curl --request POST 'https://amplerun-api.spiry.org/api/v1/withdrawal-addresses' \
  --header "Authorization: Bearer $AMPLERUN_API_KEY"
```

[Schema definitions](https://docs.amplerun.com/reference/schemas.md) · [Download OpenAPI](/openapi.json) · [Authentication](https://docs.amplerun.com/agents/authentication.md) · [Errors and recovery](https://docs.amplerun.com/reference/errors.md)

---
Generated from the AmpleRun API contract.
Canonical: https://docs.amplerun.com/reference/api/add-withdrawal-address/