Planbok V2 API

Signing

Endpoint

Sign message

POST

https://api.planbok.io

/v2/organization/sign/message

Signs a message using an organizational wallet.

Sign message › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign message › Request Body

walletId

string · required

Wallet ID

message

string · required

Message to sign

encodedByHex

boolean

Boolean to indicate if message is hex encoded. Default is false.

Default: false

memo

string

Human readable explanation for message signing action.

encryptedOrganizationSecret

string

Required only for organizations operating in trustless MPC mode. Must be a base64 encoded ciphertext.

Sign message › Responses

200

Message signed successfully

success

boolean

status

integer

message

string

object

POST/v2/organization/sign/message

curl --request POST \
  --url https://api.planbok.io/v2/organization/sign/message \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "walletId": "69a2f6c3a80a22691f80f8a8",
  "message": "Hello World",
  "encodedByHex": false,
  "memo": "Greetings",
  "encryptedOrganizationSecret": ""
}
'

shell

Example Request Body

{
  "walletId": "69a2f6c3a80a22691f80f8a8",
  "message": "Hello World",
  "encodedByHex": false,
  "memo": "Greetings",
  "encryptedOrganizationSecret": ""
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "signature": "7e933bd43c99e6a2f96cde9a8ca7de3b9a4f1251f8a171bdc9b4777c468376000d5f2a3eaa17966676d42d6aa7a0a33e4cda7f1e6fcf2f8462abbdeeb4e753b8",
    "r": "7e933bd43c99e6a2f96cde9a8ca7de3b9a4f1251f8a171bdc9b4777c46837600",
    "s": "0d5f2a3eaa17966676d42d6aa7a0a33e4cda7f1e6fcf2f8462abbdeeb4e753b8",
    "v": 1,
    "messageHash": "0xa1de988600a42c4b4ab089b619297c17d53cffae5d5120d82d8a92d0bb3b78f2"
  },
  "message": "Message signed successfully",
  "status": 200
}

json

application/json

Sign Transaction

POST

https://api.planbok.io

/v2/organization/sign/transaction

Signs a transaction using an organizational wallet without broadcasting onchain.

Sign Transaction › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign Transaction › Request Body

walletId

string · required

Wallet ID

rawTransaction

string

Raw unsigned transaction string to sign (base64 for non-EVM, hex for EVM). Required in the absence of transaction object.

transaction

string

Transaction object (JSON string). Required in the absence of rawTransaction.

memo

string

Human readable explanation for transaction signing action.

encryptedOrganizationSecret

string

Required only for organizations operating in trustless MPC mode. Must be a base64 encoded ciphertext.

Sign Transaction › Responses

200

Transaction signed successfully

success

boolean

status

integer

object

POST/v2/organization/sign/transaction

curl --request POST \
  --url https://api.planbok.io/v2/organization/sign/transaction \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "walletId": "69a2f6c2a80a22691f80f868",
  "transaction": "{\"to\":\"0xa0780f1403419ad992cA0420AAb81a4562e179dd\",\"value\":\"1000000000000000\",\"data\":\"0x\",\"gasLimit\":\"21000\"}",
  "memo": "EVM Transfer",
  "encryptedOrganizationSecret": ""
}
'

shell

Example Request Body

{
  "walletId": "69a2f6c2a80a22691f80f868",
  "transaction": "{\"to\":\"0xa0780f1403419ad992cA0420AAb81a4562e179dd\",\"value\":\"1000000000000000\",\"data\":\"0x\",\"gasLimit\":\"21000\"}",
  "memo": "EVM Transfer",
  "encryptedOrganizationSecret": ""
}

json

application/json

Example Responses

{
  "success": true,
  "status": 0,
  "data": {
    "signedTransaction": "signedTransaction",
    "signature": {
      "signature": "signature",
      "r": "r",
      "s": "s",
      "v": 0
    },
    "memo": "memo"
  }
}

json

application/json

Sign Typed Data

POST

