Honest Money LIVE· Weekly broadcast · Noon CTWatch
← honest.money

Ecosystem API

Quiet reference for our other sites. Post a new subscriber to the central Honest Money list and tag them by interest.

New partner? Start with the plain-English overview at /build.

1 · Sign in with Honest Money (SSO)

Open our login popup with your return address. Your domain must be on our allow-list first — ask us to add it. Existing members only; logins never create accounts.

https://honest.money/sso-login?popup=1&return_to=https://yoursite.com/sso

After a 6-digit email code (or an existing session), we redirect to:

https://yoursite.com/sso?token=<ticket>&popup=1

Ticket = base64url(JSON) + "." + HMAC-SHA256 hex of the encoded part, keyed with your site’s unique HME_ECOSYSTEM key (sso:sign permission). Expires in 120 seconds; accept each nonce once.

{ "iss": "honest.money", "site": "<your stable site code>", "minerId": "<member uuid>", "email": "member@example.com",
  "exp": 1760000000, "nonce": "<random>", "redirect": "/my" }
// verify (Node / Workers)
const [body, sig] = token.split(".");
const mac = hmacSha256Hex(HME_ECOSYSTEM, body);   // compare timing-safe
if (mac !== sig) reject();
const t = JSON.parse(base64urlDecode(body));
if (t.iss !== "honest.money" || t.site !== YOUR_STABLE_SITE_CODE) reject();
if (t.exp * 1000 < Date.now() || nonceUsed(t.nonce)) reject();
signIn(t.minerId);

Permanent account matching: use the member UUID

Store the verified SSO ticket's minerId as your permanent Honest Money account key. This is the same UUID returned as hmeId by member-check and hme_miner_id in profile APIs. It is not the login's auth user ID, the member number, or their email.

  • First verified sign-in: attach this UUID to the existing local account only after proving that account belongs to this member. Enforce a unique constraint on the stored UUID.
  • Every later sign-in: find the local account by UUID first. Update email as a contact detail; an email change must not create another account.
  • Never automatically merge conflicting accounts, move balances, or invent another UUID when matching fails. Send conflicts for review.
  • Backfilling existing accounts is read-only. An email lookup is a matching aid, not proof of login or ownership.

Site-specific API keys

Super admins issue, replace or revoke a key in Admin → Ecosystem → SSO sites, inside the partner's entry. Each stable site code gets one unique key, shared by that site's addresses. The value is shown once and its verification hash and a server-encrypted copy are retained; the encrypted copy lets Honest Money sign tickets and requests for this destination. Save it privately in the partner project as HME_ECOSYSTEM; never put it in browser code.

Authorization: Bearer <your site's HME_ECOSYSTEM>
X-HME-Site: tsd
Content-Type: application/json

One API key per site, with permissions assigned by a Super admin in that entry. Select permissions before issuing a new key; new keys start with none selected. Save permissions on an existing key without changing its value or updating the partner project. Existing issued keys retain their previous capabilities until you change them. An empty permission list blocks every authenticated ecosystem service, including sign-in.

PermissionCodeEndpoint
Member lookupmembers:lookup/api/public/minetxc/member-check
Report member activityactivity:write/api/public/hub/events
Publish calendar eventscalendar:write/api/public/hub/calendar
Publish news and noticesnews:write/api/public/hub/news
Add email subscribersmailing:subscribe/api/public/subscribe
Read this site's admin accessadmins:read/api/public/hub/admins
Publish this site's role definitionsroles:write/api/public/hub/admin-roles
Report email unsubscribes and bouncesmailing:suppressions/api/public/suppressions
Member sign-insso:signSSO tickets
Request member hand-off to another sitehandoff:issue/handoff
Verify member hand-off ticketshandoff:verifyPOST /api/public/hub/handoff/verify
Read full member profilesprofiles:read/api/public/minetxc/miner-profile
Read payout wallet feedwallets:read/api/public/minetxc/wallets
Create new profiles · MineHME onlyprofiles:create/api/public/hme/profiles/upsert|bulk
Confirm members' emails (unconfirmed → confirmed only) · MineHME only · Super onlyprofiles:confirm-email/api/public/hme/profiles/email-confirmed
Sign up new members (we email a sign-up code) · Super onlymembers:create/api/public/hme/members/start|verify
Import wallet/history records · MineHME onlysync:write/api/public/hme/{kind}/bulk
Read sync checksums · MineHME onlysync:read/api/public/hme/{kind}/checksum
Match confirmed member email hasheshub:match/api/public/hub/match
Import Hub recordshub:profiles/api/public/hub/profiles/bulk
Save encrypted wallet backupsbackup:savePOST /api/public/backup
Restore encrypted wallet backupsbackup:restoreGET /api/public/backup
Delete encrypted wallet backupsbackup:deleteDELETE /api/public/backup
Check wallet backup statusbackup:statusGET /api/public/backup?status=1
Read signed trusted-site listtrusted-sites:read/api/public/v1/trusted-sites
May propose trades, member approves each · Super onlywallet:proposeHME Wallet hm-link-delegate (approve mode)
Allowed to receive a spending key · Super onlywallet:delegateHME Wallet hm-link-delegate (access mode)
Verify and redeem free-coin claimsclaims:verify/api/public/blockchainmint/claim-verify
Share mining summaries with Honest Moneysister:readPartner miner-summary / miner-rewards
Receive Honest Money profile updatesprofiles:pushPartner profile-update
Receive mining enrollment ordersmining:provisionPartner provision / sale
Receive LIVE expenses · Beansexpenses:writePartner ecosystem/expenses
Receive free-coin store ordersorders:writePartner external-orders
Read payment invoicespayments:readPartner v1/invoices/{id}
Create payment invoicespayments:writePartner v1/invoices
Report confirmed paymentspayments:notify/api/public/nectarpay/webhook

