Planbok V2 API

Signing

Endpoint

Sign Message Challenge

POST

https://api.planbok.io

/v2/customers/{id}/sign/message

Starts a challenge for signing a plain text or hex-encoded message with a customer wallet.

Sign Message Challenge › path Parameters

id

string · required

Customer ID

Sign Message Challenge › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign Message Challenge › Request Body

walletId

string · required

Wallet ID

message

string · required

Message to sign

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

encodedByHex

boolean

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

Default: false

memo

string

Human readable explanation for message signing action.

Sign Message Challenge › Responses

200

Sign message challenge created

success

boolean

status

integer

message

string

object

POST/v2/customers/{id}/sign/message

curl --request POST \
  --url https://api.planbok.io/v2/customers/:id/sign/message \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "walletId": "69a5380b969f8c8adc76af56",
  "message": "Hello World",
  "encodedByHex": false,
  "memo": "Testing",
  "redirectUrl": "https://example.com/sign/message?step=verify"
}
'

shell

Example Request Body

{
  "walletId": "69a5380b969f8c8adc76af56",
  "message": "Hello World",
  "encodedByHex": false,
  "memo": "Testing",
  "redirectUrl": "https://example.com/sign/message?step=verify"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "challengeId": "69a53c77969f8c8adc76af79",
    "redirectUrl": "https://gateway.planbok.io/pin/verify?challenge=69a53c77969f8c8adc76af79&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2OWE1MTVlZWVlN2EyMjBmZWNmM2NhNmYiLCJvcmciOiI2OWExZjQ3YjA5OTNiMGQxOWY0MGU3M2MiLCJjaGFsbGVuZ2UiOiI2OWE1M2M3Nzk2OWY4YzhhZGM3NmFmNzkiLCJvcGVyYXRpb24iOiJ2ZXJpZnkiLCJpYXQiOjE3NzI0MzY1OTksImV4cCI6MTc3MjQzNzQ5OX0.gnuSvOg3HAJ0OPQp3nBbsibUO2ioqD3DRNsny44vZLo&encryptionKey=RPrs2HcblYCD1LsGXRjxk3iWjmbIJibpu19baRAvZRg%3D&redirectUrl=https%3A%2F%2Fexample.com%2Fsign%2Fmessage%3Fstep%3Dverify&customerId=69a515eeee7a220fecf3ca6f&task=sign-message&walletId=69a5380b969f8c8adc76af56&message=Hello%2520World&encodedByHex=false",
    "status": "pending",
    "expiresAt": "2026-03-02T07:44:59.732Z"
  },
  "message": "Sign message challenge created",
  "status": 200
}

json

application/json

Sign Transaction Challenge

POST

https://api.planbok.io

/v2/customers/{id}/sign/transaction

Starts a challenge for signing a transaction with a customer wallet.

Sign Transaction Challenge › path Parameters

id

string · required

Customer ID

Sign Transaction Challenge › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign Transaction Challenge › Request Body

walletId

string · required

Wallet ID

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

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 message signing action.

Sign Transaction Challenge › Responses

200

Sign transaction challenge created

success

boolean

status

integer

message

string

object

POST/v2/customers/{id}/sign/transaction

curl --request POST \
  --url https://api.planbok.io/v2/customers/:id/sign/transaction \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "walletId": "69a5380b969f8c8adc76af56",
  "transaction": "{\"to\":\"0xa0780f1403419ad992cA0420AAb81a4562e179dd\",\"value\":\"1000000000000000\",\"data\":\"0x\",\"gasLimit\":\"21000\"}",
  "memo": "EVM Transfer",
  "redirectUrl": "https://example.com/sign/transaction?step=verify"
}
'

shell

Example Request Body

{
  "walletId": "69a5380b969f8c8adc76af56",
  "transaction": "{\"to\":\"0xa0780f1403419ad992cA0420AAb81a4562e179dd\",\"value\":\"1000000000000000\",\"data\":\"0x\",\"gasLimit\":\"21000\"}",
  "memo": "EVM Transfer",
  "redirectUrl": "https://example.com/sign/transaction?step=verify"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "challengeId": "69a5411d969f8c8adc76af85",
    "redirectUrl": "https://gateway.planbok.io/pin/verify?challenge=69a5411d969f8c8adc76af85&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2OWE1MTVlZWVlN2EyMjBmZWNmM2NhNmYiLCJvcmciOiI2OWExZjQ3YjA5OTNiMGQxOWY0MGU3M2MiLCJjaGFsbGVuZ2UiOiI2OWE1NDExZDk2OWY4YzhhZGM3NmFmODUiLCJvcGVyYXRpb24iOiJ2ZXJpZnkiLCJpYXQiOjE3NzI0Mzc3ODksImV4cCI6MTc3MjQzODY4OX0.sfqDlm5KNse1rpT55wkPIGeYJ7ARSYPcOiyP9cogkHY&encryptionKey=rjHDkkgA48moF7DOzcfrrsNa1FDZx9qWYfIr%2BCFnxnc%3D&redirectUrl=https%3A%2F%2Fexample.com%2Fsign%2Ftransaction%3Fstep%3Dverify&customerId=69a515eeee7a220fecf3ca6f&task=sign-transaction&walletId=69a5380b969f8c8adc76af56&transaction=%257B%2522to%2522%253A%25220xa0780f1403419ad992cA0420AAb81a4562e179dd%2522%252C%2522value%2522%253A%25221000000000000000%2522%252C%2522data%2522%253A%25220x%2522%252C%2522gasLimit%2522%253A%252221000%2522%257D",
    "status": "pending",
    "expiresAt": "2026-03-02T08:04:49.252Z"
  },
  "message": "Sign transaction challenge created",
  "status": 200
}

