Planbok V2 API

Challenges

Endpoint

List Challenges

GET

https://api.planbok.io

/v2/customers/{id}/challenges

Returns a list of challenges for a specific customer.

List Challenges › path Parameters

id

string · required

Customer ID

List Challenges › query Parameters

page

integer

Default: 1

limit

integer

Default: 10

order

string · enum

Enum values:

asc

desc

Default: desc

List Challenges › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

List Challenges › Responses

200

List of challenges history

success

boolean

status

integer

object

message

string

object[]

GET/v2/customers/{id}/challenges

curl --request GET \
  --url https://api.planbok.io/v2/customers/:id/challenges \
  --header 'PLANBOK-X-API-KEY: <string>'

shell

Example Responses

{
  "success": true,
  "data": [
    {
      "id": "69a55537969f8c8adc76afcf",
      "operation": "verify",
      "task": "transfer",
      "status": "pending",
      "expiresAt": "2026-03-02T09:30:35.411Z",
      "attempts": 0,
      "maxAttempts": 3,
      "redirectUrl": "https://example.com/transfer?step=verify",
      "metadata": {
        "blockchains": [],
        "walletId": "69a5380b969f8c8adc76af56",
        "destinationAddress": "0xa0780f1403419ad992cA0420AAb81a4562e179dd",
        "tokenId": "69a2f6c2a80a22691f80f86f",
        "amounts": [
          "0.0001"
        ],
        "nftTokenIds": [],
        "feeLevel": "low",
        "refId": "",
        "abiParameters": [],
        "transactionDescription": "Transfer 0.0001 ETH on Sepolia ETH to 0xa0780f..."
      },
      "createdAt": "2026-03-02T09:15:35.413Z",
      "updatedAt": "2026-03-02T09:15:35.413Z"
    },
    {
      "id": "69a5541b969f8c8adc76afb8",
      "operation": "verify",
      "task": "sign-message",
      "status": "verified",
      "expiresAt": "2026-03-02T09:25:51.703Z",
      "attempts": 0,
      "maxAttempts": 3,
      "redirectUrl": "https://example.com/sign/message?step=verify",
      "metadata": {
        "blockchains": [],
        "walletId": "69a5380b969f8c8adc76af56",
        "amounts": [],
        "nftTokenIds": [],
        "abiParameters": [],
        "message": "Hello World",
        "encodedByHex": false,
        "memo": "Testing",
        "transactionDescription": "Sign message on Sepolia ETH: \"Hello World\""
      },
      "createdAt": "2026-03-02T09:10:51.707Z",
      "updatedAt": "2026-03-02T09:10:51.707Z"
    }
  ],
  "message": "Challenges fetched successfully",
  "pagination": {
    "total": 2,
    "page": 1,
    "pages": 1
  },
  "status": 200
}

json

application/json

Get Challenge Details

GET

https://api.planbok.io

/v2/customers/{id}/challenges/{challengeId}

Returns details for a specific challenge.

Get Challenge Details › path Parameters

id

string · required

Customer ID

challengeId

string · required

Challenge ID

Get Challenge Details › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Get Challenge Details › Responses

200

Challenge details

success

boolean

status

integer

message

string

object

GET/v2/customers/{id}/challenges/{challengeId}

curl --request GET \
  --url https://api.planbok.io/v2/customers/:id/challenges/:challengeId \
  --header 'PLANBOK-X-API-KEY: <string>'

shell

Example Responses

{
  "success": true,
  "data": {
    "id": "69a55537969f8c8adc76afcf",
    "operation": "verify",
    "task": "transfer",
    "status": "pending",
    "expiresAt": "2026-03-02T09:30:35.411Z",
    "attempts": 0,
    "maxAttempts": 3,
    "redirectUrl": "https://example.com/transfer?step=verify",
    "metadata": {
      "blockchains": [],
      "walletId": "69a5380b969f8c8adc76af56",
      "destinationAddress": "0xa0780f1403419ad992cA0420AAb81a4562e179dd",
      "tokenId": "69a2f6c2a80a22691f80f86f",
      "amounts": [
        "0.0001"
      ],
      "nftTokenIds": [],
      "feeLevel": "low",
      "refId": "",
      "abiParameters": [],
      "transactionDescription": "Transfer 0.0001 ETH on Sepolia ETH to 0xa0780f..."
    },
    "createdAt": "2026-03-02T09:15:35.413Z",
    "updatedAt": "2026-03-02T09:15:35.413Z"
  },
  "message": "Challenge fetched successfully",
  "status": 200
}

json

application/json

Transactions

