Skip to main content
API docs by Redocly

FiledGr API (0.1.0)

Download OpenAPI specification:Download

The Filedgr partner API. Every endpoint is authenticated with a key/secret pair sent as the x-api-key and x-api-secret headers; there are no anonymous endpoints.

The API key is the principal. Path segments that name a user (for example /users/{user_id}/favorites) always resolve to the key holder — you cannot read or modify another user's data by changing the id.

Pagination. Most list endpoints use offset pagination (page, page_size) and return {total_records, current_page, total_pages, content}. An empty result is returned as 204 No Content with no body, not as an empty page. /me/proof-packages is the exception: it uses cursor pagination (limit, cursor) and the cursor must be treated as opaque.

Errors. Failures return {"error": "<code>", "message": "<text>"}. A 402 InsufficientCreditsError additionally carries required, balance and has_subscription. Request-validation failures, and authentication failures on the two headers above, use the {"detail": ...} shape instead. A 500 body interpolates the underlying exception text into message — log it, but never parse or branch on it.

This API is server-to-server: x-api-key and x-api-secret are not in the CORS Access-Control-Allow-Headers allowlist, so browser calls will fail preflight.

attachments

Get Data Attachments

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Add Data Attachment

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)
stream_id
required
string <uuid> (Stream Id)
ledger
required
string (Ledgers)
Enum: "XRPL" "POLYGON_ZKEVM" "POLYGON_POS" "ETHEREUM"
estimated_size
required
integer (Estimated Size) > 0

Size in bytes, must be > 0

Filename (string) or Filename (null) (Filename)
Network Owner (string) or Network Owner (null) (Network Owner)
Created By (string) or Created By (null) (Created By)
AddDataAttachmentConfig (object) or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "ledger": "XRPL",
  • "estimated_size": 0,
  • "filename": "string",
  • "network_owner": "string",
  • "created_by": "string",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "ledger": "XRPL",
  • "status": "FILEDGR_RECEIVED",
  • "presigned_urls": [
    ],
  • "public_vault": true,
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "network_owner": "string",
  • "filename": "string",
  • "tx_hash": "string",
  • "estimated_size": 0,
  • "size": 0,
  • "stream": {
    },
  • "vault": {
    },
  • "file_count": 0,
  • "files": [ ],
  • "error_message": "string",
  • "progress": [
    ],
  • "config": {
    },
  • "created_by": "string",
  • "retry": {
    }
}

Get Data Attachment

Authorizations:
api-keyapi-secret
path Parameters
data_attachment_id
required
string <uuid> (Data Attachment Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "ledger": "XRPL",
  • "status": "FILEDGR_RECEIVED",
  • "presigned_urls": [
    ],
  • "public_vault": true,
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "network_owner": "string",
  • "filename": "string",
  • "tx_hash": "string",
  • "estimated_size": 0,
  • "size": 0,
  • "stream": {
    },
  • "vault": {
    },
  • "file_count": 0,
  • "files": [ ],
  • "error_message": "string",
  • "progress": [
    ],
  • "config": {
    },
  • "created_by": "string",
  • "retry": {
    }
}

Update Data Attachment Upload

Mark the attachment's multipart upload as complete.

Without this the attachment never leaves the uploading state and is never notarised, so an integration that only had POST could create attachments it could not finish.

Authorizations:
api-keyapi-secret
path Parameters
data_attachment_id
required
string <uuid> (Data Attachment Id)
Request Body schema: application/json
required
Array
part
required
integer (Part)
Link (string) or Link (null) (Link)
Etag (string) or Etag (null) (Etag)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "ledger": "XRPL",
  • "status": "FILEDGR_RECEIVED",
  • "presigned_urls": [
    ],
  • "public_vault": true,
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "network_owner": "string",
  • "filename": "string",
  • "tx_hash": "string",
  • "estimated_size": 0,
  • "size": 0,
  • "stream": {
    },
  • "vault": {
    },
  • "file_count": 0,
  • "files": [ ],
  • "error_message": "string",
  • "progress": [
    ],
  • "config": {
    },
  • "created_by": "string",
  • "retry": {
    }
}

users

Get User

Authorizations:
api-keyapi-secret

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "first_name": "string",
  • "last_name": "string",
  • "username": "string",
  • "user_profile_picture": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "entities": [
    ],
  • "credentials": [
    ],
  • "image_upload_url": "string",
  • "image_download_url": "string",
  • "configs": {
    }
}

Update User Configs

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
Webapp Tour Completed (boolean) or Webapp Tour Completed (null) (Webapp Tour Completed)
Mobile Tour Completed (boolean) or Mobile Tour Completed (null) (Mobile Tour Completed)
Theme (string) or Theme (null) (Theme)
Language (string) or Language (null) (Language)

Responses

Request samples

Content type
application/json
{
  • "webapp_tour_completed": true,
  • "mobile_tour_completed": true,
  • "theme": "string",
  • "language": "string"
}

Response samples

Content type
application/json
{
  • "webapp_tour_completed": false,
  • "mobile_tour_completed": false,
  • "theme": "system",
  • "language": "en"
}

Get User Entities

List the entities the API key holder belongs to.

user_id in the path is decorative: the user is always the API key holder, so the path cannot be used to read somebody else's entities.

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Add Favorite

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
type
required
string (FavoriteType)
Enum: "TEMPLATE" "VAULT" "STREAM"
ref
required
string (Ref)

Responses

Request samples

Content type
application/json
{
  • "type": "TEMPLATE",
  • "ref": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "type": "TEMPLATE",
  • "ref": "string"
}

Get Favorite

Authorizations:
api-keyapi-secret
path Parameters
favorite_type
required
string (FavoriteType)
Enum: "TEMPLATE" "VAULT" "STREAM"
favorite_id
required
string <uuid> (Favorite Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "type": "TEMPLATE",
  • "ref": "string"
}

Delete Favorite

Authorizations:
api-keyapi-secret
path Parameters
favorite_type
required
string (FavoriteType)
Enum: "TEMPLATE" "VAULT" "STREAM"
favorite_id
required
string <uuid> (Favorite Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "type": "TEMPLATE",
  • "ref": "string"
}

Get Favorites

Authorizations:
api-keyapi-secret
path Parameters
favorite_type
required
string (FavoriteType)
Enum: "TEMPLATE" "VAULT" "STREAM"
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Add Invitation

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
send_email_to
required
string (Send Email To)
Invite To (string) or Invite To (null) (Invite To)