json

application/json

Sign Typed Data Challenge

POST

https://api.planbok.io

/v2/customers/{id}/sign/typed-data

Starts a challenge for signing EIP-712 typed data.

Sign Typed Data Challenge › path Parameters

id

string · required

Customer ID

Sign Typed Data Challenge › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign Typed Data Challenge › Request Body

walletId

string · required

Wallet ID

typedData

string · required

EIP-712 typed data (JSON string)

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

memo

string

Human readable explanation for typed data signing action.

Sign Typed Data Challenge › Responses

200

Sign typed data challenge created

success

boolean

status

integer

message

string

object

POST/v2/customers/{id}/sign/typed-data

curl --request POST \
  --url https://api.planbok.io/v2/customers/:id/sign/typed-data \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "walletId": "69a5380b969f8c8adc76af56",
  "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",
  "redirectUrl": "https://example.com/sign/typed-data?step=verify"
}
'

shell

Example Request Body

{
  "walletId": "69a5380b969f8c8adc76af56",
  "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",
  "redirectUrl": "https://example.com/sign/typed-data?step=verify"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "challengeId": "69a545c5969f8c8adc76af8e",
    "redirectUrl": "https://gateway.planbok.io/pin/verify?challenge=69a545c5969f8c8adc76af8e&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2OWE1MTVlZWVlN2EyMjBmZWNmM2NhNmYiLCJvcmciOiI2OWExZjQ3YjA5OTNiMGQxOWY0MGU3M2MiLCJjaGFsbGVuZ2UiOiI2OWE1NDVjNTk2OWY4YzhhZGM3NmFmOGUiLCJvcGVyYXRpb24iOiJ2ZXJpZnkiLCJpYXQiOjE3NzI0Mzg5ODEsImV4cCI6MTc3MjQzOTg4MX0.G1Zp0lxwlkhU66bNPaJm_2BHkByqywGT_P-leZtfIFU&encryptionKey=QH4rFex0mWT%2FMWqOXU3IvG30gVm4eFh7OF60DZCVE5w%3D&redirectUrl=https%3A%2F%2Fexample.com%2Fsign%2Ftyped-data%3Fstep%3Dverify&customerId=69a515eeee7a220fecf3ca6f&task=sign-typed-data&walletId=69a5380b969f8c8adc76af56&typedData=%257B%2522types%2522%253A%257B%2522Message%2522%253A%255B%257B%2522name%2522%253A%2522content%2522%252C%2522type%2522%253A%2522string%2522%257D%252C%257B%2522name%2522%253A%2522from%2522%252C%2522type%2522%253A%2522address%2522%257D%252C%257B%2522name%2522%253A%2522to%2522%253A%2522address%2522%257D%255D%257D%252C%2522primaryType%2522%253A%2522Message%2522%252C%2522domain%2522%253A%257B%2522name%2522%253A%2522Planbok%2520API%2520Tester%2522%252C%2522version%2522%253A%25221%2522%252C%2522chainId%2522%253A11155111%252C%2522verifyingContract%2522%253A%25220x0000000000000000000000000000000000000000%2522%257D%252C%2522message%2522%253A%257B%2522content%2522%253A%2522Hello%2520from%2520Planbok%21%2522%252C%2522from%2522%253A%25220x0000000000000000000000000000000000000001%2522%252C%2522to%2522%253A%25220x0000000000000000000000000000000000000000%2522%257D%257D",
    "status": "pending",
    "expiresAt": "2026-03-02T08:24:41.797Z"
  },
  "message": "Sign typed data challenge created",
  "status": 200
}

json

application/json

Sign Delegate Action Challenge

POST

https://api.planbok.io

/v2/customers/{id}/sign/delegate-action

Starts a challenge for signing a protocol delegate action.

Sign Delegate Action Challenge › path Parameters

id

string · required

Customer ID

Sign Delegate Action Challenge › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign Delegate Action Challenge › Request Body

