๐Data Types
The Docflo Data Types below represent different types of fields that you can use both when consuming Docflo API through Integrations, or within your Automations. When working with Docflo Fields, you will alway have:
typeproperty for each field, that matches one of data types belowvaluethat holds relevant field data, in relevant format per table belowconfidence- a double / float from 0 to 1 representing extraction confidence. The higher - the better!
In addition to fields above there are additional fields you can use, but they are not guaranteed for all cases, use with caution:
contentof value that was parsed, always coming as string. Appears for most of the field typeschangedOn- A string including ISO date of a timestamp the value was changed (if updated by user)changedBy- A string with changing user's full name
Data Types supportedโ
| Data Type | Description |
|---|---|
string | Text-based data, including any alphanumeric characters and special characters |
boolean | Boolean true/false values for yes/no states |
number | Numeric values including integers and decimal numbers |
currency | Monetary values with currency formatting and symbols, included withing a JSON object with 'amount' and 'currencyCode' |
date | A string representation of a date in YYYY-MM-DD format |
object | Structured data containing key-value pairs or nested properties |
array | Ordered collection of objects |
address | Formatted address fields with standardized structure |
prompt | String (result) value of prompt execution. Can include MD format and other stuff, depending on what you asked for within the prompt. |
country | Country field, containing a JSON structure with countryCodes or names |
list | Static enumerated list with predefined options, each entry containing 'key' and 'value' |
dynamic_list | List with options that can change based on conditions or external data sources |
Data Type Examplesโ
Below are practical examples of each data type as they appear in Docflo API responses:
stringโ
Simple text values extracted from documents.
{
"type": "string",
"content": "110820567",
"confidence": 0.942,
"value": "110820567"
}
booleanโ
True/false values for approval states or yes/no conditions.
{
"type": "boolean",
"value": true,
"changedOn": "2025-12-30T07:41:44.785Z",
"changedBy": "Ivan Tagiltsev"
}
numberโ
Numeric values including integers and decimals.
{
"type": "number",
"content": "2.00",
"confidence": 0.935,
"value": 2
}
currencyโ
Monetary values with structured amount and currency information.
{
"type": "currency",
"content": "52,133.00",
"confidence": 0.868,
"value": {
"amount": 52133,
"currencyCode": "ILS"
}
}
dateโ
Date values in standardized YYYY-MM-DD format.
{
"type": "date",
"content": "29.02.24",
"confidence": 0.939,
"value": "2024-02-29"
}
objectโ
Structured data with nested properties, commonly used for complex items.
{
"type": "object",
"confidence": 0.844,
"value": {
"Amount": {
"type": "currency",
"value": {
"amount": 60,
"currencyCode": "ILS"
}
},
"Description": {
"type": "string",
"value": "ืืื ืืจืืฉ ืขืืื"
},
"Quantity": {
"type": "number",
"value": 2
}
}
}
arrayโ
Ordered collections of objects, typically used for line items or multiple entries.
{
"type": "array",
"value": [
{
"type": "object",
"value": {
"Amount": {
"type": "currency",
"value": {
"amount": 60,
"currencyCode": "ILS"
}
},
"Description": {
"type": "string",
"value": "ืืื ืืจืืฉ ืขืืื"
}
},
"index": 0,
"_id": "f8454b63-07c5-47f2-9458-ada30afe4d99"
},
{
"type": "object",
"value": {
"Amount": {
"type": "currency",
"value": {
"amount": -600,
"currencyCode": "ILS"
}
},
"Description": {
"type": "string",
"value": "Something"
}
},
"index": 1,
"_id": "c134bba3-f396-4166-b9ac-41d14aa55628"
}
]
}
addressโ
Structured address information with standardized components.
{
"type": "address",
"content": "Some street 123, New Jersey, NY 15165, USA",
"confidence": 0.878,
"value": {
"postalCode": "15165",
"city": "New Jersey",
"streetAddress": "Some street",
"house": "123"
}
}
promptโ
AI-generated content based on document analysis.
{
"type": "prompt",
"confidence": 1,
"value": "The document appears to be a detailed invoice from a company named \"Whatever\", which seems to be involved in agricultural supplies. The document includes multiple transactions with specific dates, item descriptions, quantities, prices, and associated taxes (VAT)."
}
countryโ
Country information with standardized codes and names.
{
"type": "string",
"confidence": 0,
"value": {
"countryName": "Albania",
"countryCode": "AL"
},
"changedOn": "2025-12-30T07:40:15.193Z",
"changedBy": "Ivan Tagiltsev"
}
listโ
Static enumerated options with predefined key-value pairs.
{
"type": "string",
"confidence": 0,
"value": {
"key": "1010",
"value": "Some Company- DE"
},
"changedOn": "2025-12-30T07:40:15.193Z",
"changedBy": "Ivan Tagiltsev"
}
dynamic_listโ
Lists with options that can change based on external data sources.
{
"type": "string",
"confidence": 0,
"value": {
"key": "1000014",
"value": "AOG COURIERS"
},
"changedOn": "2025-12-30T07:40:15.193Z",
"changedBy": "Ivan Tagiltsev"
}