Planbok V2 API

Customers

Endpoint

List Customers

GET

https://api.planbok.io

/v2/customers

Returns a list of customers for the organization.

List Customers › query Parameters

page

integer

Default: 1

limit

integer

Default: 10

order

string · enum

Enum values:

asc

desc

Default: desc

List Customers › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

List Customers › Responses

200

List of customers

success

boolean

status

integer

object

message

string

object[]

Create Customer

POST

https://api.planbok.io

/v2/customers

Creates a customer profile, idempotently. If the organization already has a customer with this name and refId, the existing customer is returned and no second row is written; data.created tells you which happened, and the id is the same on every retry, so a repeated click or a retried request is safe.

Two concurrent calls with the same pair can only write one row. The losing call returns the winner, so both responses carry the same id.

The status is 201 in both cases; read data.created to distinguish a new customer from an existing one.

Create Customer › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Create Customer › Request Body

name

string · required

Name of the customer

refId

string · required

Reference ID of the customer

Create Customer › Responses

Returns the customer. data.created is true when this call wrote the row and false when an existing customer with the same name and refId was returned.

success

boolean

status

integer

message

string

object

POST/v2/customers

curl --request POST \
  --url https://api.planbok.io/v2/customers \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "name": "John Doe",
  "refId": "123e4568-e89b-12d3-a456-426614174020"
}
'

shell

Example Request Body

{
  "name": "John Doe",
  "refId": "123e4568-e89b-12d3-a456-426614174020"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "id": "69a515eeee7a220fecf3ca6f",
    "name": "John Doe",
    "refId": "123e4568-e89b-12d3-a456-426614174020",
    "custodyType": "customer",
    "status": "active",
    "hasPin": false,
    "hasRecovery": false,
    "created": true,
    "createdAt": "2026-03-02T04:45:34.674Z",
    "updatedAt": "2026-03-02T04:45:34.750Z"
  },
  "message": "Customer created successfully",
  "status": 201
}

json

application/json

Get Customer Details

GET

https://api.planbok.io

/v2/customers/{id}

Returns details for a specific customer.

Get Customer Details › path Parameters

id

string · required

Customer ID

Get Customer Details › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Get Customer Details › Responses

200

Customer details

success

boolean

status

integer

message

string

object

Initialize Customer

POST

https://api.planbok.io

/v2/customers/{id}/initialize

Starts the PIN setup process for a customer.

Initialize Customer › path Parameters

id

string · required

Customer ID

Initialize Customer › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Initialize Customer › Request Body

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

Initialize Customer › Responses

200

Initialization challenge created

success

boolean

status

integer

message

string

object

POST/v2/customers/{id}/initialize

curl --request POST \
  --url https://api.planbok.io/v2/customers/:id/initialize \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}
'

shell

Example Request Body

{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "challengeId": "69a519b8ee7a220fecf3ca75",
    "redirectUrl": "https://gateway.planbok.io/pin/setup?challenge=69a519b8ee7a220fecf3ca75&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2OWE1MTVlZWVlN2EyMjBmZWNmM2NhNmYiLCJvcmciOiI2OWExZjQ3YjA5OTNiMGQxOWY0MGU3M2MiLCJjaGFsbGVuZ2UiOiI2OWE1MTliOGVlN2EyMjBmZWNmM2NhNzUiLCJvcGVyYXRpb24iOiJzZXR1cCIsImlhdCI6MTc3MjQyNzcwNCwiZXhwIjoxNzcyNDI4NjA0fQ._EA1RzVSXYcqQ8_cCIZz0v_dUY77XHenljnf4CX0l3Q&encryptionKey=oJKmMAoyHWq3p%2F%2Fb6Zxhwvb01V5ZTcF3hgCoMmskkjY%3D&redirectUrl=https%3A%2F%2Fexample.com%2Fcustomer%2Fsetup%3Fstep%3Dverify&customerId=69a515eeee7a220fecf3ca6f",
    "status": "pending",
    "expiresAt": "2026-03-02T05:16:44.059Z"
  },
  "message": "Customer initialization challenge created successfully",
  "status": 200
}

