π¦Accounts
API reference for account-related endpoints
Creating a New Account for a Customer
A new account for a customer can be created using the POST
endpoint: /customers/{customerId}/accounts
. .
Creates new account for the customer and generates a challenge to be signed in order to create a related blockchain account
Unique customer ID
HTTP message signature
HTTP message signature input
Idempotency key (UUID)
Content digest
Type of the account
Currencies of the account, at least one is required (ISO-4217)
POST /v1/customers/{customerId}/accounts HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Content-Digest: text
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"type": "card_account",
"currencies": [
"text"
]
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"customerId": "123e4567-e89b-12d3-a456-426614174000",
"chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
"status": "initiating",
"type": "card_account",
"currencies": [
"text"
],
"createdAt": "2025-06-27T09:35:11.687Z",
"updatedAt": "2025-06-27T09:35:11.687Z",
"challenge": "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUZZd0VBWUhLb1pJemowQ0FRWUZLNEVFQUFvRFFnQUUzTEw1RldmVFgvL3BJaXNEL0xneFVIT2lxdlFTSUVWTgpGekloOTdLZXBlWk1iZVZsUGd1akZ4Yk5MN2x1ZVhRQnBpUWUzNmZLN0xSbXZNNHdEaWZFTkE9PQotLS0tLUVORCBQVUJMSUMgS0VZLS0tLS0="
}
Account Entity Updates
Any internal updates to the account entity will be reported through webhook update events. For details on how to set up and manage webhook subscriptions, please refer to Webhooks.
Blockchain Updates
To proceed with account deployment and activation, a challenge issued by the endpoint must be signed and verified (see Blockchain Updates).
Retrieve Account Entities
To retrieve a list of all account entities registered for the programme, make a GET
request to /accounts
.
Retrieves accounts' details
HTTP message signature
HTTP message signature input
GET /v1/accounts HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"customerId": "123e4567-e89b-12d3-a456-426614174000",
"chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
"status": "initiating",
"type": "card_account",
"currencies": [
"text"
],
"createdAt": "2025-06-27T09:35:11.687Z",
"updatedAt": "2025-06-27T09:35:11.687Z"
}
]
Retrieve an Individual Customer's Accounts
To retrieve information about an individual customer's accounts, make a GET
request to /customers/{customerId}/account
with the customer ID as a path parameter.
Retrieves customer's accounts
Unique customer ID
HTTP message signature
HTTP message signature input
GET /v1/customers/{customerId}/accounts HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"customerId": "123e4567-e89b-12d3-a456-426614174000",
"chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
"status": "initiating",
"type": "card_account",
"currencies": [
"text"
],
"createdAt": "2025-06-27T09:35:11.687Z",
"updatedAt": "2025-06-27T09:35:11.687Z"
}
]
Retrieve an Individual Account
To retrieve information about an individual account, make a GET
request to /accounts/{accountId}
.
Retrieves account's details
Unique account ID
HTTP message signature
HTTP message signature input
GET /v1/accounts/{accountId} HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"customerId": "123e4567-e89b-12d3-a456-426614174000",
"chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
"status": "initiating",
"type": "card_account",
"currencies": [
"text"
],
"createdAt": "2025-06-27T09:35:11.687Z",
"updatedAt": "2025-06-27T09:35:11.687Z"
}
Deactivate an Account
To deactivate an account, use a PATCH
request to /accounts/{accountId}/deactivate
. This action will also deactivate all associated resources, such as cards.
Deactivates account and all associated resources
Unique account ID
HTTP message signature
HTTP message signature input
Idempotency key (UUID)
PATCH /v1/accounts/{accountId}/deactivate HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"customerId": "123e4567-e89b-12d3-a456-426614174000",
"chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
"status": "initiating",
"type": "card_account",
"currencies": [
"text"
],
"createdAt": "2025-06-27T09:35:11.687Z",
"updatedAt": "2025-06-27T09:35:11.687Z"
}
Reactivate an Account
To reactivate a previously deactivated account, use a PATCH
request to /accounts/{accountId}/activate
.
Activates account and all associated resources
Unique account ID
HTTP message signature
HTTP message signature input
Idempotency key (UUID)
PATCH /v1/accounts/{accountId}/activate HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"customerId": "123e4567-e89b-12d3-a456-426614174000",
"chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
"status": "initiating",
"type": "card_account",
"currencies": [
"text"
],
"createdAt": "2025-06-27T09:35:11.687Z",
"updatedAt": "2025-06-27T09:35:11.687Z"
}
Closing an Account
An account can be closed and subsequently removed from the programme using a DELETE
request to /account/{accountId}
. This will also deactivate all associated resources, including cards, and irreversibly deactivate the smart contract associated with it. All data will be preserved for audit and compliance purposes.
Closes account and generates a challenge to be signed in order to delete related blockchain account
Unique account ID
HTTP message signature
HTTP message signature input
Idempotency key (UUID)
DELETE /v1/accounts/{accountId} HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*
No content
Last updated