canonical: https://jentic.com/apis/onparallel.com/parallel

# Onparallel Parallel API

Jentic publishes the only available OpenAPI specification for Parallel API, keeping it validated and agent-ready. Parallel is a structured-data collection platform that uses petitions, which are smart forms with branching logic and document attachments, to gather information from clients, partners, or employees. The API lets developers create petitions from templates, send them to recipients, and download replies for downstream processing. It is built for back-office workflows in financial services, legal, and operations where unstructured email and PDFs make data entry slow and error-prone.

## For AI agents

Send a structured data-collection petition to a recipient and download replies and attachments using bearer-token authentication.

## Scope

Does not handle e-signature, contract negotiation, or scheduling - use for sending structured data-collection petitions and reading replies only.

## Capabilities

- Create a petition from an existing template and pre-fill its fields
- Add one or more recipients to an existing petition
- Read the field definitions of a petition to map them onto an internal schema
- List the templates available to the calling account
- Download a recipient's reply file when the petition is completed

## Use cases

### Client onboarding for financial services

Wealth managers, accountants, and lenders use Parallel to collect KYC information, supporting documents, and disclosures from new clients. The API lets the firm's CRM or onboarding tool create a petition from a template, pre-fill known fields, and send the link to the client. Replies come back as structured data plus attached files, ready to be loaded into the back office without re-keying.

Example prompt: POST /petitions with a template id and the client's prefill data, then POST `/petitions/{petitionId}/recipients` with the client's name and email.

### Legal intake and document collection

Law firms run client intake through structured forms that branch based on matter type. Parallel's petition model handles the conditional logic, so the firm only sees the questions relevant to a given engagement. The API surfaces the resulting field map and reply files for ingestion into the matter management system, replacing PDF email loops.

Example prompt: GET /templates to find the intake template, POST /petitions to instantiate it, then GET `/petitions/{petitionId}/fields` to confirm the field mapping before sending.

### AI agent structured collection through Jentic

An AI agent that handles back-office onboarding can use Parallel through Jentic to send a structured form rather than asking the client to write a long email. The agent searches Jentic for the petition operation, loads the schema, and posts the petition with the recipient. Once the recipient replies, a follow-up agent can pull the reply file and parse it into the system of record.

Example prompt: Search Jentic for 'send a parallel petition', load the POST /petitions operation, and execute it for a known template_id with a single recipient.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/petitions` | Create a new petition from a template |
| GET | `/petitions/{petitionId}/fields` | Read the field schema of a petition |
| POST | `/petitions/{petitionId}/recipients` | Add recipients to a petition |
| GET | `/petitions/{petitionId}/replies/{replyId}/download` | Download a recipient's reply file |
| GET | `/templates` | List available petition templates |

## Key resources

- **Parallels (Petitions)** — The smart forms sent to recipients to collect structured data
- **Recipients** — Per-recipient links and reply data attached to a petition
- **Templates** — Reusable petition definitions, listed via GET /templates

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 68 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 93 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/onparallel.com/parallel/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Parallel API by hand means managing a long-lived workspace bearer token that can both create petitions and download replies containing client PII, and building each call against www.onparallel.com/api/v1 yourself. Through Jentic you install once, import the Parallel API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Parallel puts the petition id in the URL path (`/petitions/{petitionId}/fields`, `/petitions/{petitionId}/recipients`), so a rule can pin your agent to one petition: it can read fields and add recipients for that petition and nothing else. You choose the operations it may call, so downloading recipient replies is not included unless you add it.
- **Credential handling:** Your Parallel bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send a structured client form' or 'download a petition reply', and Jentic returns the matching Parallel operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **PandaDoc API** — Document automation and signature platform for proposals and agreements
- **Calendly API** — Schedule the follow-up meeting once the petition reply has been received
- **HubSpot CRM Contacts** — Source of recipient contact data and destination for parsed petition replies

## FAQ

### Why is there no official OpenAPI spec for Parallel API?

Parallel publishes its API as developer-facing HTML at onparallel.com/developers/api but does not ship a maintained OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Parallel via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Parallel API use?

Parallel uses HTTP bearer authentication. Pass your API key as 'Authorization: Bearer <key>' on every request. Through Jentic, the bearer token is held in the vault and injected at execution time, which keeps client-data tokens out of agent prompts and logs.

### Can I send a petition to multiple recipients?

Yes. Create the petition with POST /petitions, then call POST `/petitions/{petitionId}/recipients` once per recipient or in a single batch payload. Each recipient receives their own link so replies can be tracked individually against the same petition.

### What are the rate limits for the Parallel API?

Parallel does not publish a global rate limit in its OpenAPI spec. In practice, the platform handles bursts from typical onboarding workflows comfortably, and integrations should back off on 429 responses if they appear during bulk sends. Surface area is small (5 endpoints), so rate limit pressure is unusual outside of bulk-import jobs.

### How do I download a recipient's reply through Jentic?

Install the SDK with 'pip install jentic', search for the operation with the query 'download parallel reply', then load the GET `/petitions/{petitionId}/replies/{replyId}/download` operation, and execute it with the petitionId and replyId. Jentic streams the reply file back to the agent.

### How do I find the right template to send?

Call GET /templates to list the templates configured in the account, then use the matching template_id when calling POST /petitions. The template id is also what governs the field schema that GET `/petitions/{petitionId}/fields` will return.

### Can I limit what my agent is allowed to do with the Parallel API?

Yes. Because you run Jentic One yourself, your own rules decide which Parallel operations and credentials the agent may use, and you pick the specific endpoints it can call. Parallel puts the petition id in the URL path, such as GET `/petitions/{petitionId}/fields` and POST `/petitions/{petitionId}/recipients`, so a rule can pin the agent to a single petition, letting it read that petition's field schema and add recipients while touching nothing else. Since you choose the allowed operations, downloading a recipient's reply file through GET `/petitions/{petitionId}/replies/{replyId}/download` stays off unless you explicitly grant it.