json

application/json

Update PIN

POST

https://api.planbok.io

/v2/customers/{id}/update-pin

Starts the PIN update process for a customer.

Update PIN › path Parameters

id

string · required

Customer ID

Update PIN › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Update PIN › Request Body

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

Update PIN › Responses

200

PIN update challenge created

success

boolean

status

integer

message

string

object

POST/v2/customers/{id}/update-pin

curl --request POST \
  --url https://api.planbok.io/v2/customers/:id/update-pin \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}
'

shell

Example Request Body

{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "challengeId": "69a527c3969f8c8adc76af41",
    "redirectUrl": "https://gateway.planbok.io/pin/update?challenge=69a527c3969f8c8adc76af41&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2OWE1MTVlZWVlN2EyMjBmZWNmM2NhNmYiLCJvcmciOiI2OWExZjQ3YjA5OTNiMGQxOWY0MGU3M2MiLCJjaGFsbGVuZ2UiOiI2OWE1MjdjMzk2OWY4YzhhZGM3NmFmNDEiLCJvcGVyYXRpb24iOiJ1cGRhdGVfcGluIiwiaWF0IjoxNzcyNDMxMjk5LCJleHAiOjE3NzI0MzIxOTl9.6M070Rg2whF7zf4EpvPpPtXdnTwxFfPZrlTHsEb3ZNY&encryptionKey=83EkLCeINcwCRnshA59Avn4fkMEt5EYvWSIIrl%2BYOh0%3D&redirectUrl=https%3A%2F%2Fexample.com%2Fcustomer%2Fsetup%3Fstep%3Dverify&customerId=69a515eeee7a220fecf3ca6f",
    "status": "pending",
    "expiresAt": "2026-03-02T06:16:39.498Z"
  },
  "message": "PIN update challenge created",
  "status": 200
}

json

application/json

Reset PIN

POST

https://api.planbok.io

/v2/customers/{id}/reset-pin

Starts the PIN reset process via recovery questions.

Reset PIN › path Parameters

id

string · required

Customer ID

Reset PIN › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Reset PIN › Request Body

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

Reset PIN › Responses

200

PIN reset challenge created

success

boolean

status

integer

message

string

object

POST/v2/customers/{id}/reset-pin

curl --request POST \
  --url https://api.planbok.io/v2/customers/:id/reset-pin \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}
'

shell

Example Request Body

{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "challengeId": "69a52b5f969f8c8adc76af47",
    "redirectUrl": "https://gateway.planbok.io/pin/reset?challenge=69a52b5f969f8c8adc76af47&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2OWE1MTVlZWVlN2EyMjBmZWNmM2NhNmYiLCJvcmciOiI2OWExZjQ3YjA5OTNiMGQxOWY0MGU3M2MiLCJjaGFsbGVuZ2UiOiI2OWE1MmI1Zjk2OWY4YzhhZGM3NmFmNDciLCJvcGVyYXRpb24iOiJyZXNldCIsInJlY292ZXJ5TWV0aG9kIjoiZW1haWwiLCJpYXQiOjE3NzI0MzIyMjMsImV4cCI6MTc3MjQzMzEyM30.rjv9Ws-JtpKvfjKizew5MlnvGB9IglKeA4Pi6HMGIQ0&encryptionKey=kbmZJSSmWD30WYlDfTPYM08YrvSnfDkBm%2FT7nznPnUs%3D&redirectUrl=https%3A%2F%2Fexample.com%2Fcustomer%2Fsetup%3Fstep%3Dverify&customerId=69a515eeee7a220fecf3ca6f&method=email&initial=true",
    "status": "pending",
    "expiresAt": "2026-03-02T06:32:03.066Z"
  },
  "message": "PIN reset challenge created",
  "status": 200
}

json

application/json

Setup Recovery

POST

https://api.planbok.io

/v2/customers/{id}/recovery

Starts the recovery method setup process for a customer.

Setup Recovery › path Parameters

id

string · required

Customer ID

Setup Recovery › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Setup Recovery › Request Body

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

Setup Recovery › Responses

200

Recovery challenge created

success

boolean

status

integer

message

string

object

POST/v2/customers/{id}/recovery

curl --request POST \
  --url https://api.planbok.io/v2/customers/:id/recovery \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}
'

shell

Example Request Body

{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "challengeId": "69a51cc8ee7a220fecf3ca8b",
    "redirectUrl": "https://gateway.planbok.io/recovery/setup?challenge=69a51cc8ee7a220fecf3ca8b&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2OWE1MTVlZWVlN2EyMjBmZWNmM2NhNmYiLCJvcmciOiI2OWExZjQ3YjA5OTNiMGQxOWY0MGU3M2MiLCJjaGFsbGVuZ2UiOiI2OWE1MWNjOGVlN2EyMjBmZWNmM2NhOGIiLCJvcGVyYXRpb24iOiJzZXR1cF9yZWNvdmVyeSIsImlhdCI6MTc3MjQyODQ4OCwiZXhwIjoxNzcyNDI5Mzg4fQ.jqkXMv7RFnMOfp9Wtl62k9GsjmrVgTiy_nECMMAfYSE&encryptionKey=g7Q3tVNBqF87pvhrPVAodi%2F3tYrwxzBg7HAHQIBU2A8%3D&redirectUrl=https%3A%2F%2Fexample.com%2Fcustomer%2Fsetup%3Fstep%3Dverify&customerId=69a515eeee7a220fecf3ca6f",
    "status": "pending",
    "expiresAt": "2026-03-02T05:29:48.844Z"
  },
  "message": "Recovery setup challenge created successfully",
  "status": 200
}

json

application/json

Export Private Keys

POST

https://api.planbok.io

/v2/customers/{id}/export-private-keys

Starts a challenge for exporting the private keys of all customer wallets.

Export Private Keys › path Parameters

id

string · required

Customer ID

Export Private Keys › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Export Private Keys › Request Body

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

Export Private Keys › Responses

200

Export challenge created

success

boolean

status

integer

message

string

object

POST/v2/customers/{id}/export-private-keys

curl --request POST \
  --url https://api.planbok.io/v2/customers/:id/export-private-keys \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "redirectUrl": "https://example.com/customer/export?step=verify"
}
'

shell

Example Request Body

{
  "redirectUrl": "https://example.com/customer/export?step=verify"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "challengeId": "69a5368e969f8c8adc76af4e",
    "redirectUrl": "https://gateway.planbok.io/pin/verify?challenge=69a5368e969f8c8adc76af4e&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2OWE1MTVlZWVlN2EyMjBmZWNmM2NhNmYiLCJvcmciOiI2OWExZjQ3YjA5OTNiMGQxOWY0MGU3M2MiLCJjaGFsbGVuZ2UiOiI2OWE1MzY4ZTk2OWY4YzhhZGM3NmFmNDUiLCJvcGVyYXRpb24iOiJ2ZXJpZnkiLCJpYXQiOjE3NzI0MzUwODcsImV4cCI6MTc3MjQzNTk4N30.Z90f6ki2fJC0EM7HH9VR5aQgRoHK3SYPlltboMJrEVI&encryptionKey=CWBRbcKvRkpLD8bwkFpil31hUQQSrG6fK7J16utqlkE%3D&redirectUrl=https%3A%2F%2Fexample.com%2Fcustomer%2Fexport%3Fstep%3Dverify&customerId=69a515eeee7a220fecf3ca6f&task=export-private-keys",
    "status": "pending",
    "expiresAt": "2026-03-02T05:29:48.844Z"
  },
  "message": "Export private keys challenge created",
  "status": 200
}

json

application/json

Virtual Accounts Wallets

Planbok V2 API

Customers

Endpoint

List Customers

GET

https://api.planbok.io

/v2/customers

Returns a list of customers for the organization.

List Customers › query Parameters

page

integer

Default: 1

limit

integer

Default: 10

order

string · enum

Enum values:

asc

desc

Default: desc

List Customers › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

List Customers › Responses

200

List of customers

success

boolean

status

integer

object

message

string

object[]

Create Customer

POST

https://api.planbok.io

/v2/customers

Two concurrent calls with the same pair can only write one row. The losing call returns the winner, so both responses carry the same id.

The status is 201 in both cases; read data.created to distinguish a new customer from an existing one.

Create Customer › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Create Customer › Request Body

name

string · required

Name of the customer

refId

string · required

Reference ID of the customer

Create Customer › Responses

Returns the customer. data.created is true when this call wrote the row and false when an existing customer with the same name and refId was returned.

success

boolean

status

integer

message

string

object

POST/v2/customers

curl --request POST \
  --url https://api.planbok.io/v2/customers \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "name": "John Doe",
  "refId": "123e4568-e89b-12d3-a456-426614174020"
}
'

shell

Example Request Body

{
  "name": "John Doe",
  "refId": "123e4568-e89b-12d3-a456-426614174020"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "id": "69a515eeee7a220fecf3ca6f",
    "name": "John Doe",
    "refId": "123e4568-e89b-12d3-a456-426614174020",
    "custodyType": "customer",
    "status": "active",
    "hasPin": false,
    "hasRecovery": false,
    "created": true,
    "createdAt": "2026-03-02T04:45:34.674Z",
    "updatedAt": "2026-03-02T04:45:34.750Z"
  },
  "message": "Customer created successfully",
  "status": 201
}

json

application/json

Get Customer Details

GET

https://api.planbok.io

/v2/customers/{id}

Returns details for a specific customer.

Get Customer Details › path Parameters

id

string · required

Customer ID

Get Customer Details › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Get Customer Details › Responses

200

Customer details

success

boolean

status

integer

message

string

object

Initialize Customer

POST

https://api.planbok.io

/v2/customers/{id}/initialize

Starts the PIN setup process for a customer.

Initialize Customer › path Parameters

id

string · required

Customer ID

Initialize Customer › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Initialize Customer › Request Body

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

Initialize Customer › Responses

200

Initialization challenge created

success

boolean

status

integer

message

string

object

POST/v2/customers/{id}/initialize

curl --request POST \
  --url https://api.planbok.io/v2/customers/:id/initialize \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}
'

shell

Example Request Body

{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "challengeId": "69a519b8ee7a220fecf3ca75",
    "redirectUrl": "https://gateway.planbok.io/pin/setup?challenge=69a519b8ee7a220fecf3ca75&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2OWE1MTVlZWVlN2EyMjBmZWNmM2NhNmYiLCJvcmciOiI2OWExZjQ3YjA5OTNiMGQxOWY0MGU3M2MiLCJjaGFsbGVuZ2UiOiI2OWE1MTliOGVlN2EyMjBmZWNmM2NhNzUiLCJvcGVyYXRpb24iOiJzZXR1cCIsImlhdCI6MTc3MjQyNzcwNCwiZXhwIjoxNzcyNDI4NjA0fQ._EA1RzVSXYcqQ8_cCIZz0v_dUY77XHenljnf4CX0l3Q&encryptionKey=oJKmMAoyHWq3p%2F%2Fb6Zxhwvb01V5ZTcF3hgCoMmskkjY%3D&redirectUrl=https%3A%2F%2Fexample.com%2Fcustomer%2Fsetup%3Fstep%3Dverify&customerId=69a515eeee7a220fecf3ca6f",
    "status": "pending",
    "expiresAt": "2026-03-02T05:16:44.059Z"
  },
  "message": "Customer initialization challenge created successfully",
  "status": 200
}

json

application/json

Update PIN

POST

https://api.planbok.io

/v2/customers/{id}/update-pin

Starts the PIN update process for a customer.