Planbok V2 API

Challenges

Endpoint

List Challenges

GET

https://api.planbok.io

/v2/customers/{id}/challenges

Returns a list of challenges for a specific customer.

List Challenges › path Parameters

id

string · required

Customer ID

List Challenges › query Parameters

page

integer

Default: 1

limit

integer

Default: 10

order

string · enum

Enum values:

asc

desc

Default: desc

List Challenges › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

List Challenges › Responses

200

List of challenges history

success

boolean

status

integer

object

message

string

object[]

GET/v2/customers/{id}/challenges

curl --request GET \
  --url https://api.planbok.io/v2/customers/:id/challenges \
  --header 'PLANBOK-X-API-KEY: <string>'

shell

Example Responses

{
  "success": true,
  "data": [
    {
      "id": "69a55537969f8c8adc76afcf",
      "operation": "verify",
      "task": "transfer",
      "status": "pending",
      "expiresAt": "2026-03-02T09:30:35.411Z",
      "attempts": 0,
      "maxAttempts": 3,
      "redirectUrl": "https://example.com/transfer?step=verify",
      "metadata": {
        "blockchains": [],
        "walletId": "69a5380b969f8c8adc76af56",
        "destinationAddress": "0xa0780f1403419ad992cA0420AAb81a4562e179dd",
        "tokenId": "69a2f6c2a80a22691f80f86f",
        "amounts": [
          "0.0001"
        ],
        "nftTokenIds": [],
        "feeLevel": "low",
        "refId": "",
        "abiParameters": [],
        "transactionDescription": "Transfer 0.0001 ETH on Sepolia ETH to 0xa0780f..."
      },
      "createdAt": "2026-03-02T09:15:35.413Z",
      "updatedAt": "2026-03-02T09:15:35.413Z"
    },
    {
      "id": "69a5541b969f8c8adc76afb8",
      "operation": "verify",
      "task": "sign-message",
      "status": "verified",
      "expiresAt": "2026-03-02T09:25:51.703Z",
      "attempts": 0,
      "maxAttempts": 3,
      "redirectUrl": "https://example.com/sign/message?step=verify",
      "metadata": {
        "blockchains": [],
        "walletId": "69a5380b969f8c8adc76af56",
        "amounts": [],
        "nftTokenIds": [],
        "abiParameters": [],
        "message": "Hello World",
        "encodedByHex": false,
        "memo": "Testing",
        "transactionDescription": "Sign message on Sepolia ETH: \"Hello World\""
      },
      "createdAt": "2026-03-02T09:10:51.707Z",
      "updatedAt": "2026-03-02T09:10:51.707Z"
    }
  ],
  "message": "Challenges fetched successfully",
  "pagination": {
    "total": 2,
    "page": 1,
    "pages": 1
  },
  "status": 200
}

json

application/json

Get Challenge Details

GET

https://api.planbok.io

/v2/customers/{id}/challenges/{challengeId}

Returns details for a specific challenge.

Get Challenge Details › path Parameters

id

string · required

Customer ID

challengeId

string · required

Challenge ID

Get Challenge Details › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Get Challenge Details › Responses

200

Challenge details

success

boolean

status

integer

message

string

object

GET/v2/customers/{id}/challenges/{challengeId}

curl --request GET \
  --url https://api.planbok.io/v2/customers/:id/challenges/:challengeId \
  --header 'PLANBOK-X-API-KEY: <string>'

shell

Example Responses

{
  "success": true,
  "data": {
    "id": "69a55537969f8c8adc76afcf",
    "operation": "verify",
    "task": "transfer",
    "status": "pending",
    "expiresAt": "2026-03-02T09:30:35.411Z",
    "attempts": 0,
    "maxAttempts": 3,
    "redirectUrl": "https://example.com/transfer?step=verify",
    "metadata": {
      "blockchains": [],
      "walletId": "69a5380b969f8c8adc76af56",
      "destinationAddress": "0xa0780f1403419ad992cA0420AAb81a4562e179dd",
      "tokenId": "69a2f6c2a80a22691f80f86f",
      "amounts": [
        "0.0001"
      ],
      "nftTokenIds": [],
      "feeLevel": "low",
      "refId": "",
      "abiParameters": [],
      "transactionDescription": "Transfer 0.0001 ETH on Sepolia ETH to 0xa0780f..."
    },
    "createdAt": "2026-03-02T09:15:35.413Z",
    "updatedAt": "2026-03-02T09:15:35.413Z"
  },
  "message": "Challenge fetched successfully",
  "status": 200
}

json

application/json

Transactions