Vaults

Create Address

Create a new address.

post/api/v1/vaults/{id}/addresses

Request

Base URL: https://api.fordefi.com
URL: https://api.fordefi.com/api/v1/vaults/{id}/addresses
Auth: HTTP bearer

Path parameters

idstring uuid required

ID of the vault to create address in.

Request body

namestring

The name of the address.

address_type'legacy' | 'segwit' | 'taproot'

Example request

{
  "import_address": {
    "derivation_path": "m/44/60/0/0/0"
  }
}

Response

Successful Response

idstring uuid required

The unique identifier of the object in the Fordefi platform.

created_atstring date-time required

The date and time when the object was created.

modified_atstring date-time required

The date and time when the object was last modified. Any change to any field of the resource is considered a modification.

namestring required

The name of the address.

public_key_compressedstring required

The compressed public key of the address. As defined in the SEC1 standard: https://www.secg.org/SEC1-Ver-1.0.pdf.

derivation_pathstring required

The BIP-32 derivation path of the address.

type'utxo' required

The type of the vault address.

Example response

{
  "vault": {
    "end_user": {
      "external_id": "user|1234"
    }
  },
  "balances": {
    "total_mined": "1000000000000000000",
    "total_pending_incoming": "1000000000000000000",
    "available_mined": "1000000000000000000",
    "available_pending_incoming": "1000000000000000000",
    "frozen_mined": "1000000000000000000",
    "frozen_pending_incoming": "1000000000000000000",
    "trustline_limit": "1000000000000000000"
  },
  "public_key_compressed": "SGVsbG8=",
  "derivation_path": "m/44/60/0/0/0",
  "address": {
    "address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq"
  }
}

Changes

No recorded changes to this operation across all 23 revisions of this API.