Sign in

v1

latestOpenAPI 3.1.02026-08-066378446.6 KB
General

Create document from PDF

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

Creates a new document from a previously uploaded PDF file.

This endpoint requires a two-step upload process:

  1. Generate upload URL: Call the Create document PDF upload URL endpoint to get a presigned upload URL
  2. Upload PDF: Make either PUT (deprecated) or POST request (depending on the "method" field) to the returned URL with the PDF file contents and the specified headers/POST body fields
  3. Create document: Call this endpoint with file_upload_uuid set to the uuid received in step 1

The PDF will be processed and converted into a fynk document with extractable content and signature fields.

For a complete guide with examples, see How to create a document from a PDF file.

post/documents/create-from-pdf

Request body

file_upload_uuidstring uuid required

The UUID received in the Create document PDF upload URL response

file_namestring required

The name of the PDF file

initial_stagestring required

The new document will be created in this stage. One of: draft, done

namestring

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

template_uuidstring uuid nullable

Copy document settings from the template with this UUID. Checkpoints, document type, metadata, parties, tags, teams, etc. will all be copied.

account_party_uuidstring uuid

UUID of the party from Settings > My Parties involved in the document

ai_analysis_auto_applyboolean

If true, AI analysis results will be automatically applied to the document. If false (the default), AI analysis results must be manually applied

owner_emailsstring[]

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

team_uuidsstring[]

UUIDs of any teams that should have access to the document

tag_uuidsstring[]

UUIDs of any tags to add to the document

Example request

{
  "file_upload_uuid": "ab2665c1-9a7c-4230-a431-21682eb302aa",
  "file_name": "NDA_BigCorp.pdf",
  "initial_stage": "draft",
  "name": "Kundenvertrag Muster GmbH",
  "template_uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2"
}

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"
      }
    ]
  }
}