🆔Idempotency

The OffBlocks API supports API idempotency. This allows safe request retries (during the validity time window of the key) while only performing the requested action once.

For example, if there is a temporary connection issue, a request to create an account could be safely retried several times without creating multiple accounts.

Always use a different idempotency key for different requests

You must use different idempotency keys for different requests. Reusing the same idempotency key will cause the subsequent requests to not be executed. Reuse of an idempotency key with a different payload, while the key is still valid, results in an error.

Enabling Idempotency

To use idempotency, where required (this includes all modifying requests such as POST, PUT, PATCH and DELETE), add the Idempotency-Key header as shown in the following example endpoint. We expect a key in a format of UUID to be provided. This is automatically generated and populated for relevant requests in our Postman collection.

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

JavaScriptCurl

const response = await fetch('https://api.offblocks.xyz/v1/customers', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "chainId": "text",
      "externalId": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "text",
  "chainId": "text",
  "status": "initiating",
  "createdAt": "2024-07-27T07:15:00.916Z",
  "updatedAt": "2024-07-27T07:15:00.916Z",
  "challenge": "Ynl0ZXM="
}

Scope and Validity

Each idempotency key has a duration of 1 hour.

During the validity period, you can only send the same payload with the same idempotency key. If you do this, you receive an identical response.

If the payload is different, but the idempotency key is the same, you receive an error. The error is likely 422 or 409, explained below.

Error Handling

These are some of the common errors associated with idempotency:

Error code	Error type	Detail	Solution
400	BadRequest	Invalid request signature.	Include the Idempotency-Key header when making requests to endpoints where idempotency is mandatory.
409	Idempotency-Key Concurrency Conflict	The Idempotency-Key value is being used for a concurrent request.	You submit a new request with a different idempotency key. This error occurs because another request with the same idempotency key is in flight. If you wait until the request is no longer in flight and make the same request with the same idempotency key, you receive an identical response.
422	Idempotency-Key Reuse	The Idempotency-Key value has already been used for a different request.	Make your request with a new idempotency key. Technically, you could also wait for the validity period of the idempotency key to end after 1 hours.