Hub bodies must use the same code in service; a conflicting X-HME-Site header is rejected. Role publishing defines available roles, never assigns people access. A site's key cannot impersonate another site. Pausing all its addresses blocks API access. Replacement invalidates the previous key immediately; revocation does not restore shared-key access. A 401 may mean an invalid key, inactive site or missing permission.

All authenticated ecosystem services now use this one per-site key. Shared keys and missing site identities are rejected. Existing hash-only keys must be replaced to enable signing. Only the stable minehme site can receive creation and canonical-sync permissions. No permission permits external profile edits or deletions. Member wallet-link and backup approval passes remain separate, short-lived approvals—not partner credentials.

Partner rollout checklist

  1. Publish the updated Honest Money API before switching a partner's credentials.
  2. In Admin → Ecosystem → SSO sites, choose only the permissions the partner needs, then issue its key.
  3. Store it privately as HME_ECOSYSTEM on the partner. API calls send Authorization: Bearer and X-HME-Site with its stable code; Hub bodies use that same service code.
  4. Test an allowed operation and an unselected operation. Never put a key in a browser, URL or public log.
  5. Change the partner’s code to use this same HME_ECOSYSTEM for SSO verification, signed imports, backups and enabled outbound services. Adding a secret alone is not enough: replace old credential reads and add the site header.
  6. Partner receivers must compare the same site key, reject other site codes and preserve nonce, expiry, role/AAL2, member approval and payment idempotency checks. Remove old shared credential fallback only after this code is deployed.
  7. Test real sign-in, permanent UUID matching and each enabled service before removing obsolete partner secrets. Honest Money’s internal encryption, email, session and member-approval signing secrets are not partner keys.

Publishing is a coordinated cutover: old partner credentials stop working when this Honest Money release goes live. Prepare partner code and keys first, then deploy both sides together. An issued/replaced key invalidates the previous key immediately; do not replace a working key until its project is ready.

Signed requests and destination services

Signed imports, Hub matching/imports, claim verification and payment notices use the same site key. Sign the exact raw request body; GET checksums use an empty body. Send the stable site header and the following headers. We enforce the endpoint’s permission, a five-minute timestamp limit and a one-use UUID nonce.

X-HME-Site: <stable site code>
X-HME-Timestamp: <Unix seconds>
X-HME-Nonce: <fresh UUID>
X-HME-Signature: <HMAC-SHA256 hex, HME_ECOSYSTEM, timestamp + "." + nonce + "." + rawBody>

Honest Money’s outbound mining reads, profile updates, enrollments, Beans expenses, store orders and NectarPay invoices use the destination’s own key with Authorization: Bearer and X-HME-Site. The destination must update its receiver to accept that key; its required permission is listed above. Existing request bodies, idempotency references and retry behavior are unchanged.

Trusted-site requests require trusted-sites:read, Bearer authorization and X-HME-Site. Verify the returned signature with your same HME_ECOSYSTEM; responses are private and not cached. Each entry is { "host", "label", "active", "delegate", "delegate_modes", "delegate_branches" }; delegation fields are set only from wallet:propose / wallet:delegate on exact hosts (see Trading delegate). Public calendar/branch feeds and member-approved one-use wallet QR flows remain public or member-authorized—not general partner-key access.

Bulk email → permanent member ID (read-only)

POST https://honest.money/api/public/minetxc/member-check
Authorization: Bearer <your site's HME_ECOSYSTEM>
X-HME-Site: tsd
Content-Type: application/json

{ "members": [ { "ref": "local-account-42", "email": "member@example.com" } ] }

→ { "checked": 1, "summary": { "found_by_email": 1 }, "results": [
  { "ref": "local-account-42", "result": "found_by_email", "hmeId": "<permanent member UUID>",
    "memberNo": "1506", "username": "member", "emailOnFile": "member@example.com", "status": "APPROVED" }
] }

Up to 1,000 rows per call; primary and confirmed extra emails are matched. Include hmeId when you already have it: ID matching takes priority. Results include found, found_different_email, found_by_email, found_by_email_different_id, ambiguous_email, and not_found. Review ambiguous/different-ID results; never create or merge accounts automatically from them. A 401 means the credential/site combination is rejected—not that the member is missing. The legacy header x-minetxc-secret also works; new site keys require X-HME-Site.

Payout wallets feed — name the wallet type (read-only)

POST https://honest.money/api/public/minetxc/wallets
Authorization: Bearer <your site key>
X-HME-Site: minetxc
Content-Type: application/json

{ "coin": "TXC" }                      // mining payouts
{ "coins": ["TSD", "USDC"] }           // commission payouts
// optional: since, minerIds, limit, offset, includeDeleted

→ { "wallets": [ { "minerId", "walletId", "address", "coin", "payoutType",
     "percentBps", "isDefault", "label", "deletedAt", "updatedAt" } ],
    "count", "total", "nextOffset", "done", "syncedAt" }

You must say which wallet type you want. Send coin or coins with any of TXC, ISK, ZCU, TSD, USDC. A request without one returns 400 coin_required; an unknown value returns 400 invalid_coin. Only the types you ask for come back, so a TXC payout run never receives USDC/TSD commission wallets. Every address is also checked against its type before it is sent (TXC/TSD legacy T…, TXC txc1…, ISK K/I/L… or isk1…, ZCU/USDC 0x…); mismatches are left out. percentBps is the share out of 10,000 per member per type and always totals 10,000. Never mix types when splitting a payout.

2 · Affiliate links

https://honest.money/r/{code}               → honest.money hub
https://honest.money/r/{code}/{service}     → your registered service URL
https://honest.money/r/{code}?to=https://yoursite.com/page
  • Visitors arrive at your site with ?ref={code} appended.
  • Keep that code (cookie or session) and send it with signups. Our own cookie hm_ref lasts 30 days; last click wins.
  • ?to= only forwards to ecosystem domains — ask us to add yours.

