v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Account

List metadata

<small>Requires an API token with one of the following roles: Document Reader, Document Manager, Template Reader, or Metadata Manager.</small>

Lists available metadata fields that help you enrich your documents.

Metadata Types

Each metadata has an associated type that defines where its value comes from and what actions can be taken on it.

Type	Description
account	Custom metadata fields that are specific to your account.
system_reference	Pre-defined useful metadata fields provided by fynk.
system_autofilled	Fields that are automatically filled by the system in response to events, like "Signing completion date".
system_computed	Fields that are calculated by the system based on other metadata values. e.g. "Signing duration" is the difference between "Signing date" and "Signed date"
system	Other system-provided metadata fields.

Note that the type is distinct from the value_type, which controls which kinds of values may be stored in the field.

Entries with the multi_select value type are only included in the response if you are using API version 2026-04-02 or newer.

get/metadata

Response

Array of MetadataResource

Example response

{
  "data": [
    {
      "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."
    }
  ]
}