METADATA

We support including metadata on most of our resources as a way to add internal information to our system. Metadata takes the form of key-value pairs. This allows easier searching through both the API and web interfaces. Developers can also add individual rules based on metadata values. You may write metadata both when you create an object and when updating the object.

If you would like to remove metadata that is already on an object, you can unset it by passing in the key-value pair with an empty string or null as the value, like this:

{
  "metadata": {
    "customer_id": "05bf605b-a0b3-4fdc-bbd8-aff1ab677793",
    "loan_type": "installment"
  }
}

Searching via Metadata

GET endpoints allow you to query resources via metadata. It is possible to query on multiple metadata tags at once by including them as separate URL parameters separated by &. This delivers all objects tagged with both metadata tags, functioning like an AND operator. There are no other logical operators (OR, etc.) available when querying by metadata.