Wallet cloud backup (approved wallets only)

  • Only approved site keys with the corresponding backup permission work here. The same HME_ECOSYSTEM key covers save, restore, delete and status separately.
  • For each action, open https://honest.money/backup-pass?action=save|restore|delete&return_to=<your page>. The member approves it (with their two-step code for restore/delete if they have one), and we send them back with #hm_backup_pass=... in the web address fragment — never the query string — so the pass can't land in server or proxy logs. Your return page must read it with client-side JavaScript (new URLSearchParams(location.hash.slice(1)).get("hm_backup_pass")) and send it to your server in the request body. It lasts 5 minutes and works once.
  • From your server, send Authorization: Bearer <your site’s HME_ECOSYSTEM> + X-HME-Site: your-site-code + X-HM-Backup-Pass to /api/public/backup: POST { blob } saves (base64, max 64 KB), GET restores, DELETE removes, GET ?status=1 returns { exists, updated_at, size }. A status check doesn't use up the pass.
  • Scramble on the device with a slow password method (Argon2id or PBKDF2 with 600,000+ rounds) plus AES-GCM. We never see the password or anything readable.
  • Limits per member per day: 10 saves, 5 restores, 5 deletes. Members get an email whenever a backup is restored or deleted.

Member hand-off to another site (approved pairs only)

Lets one app (the requester, e.g. CryptoPOP Wallet, site code pop-wallet) pass verified proof of who a member is to another site (the audience, e.g. TSD, site code tsd) for one purpose. It proves identity only — never a sign-in session, cash-out right or spending authority.

  • The requester's key needs handoff:issue; the audience's key needs handoff:verify. Both are off by default.
  • Requester: send the member's browser to https://honest.money/handoff?to=tsd&purpose=receiving_setup&state=<random 16-128 chars>&return_to=<your registered callback>. return_to must exactly match (host + path) a callback URL we have registered for your site — send us yours first. state is a fresh random value (letters, digits, - or _) you create per request and remember alongside the pending setup. Members with two-step sign-in are asked for their code. The member signs in if needed (their existing session is reused) and taps Approve.
  • We send them back with #hm_handoff=... in the fragment, never the query string. Read it with client-side JavaScript and pass it to the audience in a request body.
  • Audience: from your server, POST /api/public/hub/handoff/verify with Authorization: Bearer <your own site key>, X-HME-Site: tsd, body { "ticket": "...", "purpose": "receiving_setup" }. Success: { ok, member: { id, memberNo, email, emailVerified }, requester, audience, purpose, state, iss, iat, exp }. Before acting, check iss is https://honest.money, purpose is what you expect, and state matches the pending setup you are completing — otherwise refuse (this stops someone slipping their own ticket into another member's setup). Make verify the last step before you commit; never put the ticket in a query string (we reject it). member.id is the permanent member UUID — the same value as minerId in normal sign-in tickets.
  • Errors: 400 malformed; 401 unauthorized / invalid_signature / expired / not_yet_valid; 403 wrong_audience / wrong_purpose / wrong_issuer / requester_revoked / member_inactive; 409 replayed; 503 unavailable (only this one is safe to retry with the same ticket).
  • Tickets last 5 minutes (30 s clock allowance), work once, and are used up on the first verify call even if your own flow fails afterwards — get a fresh one to retry. Only honest.money holds the signing key; verify remotely, don't try to check the signature yourself.

2b · Referral snippet (paste once)

<script src="https://honest.money/hm.js" async></script>
  • Put it in your site's page head, on every page.
  • Saves the ?ref= code in your own 30-day hm_ref cookie and counts the landing in our affiliate stats.
  • Adds a hidden hm_ref field to every form on submit, and window.honestMoney.ref() returns the code anytime.
  • Counts every visit (once per browser session) so the member Journey shows which ecosystem sites people come back to.
  • When a form with an email field is submitted, it tells us that email so the visit can be matched to a member. These matches are marked unconfirmed and are display-only — never used for payouts or access.
  • Optional, recommended: when a visitor is signed in, call window.honestMoney && honestMoney.identify(memberIdOrEmail) once per page. That matches every visit reliably.
  • Still send ref with your server-side signup event (section 3) — the snippet can't see in-app actions like purchases or wallet downloads.

2c · Help desk button (paste once)

Adds a floating “Get help” button that opens the Honest Money Help Desk (Helio chat plus a support-ticket form) in a panel on your site. Tickets land in the central help desk at help.honest.money. No API key is needed.

<script async
  src="https://help.honest.money/api/public/widget.js"
  data-ecosystem="minetxc"
  data-folder="minetxc"
  data-brand-name="mineTXC"
  data-context="mineTXC"
  data-theme="auto"
></script>
  • Paste it once in your shared footer / custom-code area, right before </body>, so it is on every page. It is separate from the referral snippet above — install both if you want both.
  • Swap the four data- values for your site. Settings already agreed: swap / Swap, wtxc / wTXC, usdc / USDC, minetxc / mineTXC.
  • New site? Ask us for your folder name first — data-folder must match a folder that already exists in the help desk, or tickets fall back to automatic sorting. Don't make one up.
  • Optional look settings: data-theme (auto, light, dark), data-side (left or right, default right), data-label (button name, default “Get help”), and data-bottom, data-offset, data-size (CSS lengths).
  • Always use the published help.honest.money address, never a preview address.
  • The help panel loads in the background as soon as the page opens (not only when the button is pressed). Mention the help desk in your privacy notice.
  • The data- values and any email a visitor types are routing hints and contact details only — not proof of who the visitor is. Never use the help desk for sign-in, wallet approvals or account changes; use the sections above for those.
  • To check it: open a page on desktop and phone and make sure the button and panel appear. Ask us before sending a test ticket so we can watch for it.
  • To remove it, delete the script. Existing tickets stay in the help desk.
  • Reading or annotating tickets from your own server uses a separate, private help desk key that we issue only to approved partners. It is not your Honest Money site key — ask us if you need it, and never put it in a browser or footer.

3 · Report signups & usage (Hub events)

POST https://honest.money/api/public/hub/events
Authorization: Bearer <your site's HME_ECOSYSTEM>
Content-Type: application/json