Responses

Request samples

Content type
application/json
{
  • "send_email_to": "string",
  • "invite_to": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "send_to_email": "string",
  • "email_reference": "string",
  • "invited_by": "string",
  • "invite_to": "string",
  • "status": "RECEIVED",
  • "progress": [
    ]
}

Get Invitations

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Get Invitation Statistics

Authorizations:
api-keyapi-secret

Responses

Response samples

Content type
application/json
{
  • "received": 0,
  • "sent": 0,
  • "opened": 0,
  • "clicked": 0,
  • "accepted": 0,
  • "rejected": 0
}

Get Invitation

Authorizations:
api-keyapi-secret
path Parameters
invitation_id
required
string <uuid> (Invitation Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "send_to_email": "string",
  • "email_reference": "string",
  • "invited_by": "string",
  • "invite_to": "string",
  • "status": "RECEIVED",
  • "progress": [
    ]
}

templates

Get Templates

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1
public
boolean (Public)
Default: false
search_term
string (Search Term)
Default: ""
sort_by
string (Sort By)
Default: ""
sort_type
string (Sort Type)
Default: ""

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Add Template

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)
Author (string) or Author (null) (Author)
required_streams
required
Array of strings (Required Streams)
public
boolean (Public)
Default: false
TemplateConfigDto (object) or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "author": "string",
  • "required_streams": [
    ],
  • "public": false,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "author": "string",
  • "status": "UPLOAD_PENDING",
  • "default_image": "string",
  • "default_image_cid": "string",
  • "image_upload_url": "string",
  • "public": true,
  • "required_streams": [
    ],
  • "config": {
    }
}

Get Template

Authorizations:
api-keyapi-secret
path Parameters
template_id
required
string <uuid> (Template Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "author": "string",
  • "status": "UPLOAD_PENDING",
  • "default_image": "string",
  • "default_image_cid": "string",
  • "image_upload_url": "string",
  • "public": true,
  • "required_streams": [
    ],
  • "config": {
    }
}

Delete Template

Authorizations:
api-keyapi-secret
path Parameters
template_id
required
string <uuid> (Template Id)

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Update Template

Authorizations:
api-keyapi-secret
path Parameters
template_id
required
string <uuid> (Template Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Description (string) or Description (null) (Description)
Array of Required Streams (strings) or Required Streams (null) (Required Streams)
Public (boolean) or Public (null) (Public)
TemplateConfigDto (object) or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "required_streams": [
    ],
  • "public": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "author": "string",
  • "status": "UPLOAD_PENDING",
  • "default_image": "string",
  • "default_image_cid": "string",
  • "image_upload_url": "string",
  • "public": true,
  • "required_streams": [
    ],
  • "config": {
    }
}

vaults

Get Vaults

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1
archived
boolean (Archived)
Default: false
search_term
string (Search Term)
Default: ""
sort_by
string (Sort By)
Default: ""
sort_type
string (Sort Type)
Default: ""
vault_permission_type
string (VaultPermissionType)
Enum: "OWNER" "ADMIN" "EDITOR" "VIEWER" "CUSTOM"
Array of Template Id (strings) or Template Id (null) (Template Id)

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Add Vault

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
template_id
required
string <uuid> (Template Id)
name
required
string (Name)
Description (string) or Description (null) (Description)
Ledgers (string) or null
Default: "XRPL"
Json Payload (string) or Json Payload (null) (Json Payload)
AddVaultConfiguration (object) or null

Responses

Request samples

Content type
application/json
{
  • "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  • "name": "string",
  • "description": "string",
  • "ledger": "XRPL",
  • "json_payload": "string",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  • "status": "FILEDGR_RECEIVED",
  • "ledger": "XRPL",
  • "tx_hash": "string",
  • "network_owner": "string",
  • "nft_network_issuer": "string",
  • "nft_network_owner": "string",
  • "nft_network_id": "string",
  • "cid": "string",
  • "image_cid": "string",
  • "default_image_cid": "string",
  • "metadata_cid": "string",
  • "streams": [
    ],
  • "json_payload": "string",
  • "image_upload_url": "string",
  • "custom_image": false,
  • "vault_permission_type": "OWNER",
  • "config": {
    },
  • "progress": [
    ],
  • "archived": false,
  • "error_message": "string",
  • "retry": {
    }
}

Get Vault

Authorizations:
api-keyapi-secret
path Parameters
vault_id
required
string <uuid> (Vault Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  • "status": "FILEDGR_RECEIVED",
  • "ledger": "XRPL",
  • "tx_hash": "string",
  • "network_owner": "string",
  • "nft_network_issuer": "string",
  • "nft_network_owner": "string",
  • "nft_network_id": "string",
  • "cid": "string",
  • "image_cid": "string",
  • "default_image_cid": "string",
  • "metadata_cid": "string",
  • "streams": [
    ],
  • "json_payload": "string",
  • "image_upload_url": "string",
  • "custom_image": false,
  • "vault_permission_type": "OWNER",
  • "config": {
    },
  • "progress": [
    ],
  • "archived": false,
  • "error_message": "string",
  • "retry": {
    }
}

Update Vault

Authorizations:
api-keyapi-secret
path Parameters
vault_id
required
string <uuid> (Vault Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Description (string) or Description (null) (Description)
Archived (boolean) or Archived (null) (Archived)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  • "status": "FILEDGR_RECEIVED",
  • "ledger": "XRPL",
  • "tx_hash": "string",
  • "network_owner": "string",
  • "nft_network_issuer": "string",
  • "nft_network_owner": "string",
  • "nft_network_id": "string",
  • "cid": "string",
  • "image_cid": "string",
  • "default_image_cid": "string",
  • "metadata_cid": "string",
  • "streams": [
    ],
  • "json_payload": "string",
  • "image_upload_url": "string",
  • "custom_image": false,
  • "vault_permission_type": "OWNER",
  • "config": {
    },
  • "progress": [
    ],
  • "archived": false,
  • "error_message": "string",
  • "retry": {
    }
}

Update Vault Picture Status

Authorizations:
api-keyapi-secret
path Parameters
vault_id
required
string <uuid> (Vault Id)
Request Body schema: application/json
required
status
required
string (VaultStatus)
Enum: "FILEDGR_RECEIVED" "FILEDGR_REVIEWED" "FILEDGR_IMAGE_UPLOADED" "DLT_VAULT_ID_REQUESTED" "FILEDGR_PAGE_GENERATED" "DCSTORAGE_PAGE_UPLOADED" "FILEDGR_METADATA_GENERATED" "FILEDGR_METADATA_UPLOADED" "FILEDGR_VAULT_COMPLETED" "ERROR"