Update PIN › path Parameters

id

string · required

Customer ID

Update PIN › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Update PIN › Request Body

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

Update PIN › Responses

200

PIN update challenge created

success

boolean

status

integer

message

string

object

POST/v2/customers/{id}/update-pin

curl --request POST \
  --url https://api.planbok.io/v2/customers/:id/update-pin \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}
'

shell

Example Request Body

{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "challengeId": "69a527c3969f8c8adc76af41",
    "redirectUrl": "https://gateway.planbok.io/pin/update?challenge=69a527c3969f8c8adc76af41&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2OWE1MTVlZWVlN2EyMjBmZWNmM2NhNmYiLCJvcmciOiI2OWExZjQ3YjA5OTNiMGQxOWY0MGU3M2MiLCJjaGFsbGVuZ2UiOiI2OWE1MjdjMzk2OWY4YzhhZGM3NmFmNDEiLCJvcGVyYXRpb24iOiJ1cGRhdGVfcGluIiwiaWF0IjoxNzcyNDMxMjk5LCJleHAiOjE3NzI0MzIxOTl9.6M070Rg2whF7zf4EpvPpPtXdnTwxFfPZrlTHsEb3ZNY&encryptionKey=83EkLCeINcwCRnshA59Avn4fkMEt5EYvWSIIrl%2BYOh0%3D&redirectUrl=https%3A%2F%2Fexample.com%2Fcustomer%2Fsetup%3Fstep%3Dverify&customerId=69a515eeee7a220fecf3ca6f",
    "status": "pending",
    "expiresAt": "2026-03-02T06:16:39.498Z"
  },
  "message": "PIN update challenge created",
  "status": 200
}

json

application/json

Reset PIN

POST

https://api.planbok.io

/v2/customers/{id}/reset-pin

Starts the PIN reset process via recovery questions.

Reset PIN › path Parameters

id

string · required

Customer ID

Reset PIN › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Reset PIN › Request Body

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

Reset PIN › Responses

200

PIN reset challenge created

success

boolean

status

integer

message

string

object

POST/v2/customers/{id}/reset-pin

curl --request POST \
  --url https://api.planbok.io/v2/customers/:id/reset-pin \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}
'

shell

Example Request Body

{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "challengeId": "69a52b5f969f8c8adc76af47",
    "redirectUrl": "https://gateway.planbok.io/pin/reset?challenge=69a52b5f969f8c8adc76af47&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2OWE1MTVlZWVlN2EyMjBmZWNmM2NhNmYiLCJvcmciOiI2OWExZjQ3YjA5OTNiMGQxOWY0MGU3M2MiLCJjaGFsbGVuZ2UiOiI2OWE1MmI1Zjk2OWY4YzhhZGM3NmFmNDciLCJvcGVyYXRpb24iOiJyZXNldCIsInJlY292ZXJ5TWV0aG9kIjoiZW1haWwiLCJpYXQiOjE3NzI0MzIyMjMsImV4cCI6MTc3MjQzMzEyM30.rjv9Ws-JtpKvfjKizew5MlnvGB9IglKeA4Pi6HMGIQ0&encryptionKey=kbmZJSSmWD30WYlDfTPYM08YrvSnfDkBm%2FT7nznPnUs%3D&redirectUrl=https%3A%2F%2Fexample.com%2Fcustomer%2Fsetup%3Fstep%3Dverify&customerId=69a515eeee7a220fecf3ca6f&method=email&initial=true",
    "status": "pending",
    "expiresAt": "2026-03-02T06:32:03.066Z"
  },
  "message": "PIN reset challenge created",
  "status": 200
}

json

application/json

Setup Recovery

POST

https://api.planbok.io

/v2/customers/{id}/recovery

Starts the recovery method setup process for a customer.

Setup Recovery › path Parameters

id

string · required

Customer ID

Setup Recovery › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Setup Recovery › Request Body

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

Setup Recovery › Responses

200

Recovery challenge created

success