{
  "service": "passage",         // YOUR site name, lowercase — this is how we know who sent it
  "event": "service_used",      // signup | service_used | purchase | wallet_download
  "member_id": "<uuid from SSO>", // or "email"
  "ref": "minetxc",             // the ?ref code you stored (optional)
  "metadata": { "plan": "basic" }
}

Use your site's API key from your server only, never from a web page. Send your stable site code in service. The matching activity:write permission is required. Response: { "ok": true, "member_found": true }.

Wallet apps (HME Wallet, Beekeeper, CryptoPOP): send "event": "wallet_download" the first time a member installs or connects your wallet, with service set to hme-wallet, beekeeper or cryptopop and optionally "metadata": { "platform": "ios" }. It shows on the member's journey in our admin.

  • New people (no honest.money profile yet): send a signup event with their email and the stored ref. We hold the referral, and when they later create an honest.money profile with that email, the referrer becomes their sponsor automatically.
  • Your service name is also recorded as the site where they first signed up.
  • Existing members: send member_id (from SSO) when you have it — it never changes, even if their email does. Members may have several verified emails; any of them will match.

Member account and wallet approvals

Manual wallet additions, removals, primary-wallet choices and payout splits require a six-digit wallet-specific email code. Each code approves only the exact change shown, expires after 15 minutes and works once; sign-in codes cannot approve wallets. HME Wallet QR linking keeps its separate signed, one-use five-minute approval. Only Super administrators using two-step sign-in may reset a member’s authenticator or change a primary email; a new primary email must already be confirmed on that member’s Extra emails list. Security changes send account notices.

3a · Sign up new members from your site (members:create)

Approved sites with the members:create permission (switched on by an Honest Money Super admin only) can sign up brand-new Honest Money members without sending them away. You never vouch for the email: Honest Money emails the person a six-digit sign-up code from no-reply@honest.money, you collect it on your page, and we create the profile only after the code checks out. The code only finishes that one sign-up: it is not a sign-in code, the email has no sign-in link, and verify never returns a session. After joining, members sign in to you with SSO like everyone else. Show the Honest Money agreements (honest.money/join) before calling start. Existing members get member_exists — sign them in with SSO. Deleted identities cannot be recreated. Requests expire after 30 minutes, allow 5 code tries, and each site is limited to 100 starts per hour. This never edits profiles, grants admin access or enrolls anyone in mining. Sign both calls exactly like the other signed endpoints (X-HME-Site, timestamp, nonce, signature).

POST https://honest.money/api/public/hme/members/start
{ "email": "new@example.com", "full_name": "Jane Doe", "username": "janedoe", "ref": "sponsorcode", "agreements_accepted": true }
→ 200 { "ok": true, "request_id": "<uuid>", "expires_in": 1800 }
→ 409 { "ok": false, "error": "member_exists" | "profile_retired" | "username_taken" }
→ 429 { "ok": false, "error": "rate_limited" }

POST https://honest.money/api/public/hme/members/verify
{ "request_id": "<uuid>", "code": "123456" }
→ 200 { "ok": true, "result": "created", "hme_miner_id": "<uuid>", "member_no": "60123", "affiliate_code": "janedoe" }
→ 401 { "ok": false, "error": "invalid_code" }   409 already_used | member_exists   410 expired   429 too_many_attempts

username and ref are optional; we pick a handle if you leave it blank. signup_site is your site code automatically, and the member gets our welcome email. Repeating verify after success returns the same member. What to show the person for each verify answer: invalid_code — “That code didn’t match, try again”; too_many_attempts, expired or already_used — “This sign-up expired, please start again” (call start for a fresh code); member_exists — this email became an Honest Money member while they were signing up (the code is used up), so send them to sign in with SSO instead of starting again.

3b · Bulk profile imports: MineHME only, creation only

Only mine.honest.money may import profiles directly (without our email code). Other sites use members:create above. Existing profiles can only be edited by members or authorized admins on honest.money. Only minehme’s unique site key with profiles:create authorizes direct imports; no other site can obtain this permission.

POST https://honest.money/api/public/hme/profiles/check
{ "email": "new@example.com", "username": "newminer", "affiliate_code": "newminer" }
→ { "available": false, "fields": { "email": { "taken": true, "hme_miner_id": "<uuid>" } } }
POST https://honest.money/api/public/hme/profiles/upsert
Content-Type: application/json
X-HME-Site: minehme
x-hme-timestamp: <Unix seconds>
x-hme-nonce: <new UUID>
x-hme-signature: <HMAC-SHA256 hex of timestamp.nonce.rawBody>

{ "event": "created", "profile": {
  "hme_miner_id": "<new permanent UUID>",
  "email": "new@example.com", "email_verified": true,
  "username": "newminer", "full_name": "New Member",
  "sponsor_hme_miner_id": "<sponsor UUID or null>"
} }

// Sign with MineHME’s unique HME_ECOSYSTEM (profiles:create).
// Send X-HME-Site: minehme.
  • We set signup_site to minehme. A submitted site name cannot grant access.
  • Requests expire after 5 minutes; every nonce works once. Use a fresh nonce on retries.
  • updated and deleted events return 403 external_profile_updates_disabled. Existing IDs return 409 profile_exists, including unchanged retries; do not replace them with a new UUID.
  • Retired identities return 409 profile_retired. Future erasures retain a protected member-ID and email fingerprint to stop external recreation; profiles fully erased before this safeguard may not be identifiable.
  • /api/public/hme/profiles/bulk uses the same site-key signature and accepts { "profiles": [...] } (up to 500). Each row is creation-only; inspect the rejected list. No existing public or private details are overwritten.
  • External sponsor changes at /hme/affiliates/upsert and profile settings at /hme/profile-extras/bulk are disabled. Wallet and read-only mining/history imports remain separate; histories cannot change profile dates.
  • Duplicates are refused with 409 and a message you can show the person (email already has a profile / name taken).
  • Member numbers come from us. Don't assign one — use the member_no in our reply.