Enum class representing the various statuses a NFT can have in it's lifetime

Responses

Request samples

Content type
application/json
{
  • "status": "FILEDGR_RECEIVED"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  • "status": "FILEDGR_RECEIVED",
  • "ledger": "XRPL",
  • "tx_hash": "string",
  • "network_owner": "string",
  • "nft_network_issuer": "string",
  • "nft_network_owner": "string",
  • "nft_network_id": "string",
  • "cid": "string",
  • "image_cid": "string",
  • "default_image_cid": "string",
  • "metadata_cid": "string",
  • "streams": [
    ],
  • "json_payload": "string",
  • "image_upload_url": "string",
  • "custom_image": false,
  • "vault_permission_type": "OWNER",
  • "config": {
    },
  • "progress": [
    ],
  • "archived": false,
  • "error_message": "string",
  • "retry": {
    }
}

Add Stream

Create a stream inside a vault.

Streams only exist in the context of the vault that pays for them, which is why this lives here rather than under /streams.

Authorizations:
api-keyapi-secret
path Parameters
vault_id
required
string <uuid> (Vault Id)
Request Body schema: application/json
required
mapping
required
string (Mapping)
required
Description (string) or Description (null) (Description)
required
required
boolean (Required)

Responses

Request samples

Content type
application/json
{
  • "mapping": "string",
  • "description": "string",
  • "required": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "vault_id": "432b199b-1f71-42bf-ba0b-33d512afa9de",
  • "vault_network_id": "string",
  • "asset_code": "string",
  • "description": "string",
  • "network_owner": "string",
  • "ledger": "XRPL",
  • "tx_hash": "string",
  • "status": "FILEDGR_RECEIVED",
  • "required": true,
  • "archived": false,
  • "issuer": "string",
  • "distribution_wallet": "string",
  • "mapping": "string",
  • "metadata_cid": "string",
  • "stream_permission_type": "ADMIN",
  • "progress": [
    ],
  • "retry": {
    }
}

Get Vault Data Attachments

Authorizations:
api-keyapi-secret
path Parameters
vault_id
required
string <uuid> (Vault Id)
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Add Vault Permissions

Grant a permission on a vault to another user.

The caller must be OWNER or ADMIN of the vault; that is enforced by filedgr-service-nft, which answers 404 for everything else so the existence of a vault is never leaked.

Authorizations:
api-keyapi-secret
path Parameters
vault_id
required
string <uuid> (Vault Id)
Request Body schema: application/json
required
credentials_key
required
string (Credentials Key)
credentials_type
required
string (CredentialsType)
Enum: "EMAIL" "API_KEY" "WALLET"
vault_id
required
string <uuid> (Vault Id)
type
required
string (VaultPermissionType)
Enum: "OWNER" "ADMIN" "EDITOR" "VIEWER" "CUSTOM"
action
required
string (PermissionAction)
Enum: "ADD" "REMOVE"
network
required
string (Ledgers)
Enum: "XRPL" "POLYGON_ZKEVM" "POLYGON_POS" "ETHEREUM"

Responses

Request samples

Content type
application/json
{
  • "credentials_key": "string",
  • "credentials_type": "EMAIL",
  • "vault_id": "432b199b-1f71-42bf-ba0b-33d512afa9de",
  • "type": "OWNER",
  • "action": "ADD",
  • "network": "XRPL"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "requester_entity_id": "25568e6e-472a-4fc5-94c1-b114ec061bb8",
  • "requester_wallet": "string",
  • "target_entity_id": "dae9646c-1cdc-42fb-8650-576539f0343f",
  • "target_wallet": "string",
  • "target_email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "action": "ADD",
  • "status": "FILEDGR_RECEIVED",
  • "network": "XRPL",
  • "tx_hash": "string",
  • "error_message": "string",
  • "progress": [
    ],
  • "retry": {
    },
  • "vault_id": "432b199b-1f71-42bf-ba0b-33d512afa9de",
  • "vault_network_id": "string",
  • "type": "OWNER"
}

Delete Vault Permissions

Revoke a permission previously granted on a vault.

Authorizations:
api-keyapi-secret
path Parameters
vault_id
required
string <uuid> (Vault Id)
Request Body schema: application/json
required
id
string <uuid> (Id)
requester_entity_id
required
string <uuid> (Requester Entity Id)
requester_wallet
required
string (Requester Wallet)
target_entity_id
required
string <uuid> (Target Entity Id)
target_wallet
required
string (Target Wallet)
Target Email (string) or Target Email (null) (Target Email)
created_at
string <date-time> (Created At)
action
required
string (PermissionAction)
Enum: "ADD" "REMOVE"
status
string (PermissionStatus)
Default: "FILEDGR_RECEIVED"
Enum: "FILEDGR_RECEIVED" "FILEDGR_REVIEWED" "FILEDGR_APPLIED" "DLT_COMPLETED" "FILEDGR_COMPLETED" "ERROR"

Enum class representing the various statuses a Permission can have in it's lifetime

network
required
string (Ledgers)
Enum: "XRPL" "POLYGON_ZKEVM" "POLYGON_POS" "ETHEREUM"
Tx Hash (string) or Tx Hash (null) (Tx Hash)
Error Message (string) or Error Message (null) (Error Message)
Array of Progress (objects) or Progress (null) (Progress)
RetryMetadata (object) or null
vault_id
required
string <uuid> (Vault Id)
Vault Network Id (string) or Vault Network Id (null) (Vault Network Id)
type
required
string (VaultPermissionType)
Enum: "OWNER" "ADMIN" "EDITOR" "VIEWER" "CUSTOM"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "requester_entity_id": "25568e6e-472a-4fc5-94c1-b114ec061bb8",
  • "requester_wallet": "string",
  • "target_entity_id": "dae9646c-1cdc-42fb-8650-576539f0343f",
  • "target_wallet": "string",
  • "target_email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "action": "ADD",
  • "status": "FILEDGR_RECEIVED",
  • "network": "XRPL",
  • "tx_hash": "string",
  • "error_message": "string",
  • "progress": [
    ],
  • "retry": {
    },
  • "vault_id": "432b199b-1f71-42bf-ba0b-33d512afa9de",
  • "vault_network_id": "string",
  • "type": "OWNER"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "requester_entity_id": "25568e6e-472a-4fc5-94c1-b114ec061bb8",
  • "requester_wallet": "string",
  • "target_entity_id": "dae9646c-1cdc-42fb-8650-576539f0343f",
  • "target_wallet": "string",
  • "target_email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "action": "ADD",
  • "status": "FILEDGR_RECEIVED",
  • "network": "XRPL",
  • "tx_hash": "string",
  • "error_message": "string",
  • "progress": [
    ],
  • "retry": {
    },
  • "vault_id": "432b199b-1f71-42bf-ba0b-33d512afa9de",
  • "vault_network_id": "string",
  • "type": "OWNER"
}

