Skip to content

Deel: Upload Organization Secure Vault Files

Deel documents.uploadOrganizationSecureVaultFiles: arguments, response, policy and SDK examples.

← Documents operations · Get started

Operation deel.documents_uploadorganizationsecurevaultfiles_v2026_08_05

Provider route: POST /organizations/secure-vault/files. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["documents"]["uploadOrganizationSecureVaultFiles"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.documents.uploadOrganizationSecureVaultFiles(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.documents.upload_organization_secure_vault_files(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectOptional
body.dataModelRequired within parentExpand Upload Organization Secure Vault Files — request body — body data
The files to attach to the Organization Secure Vault.

Referenced models: Upload Organization Secure Vault Files — request body — body data

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Upload Organization Secure Vault Files — 201 response body

Referenced models: Upload Organization Secure Vault Files — 201 response body

Upload Organization Secure Vault Files — request body — body data
FieldTypePresenceDescription and constraints
$objectRootThe files to attach to the Organization Secure Vault.
filesarrayRequired within parentFiles previously uploaded to the File Service. Allowed types: pdf, jpg, jpeg, png, doc, docx, csv, xls, xlsx, txt, xml, zip, mov, mp4.
files[]ModelEach itemExpand Upload Organization Secure Vault Files — request body — body data files item

Referenced models: Upload Organization Secure Vault Files — request body — body data files item

Upload Organization Secure Vault Files — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Upload Organization Secure Vault Files — 201 response body — data
Result of the upload.

Referenced models: Upload Organization Secure Vault Files — 201 response body — data

Upload Organization Secure Vault Files — request body — body data files item
FieldTypePresenceDescription and constraints
$objectRoot
content_typestringRequired within parentMIME type.
Maximum length: 255
file_idstringRequired within parentFile Service file id.
Format: uuid
one_time_secretstringRequired within parentFile Service one-time secret.
Maximum length: 1024
Minimum length: 1
original_filenamestringRequired within parentOriginal filename.
Maximum length: 500
Upload Organization Secure Vault Files — 201 response body — data
FieldTypePresenceDescription and constraints
$objectRootResult of the upload.
file_idsarrayRequired within parentPublic UUIDs of the created Organization Secure Vault files, in upload order.
file_ids[]stringEach itemFormat: uuid
folderJSONOptionalFolder the files were stored in. When no folder is given, files land in the organization's "Other Files" folder.
folder (anyOf 1)ModelAlternativeExpand Upload Organization Secure Vault Files — 201 response body — data folder id, name
folder (anyOf 2)nullAlternative

Referenced models: Upload Organization Secure Vault Files — 201 response body — data folder id, name

Upload Organization Secure Vault Files — 201 response body — data folder id, name
FieldTypePresenceDescription and constraints
$objectRootFolder the files were stored in. When no folder is given, files land in the organization's "Other Files" folder.
idJSONOptional
id (anyOf 1)stringAlternativePublic UUID of the folder.
Format: uuid
id (anyOf 2)nullAlternativePublic UUID of the folder.
Format: uuid
nameJSONOptional
name (anyOf 1)stringAlternativeFolder name.
name (anyOf 2)nullAlternativeFolder name.

SDK function policy ID: deel.documents_uploadorganizationsecurevaultfiles_v2026_08_05. Catalog operation: documents_uploadorganizationsecurevaultfiles_v2026_08_05. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["organizations:write"]

Pinned headers: {"X-Version": "2026-08-05"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.