walletId

string · required

Wallet ID

unsignedDelegateAction

string · required

Base64 encoded unsigned delegate action

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

Sign Delegate Action Challenge › Responses

200

Sign delegate action challenge created

success

boolean

status

integer

message

string

object

POST/v2/customers/{id}/sign/delegate-action

curl --request POST \
  --url https://api.planbok.io/v2/customers/:id/sign/delegate-action \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "walletId": "69a5380c969f8c8adc76af6b",
  "unsignedDelegateAction": "ewogICJ0byI6ICIweC4uLiIsCiAgInZhbHVlIjogIjAiLAogICJkYXRhIjogIjB4Igp9",
  "redirectUrl": "https://example.com/sign/delegate-action?step=verify"
}
'

shell

Example Request Body

{
  "walletId": "69a5380c969f8c8adc76af6b",
  "unsignedDelegateAction": "ewogICJ0byI6ICIweC4uLiIsCiAgInZhbHVlIjogIjAiLAogICJkYXRhIjogIjB4Igp9",
  "redirectUrl": "https://example.com/sign/delegate-action?step=verify"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "challengeId": "69a54766969f8c8adc76af96",
    "redirectUrl": "https://gateway.planbok.io/pin/verify?challenge=69a54766969f8c8adc76af96&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2OWE1MTVlZWVlN2EyMjBmZWNmM2NhNmYiLCJvcmciOiI2OWExZjQ3YjA5OTNiMGQxOWY0MGU3M2MiLCJjaGFsbGVuZ2UiOiI2OWE1NDc2Njk2OWY4YzhhZGM3NmFmOTYiLCJvcGVyYXRpb24iOiJ2ZXJpZnkiLCJpYXQiOjE3NzI0MzkzOTgsImV4cCI6MTc3MjQ0MDI5OH0.JE5Ifx_GMhAefKRETvEaFypHJqWIzeWz2kc3ddw13AA&encryptionKey=RD0AQpUZ3OTkV5Hn9WBOu3eY0ux4ccRmxDMomWfJ9bc%3D&redirectUrl=https%3A%2F%2Fexample.com%2Fsign%2Fdelegate-action%3Fstep%3Dverify&customerId=69a515eeee7a220fecf3ca6f&task=sign-delegate-action&walletId=69a5380c969f8c8adc76af6b&unsignedDelegateAction=true",
    "status": "pending",
    "expiresAt": "2026-03-02T08:31:38.583Z"
  },
  "message": "Sign delegate action challenge created",
  "status": 200
}

json

application/json

Tokens Transactions

Sign Message Challenge

POST

https://api.planbok.io

/v2/customers/{id}/sign/message

Starts a challenge for signing a plain text or hex-encoded message with a customer wallet.

Sign Message Challenge › path Parameters

id

string · required

Customer ID

Sign Message Challenge › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign Message Challenge › Request Body

walletId

string · required

Wallet ID

message

string · required

Message to sign

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

encodedByHex

boolean

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

Default: false

memo

string

Human readable explanation for message signing action.

Sign Message Challenge › Responses

200

Sign message challenge created

success

boolean

status

integer

message

string

object

Sign Transaction Challenge

POST

https://api.planbok.io

/v2/customers/{id}/sign/transaction

Starts a challenge for signing a transaction with a customer wallet.

Sign Transaction Challenge › path Parameters

id

string · required

Customer ID

Sign Transaction Challenge › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign Transaction Challenge › Request Body

walletId

string · required

Wallet ID

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

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 message signing action.

Sign Transaction Challenge › Responses

200

Sign transaction challenge created

success

boolean

status

integer

message

string

object

Sign Typed Data Challenge

POST

https://api.planbok.io

/v2/customers/{id}/sign/typed-data

Starts a challenge for signing EIP-712 typed data.

Sign Typed Data Challenge › path Parameters

id

string · required

Customer ID

Sign Typed Data Challenge › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign Typed Data Challenge › Request Body

walletId

string · required

Wallet ID

typedData

string · required

EIP-712 typed data (JSON string)

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

memo

string

Human readable explanation for typed data signing action.

Sign Typed Data Challenge › Responses

200

Sign typed data challenge created

success

boolean

status

integer

message

string

object

Sign Delegate Action Challenge

POST

https://api.planbok.io

/v2/customers/{id}/sign/delegate-action

Starts a challenge for signing a protocol delegate action.

Sign Delegate Action Challenge › path Parameters

id

string · required

Customer ID

Sign Delegate Action Challenge › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Sign Delegate Action Challenge › Request Body

walletId

string · required

Wallet ID

unsignedDelegateAction

string · required

Base64 encoded unsigned delegate action

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

Sign Delegate Action Challenge › Responses

200

Sign delegate action challenge created

success

boolean

status

integer

message

string

object