Get Vault Permissions

List the permissions currently held on a vault.

Authorizations:
api-keyapi-secret
path Parameters
vault_id
required
string <uuid> (Vault Id)
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

streams

Get Streams

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1
stream_permission_type
string (StreamPermissionType)
Enum: "ADMIN" "EDITOR" "VIEWER"

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Get Stream

Authorizations:
api-keyapi-secret
path Parameters
stream_id
required
string <uuid> (Stream Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "vault_id": "432b199b-1f71-42bf-ba0b-33d512afa9de",
  • "vault_network_id": "string",
  • "asset_code": "string",
  • "description": "string",
  • "network_owner": "string",
  • "ledger": "XRPL",
  • "tx_hash": "string",
  • "status": "FILEDGR_RECEIVED",
  • "required": true,
  • "archived": false,
  • "issuer": "string",
  • "distribution_wallet": "string",
  • "mapping": "string",
  • "metadata_cid": "string",
  • "stream_permission_type": "ADMIN",
  • "progress": [
    ],
  • "retry": {
    }
}

Update Stream

Authorizations:
api-keyapi-secret
path Parameters
stream_id
required
string <uuid> (Stream Id)
Request Body schema: application/json
required
Mapping (string) or Mapping (null) (Mapping)
Description (string) or Description (null) (Description)
Archived (boolean) or Archived (null) (Archived)

Responses

Request samples

Content type
application/json
{
  • "mapping": "string",
  • "description": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "vault_id": "432b199b-1f71-42bf-ba0b-33d512afa9de",
  • "vault_network_id": "string",
  • "asset_code": "string",
  • "description": "string",
  • "network_owner": "string",
  • "ledger": "XRPL",
  • "tx_hash": "string",
  • "status": "FILEDGR_RECEIVED",
  • "required": true,
  • "archived": false,
  • "issuer": "string",
  • "distribution_wallet": "string",
  • "mapping": "string",
  • "metadata_cid": "string",
  • "stream_permission_type": "ADMIN",
  • "progress": [
    ],
  • "retry": {
    }
}

Get Stream Attachments

Authorizations:
api-keyapi-secret
path Parameters
stream_code
required
string (Stream Code)
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Add Stream Permission

Grant a permission on a stream to another user.

The caller must be OWNER or ADMIN of the stream; that is enforced by filedgr-service-nft, which answers 404 for everything else so the existence of a stream is never leaked.

Authorizations:
api-keyapi-secret
path Parameters
stream_id
required
string <uuid> (Stream Id)
Request Body schema: application/json
required
credentials_key
required
string (Credentials Key)
credentials_type
required
string (CredentialsType)
Enum: "EMAIL" "API_KEY" "WALLET"
stream_id
required
string <uuid> (Stream Id)
type
required
string (StreamPermissionType)
Enum: "ADMIN" "EDITOR" "VIEWER"
action
required
string (PermissionAction)
Enum: "ADD" "REMOVE"
network
required
string (Ledgers)
Enum: "XRPL" "POLYGON_ZKEVM" "POLYGON_POS" "ETHEREUM"

Responses

Request samples

Content type
application/json
{
  • "credentials_key": "string",
  • "credentials_type": "EMAIL",
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "type": "ADMIN",
  • "action": "ADD",
  • "network": "XRPL"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "requester_entity_id": "25568e6e-472a-4fc5-94c1-b114ec061bb8",
  • "requester_wallet": "string",
  • "target_entity_id": "dae9646c-1cdc-42fb-8650-576539f0343f",
  • "target_wallet": "string",
  • "target_email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "action": "ADD",
  • "status": "FILEDGR_RECEIVED",
  • "network": "XRPL",
  • "tx_hash": "string",
  • "error_message": "string",
  • "progress": [
    ],
  • "retry": {
    },
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "stream_network_id": "string",
  • "vault_network_id": "string",
  • "type": "ADMIN"
}

Delete Stream Permission

Revoke a permission previously granted on a stream.

Authorizations:
api-keyapi-secret
path Parameters
stream_id
required
string <uuid> (Stream Id)
Request Body schema: application/json
required
id
string <uuid> (Id)
requester_entity_id
required
string <uuid> (Requester Entity Id)
requester_wallet
required
string (Requester Wallet)
target_entity_id
required
string <uuid> (Target Entity Id)
target_wallet
required
string (Target Wallet)
Target Email (string) or Target Email (null) (Target Email)
created_at
string <date-time> (Created At)
action
required
string (PermissionAction)
Enum: "ADD" "REMOVE"
status
string (PermissionStatus)
Default: "FILEDGR_RECEIVED"
Enum: "FILEDGR_RECEIVED" "FILEDGR_REVIEWED" "FILEDGR_APPLIED" "DLT_COMPLETED" "FILEDGR_COMPLETED" "ERROR"

Enum class representing the various statuses a Permission can have in it's lifetime

