---
description: api/v1
---

# Recover an HD wallet

**Request Body - `Content-Type: application/json;charset=utf-8`**

| Parameter    | Type   | Required | Description                                                     |
| ------------ | ------ | -------- | --------------------------------------------------------------- |
| `name`       | string | Yes      | A unique wallet name                                            |
| `mnemonic`   | string | Yes      | A 12- to 24-word BIP39 phrase to seed your wallet's private key |
| `language`   | string | Yes      | Language of your wallet's mnemonic                              |
| `password`   | string | No       | A password used to authenticate wallet use                      |
| `passphrase` | string | No       | Custom text used as part of your wallet's address generation    |
| `hint`       | string | No       | A hint for your password                                        |

Please check _Appendix > Language Support_ for more information. **$language** is not case-sensitive.

**Response - `200 OK, text/plain`**

| Parameter | Type   | Description                                                     |
| --------- | ------ | --------------------------------------------------------------- |
| `address` | string | A 12- to 24-word BIP39 phrase to seed your wallet's private key |

POST/api/v1/recoverHDWallet/

**Example request body**

```
{
    "name": "test",
    "mnemonic": "someone window crucial magic shoulder latin satisfy total siege curtain candy trip",
    "language": "english"
}
```

**Example request**

```
$ curl -X POST http://localhost:2442/api/v1/recoverHDWallet \
    -H 'Content-Type: application/json;charset=utf-8' \
    -d '{
        "name": "test",
        "mnemonic": "someone window crucial magic shoulder latin satisfy total siege curtain candy trip",
        "language": "english"
    }'
```

**Response (Success)**

```
"test"
```

**Response (Error)**

```
false
```
