GET/api/v1/signing-profile-address

Get your profile address

Returns the caller's profile address for a Bitcoin network, along with the descriptor and the registered key it is derived from.

AccessRequires a signed-in caller

A member's profile address is a personal Bitcoin address derived from their own registered signing key, and it belongs to their Signing Profile. It is where purchased Bitcoin is delivered: because the address comes from the member's own key, the platform never takes custody of the coins, and spending from it needs only the member's own signature. The address depends on having a key registered on the network you ask for, which POST /api/v1/register-key does.

Read the address here rather than deriving it yourself. Where a member has several registered keys, one per network plus any that have been replaced, the profile address is what identifies which key is meant, and if your application and the platform disagree about that address the request is rejected rather than guessed. Both POST /api/v1/moonpay/sign-buy-url and POST /api/v1/forward-to-vault take the address this call returns.

Query parameters

workspace_idnumberrequired

The workspace the request applies to. You must be a member of it.

networkstringrequired

The Bitcoin network to return the address for. Either mainnet or testnet.

bash

curl "$SQRL_API/api/v1/signing-profile-address?workspace_id=342&network=mainnet" \
  -H "authorization: Bearer $SQRL_TOKEN"

const params = new URLSearchParams({
  workspace_id: "342",
  network: "mainnet",
});
const res = await fetch(
  `${process.env.SQRL_API}/api/v1/signing-profile-address?${params}`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { address, key_id } = await res.json();

rust

let res = client
    .get(format!("{}/api/v1/signing-profile-address", api_base))
    .query(&[("workspace_id", "342"), ("network", "mainnet")])
    .bearer_auth(&token)
    .send()
    .await?;

Response200 OK

{
"address": "bc1qm34lsc65zpw79lxes69zkqmk6ee3ewf0j77s3h",
"descriptor": "wpkh([7f3a1c4d/84'/0'/0']zpub6rFR7y4Q2AijBEqTUquhVz…/0/0)",
"key_id": "key_01HZX4M8QT",
"network": "mainnet"
}

Was this page helpful?