Wallet address ownership

Every supported coin requires one member owner per address. TXC and TSD share an address family: the same member may save the same address for both, but another member cannot claim it. EVM and bech32 address case is normalized; legacy Base58 addresses remain case-sensitive. Removing a wallet does not transfer its historical ownership.

Wallet imports at /api/public/hme/wallets/bulk report conflicting rows in rejected with wallet_owned_by_another_member or wallet_ownership_review_required; unrelated rows continue syncing. Existing shared addresses are preserved for review, not assigned to an arbitrary member. Do not treat a shared address as proof of individual participation or ownership. Saving an address is not cryptographic proof that the member controls it.

Wallet QR linking (HME Wallet)

Members can link their HME Wallet without copy-paste. Honest Money shows a one-time QR on Dashboard → Wallets; the wallet app scans it with its Ecosystem link feature, fetches the manifest, asks the member to approve, and POSTs back watch-only account keys (xpubs) plus the signed identity address. We use the wallet's standard "NectarPay bundle" dialect of hm-link-xpubs, requesting TXC (the same key family covers TSD), ISK, and EVM (covers ZCU, USDC and ETH) — so no wallet app changes are needed.

The QR encodes hm-link:https://honest.money/api/public/wallet-link/<token>. The token is the credential: it expires in 5 minutes, works exactly once, and is bound to the signed-in member who generated it. The manifest and callback are on the same origin:

GET https://honest.money/api/public/wallet-link/<token>

→ 200 {
  "v": 1,
  "type": "hm-link-xpubs",
  "challenge_id": "<token>",
  "from": "honest.money",
  "callback_url": "https://honest.money/api/public/wallet-link",
  "manifest_url": "https://honest.money/api/public/wallet-link/<token>",
  "chains": ["TXC", "ISK", "EVM"],
  "exp": <unix seconds>,
  "allow_new_wallet": true,
  "merchant_name": "Honest Money"
}

POST https://honest.money/api/public/wallet-link
{ "payload": { "v": 1, "type": "hm-link-xpubs", "challenge_id": "<token>",
               "from": "honest.money", "callback_url": "…", "chains": […],
               "xpubs": { "TXC": "xpub…", "ISK": "…", "EVM": "…", … },
               "exp": <unix seconds>, "issued_at": "<iso>" },
  "signature": "<base64 BIP-137>",
  "address": "T…" }

→ 200 { "ok": true, "linked_to": "Honest Money", "chains_linked": ["TXC","ISK","EVM","ZCU"] }
→ 404 unknown_token · 409 token_used · 410 token_expired · 400 bad_signature / wrong_origin

The signature is BIP-137 over the canonical JSON of the payload (sorted keys, no whitespace), made by the wallet's TXC identity key (m/44'/696969'/0'/0/0) with the TEXITcoin message prefix — we verify it against address before accepting anything. The xpubs are watch-only — they can monitor participation, never spend. We store them on the link record and save the identity address as the member's TXC wallet (one-owner-per-address rules apply; an address already owned by another member is rejected). The link shows in the member's backoffice history.

Ecosystem link protocol (HME Wallet)

Any ecosystem site can let members link their HME Wallet — the same feature our Wallets page uses. You show a QR (or a pasteable URL), the member scans it in the wallet app's Ecosystem link box, the wallet fetches a link manifest from your server, shows an approval screen, and POSTs the result back to you. The member's seed phrase never leaves their device; you only ever receive watch-only keys (or, for trading links, explicitly approved access).

The QR payload is hm-link:<https manifest URL> (a bare https URL also works). The URL must be plain https on a public DNS name — no port, no credentials, no IP literals, no localhost. The wallet never calls your server directly; it goes through its own same-origin proxy, which means: GET/POST only, JSON request and response bodies only, 32 KB cap each way, 10-second timeout, and redirects are rejected. No CORS setup is needed on your side.

Three manifest dialects are supported; the wallet auto-detects which one you serve. All share these rules: challenge_id (your one-use token, 8–64 chars of A–Z a–z 0–9 - _), challenge (random string the wallet signs, 8–128 chars), expires_at (ISO timestamp — expired links are refused), and submit_url/callback_url must be on the same origin as the manifest URL.

1 · Requested paths (simplest — ask for one account key)

Detected when the manifest has a request array and a submit_url. You ask for exactly one hardened account-level xpub on the TXC or ISK coin type — path must be m/44'/696969'/<account>' (TXC) or m/44'/969696'/<account>' (ISK). The wallet rebuilds the signed message locally from your message_template, which must match this fixed shape (placeholders are substituted by the wallet):

GET https://your-site.example/link/<token>

→ 200 {
  "type": "hm-link-xpubs",
  "challenge_id": "<token>",
  "challenge": "<random>",
  "request": [ { "chain": "TXC", "path": "m/44'/696969'/0'", "label": "TEXITcoin account" } ],
  "message_template": "Honest Money - Link wallet\n\nDomain: {domain}\nChallenge: {challenge}\nPath: {path}\nXpub: {xpub}\n\n<one line, 10–300 chars, no braces>",
  "submit_url": "https://your-site.example/link/submit",
  "expires_at": "<iso>",
  "app": { "name": "Your Site" },
  "purpose": "Shown on the approval screen (optional, max 300 chars)"
}

POST submit_url
{ "token": "<challenge_id>", "identity_address": "T…", "xpub": "xpub…",
  "path": "m/44'/696969'/0'", "signature": "<BIP-137>", "app_name": "honest.money wallet" }

→ 200 { "linked_to": "Your Site" }   ·   errors: { "error": "…" } with 4xx/5xx

The signature is BIP-137 over the rendered template, made by the wallet's TXC identity key (m/44'/696969'/0'/0/0) — verify it against identity_address to prove the member controls the wallet. Honest Money's own implementation of this dialect is documented above under "Wallet QR linking".

2 · NectarPay bundle (many chains at once)