network
required
string (Ledgers)
Enum: "XRPL" "POLYGON_ZKEVM" "POLYGON_POS" "ETHEREUM"
Tx Hash (string) or Tx Hash (null) (Tx Hash)
Error Message (string) or Error Message (null) (Error Message)
Array of Progress (objects) or Progress (null) (Progress)
RetryMetadata (object) or null
stream_id
required
string <uuid> (Stream Id)
Stream Network Id (string) or Stream Network Id (null) (Stream Network Id)
Vault Network Id (string) or Vault Network Id (null) (Vault Network Id)
type
required
string (StreamPermissionType)
Enum: "ADMIN" "EDITOR" "VIEWER"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "requester_entity_id": "25568e6e-472a-4fc5-94c1-b114ec061bb8",
  • "requester_wallet": "string",
  • "target_entity_id": "dae9646c-1cdc-42fb-8650-576539f0343f",
  • "target_wallet": "string",
  • "target_email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "action": "ADD",
  • "status": "FILEDGR_RECEIVED",
  • "network": "XRPL",
  • "tx_hash": "string",
  • "error_message": "string",
  • "progress": [
    ],
  • "retry": {
    },
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "stream_network_id": "string",
  • "vault_network_id": "string",
  • "type": "ADMIN"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "requester_entity_id": "25568e6e-472a-4fc5-94c1-b114ec061bb8",
  • "requester_wallet": "string",
  • "target_entity_id": "dae9646c-1cdc-42fb-8650-576539f0343f",
  • "target_wallet": "string",
  • "target_email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "action": "ADD",
  • "status": "FILEDGR_RECEIVED",
  • "network": "XRPL",
  • "tx_hash": "string",
  • "error_message": "string",
  • "progress": [
    ],
  • "retry": {
    },
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "stream_network_id": "string",
  • "vault_network_id": "string",
  • "type": "ADMIN"
}

Get Stream Permissions

List the permissions currently held on a stream.

Authorizations:
api-keyapi-secret
path Parameters
stream_id
required
string <uuid> (Stream Id)
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

entities

Get User Entities

List the entities the API key holder belongs to.

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

assets

Register Asset

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
token_address
required
string (Token Address)
asset_code
required
string (Asset Code)
asset_name
required
string (Asset Name)
decimals
integer (Decimals)
Default: 18
ledger
required
string (Ledgers)
Enum: "XRPL" "POLYGON_ZKEVM" "POLYGON_POS" "ETHEREUM"
create_oracle
boolean (Create Oracle)
Default: true
Vault Id (string) or Vault Id (null) (Vault Id)

Responses

Request samples

Content type
application/json
{
  • "token_address": "string",
  • "asset_code": "string",
  • "asset_name": "string",
  • "decimals": 18,
  • "ledger": "XRPL",
  • "create_oracle": true,
  • "vault_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  • "token_address": "string",
  • "asset_code": "string",
  • "asset_name": "string",
  • "decimals": 18,
  • "ledger": "XRPL",
  • "create_oracle": true,
  • "vault_id": "string",
  • "registry_address": "string",
  • "oracle_address": "string",
  • "factory_address": "string",
  • "ownership_verified": false,
  • "status": "FILEDGR_RECEIVED",
  • "tx_hash": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "error_message": "string",
  • "retry": {
    },
  • "asset_permission_type": "OWNER"
}

Get Assets

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1
Search (string) or Search (null) (Search)
Ledgers (string) or Ledger (null) (Ledger)
AssetStatus (string) or Status Filter (null) (Status Filter)
Sort By (string) or Sort By (null) (Sort By)
Default: "created_at"
Sort Order (string) or Sort Order (null) (Sort Order)
Default: "desc"
AssetPermissionType (string) or Asset Permission Type (null) (Asset Permission Type)

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Get Asset

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  • "token_address": "string",
  • "asset_code": "string",
  • "asset_name": "string",
  • "decimals": 18,
  • "ledger": "XRPL",
  • "create_oracle": true,
  • "vault_id": "string",
  • "registry_address": "string",
  • "oracle_address": "string",
  • "factory_address": "string",
  • "ownership_verified": false,
  • "status": "FILEDGR_RECEIVED",
  • "tx_hash": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "error_message": "string",
  • "retry": {
    },
  • "asset_permission_type": "OWNER",
  • "price_types": [
    ]
}

Update Vault

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)
Request Body schema: application/json
required
vault_id
required
string (Vault Id)

Responses

Request samples

Content type
application/json
{
  • "vault_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  • "token_address": "string",
  • "asset_code": "string",
  • "asset_name": "string",
  • "decimals": 18,
  • "ledger": "XRPL",
  • "create_oracle": true,
  • "vault_id": "string",
  • "registry_address": "string",
  • "oracle_address": "string",
  • "factory_address": "string",
  • "ownership_verified": false,
  • "status": "FILEDGR_RECEIVED",
  • "tx_hash": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "error_message": "string",
  • "retry": {
    },
  • "asset_permission_type": "OWNER",
  • "price_types": [
    ]
}

Add Price Type

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)
Request Body schema: application/json
required
name
required
string (Name)
currency
string (Currency)
Default: "USD"
decimals
integer (Decimals)
Default: 8

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "currency": "USD",
  • "decimals": 8
}

Response samples

Content type
application/json
null

Get Price Types

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)

Responses

Response samples

Content type
application/json
null

Remove Price Type

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)
price_type
required
string (Price Type)

Responses

Response samples

Content type
application/json
null

Set Primary Price Type

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)
Request Body schema: application/json
required
price_type
required
string (Price Type)

Responses

Request samples

Content type
application/json
{
  • "price_type": "string"
}

Response samples

Content type
application/json
null

Process Prices

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)
Request Body schema: application/json
required
stream_id
required
string <uuid> (Stream Id)
attachment_id
required
string <uuid> (Attachment Id)

Responses

Request samples

Content type
application/json
{
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "attachment_id": "4c76e620-6daa-46e6-9da1-9ac96abab601"
}

Response samples

Content type
application/json
null

Get Latest Prices

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)

Responses

Response samples

Content type
application/json
null

Get Price Chart

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)
query Parameters
Price Type (string) or Price Type (null) (Price Type)
From Date (string) or From Date (null) (From Date)
To Date (string) or To Date (null) (To Date)

Responses

Response samples

Content type
application/json
{
  • "asset_id": "b4695157-0d1d-4da0-8f9e-5c53149389e4",
  • "series": [ ],
  • "from_date": "2019-08-24T14:15:22Z",
  • "to_date": "2019-08-24T14:15:22Z",
  • "total_data_points": 0
}

Get Prices By Type

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)
price_type
required
string (Price Type)
query Parameters
page
integer (Page)
Default: 1
page_size
integer (Page Size)
Default: 10
Sort Order (string) or Sort Order (null) (Sort Order)
Default: "desc"

Responses

Response samples

Content type
application/json
{
  • "asset_id": "b4695157-0d1d-4da0-8f9e-5c53149389e4",
  • "price_type": "string",
  • "prices": [ ],
  • "total_records": 0,
  • "current_page": 1,
  • "total_pages": 1
}

Create Ownership Challenge

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)
Request Body schema: application/json
required
claimer_address
required
string (Claimer Address)

Responses

Request samples

Content type
application/json
{
  • "claimer_address": "string"
}