https://api.planbok.io

/v2/organization/sign/typed-data

Signs EIP-712 typed data using an organizational wallet.

Sign Typed Data › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign Typed Data › Request Body

walletId

string · required

Wallet ID

typedData

string · required

EIP-712 typed data (JSON string)

memo

string

Human readable explanation for typed data signing action.

encryptedOrganizationSecret

string

Required only for organizations operating in trustless MPC mode. Must be a base64 encoded ciphertext.

Sign Typed Data › Responses

200

Typed data signed successfully

success

boolean

status

integer

message

string

object

POST/v2/organization/sign/typed-data

curl --request POST \
  --url https://api.planbok.io/v2/organization/sign/typed-data \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "walletId": "69a2f6c2a80a22691f80f868",
  "typedData": "{\"types\":{\"Message\":[{\"name\":\"content\",\"type\":\"string\"},{\"name\":\"from\",\"type\":\"address\"},{\"name\":\"to\",\"type\":\"address\"}]},\"primaryType\":\"Message\",\"domain\":{\"name\":\"Planbok API Tester\",\"version\":\"1\",\"chainId\":11155111,\"verifyingContract\":\"0x0000000000000000000000000000000000000000\"},\"message\":{\"content\":\"Hello from Planbok!\",\"from\":\"0x0000000000000000000000000000000000000001\",\"to\":\"0x0000000000000000000000000000000000000000\"}}",
  "memo": "EIP-712 Signing",
  "encryptedOrganizationSecret": ""
}
'

shell

Example Request Body

{
  "walletId": "69a2f6c2a80a22691f80f868",
  "typedData": "{\"types\":{\"Message\":[{\"name\":\"content\",\"type\":\"string\"},{\"name\":\"from\",\"type\":\"address\"},{\"name\":\"to\",\"type\":\"address\"}]},\"primaryType\":\"Message\",\"domain\":{\"name\":\"Planbok API Tester\",\"version\":\"1\",\"chainId\":11155111,\"verifyingContract\":\"0x0000000000000000000000000000000000000000\"},\"message\":{\"content\":\"Hello from Planbok!\",\"from\":\"0x0000000000000000000000000000000000000001\",\"to\":\"0x0000000000000000000000000000000000000000\"}}",
  "memo": "EIP-712 Signing",
  "encryptedOrganizationSecret": ""
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "signature": "944b5d73e5270cfc77280d434b513993882d5b6ff7fd89b8bd2677ec6c01387f01333859c61ecb9bacf9239f155330e574616b57b4c7b92758b6a17ce04802dd",
    "r": "944b5d73e5270cfc77280d434b513993882d5b6ff7fd89b8bd2677ec6c01387f",
    "s": "01333859c61ecb9bacf9239f155330e574616b57b4c7b92758b6a17ce04802dd",
    "v": 0,
    "messageHash": "0x1b8014d08d054a62928b26bb9142f557a97002ec08404b52468be38bbdcdec2a",
    "memo": "EIP-712 Signing"
  },
  "message": "Typed data signed successfully",
  "status": 200
}

json

application/json

Sign Delegate Action

POST

https://api.planbok.io

/v2/organization/sign/delegate-action

Signs a delegate action (e.g., protocol delegation). This endpoint is only available for NEAR and NEAR-TESTNET at the moment.

Sign Delegate Action › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign Delegate Action › Request Body

walletId

string · required

Wallet ID

unsignedDelegateAction

string · required

Base64 encoded unsigned delegate action

encryptedOrganizationSecret

string

Required only for organizations operating in trustless MPC mode. Must be a base64 encoded ciphertext.

Sign Delegate Action › Responses

200

Delegate action signed successfully

success

boolean

status

integer

message

string

object

POST/v2/organization/sign/delegate-action

