create-session
Start a document interview session to obtain a token and shareable URL, letting recipients complete forms directly.
Instructions
Start a new interview session for a document package. Returns the session token and a ready-to-use interview URL that can be sent to a recipient to complete the form.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| source | No | Optional label identifying where this session was created from. | |
| prefill | No | Optional key-value pairs to pre-populate form fields (e.g. { firstName: 'Jane', lastName: 'Smith' }). | |
| packageId | Yes | The numeric ID of the package to use for this session. | |
| recipientEmail | No | Optional email address of the person who will complete the interview. | |
| transactionScope | No | Optional label describing the transaction (e.g. 'IRA rollover'). |