Response samples

Content type
application/json
{
  • "claim_id": "6ed32748-64af-4d95-94ea-a78b6397033c",
  • "challenge_message": "string"
}

Submit Ownership Verification

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)
Request Body schema: application/json
required
claim_id
required
string <uuid> (Claim Id)
signature
required
string (Signature)

Responses

Request samples

Content type
application/json
{
  • "claim_id": "6ed32748-64af-4d95-94ea-a78b6397033c",
  • "signature": "string"
}

Response samples

Content type
application/json
null

Get Ownership Status

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)

Responses

Response samples

Content type
application/json
{
  • "asset_id": "b4695157-0d1d-4da0-8f9e-5c53149389e4",
  • "ownership_verified": true,
  • "status": "CHALLENGE_CREATED",
  • "verified_at": "2019-08-24T14:15:22Z",
  • "tx_hash": "string",
  • "error_message": "string"
}

Add Asset Permissions

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)
Request Body schema: application/json
required
credentials_key
required
string (Credentials Key)
credentials_type
required
string (CredentialsType)
Enum: "EMAIL" "API_KEY" "WALLET"
asset_id
required
string <uuid> (Asset Id)
type
required
string (AssetPermissionType)
Enum: "OWNER" "ADMIN" "EDITOR" "VIEWER"
action
required
string (PermissionAction)
Enum: "ADD" "REMOVE"
network
required
string (Ledgers)
Enum: "XRPL" "POLYGON_ZKEVM" "POLYGON_POS" "ETHEREUM"

Responses

Request samples

Content type
application/json
{
  • "credentials_key": "string",
  • "credentials_type": "EMAIL",
  • "asset_id": "b4695157-0d1d-4da0-8f9e-5c53149389e4",
  • "type": "OWNER",
  • "action": "ADD",
  • "network": "XRPL"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "requester_entity_id": "25568e6e-472a-4fc5-94c1-b114ec061bb8",
  • "requester_wallet": "string",
  • "target_entity_id": "dae9646c-1cdc-42fb-8650-576539f0343f",
  • "target_wallet": "string",
  • "target_email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "action": "ADD",
  • "status": "FILEDGR_RECEIVED",
  • "network": "XRPL",
  • "tx_hash": "string",
  • "error_message": "string",
  • "progress": [
    ],
  • "retry": {
    },
  • "asset_id": "b4695157-0d1d-4da0-8f9e-5c53149389e4",
  • "type": "OWNER"
}

Delete Asset Permissions

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)
Request Body schema: application/json
required
id
string <uuid> (Id)
requester_entity_id
required
string <uuid> (Requester Entity Id)
requester_wallet
required
string (Requester Wallet)
target_entity_id
required
string <uuid> (Target Entity Id)
target_wallet
required
string (Target Wallet)
Target Email (string) or Target Email (null) (Target Email)
created_at
string <date-time> (Created At)
action
required
string (PermissionAction)
Enum: "ADD" "REMOVE"
status
string (PermissionStatus)
Default: "FILEDGR_RECEIVED"
Enum: "FILEDGR_RECEIVED" "FILEDGR_REVIEWED" "FILEDGR_APPLIED" "DLT_COMPLETED" "FILEDGR_COMPLETED" "ERROR"

Enum class representing the various statuses a Permission can have in it's lifetime

network
required
string (Ledgers)
Enum: "XRPL" "POLYGON_ZKEVM" "POLYGON_POS" "ETHEREUM"
Tx Hash (string) or Tx Hash (null) (Tx Hash)
Error Message (string) or Error Message (null) (Error Message)
Array of Progress (objects) or Progress (null) (Progress)
RetryMetadata (object) or null
asset_id
required
string <uuid> (Asset Id)
type
required
string (AssetPermissionType)
Enum: "OWNER" "ADMIN" "EDITOR" "VIEWER"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "requester_entity_id": "25568e6e-472a-4fc5-94c1-b114ec061bb8",
  • "requester_wallet": "string",
  • "target_entity_id": "dae9646c-1cdc-42fb-8650-576539f0343f",
  • "target_wallet": "string",
  • "target_email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "action": "ADD",
  • "status": "FILEDGR_RECEIVED",
  • "network": "XRPL",
  • "tx_hash": "string",
  • "error_message": "string",
  • "progress": [
    ],
  • "retry": {
    },
  • "asset_id": "b4695157-0d1d-4da0-8f9e-5c53149389e4",
  • "type": "OWNER"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "requester_entity_id": "25568e6e-472a-4fc5-94c1-b114ec061bb8",
  • "requester_wallet": "string",
  • "target_entity_id": "dae9646c-1cdc-42fb-8650-576539f0343f",
  • "target_wallet": "string",
  • "target_email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "action": "ADD",
  • "status": "FILEDGR_RECEIVED",
  • "network": "XRPL",
  • "tx_hash": "string",
  • "error_message": "string",
  • "progress": [
    ],
  • "retry": {
    },
  • "asset_id": "b4695157-0d1d-4da0-8f9e-5c53149389e4",
  • "type": "OWNER"
}

Get Asset Permissions

Authorizations:
api-keyapi-secret
path Parameters
asset_id
required
string <uuid> (Asset Id)
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

notifications

Add Webhook Config

Add a new webhook notification configuration

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
url
required
string <uri> (Url) [ 1 .. 2083 ] characters
event_types
required
Array of strings (Event Types)
Description (string) or Description (null) (Description)
Secret (string) or Secret (null) (Secret)
Custom Headers (object) or Custom Headers (null) (Custom Headers)
Resource Filters (object) or Resource Filters (null) (Resource Filters)

Responses

Request samples