Detected when the manifest has chains and callback_url. You receive watch-only account xpubs for every chain you list (BTC, TXC, EVM, ZCU, LTC, BCH, TRX, DOGE, DASH, ISK, SOL). from must equal the manifest's hostname, and manifest_url must exactly equal the URL the wallet fetched. Optional known_addresses_count/known_addresses_hash (sha256 of the sorted, newline-joined address list) let the wallet stay silent when it recognises the member, or warn when it's a different wallet (allow_new_wallet controls whether that's allowed).

→ manifest {
  "v": 1, "type": "hm-link-xpubs", "from": "your-site.example",
  "challenge_id": "…", "chains": ["TXC","ZCU","EVM"], "exp": <unix seconds>,
  "callback_url": "https://your-site.example/link/callback",
  "manifest_url": "https://your-site.example/link/<token>",
  "merchant_name": "Your Site"   // optional, shown on approval
}

POST callback_url
{ "payload": "<canonical JSON of xpubs>", "signature": "<BIP-137>", "address": "T…" }

→ 200 { "store_id": "…", "merchant_name": "…", "chains_linked": ["TXC",…] }

The payload is canonical JSON (keys sorted, no whitespace) signed with the TEXITcoin message prefix; full spec in the wallet's NECTARPAY-LINK.md.

3 · Trading delegate (Seeds-style, restricted)

type: "hm-link-delegate" lets a site trade from the member's separate Trading pocket. This dialect is restricted per site by Honest Money: being on the trusted list for sign-in is not enough. Each trusted-site entry carries delegate, delegate_modes ("approve" = xpubs only, you propose unsigned transactions and the member approves each; "access" = account xprv sealed to your key) and delegate_branches (the one account Honest Money assigned to your site from its reserved branches, e.g. [1106]; each branch belongs to one site only). Only exact hostnames qualify; wildcard entries are sign-in only.

The branch is ours to choose, never yours. Read your own entry from the signed trusted-site list and use the branch in delegate_branches — that number is the only one you may ever ask for. Do not pick a branch, guess one, reuse another app's, or ask for the main account (0); if delegate_branches is empty, your site has no trading access yet, so ask us to assign one. The wallet must request and honor exactly that branch: derive the path from it, offer only the modes in delegate_modes, and refuse any request naming a branch outside your delegate_branches — including a site that asks for the member's main account or another site's branch — with no override and no fallback. If you need a different branch, ask us to reassign it; we record every change.

The wallet must also refuse any request whose host lacks delegate: true, whose mode isn't listed, or whose branch isn't listed. Requested paths must be exactly a listed branch on a pocket chain. You must also provide a revoke_url so the member can cut access. If you need this dialect, talk to us first — a Super admin at Honest Money has to switch on the matching permission and pick your branch for your site.

Operational rules for every dialect: tokens are single-use — mark them consumed before doing work so a racing second submit fails; keep expiry short (minutes, not days); return JSON errors as { "error": "code" } with a 4xx/5xx status so the wallet can show the member what went wrong; and never ask for anything outside the fixed message shapes — the wallet rebuilds and checks the exact text it signs.

3b+ · Tell us which members' emails you've confirmed (MineHME only)

honest.money only opens a profile for a sign-in when that profile's email is marked confirmed. Profiles that reached us marked unconfirmed stay locked until someone confirms them. MineHME can send us the members whose current email it has confirmed. Each match switches that profile from unconfirmed to confirmed — nothing else. We never change an address from this call. We skip any member whose stored email differs from yours, and refuse any address another profile uses. Each confirmed member gets a notice email from us and a 30-day watch for bounces and address changes. Needs mineHME's own site key with profiles:confirm-email (MineHME only; an Honest Money Super admin switches it on). Sign it exactly like the other signed endpoints.

POST https://honest.money/api/public/hme/profiles/email-confirmed
X-HME-Site: minehme
x-hme-timestamp: <Unix seconds>
x-hme-nonce: <new UUID>
x-hme-signature: <HMAC-SHA256 hex of timestamp.nonce.rawBody>

{ "batch_id": "confirm-2026-11-18-01",
  "confirmations": [ { "hme_miner_id": "<member ID>", "email": "member@example.com" } ] }   // up to 500 per call

→ 200 { "ok": true, "confirmed": 498, "already_confirmed": 1,
        "skipped": [ { "hme_miner_id": "<id>", "result": "email_mismatch" } ] }
   result: not_found | email_mismatch | email_in_use | invalid

Only send members whose email you have actually confirmed (they proved they own the inbox). Also please send email_verified: true on new profiles you create once you've confirmed them, so new members don't arrive locked. For email_mismatch, the addresses differ between our two sites. Ask support to use Change email in Admin → Members.

3c · Share your events (Hub calendar)

Send your upcoming calls, launches, meetups and webinars and they appear on honest.money/hub/calendar. Use the same shared secret as sign-in, from your server only. Send whenever something changes — or just send your full upcoming list once a day.

POST https://honest.money/api/public/hub/calendar
Authorization: Bearer <shared ecosystem secret>
Content-Type: application/json

{
  "service": "zerochill",            // your lowercase site name, same every time
  "events": [{
    "id": "evt-123",                 // YOUR id for this event — never change it
    "title": "Zero Chill Miner Call",
    "starts_at": "2026-10-14T19:00:00-05:00",   // include the time zone
    "ends_at": "2026-10-14T20:00:00-05:00",     // optional
    "all_day": false,
    "description": "Weekly update for miners",
    "location": "Zoom",
    "url": "https://zerochill.com/call",
    "category": "call",              // event | call | live | meetup | launch | webinar | other
    "format": "in_person",           // online | in_person | hybrid  (powers calendar filters)
    "access": "public",              // public | private | invite_only
    "cost": "free",                  // free | paid
    "price": "$25",                  // optional, shown when paid
    "zip": "77550",                  // optional, US ZIP for in-person — enables "distance from me"
    "lat": 29.29, "lng": -94.79,     // optional, more precise than ZIP
    "audience": "Silver Guards",     // optional: who it's for
    "rsvp_required": true, "capacity": 40, "spots_left": 23,  // optional
    "status": "published"            // published | cancelled | deleted
  }]
}
  • Updating: send the same id again with new details — it replaces the old copy, never duplicates.
  • Cancelling: "status": "cancelled" shows it crossed out; "deleted" removes it.
  • Duplicates across sites: if two sites send the same event (same title, start within 30 minutes) we show it once.
  • Up to 500 events per request. Reply: { "ok": true, "saved": 1, "deleted": 0 }.

3d · Share your news & notices (Hub news)

Post announcements, release notes, maintenance windows and other notices and they appear on honest.money/hub/news. Same shared secret, from your server only.

POST https://honest.money/api/public/hub/news
Authorization: Bearer <shared ecosystem secret>
Content-Type: application/json

{
  "service": "zerochill",               // your lowercase site name, same every time
  "items": [{
    "id": "post-42",                    // YOUR id — never change it
    "title": "Node upgrade Saturday",
    "summary": "Wallets may pause for ~10 minutes.",
    "url": "https://zerochill.com/news/node-upgrade",   // https only
    "kind": "notice",                   // news | notice
    "published_at": "2026-10-12T15:00:00-05:00",       // optional, defaults to now
    "expires_at": "2026-10-19T00:00:00-05:00"          // optional — auto-removes after
  }]
}
  • Updating: send the same id again — it replaces the old copy.
  • Removing: send the id with "remove": true.
  • Our admins can hide any item; hidden items stay hidden if you re-send them.
  • Up to 100 items per request. Reply: { "ok": true, "saved": 1, "removed": 0 }.

3d · Or let us come get them (event list at a standard address)

Don't want to send anything? Publish your upcoming events at this exact address on your site and we'll pick them up whenever we search the ecosystem. No secret needed — only list public events.

GET https://<your-site>/.well-known/hm-events.json

{
  "events": [ { "id": "evt-123", "title": "...", "starts_at": "2026-10-14T19:00:00-05:00", ... } ]
}
// Same fields as 3c. Or serve a normal calendar file (.ics) at that address.
  • Where we look: every site approved for "Sign in with Honest Money" is checked at that address automatically.
  • Already have a Google/Outlook calendar? Send its public calendar link (.ics) to support@honest.money and we'll add it.
  • Keep each event's id the same forever so updates replace, not duplicate. Include the time zone in every time.
  • We only read events from the last 45 days through the next 6 months, up to 500 per site. The address must answer within 6 seconds.

Profile changes

honest.money is where members edit their profile

Members (and our admins) change names, phone numbers, emails and account status here. Whenever that happens we send the change straight to every site that keeps its own copy of the member. Mining sites (mineTXC, Iskander, Zero Chill) get it now. Any other ecosystem site that stores member details can get the same updates — build the endpoint below and email support@honest.money to be added.

POST https://<your-site>/api/public/minehme/profile-update
Authorization: Bearer <your site’s HME_ECOSYSTEM>
X-HME-Site: <your stable site code>
// Requires profiles:push; destination verifies its own key.
Content-Type: application/json

{ "minerId": "<member ID>", "status": "blocked" }
  • minerId is always sent — the same permanent member ID you get from sign-in. Look members up by it.
  • Only the changed fields are sent: status, fullName, mobile, newEmail.
  • honest.money owns each member's email. We only send newEmail after the member confirmed the new address with a code we emailed to it. Apply it to your copy of that member (by minerId), and don't change member emails on your side.
  • status is one of active, blocked, ban, oceanfront. Apply it immediately — a blocked or banned member should lose access right away. Reject anything else with 400.
  • Compare the secret in constant time. Also accepted: x-minetxc-secret or Authorization: Bearer.
  • Reply 200 { "ok": true, "minerId": "…", "updated": { … } }, 404 if you don't have that member, 401 for a bad secret. We retry on errors, so the same update may arrive twice — just re-apply it.
  • Never create a member from this call. Wallets, 2FA, Telegram and contact preferences aren't sent here.
  • Sites without a member copy (they just use "Sign in with honest.money") don't need this — they always get fresh details at sign-in.

Can my site change a member's profile?

Not directly — honest.money is the single source of truth, so members can't end up with different details on different sites. Send members to https://honest.money/dashboard/account to edit. To report that a member should be blocked (fraud, abuse), email support@honest.money and an admin will change it here; the change then flows to every site automatically.

Signing out (do this or members get signed right back in)

Your sign-out only ends the session on your site — the member is still signed in at honest.money. Do both steps:

1. Sign out everywhere: after clearing your own session, send the browser to

https://honest.money/logout?return_to=https://yoursite.com/

We end the honest.money session and send them back. return_to must be an approved sign-in address (same list as SSO); otherwise they land on our sign-in page.

2. Don't auto sign-in right after a sign-out: add prompt=login

https://honest.money/sso-login?popup=1&prompt=login&return_to=https://yoursite.com/sso

With prompt=login we always show the sign-in box, even if they're already signed in. Use it on the first sign-in after a sign-out (or always, if you prefer).

Someone already signed in? Without prompt=login, a member already signed in to honest.money on that browser sees “Continue as their email” or “Use a different email” before we send them back. It's one tap, and it stops a shared family computer from signing in the wrong person. It works the same in the popup. Nothing changes in what you receive.

Link accounts by member ID, never by email. Key your accounts on the member ID in the ticket. Emails change and households share inboxes.

Ecosystem admins

Who is an admin on your site

honest.money keeps one list of who holds which admin role on each ecosystem site. We say who; your site decides what each role can do. Your site has a fixed site code (e.g. minehme, zerochill, beans) set by honest.money in Admin → SSO sites — usually your subdomain. Use it as service in every call below; it matches the site field in your sign-in ticket. Renaming your site doesn't change the code. If we ever change your code, your roles and admin list move with it — just switch the service value you send. Keep role keys stable too: admins are granted by key, so renaming a key (e.g. admin → approver) drops existing grants for it.

1. In the sign-in ticket. Every ticket now carries site and adminRoles. Roles are only filled in when the person used two-step sign-in; if they hold roles but didn't, you get adminMfaRequired: true and an empty list — treat them as a regular member.

{ "minerId": "…", "email": "…", "site": "minehme", "adminRoles": ["admin", "payouts"], … }

2. Ask us any time (recommended before sensitive actions, and hourly to catch removals). Server-side only, with the shared ecosystem secret.

POST https://honest.money/api/public/hub/admins
Authorization: Bearer <shared ecosystem secret>
{ "service": "minehme", "member_id": "<uuid>" }        // or "email"
→ { "admin": true, "roles": ["admin"], "mfa_enrolled": true, "member_found": true }

{ "service": "minehme" }                                 // whole list
→ { "admins": [{ "member_id", "email", "name", "roles": [...] }] }

3. Publish your roles so they show up as checkboxes for us. Sending the list replaces your previous one.

POST https://honest.money/api/public/hub/admin-roles
Authorization: Bearer <shared ecosystem secret>
{ "service": "minehme", "roles": [
  { "key": "admin", "label": "Full admin" },
  { "key": "payouts", "label": "Payouts", "description": "Approve and send payouts" }
] }

Only approved members can hold roles. A paused or suspended profile returns no roles. Removing someone here takes effect at their next sign-in, or right away if you check with us.

Wallet branches

Where your app builds in the wallet

Every ecosystem app gets its own reserved branch (account number) inside the member's one HME seed, so apps never collide and one wallet serves them all. Before you derive any keys, look up your app's branch here — never pick a number yourself:

GET https://honest.money/api/public/branches

Use the branch Honest Money gives you. The number on this feed is the one your app must derive; if you also have trading delegate access, it is the same number that appears in delegate_branches on the trusted-site list — the two always agree. If your app is not on the feed, you have no branch yet: ask us to reserve one before you derive anything.

Path format: m/44'/<coin>'/<branch>'. Coin numbers: TXC 696969, ISK 969696 (not Litecoin's), ZCU 60 (ZCU is an EVM chain, so it uses Ethereum's path — same 0x address as Ethereum). ZCU network: chain ID 90031273, RPC https://node-zcu.honest.money, explorer https://mempool.zerochill.com — full specs at zerochill.com/build. Branch 0 is the normal spending account — never hand out its xpub. Need a branch? Ask honest.money to reserve one; reservations are never reused.

Reserved today (TXC unless noted): 0 main spending account — never hand out its xpub; 1101 Bonfire posts (sign-in at 1101'/2'), 1102 Bonfire messaging, 1103 File Fingerprint, 1104 Passage, 1105 streamTXC, 1106 SEEDS, 1107 HME Wallet NFC tap-to-pay pocket (TXC, ISK and ZCU), 1108 Chat, 1110 cryptoPOP, 1111 Give, 1112 npGIVE. This line is a snapshot — the GET /api/public/branches feed above is always authoritative.

4 · Mailing list

Endpoint

POST https://honest.money/api/public/subscribe

Headers

Use the ecosystem key stored in your project secrets. Send it as x-subscribe-key or a Bearer token. Always send X-HME-Site: your-site-code.

Authorization: Bearer <your site’s HME_ECOSYSTEM>
X-HME-Site: <your stable site code>

Request body

{
  "email": "subscriber@example.com",
  "name": "Jane Doe",
  "source": "texitcoin.org",
  "interests": ["texitcoin", "honest-money"]
}

Available interests

  • honest-moneyHonest Money
  • texitcoinTEXITcoin
  • minehmemineHME
  • idmcIDMC
  • cold-storage-coinsCold Storage Coins

Iskander Network submissions should use source iskandernetwork.com and include interest idmc.

Example cURL

curl -X POST https://honest.money/api/public/subscribe \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your site’s HME_ECOSYSTEM>" \
  -H "X-HME-Site: <your stable site code>" \
  -d '{
    "email": "subscriber@example.com",
    "name": "Jane Doe",
    "source": "texitcoin.org",
    "interests": ["texitcoin", "honest-money"]
  }'

