Skip to content

Rippling: Create a new employee document

Rippling restApi.createEmployeeDocuments: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.create_employee_documents

Provider route: POST /employee-documents/. Alter supplies the connection’s credentials and routing.

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

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["createEmployeeDocuments"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.restApi.createEmployeeDocuments(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.rest_api.create_employee_documents(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelOptionalExpand Create a new employee document — request body — body

Referenced models: Create a new employee document — request body — body

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

FieldTypePresenceDescription and constraints
$objectRootTop-level request body for `POST /employee-documents/`.
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
itemsarrayRequired within parentList of role/document items to process. No limit on number of items; total documents across all items must not exceed 40.
items[]ModelEach itemExpand Create a new employee document — response body — items item
updated_atstringRequired within parentRecord update date

Referenced models: Create a new employee document — response body — items item

Create a new employee document — response body — items item
FieldTypePresenceDescription and constraints
$objectRootA single item: attach `documents` to the worker identified by `worker_id`.
documentsarrayRequired within parentDocuments to attach to the role. At least one required. Each entry references a FileUploadTracker by file_id.
documents[]ModelEach itemExpand Create a new employee document — response body — items item documents item
folder_idstringOptionalOptional destination folder for documents. Accepts either: (1) an ObjectId string for custom folders, or (2) a default folder identifier ('root', 'confidential_documents', 'notices', 'work_authorization'). When omitted, documents land at the root of the worker's profile (current default behavior). When supplied, the folder must exist, be in an active state, be provisioned for the target worker, and the caller must have UPLOAD permission on it — otherwise behavior is governed by `on_invalid_folder`.
on_invalid_folderstringOptionalFallback behavior when `folder_id` is supplied but inaccessible. 'fail' (default) rejects each affected document with FOLDER_ACCESS_ERROR. 'fallback_to_root' uploads to the worker's root profile instead and attaches a FOLDER_ACCESS_FALLBACK warning to each result. Ignored when `folder_id` is omitted.
Known values: fail, fallback_to_root
worker_idstringRequired within parentId of the worker to attach documents to.

Referenced models: Create a new employee document — response body — items item documents item

Create a new employee document — request body — body
FieldTypePresenceDescription and constraints
$objectRootTop-level request body for `POST /employee-documents/`.
itemsarrayRequired within parentList of role/document items to process. No limit on number of items; total documents across all items must not exceed 40.
items[]ModelEach itemExpand Create a new employee document — request body — body items item

Referenced models: Create a new employee document — request body — body items item

Create a new employee document — response body — items item documents item
FieldTypePresenceDescription and constraints
$objectRootA document to attach to a draft hire, referencing a pre-uploaded file.
file_idstringRequired within parentId of a FileUploadTracker in ACTIVE status whose file should become a document on the hire
namestringOptionalDocument name. Defaults to the uploaded file name when omitted.
signature_datestringOptionalSignature date in YYYY-MM-DD format.
Create a new employee document — request body — body items item
FieldTypePresenceDescription and constraints
$objectRootA single item: attach `documents` to the worker identified by `worker_id`.
documentsarrayRequired within parentDocuments to attach to the role. At least one required. Each entry references a FileUploadTracker by file_id.
documents[]ModelEach itemExpand Create a new employee document — response body — items item documents item
folder_idstringOptionalOptional destination folder for documents. Accepts either: (1) an ObjectId string for custom folders, or (2) a default folder identifier ('root', 'confidential_documents', 'notices', 'work_authorization'). When omitted, documents land at the root of the worker's profile (current default behavior). When supplied, the folder must exist, be in an active state, be provisioned for the target worker, and the caller must have UPLOAD permission on it — otherwise behavior is governed by `on_invalid_folder`.
on_invalid_folderstringOptionalFallback behavior when `folder_id` is supplied but inaccessible. 'fail' (default) rejects each affected document with FOLDER_ACCESS_ERROR. 'fallback_to_root' uploads to the worker's root profile instead and attaches a FOLDER_ACCESS_FALLBACK warning to each result. Ignored when `folder_id` is omitted.
One of: fail, fallback_to_root
worker_idstringRequired within parentId of the worker to attach documents to.

Referenced models: Create a new employee document — response body — items item documents item

SDK function policy ID: rippling.rest_api.create_employee_documents. Catalog operation: create-employee-documents. 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: ["employee-documents.read-write"]

Provider entitlements: ["API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

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.