Executed Forms

In many real estate workflows, forms and contracts may be executed or signed outside of the Forms Live platform. The Executed Forms endpoint allows you to store these finalized documents back into Forms Live, ensuring a complete record of all documents and their execution history.

The executed form model

The executed form model contains information about stored versions of forms that have been executed or signed outside of Forms Live. This model tracks who created the version, when it was created, and includes a description of the stored version.

Properties

Name
id
Type
integer
Description
Unique identifier for the stored version.
Name
form_id
Type
integer
Description
Unique identifier for the form.
Name
third_party_id
Type
integer
Description
Unique identifier for the integrator that created the version.
Name
source
Type
string
Description
Name of the integrator that created the version.
Name
description
Type
string
Description
A description of the stored version.
Name
s3key
Type
string
Description
The storage key for the document file.
Name
created
Type
timestamp
Description
Timestamp of when the version was created.
Name
oauth_provider_id
Type
integer
Description
Identifier for the OAuth provider, if applicable.
Name
values
Type
object
Description
Additional values collected during the execution of the form.

POST/forms/:form_id/versions

Store an executed form

This endpoint allows you to store an executed or signed version of a form that has been processed outside of Forms Live. You can include the PDF document, a description, and any additional values collected during the execution process.

Required attributes

Name
description
Type
string
Description
A description of the version being stored (e.g., "Executed Contract").
Name
data
Type
string
Description
A base64 encoded PDF file containing the executed form.

Optional attributes

Name
values
Type
object
Description
Any additional values collected during the execution of the form, in JSON format.

Request

POST

/forms/:form_id/versions

curl https://app-api.reiformslive.com.au/forms/1/versions \
  --request POST \
  --header "content-type: application/json" \
  --header "Authorization: Basic YTlkOWIwYItNGY4Yi1hYTQxLTI5NzZmMTcyZmEyMQ==" \
  --data '{"description":"Executed Contract","data":"base64encodedPDFdata","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
}