boolean

status

integer

message

string

object

POST/v2/customers/{id}/recovery

curl --request POST \
  --url https://api.planbok.io/v2/customers/:id/recovery \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}
'

shell

Example Request Body

{
  "redirectUrl": "https://example.com/customer/setup?step=verify"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "challengeId": "69a51cc8ee7a220fecf3ca8b",
    "redirectUrl": "https://gateway.planbok.io/recovery/setup?challenge=69a51cc8ee7a220fecf3ca8b&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2OWE1MTVlZWVlN2EyMjBmZWNmM2NhNmYiLCJvcmciOiI2OWExZjQ3YjA5OTNiMGQxOWY0MGU3M2MiLCJjaGFsbGVuZ2UiOiI2OWE1MWNjOGVlN2EyMjBmZWNmM2NhOGIiLCJvcGVyYXRpb24iOiJzZXR1cF9yZWNvdmVyeSIsImlhdCI6MTc3MjQyODQ4OCwiZXhwIjoxNzcyNDI5Mzg4fQ.jqkXMv7RFnMOfp9Wtl62k9GsjmrVgTiy_nECMMAfYSE&encryptionKey=g7Q3tVNBqF87pvhrPVAodi%2F3tYrwxzBg7HAHQIBU2A8%3D&redirectUrl=https%3A%2F%2Fexample.com%2Fcustomer%2Fsetup%3Fstep%3Dverify&customerId=69a515eeee7a220fecf3ca6f",
    "status": "pending",
    "expiresAt": "2026-03-02T05:29:48.844Z"
  },
  "message": "Recovery setup challenge created successfully",
  "status": 200
}

json

application/json

Export Private Keys

POST

https://api.planbok.io

/v2/customers/{id}/export-private-keys

Starts a challenge for exporting the private keys of all customer wallets.

Export Private Keys › path Parameters

id

string · required

Customer ID

Export Private Keys › Headers

PLANBOK-X-API-KEY

string · required

API key for authentication

Export Private Keys › Request Body

redirectUrl

string · uri · required

URL to redirect to after challenge completion.

Export Private Keys › Responses

200

Export challenge created

success

boolean

status

integer

message

string

object

POST/v2/customers/{id}/export-private-keys

curl --request POST \
  --url https://api.planbok.io/v2/customers/:id/export-private-keys \
  --header 'Content-Type: application/json' \
  --header 'PLANBOK-X-API-KEY: <string>' \
  --data '
{
  "redirectUrl": "https://example.com/customer/export?step=verify"
}
'

shell

Example Request Body

{
  "redirectUrl": "https://example.com/customer/export?step=verify"
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "challengeId": "69a5368e969f8c8adc76af4e",
    "redirectUrl": "https://gateway.planbok.io/pin/verify?challenge=69a5368e969f8c8adc76af4e&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2OWE1MTVlZWVlN2EyMjBmZWNmM2NhNmYiLCJvcmciOiI2OWExZjQ3YjA5OTNiMGQxOWY0MGU3M2MiLCJjaGFsbGVuZ2UiOiI2OWE1MzY4ZTk2OWY4YzhhZGM3NmFmNDUiLCJvcGVyYXRpb24iOiJ2ZXJpZnkiLCJpYXQiOjE3NzI0MzUwODcsImV4cCI6MTc3MjQzNTk4N30.Z90f6ki2fJC0EM7HH9VR5aQgRoHK3SYPlltboMJrEVI&encryptionKey=CWBRbcKvRkpLD8bwkFpil31hUQQSrG6fK7J16utqlkE%3D&redirectUrl=https%3A%2F%2Fexample.com%2Fcustomer%2Fexport%3Fstep%3Dverify&customerId=69a515eeee7a220fecf3ca6f&task=export-private-keys",
    "status": "pending",
    "expiresAt": "2026-03-02T05:29:48.844Z"
  },
  "message": "Export private keys challenge created",
  "status": 200
}

json

application/json

Virtual Accounts Wallets