Create document from template

<small>Requires an API token with the Document Manager role.</small>

Creates a new document based on the template with the given UUID.

Note: When a provided signatory's email corresponds to an existing user in the current fynk account, the signatory will be linked to that user. Any additional fields (first_name, last_name, mobile_phone, title) will be ignored and the signatory information will be populated from the existing user's profile.

Request body

namestring nullable

The new document's name. If omitted, the name of the template will be used as the new document's name

template_uuidstring uuid required

UUID of the template to use as a basis for the new document

initial_stage'draft' | 'signing' nullable

If set, the document will be moved to this stage after creation. The default is draft. Depending on the template, moving to signing may require that the dynamic_field_values, parties and/or signatories fields are also provided.

owner_emailsstring[]

Email addresses of the user(s) from your account who should be given ownership of the new document

dynamic_field_valuesobject required

Initial values for the document's dynamic fields. Each key must identify a dynamic field on the template by either its ref_uuid or its name. Values accept the same format as the Update dynamic field endpoint.

Example request

{
  "name": "Kundenvertrag Muster GmbH",
  "initial_stage": "signing",
  "dynamic_field_values": {
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890": "EUR;95000;yearly",
    "My Text Field": "Vienna"
  },
  "parties": [
    {
      "entity_name": "Muster GmbH",
      "address": "Musterstraße 1, 12345 Berlin"
    }
  ],
  "signatories": [
    [
      {
        "email": "john@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "mobile_phone": "+447951123456",
        "title": "Sales Manager"
      }
    ]
  ]
}

Response

DocumentDetailResource

Example response

{
  "data": {
    "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
    "name": "Kundenvertrag Muster GmbH",
    "locale": "de-AT",
    "template_uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
    "document_type_uuid": "58ac52bb-8885-4580-88c1-7a7bc772c87d",
    "parties": [
      {
        "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
        "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "reference": "Employer",
        "entity_name": "Demo Inc.",
        "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ"
      }
    ],
    "teams": [
      {
        "uuid": "281b685e-4b29-4618-8231-3822537b139d",
        "name": "HR"
      }
    ],
    "integration_reference": {
      "object_type": "Opportunity",
      "external_id": "000000000000Abc",
      "external_name": "Example Opportunity"
    },
    "users": [
      {
        "uuid": "76b8e0ad-e9cd-4c21-98b1-cd0003423ec2",
        "first_name": "Emily",
        "last_name": "Miller",
        "email": "miller@example.com",
        "title": "Sales Manager",
        "party_uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
        "personal_link": {
          "uuid": "5cbe6ed1-49a9-40dc-a1c4-9e5a3c9a08f0",
          "url": "https:app.fynk.com/share/5cbe6ed1-49a9-40dc-a1c4-9e5a3c9a08f0?token=...",
          "expires_at": "2026-10-19T12:00:00Z",
          "message": "Hi Emily, please review the updated contract."
        }
      }
    ],
    "signatories": [
      {
        "uuid": "76b8e0ad-e9cd-4c21-98b1-cd0003423ec2",
        "first_name": "Emily",
        "last_name": "Miller",
        "email": "miller@example.com",
        "mobile_phone": "+447951123456",
        "title": "Sales Manager",
        "profile_photo_url": "https://ui-avatars.com/api/?name=EM",
        "party_uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f"
      }
    ],
    "dynamic_fields": [
      {
        "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
        "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "Gross salary",
        "settings": {
          "currencies": [
            "EUR",
            "USD"
          ]
        },
        "format": {
          "decimals": 2,
          "decimal_separator": ".",
          "thousands_separator": ","
        },
        "question": "What is the employee's gross salary in EUR?"
      }
    ],
    "metadata_values": [
      {
        "uuid": "4ed6c60b-bc4f-4390-bbf5-ed384e3443c9",
        "metadata": {
          "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
          "name": "discount_rate",
          "display_name": "Discount Rate",
          "settings": {
            "currencies": [
              "EUR",
              "USD"
            ]
          },
          "description": "The discount rate applied to the company valuation in a follow-on financing round.",
          "keywords": "discount, rate, valuation",
          "prompt": "Extract the discount rate percentage from the document."
        },
        "reference_dynamic_field_uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc"
      }
    ],
    "tags": [
      {
        "uuid": "58ac52bb-8885-4580-88c1-7a7bc772c87d",
        "name": "Warranty",
        "color": "#615fff"
      }
    ]
  }
}

v1

Create document from template

Request body

Example request

Response

Example response