Skip to main content
GET
/
files
/
encrypted
/
{id}
Get encrypted file details
curl --request GET \
  --url https://proxy.cci.prem.io/files/encrypted/{id} \
  --header 'Authorization: <api-key>'
{
  "status": 200,
  "data": {
    "id": "file_0198042e-6dde-7b9c-bc91-452a7e0c833b",
    "user_id": "user_0196b0e9-11d8-7f26-b1d2-bd47054e4827",
    "organization_id": "org_0196b0e9-11d8-7f26-b1d2-bd47054e4827",
    "hash": "04b9e2ec43133ae7287f97764c0beda19f304374e1d6bfe4fcc36ad54502e5dc",
    "version": "1",
    "kid": "key_01234567-89ab-cdef-0123-456789abcdef",
    "wrapped_dek": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
    "original_name": "document.pdf",
    "file_name": "0198042e-6dde-76e0-b817-3afb324e29ac.pdf.enc",
    "file_path": "encrypted/org_0196b0e9-11d8-7f26-b1d2-bd47054e4827/user_0196b0e9-11d8-7f26-b1d2-bd47054e4827/0198042e-6dde-76e0-b817-3afb324e29ac.pdf.enc",
    "mime_type": "application/pdf",
    "file_size": 1060793,
    "type": "document",
    "created_at": "2025-07-13 16:26:48.415",
    "updated_at": null,
    "url": "https://encrypted.prem.io/encrypted/org_0196b0e9-11d8-7f26-b1d2-bd47054e4827/user_0196b0e9-11d8-7f26-b1d2-bd47054e4827/0198042e-6dde-76e0-b817-3afb324e29ac.pdf.enc"
  },
  "error": null,
  "log": null,
  "validator": null,
  "support_id": null,
  "message": "Resource created successfully",
  "env": "development"
}

Authorizations

Authorization
string
header
required

Send your access token as header Authorization: Bearer {accessToken}

Authorization
string
header
required

Your API key that starts with sk_live or sk_test. You can create yours at go.prem.io/api-keys.

Path Parameters

id
string
required

Encrypted file ID

Query Parameters

url
enum<string>
default:false

Include signed download URL in response

Available options:
true,
false

Response

Encrypted file retrieved successfully

Response containing encrypted file details

status
enum<integer>
required

Status code of the response

Available options:
200,
201,
202
data
object
required

Encrypted file object containing file identifier and encrypted metadata

Example:
{
"id": "file_0198042e-6dde-7b9c-bc91-452a7e0c833b",
"user_id": "user_0196b0e9-11d8-7f26-b1d2-bd47054e4827",
"organization_id": "org_0196b0e9-11d8-7f26-b1d2-bd47054e4827",
"hash": "04b9e2ec43133ae7287f97764c0beda19f304374e1d6bfe4fcc36ad54502e5dc",
"version": "1",
"kid": "key_01234567-89ab-cdef-0123-456789abcdef",
"wrapped_dek": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"original_name": "encrypted_filename_data",
"mime_type": "encrypted_mime_type_data",
"file_name": "0198042e-6dde-76e0-b817-3afb324e29ac.enc",
"file_path": "encrypted/org_0196b0e9-11d8-7f26-b1d2-bd47054e4827/user_0196b0e9-11d8-7f26-b1d2-bd47054e4827/0198042e-6dde-76e0-b817-3afb324e29ac.enc",
"file_size": 1060793,
"type": "encrypted",
"rag_status": "pending",
"created_at": "2025-07-13 16:26:48.415",
"updated_at": null
}
message
string | null
required

Message of the response, human readable

Example:

"Resource created successfully"

env
enum<string>
required

API environment

Available options:
development,
production
error
string | null

Error message of the response, human readable

Example:

"Invalid email address"

log

Useful informaiton, not always present, to debug the response

Examples:
{ "request_id": "req_1234567890" }

"Some pertinent log message"

validator

Validator response object, each key is the field name and value is the error message

Example:
{
"email": "Invalid email address",
"password": "Password is required"
}
support_id
string<uuid> | null

Support ID linked to the response, used to identify it when talking with our team

Example:

"support_uuidv7-something-else"