Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Fast Track API

Fast Track is a OneSpan Sign feature that distributes documents for signature through a reusable link instead of creating a new transaction each merge. Author a template once; Fast Track generates a link (or QR code) you can email, embed, or bookmark for repeated use.

The Conga Sign Fast Track API wraps this feature so you need only provide the template and the signer details.

Fast Track produces two link types. Sign selects the correct one automatically based on the template's signer placeholder count.

Signing URLSending URL
Used whenTemplate has exactly 1 signer placeholderTemplate has 2 or more signer placeholders
Who opens itThe signerA sender, who then distributes to signers
What they enterTheir first name, last name, and emailFirst name, last name, and email for each signer (Signer 1, Signer 2, …)
ResultSigner goes directly into the signing experienceSender submits details; invitations are sent to all participants

Why two types? OneSpan hides the Signing URL for templates with multiple placeholders because someone must map people to roles (e.g., buyer vs. seller). That person is the sender, via the Sending URL.
Important: If a single signer already has a OneSpan Sign account, the account name overrides the name entered on the Fast Track link.

Prerequisites

These configuration requirements (not code) must be met for the API to succeed:

  • An administrator must enable Fast Track on the OneSpan account.

  • A template must exist for the Fast Track transaction.

  • The template must include at least one placeholder recipient and a document with a signature field bound to that placeholder.

  • The template's language must be supported. If the account limits languages, Fast Track URLs cannot be generated for unsupported templates.

  • The template name appears to signers on the Fast Track links. We recommend you name it clearly.

Glossary
TermMeaning
TemplateA reusable OneSpan package (documents + placeholder roles) used for Fast Track.
PlaceholderAn unassigned signer role on the template, filled with real signer details at runtime.
Signing URLLink for single-signer templates; the signer enters their details and signs.
Sending URLLink for multi-signer templates; a sender specifies each signer's details before distribution.
TokenSecurity token embedded in the Fast Track URL, used to create the transaction.

API References

Endpoint
POST /v1/cs-fast-track/{templateId}
PropertyValue
ControllerFastTrackController.CreateFastTrackTransaction
Consumesapplication/json
Producesapplication/json
AuthBearer (platform auth via CommonPolicyBaseController)
Path Parameter
NameTypeDescription
templateIdstringThe OneSpan template id containing at least one placeholder.

Request Body

A JSON array of roles (placeholders) and their assigned signers. At least one role is required.

With One Placeholder
[
  {
    "id": "PlaceholderId1",
    "name": "PlaceholderId1",
    "signers": [
      {
        "id": "PlaceholderId1",
        "email": "[email protected]",
        "firstName": "Sign",
        "lastName": "DevOne"
      }
    ]
  }
]
With Multiple Placeholders
[
  {
    "id": "PlaceholderId1",
    "name": "PlaceholderId1",
    "signers": [
      {
        "id": "PlaceholderId1",
        "email": "[email protected]",
        "firstName": "Sign",
        "lastName": "DevOne"
      }
    ]
  },
  {
    "id": "PlaceholderId2",
    "name": "PlaceholderId2",
    "signers": [
      {
        "id": "PlaceholderId2",
        "email": "[email protected]",
        "firstName": "Sign",
        "lastName": "DevTwo"
      }
    ]
  }
]

Field Definitions

ObjectFieldRequiredNotes
FastTrackRoleidYesThe placeholder id defined on the template. Must match the template exactly.
FastTrackRolenameNoThe placeholder name.
FastTrackRolesignersYes (min 1)The signer(s) assigned to this placeholder.
FastTrackSigneridYesSigner id (typically matches the placeholder id).
FastTrackSigneremailYesValid email address.
FastTrackSignerfirstNameNoSigner first name.
FastTrackSignerlastNameNoSigner last name.
Note: This API has no signing query parameter. The Signing vs Sending decision is derived from the template's placeholder count

Responses

CodeMeaning
200 OKTransaction created. Returns the OneSpan Fast Track response.
400 Validation ErrorInvalid input, or template not Fast Track–eligible (e.g., no placeholder).
401 Not AuthorizedMissing or expired auth.
404 Not FoundTemplate not found.
500 Unexpected ErrorUnhandled server error.

OutcomeResult
0 placeholdersFails fast with a clear validation message.
1 placeholderSigning URL (signing=true).
2+ placeholdersSending URL (signing=false).

PurposeEndpoint
Read template & placeholders
GET /api/packages/{templateId}

Error Scenarios and Meaning

ScenarioResultReason
Template has no placeholder400 - clear validation messageFast Track requires ≥ 1 placeholder with a signature field
id doesn't match a template placeholder400 from OneSpanPlaceholder can't be mapped
Body sent as { "roles": [...] }400 Invalid JSONOneSpan expects a bare array
Fast Track not enabled on accountError from OneSpanAdmin must enable Fast Track
Unsupported template languageError from OneSpanLanguage limited on account