View as Markdown
Openum icon

Openum ACTION

Start Signature

Initiates an electronic document delivery process to recipient(s). See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Openum account once, then configure and run Start Signature from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "openum-start-signature",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    openum: { authProvisionId: "apn_xxxxxxx" },
    requestId: "Request ID",
    configId: "Config ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Start Signature inputs
Property Type Description
requestId Request ID string
Optional reference of the request.
Optional
configId Config ID string
Numerical ID of the configuration.
Required Dynamic
contractId Contract ID string
Client reference of the process. This reference is provided as the unique identifier for the process. If auto_cancel is enabled in the configuration and an existing reference is specified, the previous pending process will be automatically canceled.
Required
levels Levels string

Definition of the viewing level/order as a JSON array. Each level object supports: level_order (integer, 0 to N), required_signatories_to_complete_level (optional integer), and signatories (array of recipient objects with fields: phone, email, name, surname, id_number, landing_access_methods, landing_access_code, landing_information). The maximum is 20 recipients across all levels.

Example:

[
  {
    "level_order": 0,
    "signatories": [{
      "email": "user@example.com",
      "name": "John",
      "surname": "Doe",
      "phone": "+34666666666"
    }]
  }
]
Required
filePaths Files string[]
PDF files to deliver to the recipients. Provide paths to files in the /tmp directory (e.g. /tmp/contract.pdf) or direct URLs to PDF files. Only PDF format is accepted. Maximum 20 files, 25 MB total.
Required
syncDir SyncDir dir
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
openum-start-signature
Version
0.0.1
App
Openum
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes