Entity

Identity shared by every business entity.

Kind
Base entity
Version
0.1.0
Definition
entity.json

Properties

KeyMeaningTypeNotesEquivalent
id IDOpaque, case-sensitive identifier in the system holding this record. Text Required
external_references External referencesReferences keyed by vendor/type. Each key holds a list of IDs with optional routing keys identifying accounts or brands within that namespace. External reference Several, keyed by a labelList of values

Example

{
  "id": "customer_123",
  "external_references": {
    "stripe/customer": [
      {
        "routing_key": "brand_1",
        "id": "cust_32HDDsd"
      },
      {
        "routing_key": "brand_2",
        "id": "cust_87ABCxy"
      }
    ],
    "fortifi/customer": [
      {
        "id": "CST_456"
      }
    ]
  }
}