Example fetch

await fetch("https://honest.money/api/public/subscribe", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <your site’s HME_ECOSYSTEM>",
    "X-HME-Site": "texitcoin",
  },
  body: JSON.stringify({
    email: "subscriber@example.com",
    name: "Jane Doe",
    source: "texitcoin.org",
    interests: ["texitcoin", "honest-money"],
  }),
});

Behavior

  • Idempotent. Posting the same email again updates the record instead of duplicating it.
  • Respects unsubscribes. If the address was previously suppressed, the API will not silently reactivate it.
  • CORS enabled. The endpoint accepts cross-origin POSTs from any domain.
  • Confirmed by default. Subscribers posted through this endpoint are treated as already confirmed.

Response

{
  "ok": true,
  "id": "<subscriber-uuid>",
  "status": "active",
  "existing": false
}

Import suppressions

mineHME and mineTXC can send unsubscribes, bounces, complaints, or other addresses that must never receive a campaign. Use the same ecosystem key. Existing suppressions are preserved.

POST https://honest.money/api/public/suppressions
Authorization: Bearer <your site’s HME_ECOSYSTEM>
X-HME-Site: <your stable site code>
Content-Type: application/json

{
  "source": "mineTXC",
  "suppressions": [
    "unsubscribed@example.com",
    {
      "email": "bounced@example.com",
      "reason": "bounce",
      "notes": "Permanent bounce"
    }
  ]
}

Source is recorded as the verified stable site code. Reasons may be unsubscribe, bounce, complaint, or manual. Each request may contain up to 10,000 addresses.

Errors

  • 401 Unauthorized — missing or invalid key.
  • 400 Invalid body — malformed JSON or failing validation.
  • 503 Not configured — ecosystem key is not set on this end.