General

Create document from PDF

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

POST

/documents/create-from-pdf

curl --request POST \
  --url https://app.fynk.com/v1/api/documents/create-from-pdf \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_party_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ai_analysis_auto_apply": true,
  "file_name": "NDA_BigCorp.pdf",
  "file_upload_uuid": "ab2665c1-9a7c-4230-a431-21682eb302aa",
  "initial_stage": "draft",
  "name": "Kundenvertrag Muster GmbH",
  "owner_emails": [
    "jsmith@example.com"
  ],
  "tag_uuids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "team_uuids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "template_uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2"
}
'

{
  "data": {
    "archived_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "document_type_uuid": "58ac52bb-8885-4580-88c1-7a7bc772c87d",
    "dynamic_fields": [
      {
        "autofill_type": "document_created_date",
        "format": {
          "decimal_separator": ".",
          "decimals": 2,
          "thousands_separator": ","
        },
        "is_mandatory": true,
        "name": "Gross salary",
        "order": 123,
        "question": "What is the employee's gross salary in EUR?",
        "question_external": "<string>",
        "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "scope": "internal",
        "select_values": [
          "<string>"
        ],
        "settings": {
          "currencies": [
            "EUR",
            "USD"
          ]
        },
        "type": "id",
        "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
        "value": "EUR;95000;yearly"
      }
    ],
    "external_signatory_invitation_message": "<string>",
    "integration_reference": {
      "external_id": "000000000000Abc",
      "external_name": "Example Opportunity",
      "integration_type": "pipedrive",
      "object_type": "Opportunity"
    },
    "locale": "de-AT",
    "metadata_values": [
      {
        "computed_at": "2023-11-07T05:31:56Z",
        "computed_status": "missing_information",
        "computed_value": "EUR;95000;yearly",
        "is_attached": true,
        "metadata": {
          "always_exists": true,
          "description": "The discount rate applied to the company valuation in a follow-on financing round.",
          "display_name": "Discount Rate",
          "is_contract_value": true,
          "keywords": "discount, rate, valuation",
          "name": "discount_rate",
          "prompt": "Extract the discount rate percentage from the document.",
          "relevant_document_type_uuids": [
            "<string>"
          ],
          "select_values": [
            "<string>"
          ],
          "settings": {
            "currencies": [
              "EUR",
              "USD"
            ]
          },
          "type": "system_autofilled",
          "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
          "value_type": "id"
        },
        "reference_dynamic_field_uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
        "uuid": "4ed6c60b-bc4f-4390-bbf5-ed384e3443c9",
        "value": "EUR;95000;yearly",
        "value_currency_monthly": "<string>",
        "value_currency_yearly": "<string>",
        "value_source": "user"
      }
    ],

Creates a new document from a previously uploaded PDF file.

This endpoint requires a two-step upload process:

Generate upload URL: Call the Create document PDF upload URL endpoint to get a presigned upload URL
Upload PDF: Make a POST request to the returned URL with the specified form fields, followed by the PDF file contents in a file field
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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

account_party_uuidstring

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

file_namestringrequired

The name of the PDF file

Maximum string length: 255

Example: NDA_BigCorp.pdf

file_upload_uuidstringrequired

The UUID received in the Create document PDF upload URL response

Example: ab2665c1-9a7c-4230-a431-21682eb302aa

initial_stagestringrequired

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

Example: draft

namestring

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

Maximum string length: 255

Example: Kundenvertrag Muster GmbH

owner_emailsstring[]

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

tag_uuidsstring[]

UUIDs of any tags to add to the document

team_uuidsstring[]

UUIDs of any teams that should have access to the document

template_uuidstring | null

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

Example: 4df1e60a-0114-4dce-89e7-8c5ad397fcf2

Response

DocumentDetailResource

dataobjectrequired

Show child attributes

Still need help? Share an idea