Executed Forms

Description: To store the executed/signed version of a form that has been executed outside of Forms Live a HTTP POST request is made to the URL with the form ID and session token.

Method: POST

URI:/forms/:form_id/versions

URI Parameters:

description: A description of the version being stored e.g. "Executed Contract".
data: A base64 encoded PDF file.
values: Any additional values collected during the execution of the form, in JSON format.

Headers: Authorization: Third party based authorization header

Returns

Field	Type	Description
id	Integer	Unique ID of the stored version.
form_id	Integer	Unique ID of the form.
third_party_id	Integer	Unique ID of the integrator that created the version.
source	String	Name of the integrator that created the version.
description	String	A description of the stored version.
created	Timestamp	Unix timestamp of when the version was created.

Example

Request

  curl http://app-api.reiformslive.com.au/forms/1/versions \
--request POST \
--header "content-type: application/json" \
--header "Authorization: Basic YTlkOWIwYItNGY4Yi1hYTQxLTI5NzZmMTcyZmEyMQ==" \
--data '{
            "description":"Executed Contract",
            "data": "...",
            "values": { "name": "John Doe" }
        }'

Response

  {
    id: 2,
    form_id: 1,
    third_party_id: 3,
    source: 'Testing Integrator',
    description: 'Executed Contract',
    s3key: 'files/1/abcdefgh-1234-abcd-1234-abcdefghijkl',
    created: '2023-01-01T00:00:00.000Z',
    oauth_provider_id: null,
    values: null,
  },