Skip to main content
POST
Store encrypted backup data

Authorizations

X-API-Key
string
header
required

API key for authentication and authorization

Body

application/json
user_identifier
string
required

User identifier (REQUIRED)

Example:

"john.doe@example.com"

verification_id
string
required

Verification ID from a previous verification. (REQUIRED) Must exist in identity_verifications table and belong to the user associated with the organisation.

Example:

"a7b8c9d0-e1f2-4345-a678-901234567890"

public_key
string
required

Public key in hexadecimal format. (REQUIRED) 32-4096 characters long.

Required string length: 32 - 4096
Pattern: ^[0-9a-fA-F]+$
Example:

"30820122300d06092a86486f70d..."

backup
object[]
required

Array of backup items to store. (REQUIRED) Allows multiple pieces of data to be backed up in a single request. Limited to a maximum of 3 items.

Required array length: 1 - 3 elements
metadata
object

Optional metadata associated with the backup. Allows custom key-value pairs.

Response

200 - application/json

Backup stored successfully

backup_type
enum<string>
required

Type of backup. Always present. Value is always "data".

Available options:
data
Example:

"data"

metadata
object
required

Metadata associated with the backup (echoed from request + enhanced with system metadata such as API key info, stored_at timestamp, and backup_items_count). Always present.

backup
object[]
required

Array of stored backup items. Each item contains the item_key, backup_id, checksum, and data_size.

Minimum array length: 1