Form Search Services Overview

The collection of Quik! Forms Engine services are used to implement Quik! features and capabilities within your environment. This is a newer, and more extensive version of the v1000 version of this service.

Endpoint URL: https://websvcs.quikforms.com/rest/qfem/v2000

Endpoint Documentation: https://websvcs.quikforms.com/rest/qfem/v2000/swagger/index.html

How to Authorize on Swagger

Retrieve your Quik! token by calling the following service in a tool such as Postman: https://websvcs.quikforms.com/rest_authentication/token
1. In the body, enter the correct grant_type for your account: grant_type=password&username=YOUR_USERNAME&password=YOUR_PASSWORD
2. Content-type should be: application/x-www-form-urlencoded
Copy the returned access_token value
In swagger, click the Authorize button, and in the value field, type Bearer, a space, and paste your token value
1. (e.g. Bearer YOUR_TOKEN_VALUE)
Now you can select any method on the swagger page, click the Try it out button, enter parameters, and test the method

Role Data Access

Simplified Role Retrieval (Recommended)

The /forms/roles/datasets endpoint has been enhanced to return all role-related information for a given Form ID through the use of request parameters.

This allows customers to retrieve client, signer, and representative role information through a single endpoint, reducing the need for multiple role-specific API calls.

New implementations should use /forms/roles/datasets for retrieving form role data.

Supported Query Parameters

Parameter	Type	Required	Description

Parameter	Type	Required	Description
FormIds	Integer (repeatable)	Yes	One or more Form IDs to retrieve role data for. This parameter may be specified multiple times in the request.
dataSetType	Integer	No	Filters roles by dataset type. If omitted or set to `0`, all dataset types are returned.

dataSetType Values

Value	Dataset Type

Value	Dataset Type
1	Client
2	Account
3	Representative
4	Company
5	Product Item
6	Fund Source
0	All types

Enhanced Sign Role Data in /datasets (New Feature - Coming Soon)

The /forms/roles/datasets endpoint will soon be enhanced to include additional signing-related role fields, aligning its output more closely with the data returned by /forms/roles/sign.

New Fields Included in Dataset Role Responses

When this feature is released, the forms/roles/datasets response will include the following additional fields:

Field Name	Description

Field Name	Description
QFFormIDs	The Quik! Form ID(s) associated with the role. Derived from the underlying Form ID and returned in a consistent format.
FullFieldName	The role name.
SignOrder	The signing order for the role when applicable. This field is included for all dataset types and defaults to `null` when not applicable.

Sample Request

GET /rest/QFEM/v2000/forms/roles/datasets?FormIds=12&FormIds=441&dataSetType=0

Sample Response

{
    "ResultData": [
        {
            "RoleID": 1000001,
            "QFDLevel1FieldID": 1,
            "FieldName": "own",
            "SystemName": "Owner",
            "Level1FieldShortName": "Owner",
            "RoleInstance": 1,
            "QFFormIDs": "12, 441",
            "FullFieldName": "1own",
            "SignOrder": 1
        },
        {
            "RoleID": 1000002,
            "QFDLevel1FieldID": 1,
            "FieldName": "own",
            "SystemName": "Owner",
            "Level1FieldShortName": "Owner",
            "RoleInstance": 2,
            "QFFormIDs": "12, 441",
            "FullFieldName": "2own",
            "SignOrder": 1
        }
      ]
}

Legacy Role Endpoints (Still Supported)

The following role-related endpoints are still supported and may be used by existing implementations:

/forms/roles/client - Returns client roles for a given Form ID
/forms/roles/rep - Returns financial representative roles for a given Form ID
/forms/roles/sign - Returns signer roles for a given Form ID

Customers using multiple legacy role endpoints may now consolidate role retrieval by using /forms/roles/datasets with the appropriate parameters.

Search & Pagination

The following endpoints return search results using pagination:

/forms/search
/forms/search/groups

When calling these endpoints:

PageSize: Number of items per page (minimum = 5)
PageNumber: Page of results to return

If not provided, default values are:

PageSize = 5
PageNumber = 1

To reverse the sort order, prepend a minus sign (-) to the sort property (e.g., -DealerName).

Field & E-Signature Metadata

The following endpoints are used to retrieve field-level and e-signature metadata and are not impacted by the role enhancements:

/fields/{id}/lookupvalue — Returns lookup values for defined and user-defined fields
/fields/esign — Returns e-signature field metadata, including:
- Field coordinates
- Page placement and dimensions
- Field role mapping

Forms Data Methods

The following methods are used to retrieve the data needed to display form information to users. It is recommended that form and dealer data be refreshed at least weekly.

GET /forms — Subscribed forms, fields, roles, and groups
GET /dealers — Subscribed dealers and attributes
GET /categories — Form categories
GET /fields — Field definitions, lookup values, and rules
GET /states — States used with forms

Important Note

Endpoints prefixed with QuikFormsApp_ are intended only for use with the Quik! Forms App and should not be used with other implementations due to differences in authentication, security, and access rights.

Forms Search Services (v2000)