🦸‍♂️Customers

API reference for customer-related endpoints

Add a New Customer

To add a new customer to the system, use the authenticated /customer POST endpoint. This will initialise a new customer entity and start KYC verification process. The response contains a verification URL that redirects to our KYC partner's portal for further verification.

Create new customer

Creates new customer and generates a cryptographic challenge to verify ownership of blockchain account

POSThttps://api.offblocks.xyz/v1/customers

Authorization

bearerAuth

Header parameters

Body

application/json

chainId*BlockchainAccountId (string)

Universal unique on-chain identifier of the account following CAIP-10 specification

externalId*string

Unique customer ID in a form of an external identifier. This would normally correspond to customer's ID in your system

Response

201400401409500

Successful operation

Body

application/json

id*CustomerId (string (uuid))

externalId*string

Unique customer ID in a form of an external ID

chainId*BlockchainAccountId (string)

Universal unique on-chain identifier of the account following CAIP-10 specification

status*CustomerStatus (enum)

Customer status

initiatingscreeningverifyingrejectedactiveinactive

createdAt*DateTime (string (date-time))

ISO-8601 timestamp

updatedAt*DateTime (string (date-time))

ISO-8601 timestamp

challenge*string (byte)

Base64 encoded message provided by this API for owner to sign

Request

JavaScriptCurlPython

const response = await fetch('https://api.offblocks.xyz/v1/customers', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Signature": "text",
      "Signature-Input": "text",
      "Idempotency-Key": "123e4567-e89b-12d3-a456-426614174000",
      "Content-Digest": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "chainId": "text",
      "externalId": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "text",
  "chainId": "text",
  "status": "initiating",
  "createdAt": "2024-11-21T06:40:01.712Z",
  "updatedAt": "2024-11-21T06:40:01.712Z",
  "challenge": "Ynl0ZXM="
}

Customer Entity Updates

Any internal updates to the customer entity will trigger a webhook update event. For details on how to set up and manage webhook subscriptions, please refer to Webhooks.

Blockchain Updates

In order to proceed with customer verification, a challenge needs to be signed and verified (see Blockchain Updates).

Retrieve Customer Entities

To retrieve a list of all customer entities registered for the programme, make a GET request to /customers.

Retrieve customers

Retrieves customers' details

GEThttps://api.offblocks.xyz/v1/customers

Authorization

bearerAuth

Header parameters

Response

200400401500

Successful operation

Body

application/json

id*CustomerId (string (uuid))

externalId*string

Unique customer ID in a form of an external ID

chainId*BlockchainAccountId (string)

Universal unique on-chain identifier of the account following CAIP-10 specification

status*CustomerStatus (enum)

Customer status

initiatingscreeningverifyingrejectedactiveinactive

createdAt*DateTime (string (date-time))

ISO-8601 timestamp

updatedAt*DateTime (string (date-time))

ISO-8601 timestamp

Request

JavaScriptCurlPython

const response = await fetch('https://api.offblocks.xyz/v1/customers', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "Signature": "text",
      "Signature-Input": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "text",
    "chainId": "text",
    "status": "initiating",
    "createdAt": "2024-11-21T06:40:01.712Z",
    "updatedAt": "2024-11-21T06:40:01.712Z"
  }
]

Retrieve an Individual Customer

To retrieve information about an individual customer, make a GET request to /customers/{customerId} with customer ID as a path parameter.

Retrieve customer

Retrieves customer's details

GEThttps://api.offblocks.xyz/v1/customers/{customerId}

Authorization

bearerAuth

Path parameters

customerId*CustomerId (string (uuid))

ID of customer to be retrieved

Header parameters

Response

200400401404500

Successful operation

Body

application/json

id*CustomerId (string (uuid))

externalId*string

Unique customer ID in a form of an external ID

chainId*BlockchainAccountId (string)

Universal unique on-chain identifier of the account following CAIP-10 specification

status*CustomerStatus (enum)

Customer status

initiatingscreeningverifyingrejectedactiveinactive

createdAt*DateTime (string (date-time))

ISO-8601 timestamp

updatedAt*DateTime (string (date-time))

ISO-8601 timestamp

Request

JavaScriptCurlPython

const response = await fetch('https://api.offblocks.xyz/v1/customers/{customerId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "Signature": "text",
      "Signature-Input": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "text",
  "chainId": "text",
  "status": "initiating",
  "createdAt": "2024-11-21T06:40:01.712Z",
  "updatedAt": "2024-11-21T06:40:01.712Z"
}

Deactivate a Customer

To deactivate a customer, use a PATCH request to /customers/{customerId}/deactivate. This will also deactivate all associated resources, such as accounts and cards.

Deactivate customer

Deactivates customer and all associated resources

PATCHhttps://api.offblocks.xyz/v1/customers/{customerId}/deactivate

Authorization

bearerAuth

Path parameters

customerId*CustomerId (any)

Unique customer ID

Header parameters

Response

200400401404409500

Successful operation

Body

application/json

id*CustomerId (string (uuid))

externalId*string

Unique customer ID in a form of an external ID

chainId*BlockchainAccountId (string)

Universal unique on-chain identifier of the account following CAIP-10 specification

status*CustomerStatus (enum)

Customer status

initiatingscreeningverifyingrejectedactiveinactive

createdAt*DateTime (string (date-time))

ISO-8601 timestamp

updatedAt*DateTime (string (date-time))

ISO-8601 timestamp

Request

JavaScriptCurlPython

const response = await fetch('https://api.offblocks.xyz/v1/customers/{customerId}/deactivate', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Signature": "text",
      "Signature-Input": "text",
      "Idempotency-Key": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "text",
  "chainId": "text",
  "status": "initiating",
  "createdAt": "2024-11-21T06:40:01.712Z",
  "updatedAt": "2024-11-21T06:40:01.712Z"
}

Reactivate a Customer

To reactivate a previously deactivated customer, use a PATCH request to /customers/{customerId}/activate.

Activate customer

Activates customer and all associated resources

PATCHhttps://api.offblocks.xyz/v1/customers/{customerId}/activate

Authorization

bearerAuth

Path parameters

customerId*CustomerId (any)

Unique customer ID

Header parameters

Response

200400401404409500

Successful operation

Body

application/json

id*CustomerId (string (uuid))

externalId*string

Unique customer ID in a form of an external ID

chainId*BlockchainAccountId (string)

Universal unique on-chain identifier of the account following CAIP-10 specification

status*CustomerStatus (enum)

Customer status

initiatingscreeningverifyingrejectedactiveinactive

createdAt*DateTime (string (date-time))

ISO-8601 timestamp

updatedAt*DateTime (string (date-time))

ISO-8601 timestamp

Request

JavaScriptCurlPython

const response = await fetch('https://api.offblocks.xyz/v1/customers/{customerId}/activate', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Signature": "text",
      "Signature-Input": "text",
      "Idempotency-Key": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "text",
  "chainId": "text",
  "status": "initiating",
  "createdAt": "2024-11-21T06:40:01.712Z",
  "updatedAt": "2024-11-21T06:40:01.712Z"
}