curl --request POST \
  --url https://api.planbok.io/v2/organization/sign/delegate-action \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "walletId": "69a2f6c2a80a22691f80f88d",
  "unsignedDelegateAction": "ewogICJ0byI6ICIweC4uLiIsCiAgInZhbHVlIjogIjAiLAogICJkYXRhIjogIjB4Igp9",
  "encryptedOrganizationSecret": ""
}
'

shell

Example Request Body

{
  "walletId": "69a2f6c2a80a22691f80f88d",
  "unsignedDelegateAction": "ewogICJ0byI6ICIweC4uLiIsCiAgInZhbHVlIjogIjAiLAogICJkYXRhIjogIjB4Igp9",
  "encryptedOrganizationSecret": ""
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "signedDelegateAction": "ewogICJ0byI6ICIweC4uLiIsCiAgInZhbHVlIjogIjAiLAogICJkYXRhIjogIjB4Igp9AJkquETl6x3+lXAO7kZPvRX9VIHqSy21J0WEyL0RBDgteloZ6+qt8gXmyZpn0uaYJjJlJfAVZrrWY64KvYrtEQc=",
    "signature": {
      "signature": "992ab844e5eb1dfe95700eee464fbd15fd5481ea4b2db5274584c8bd1104382d7a5a19ebeaadf205e6c99a67d2e69826326525f01566bad663ae0abd8aed1107"
    }
  },
  "message": "Delegate action signed successfully",
  "status": 200
}

json

application/json

Sign SEP10 Web Authentication Challenge

POST

https://api.planbok.io

/v2/organization/sign/web-auth-xdr

Signs SEP10 web authentication challenge to assert account identity. This endpoint is only available for Stellar Chains(XLM and XLM-TESTNET).

Sign SEP10 Web Authentication Challenge › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign SEP10 Web Authentication Challenge › Request Body

walletId

string · required

Wallet ID

challengeXdr

string · required

Base64 challenge transaction XDR received from the anchor/service.

serverAccountId

string · required

The anchor/service's known signing account (G...) - NOT the wallet's own account.

homeDomains

string · required

Expected home domain(s) - must match what the challenge actually contains.

webAuthDomain

string · required

Expected web_auth_domain, per SEP-10.

encryptedOrganizationSecret

string

Required only for organizations operating in trustless MPC mode. Must be a base64 encoded ciphertext.

Sign SEP10 Web Authentication Challenge › Responses

200

Web auth XDR data signed successfully

success

boolean

status

integer

message

string

object

POST/v2/organization/sign/web-auth-xdr

curl --request POST \
  --url https://api.planbok.io/v2/organization/sign/web-auth-xdr \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "walletId": "69a2f6c2a80a22691f80f88d",
  "challengeXdr": "AAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAZAAAAAMAAAAGAAAAAAAAAAEAAAAAAAAAAQAAAAAAAAAJAAAAAAAAAAHwXhY2AAAAQCPAo8QwsZe9FA0sz/...",
  "serverAccountId": "GANCHOR...SERVER",
  "homeDomains": "anchor.example.com",
  "webAuthDomain": "anchor.example.com",
  "encryptedOrganizationSecret": ""
}
'

shell

Example Request Body

{
  "walletId": "69a2f6c2a80a22691f80f88d",
  "challengeXdr": "AAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAZAAAAAMAAAAGAAAAAAAAAAEAAAAAAAAAAQAAAAAAAAAJAAAAAAAAAAHwXhY2AAAAQCPAo8QwsZe9FA0sz/...",
  "serverAccountId": "GANCHOR...SERVER",
  "homeDomains": "anchor.example.com",
  "webAuthDomain": "anchor.example.com",
  "encryptedOrganizationSecret": ""
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "signedChallengeXdr": "ewogICJ0byI6ICIweC4uLiIsCiAgInZhbHVlIjogIjAiLAogICJkYXRhIjogIjB4Igp9AJkquETl6x3+lXAO7kZPvRX9VIHqSy21J0WEyL0RBDgteloZ6+qt8gXmyZpn0uaYJjJlJfAVZrrWY64KvYrtEQc=",
    "signature": {
      "signature": "992ab844e5eb1dfe95700eee464fbd15fd5481ea4b2db5274584c8bd1104382d7a5a19ebeaadf205e6c99a67d2e69826326525f01566bad663ae0abd8aed1107"
    }
  },
  "message": "Web auth XDR data signed successfully",
  "status": 200
}

