Metadata

DigiFi lets you attach custom key–value pairs (“metadata”) to many core objects so you can keep business-specific information inside the platform. DigiFi never interprets or validates this data—it’s strictly for your integration’s private use.

Metadata limits

LimitDescription
≤ 20 pairsMaximum key-value pairs stored on the resource
Key ≤ 40 charsASCII; avoid square brackets [ ]
Value typesstring (≤ 500 chars) · number · boolean

Metadata patch limits

LimitDescription
≤ 40 keys per requestTotal keys you can add, update, or remove in a single PATCH
Key ≤ 40 charsSame key length restriction applies when patching
Value typesSame value type restrictions apply (string, number, boolean)

Security tip Never store sensitive data in metadata.
Instead, store regulated content in your own system and reference it with an ID.


When to use metadata

  • Link DigiFi objects to IDs in your own system (customer id or external integration id).
  • Track operational flags (fraud review status, fulfillment channel).
  • Preserve audit info (who created a Task).

Working with metadata

Create an object with metadata

{
  "metadata": {
    "account_id": "6573"
  }
}
 

Patch metadata on an existing object

Add or update keys

{
  "metadata": {
    "external_integration_id": "452"
  }
}

Remove a single key

{
  "metadata": {
    "external_integration_id": null
  }
}

Clear all metadata

{
  "metadata": null
}

Best practices

  • Keep it small – Use metadata for quick look-ups; store heavy data externally.
  • Stay consistent – Standardize key names (order_id, crm_user_id) across resources.

Affected resources

Metadata is now available on:

  • Borrower
  • Intermediary
  • Application
  • Application Task
  • Application Document