Content type
application/json
{
  • "custom_headers": {
    },
  • "description": "Production webhook for vault events",
  • "event_types": [
    ],
  • "resource_filters": {
    },
  • "secret": "my-secret-key",
  • "url": "https://my-app.com/webhooks"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  • "url": "string",
  • "event_types": [
    ],
  • "status": "ACTIVE",
  • "description": "string",
  • "secret": "string",
  • "custom_headers": {
    },
  • "resource_filters": {
    },
  • "failure_count": 0,
  • "last_success_at": "2019-08-24T14:15:22Z",
  • "last_failure_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Webhook Configs

Get all webhook configurations for the authenticated entity

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Get Webhook Config

Get a specific webhook configuration

Authorizations:
api-keyapi-secret
path Parameters
config_id
required
string <uuid> (Config Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  • "url": "string",
  • "event_types": [
    ],
  • "status": "ACTIVE",
  • "description": "string",
  • "secret": "string",
  • "custom_headers": {
    },
  • "resource_filters": {
    },
  • "failure_count": 0,
  • "last_success_at": "2019-08-24T14:15:22Z",
  • "last_failure_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Webhook Config

Update a webhook configuration

Authorizations:
api-keyapi-secret
path Parameters
config_id
required
string <uuid> (Config Id)
Request Body schema: application/json
required
Url (string) or Url (null) (Url)
Array of Event Types (strings) or Event Types (null) (Event Types)
Description (string) or Description (null) (Description)
Secret (string) or Secret (null) (Secret)
Custom Headers (object) or Custom Headers (null) (Custom Headers)
Status (string) or Status (null) (Status)
Resource Filters (object) or Resource Filters (null) (Resource Filters)

Responses

Request samples

Content type
application/json
{
  • "event_types": [
    ],
  • "status": "paused"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  • "url": "string",
  • "event_types": [
    ],
  • "status": "ACTIVE",
  • "description": "string",
  • "secret": "string",
  • "custom_headers": {
    },
  • "resource_filters": {
    },
  • "failure_count": 0,
  • "last_success_at": "2019-08-24T14:15:22Z",
  • "last_failure_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Webhook Config

Delete a webhook configuration

Authorizations:
api-keyapi-secret
path Parameters
config_id
required
string <uuid> (Config Id)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "message": "string"
}

Get Webhook Delivery History

Get delivery history for a webhook configuration

Authorizations:
api-keyapi-secret
path Parameters
config_id
required
string <uuid> (Config Id)
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Add Email Config

Add a new email notification configuration

Users can add up to 5 email addresses to receive notifications. The email address is specified in the request body.

Validation errors (400):

  • Maximum 5 email addresses allowed per user
  • Email address must be unique within the same account
Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
email_address
required
string (Email Address)
enabled
boolean (Enabled)
Default: true

Responses

Request samples

Content type
application/json
{
  • "email_address": "user@example.com",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  • "enabled": true,
  • "email_address": "string",
  • "failure_count": 0,
  • "last_success_at": "2019-08-24T14:15:22Z",
  • "last_failure_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Email Configs

Get all email configurations for the authenticated entity

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Get Email Config

Get a specific email configuration

Authorizations:
api-keyapi-secret
path Parameters
config_id
required
string <uuid> (Config Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  • "enabled": true,
  • "email_address": "string",
  • "failure_count": 0,
  • "last_success_at": "2019-08-24T14:15:22Z",
  • "last_failure_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Email Config

Update an email configuration

Authorizations:
api-keyapi-secret
path Parameters
config_id
required
string <uuid> (Config Id)
Request Body schema: application/json
required
Enabled (boolean) or Enabled (null) (Enabled)
Any of
boolean (Enabled)

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  • "enabled": true,
  • "email_address": "string",
  • "failure_count": 0,
  • "last_success_at": "2019-08-24T14:15:22Z",
  • "last_failure_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Email Config

Delete an email configuration

Authorizations:
api-keyapi-secret
path Parameters
config_id
required
string <uuid> (Config Id)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "message": "string"
}

Get Email Delivery History

Get delivery history for an email configuration

Authorizations:
api-keyapi-secret
path Parameters
config_id
required
string <uuid> (Config Id)
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Get In App Notifications

Get in-app notifications for the authenticated entity

Authorizations:
api-keyapi-secret
query Parameters
page
integer (Page)
Default: 1
page_size
integer (Page Size)
Default: 20
unread_only
boolean (Unread Only)
Default: false

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "unread_count": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Get Unread Count

Get count of unread notifications

Authorizations:
api-keyapi-secret

Responses

Response samples

Content type
application/json
{
  • "unread_count": 0
}

Mark Notification As Read

Mark a notification as read

Authorizations:
api-keyapi-secret
path Parameters
notification_id
required
string <uuid> (Notification Id)

Responses

Response samples

Content type
application/json
null

Mark All Notifications As Read

Mark all notifications as read

Authorizations:
api-keyapi-secret

Responses

Response samples

Content type
application/json
{
  • "marked_count": 0
}

Delete In App Notification

Delete a notification

Authorizations:
api-keyapi-secret
path Parameters
notification_id
required
string <uuid> (Notification Id)

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "message": "string"
}

Bulk Archive Notifications

Archive multiple notifications

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
notification_ids
required
Array of strings <uuid> (Notification Ids) [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "notification_ids": [
    ]
}

Response samples

Content type
application/json
null

Get Notification Preferences

Get notification preferences for the authenticated entity

Authorizations:
api-keyapi-secret

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  • "global_preferences": {
    },
  • "category_preferences": {
    },
  • "event_preferences": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Notification Preferences

Update notification preferences

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
GlobalPreferencesDto (object) or null
Category Preferences (object) or Category Preferences (null) (Category Preferences)
Event Preferences (object) or Event Preferences (null) (Event Preferences)

Responses

Request samples

Content type
application/json
{
  • "global_preferences": {
    },
  • "category_preferences": {
    },
  • "event_preferences": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  • "global_preferences": {
    },
  • "category_preferences": {
    },
  • "event_preferences": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Reset Notification Preferences

Reset notification preferences to default values

Authorizations:
api-keyapi-secret

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  • "global_preferences": {
    },
  • "category_preferences": {
    },
  • "event_preferences": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

signatures

Add Signatures

Submit already-signed statements for files in a stream.

A statement that does not match the stored file is a 400 and a wallet that is not permissioned for the file is a 403 - the batch is rejected as a whole rather than partially accepted, so the caller always knows exactly what was stored.

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
vault_id
required
string <uuid> (Vault Id)
vault_network_id
required
string (Vault Network Id)
stream_id
required
string <uuid> (Stream Id)
stream_network_id
required
string (Stream Network Id)
ledger
required
string (Ledgers)
Enum: "XRPL" "POLYGON_ZKEVM" "POLYGON_POS" "ETHEREUM"
visibility
string (Visibility)
Default: "PRIVATE"
Enum: "PUBLIC" "PRIVATE"

Enum class representing the visibility of resources, we created it first when developing signatures

required
Array of objects (Signatures)

Responses

Request samples

Content type
application/json
{
  • "vault_id": "432b199b-1f71-42bf-ba0b-33d512afa9de",
  • "vault_network_id": "string",
  • "stream_id": "173fd1b7-72c4-44c4-9244-55a0a167a352",
  • "stream_network_id": "string",
  • "ledger": "XRPL",
  • "visibility": "PUBLIC",
  • "signatures": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Signatures

Authorizations:
api-keyapi-secret
path Parameters
file_hash
required
string (File Hash)
stream_network_id
required
string (Stream Network Id)

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

statistics

Get Statistic By Resource

Authorizations:
api-keyapi-secret
path Parameters
resource
required
string (StatisticResourceType)
Enum: "data" "files" "permissions" "attachments"

In this enum we changed the pattern to a small casing we want to use it as a path parameter and do not want to have inconsistencies

Responses

Response samples

Content type
application/json
{
  • "resource": "data",
  • "metric": "TOTAL",
  • "value": 0,
  • "unit": "COUNT",
  • "scope": {
    },
  • "filters": {
    },
  • "window": "ALL_TIME",
  • "computed_at": "2019-08-24T14:15:22Z",
  • "sample_size": 0
}

balances

Get Balance

Authorizations:
api-keyapi-secret

Responses

Response samples

Content type
application/json
{
  • "balance": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

plans

Get Plan

Authorizations:
api-keyapi-secret
path Parameters
plan_id
required
string <uuid> (Plan Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "base_fee": 0,
  • "balance_fee": 0,
  • "total_fee": 0,
  • "balance": 0,
  • "monthly_renewable": true,
  • "yearly_renewable": true,
  • "one_time_payment": true,
  • "plan_status": "ACTIVE",
  • "type": "PERSONAL",
  • "plan_product_type": "BASE_PRODUCT"
}

Get Plans

Authorizations:
api-keyapi-secret
query Parameters
plan_type
string (PlanType)
Default: "CORPORATE"
Enum: "PERSONAL" "CORPORATE"
page
integer (Page)
Default: 1
page_size
integer (Page Size)
Default: 10
search_term
string (Search Term)
Default: ""
sort_by
string (Sort By)
Default: ""
sort_type
string (Sort Type)
Default: ""

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

subscriptions

Add Subscription

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan Id)
SubscriptionRenewalPeriod (string) or null
Default: "MONTHLY"

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "renew": "MONTHLY"
}

Response samples

Content type
application/json
{
  • "progress": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "ended_at": "2019-08-24T14:15:22Z",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "discount_in_percent": 0,
  • "renew": "DAILY",
  • "next_renewal": "2019-08-24T14:15:22Z",
  • "outstanding_payment": true,
  • "status": "FILEDGR_RECEIVED",
  • "links": {
    },
  • "type": "PERSONAL",
  • "subscription_product_type": "BASE_PRODUCT"
}

Get Subscriptions

Authorizations:
api-keyapi-secret
query Parameters
page_size
integer (Page Size)
Default: 10
page
integer (Page)
Default: 1

Responses

Response samples

Content type
application/json
{
  • "total_records": 0,
  • "current_page": 0,
  • "total_pages": 0,
  • "content": [ ]
}

Get Subscription

Authorizations:
api-keyapi-secret
path Parameters
subscription_id
required
string <uuid> (Subscription Id)

Responses

Response samples

Content type
application/json
{
  • "progress": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "ended_at": "2019-08-24T14:15:22Z",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "discount_in_percent": 0,
  • "renew": "DAILY",
  • "next_renewal": "2019-08-24T14:15:22Z",
  • "outstanding_payment": true,
  • "status": "FILEDGR_RECEIVED",
  • "links": {
    },
  • "type": "PERSONAL",
  • "subscription_product_type": "BASE_PRODUCT"
}

proof-packages

Create Proof Package

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
vault_id
required
string (Vault Id) non-empty
file_ids
Array of strings (File Ids)
include_signatures
boolean (Include Signatures)
Default: true
expires_in_days
integer (Expires In Days)
Default: 7
Download Limit (integer) or Download Limit (null) (Download Limit)
Password (string) or Password (null) (Password)

Responses

Request samples

Content type
application/json
{
  • "vault_id": "string",
  • "file_ids": [
    ],
  • "include_signatures": true,
  • "expires_in_days": 7,
  • "download_limit": 0,
  • "password": "string"
}

Response samples

Content type
application/json
{ }

List My Proof Packages

Authorizations:
api-keyapi-secret
query Parameters
limit
integer (Limit) [ 1 .. 200 ]
Default: 50
Cursor (string) or Cursor (null) (Cursor)

Responses

Response samples

Content type
application/json
{ }

Get My Proof Package

Authorizations:
api-keyapi-secret
path Parameters
proof_package_id
required
string (Proof Package Id)

Responses

Response samples

Content type
application/json
{ }

Extend Proof Package

Authorizations:
api-keyapi-secret
path Parameters
proof_package_id
required
string (Proof Package Id)
Request Body schema: application/json
required
expires_in_days
required
integer (Expires In Days)

Responses

Request samples

Content type
application/json
{
  • "expires_in_days": 0
}

Response samples

Content type
application/json
{ }

Download Proof Package

Authorizations:
api-keyapi-secret
path Parameters
proof_package_id
required
string (Proof Package Id)

Responses

Response samples

Content type
application/json
{ }

retry

Retry Entity

Re-drive an entity whose on-chain leg failed.

Authorizations:
api-keyapi-secret
Request Body schema: application/json
required
entity_type
required
string (Entity Type)
entity_id
required
string <uuid> (Entity Id)
force
boolean (Force)
Default: false

Responses

Request samples

Content type
application/json
{
  • "entity_type": "string",
  • "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  • "force": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "retry_count": 0,
  • "reason": "string"
}

status

Get Entity Status

Report where an entity is in its on-chain lifecycle.

Authorizations:
api-keyapi-secret
path Parameters
entity_type
required
string (Entity Type)
entity_id
required
string <uuid> (Entity Id)

Responses

Response samples

Content type
application/json
{
  • "entity_type": "string",
  • "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  • "status": "string",
  • "retry_count": 0,
  • "max_retries": 0,
  • "last_error": "string",
  • "last_error_at": "string",
  • "last_retry_at": "string",
  • "final_failure": true,
  • "status_before_error": "string",
  • "credit_refunded": true
}

app-configs

Get App Configs

Authorizations:
api-keyapi-secret

Responses

Response samples

Content type
application/json
{
  • "usecase_templates": [ ],
  • "is_admin": false,
  • "is_project_admin": false
}