json

application/json

Tokens Transactions

Sign message

POST

https://api.planbok.io

/v2/organization/sign/message

Signs a message using an organizational wallet.

Sign message › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign message › Request Body

walletId

string · required

Wallet ID

message

string · required

Message to sign

encodedByHex

boolean

Boolean to indicate if message is hex encoded. Default is false.

Default: false

memo

string

Human readable explanation for message signing action.

encryptedOrganizationSecret

string

Required only for organizations operating in trustless MPC mode. Must be a base64 encoded ciphertext.

Sign message › Responses

200

Message signed successfully

success

boolean

status

integer

message

string

object

Sign Transaction

POST

https://api.planbok.io

/v2/organization/sign/transaction

Signs a transaction using an organizational wallet without broadcasting onchain.

Sign Transaction › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign Transaction › Request Body

walletId

string · required

Wallet ID

rawTransaction

string

Raw unsigned transaction string to sign (base64 for non-EVM, hex for EVM). Required in the absence of transaction object.

transaction

string

Transaction object (JSON string). Required in the absence of rawTransaction.

memo

string

Human readable explanation for transaction signing action.

encryptedOrganizationSecret

string

Required only for organizations operating in trustless MPC mode. Must be a base64 encoded ciphertext.

Sign Transaction › Responses

200

Transaction signed successfully

success

boolean

status

integer

object

Sign Typed Data

POST

https://api.planbok.io

/v2/organization/sign/typed-data

Signs EIP-712 typed data using an organizational wallet.

Sign Typed Data › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign Typed Data › Request Body

walletId

string · required

Wallet ID

typedData

string · required

EIP-712 typed data (JSON string)

memo

string

Human readable explanation for typed data signing action.

encryptedOrganizationSecret

string

Required only for organizations operating in trustless MPC mode. Must be a base64 encoded ciphertext.

Sign Typed Data › Responses

200

Typed data signed successfully

success

boolean

status

integer

message

string

object

Sign Delegate Action

POST

https://api.planbok.io

/v2/organization/sign/delegate-action

Signs a delegate action (e.g., protocol delegation). This endpoint is only available for NEAR and NEAR-TESTNET at the moment.

Sign Delegate Action › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign Delegate Action › Request Body

walletId

string · required

Wallet ID

unsignedDelegateAction

string · required

Base64 encoded unsigned delegate action

encryptedOrganizationSecret

string

Required only for organizations operating in trustless MPC mode. Must be a base64 encoded ciphertext.

Sign Delegate Action › Responses

200

Delegate action signed successfully

success

boolean

status

integer

message

string

object

Sign SEP10 Web Authentication Challenge

POST

https://api.planbok.io

/v2/organization/sign/web-auth-xdr

Signs SEP10 web authentication challenge to assert account identity. This endpoint is only available for Stellar Chains(XLM and XLM-TESTNET).

Sign SEP10 Web Authentication Challenge › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign SEP10 Web Authentication Challenge › Request Body

walletId

string · required

Wallet ID

challengeXdr

string · required

Base64 challenge transaction XDR received from the anchor/service.

serverAccountId

string · required

The anchor/service's known signing account (G...) - NOT the wallet's own account.

homeDomains

string · required

Expected home domain(s) - must match what the challenge actually contains.

webAuthDomain

string · required

Expected web_auth_domain, per SEP-10.

encryptedOrganizationSecret

string

Required only for organizations operating in trustless MPC mode. Must be a base64 encoded ciphertext.

Sign SEP10 Web Authentication Challenge › Responses

200

Web auth XDR data signed successfully

success

boolean

status

integer

message

string

object