Metadata

The Solid Platform supports metadata to add information to the resource
General
Metadata
 last updated: 
November 22, 2022

The Solid Platform support includes metadata on the following resources:
Person, Business, Accounts, Contacts, Cards, and Transfer

Metadata takes the form of free-form key-value pairs. You may send metadata when you create an object (POST) and when updating the object (PATCH).  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, like this:

  1. {  "key": "" }

Current limitations:
- Max of 20 keys for any single metadata object
- Max of 4KB for any single metadata object

EXAMPLE (in Create a Person)

  1. {
  2.   "id": "per-3ebfa3d2-5d36-411d-984a-9e3a328011c5",
  3.   "firstName": "John",
  4.   "middleName": "",
  5.   "lastName": "Doe",
  6.   "phone": "+19418405843",
  7.   "phoneVerified": true,
  8.   "email": "john.doe@gmail.com",
  9.   "emailVerified": false,
  10.   "dateOfBirth": "1974-01-25",
  11.   "idType": "ssn",
  12.   "idNumber": "223902234",
  13.   "address": {
  14.     "addressType": "mailing",
  15.     "line1": "123 Main St",
  16.     "line2": "",
  17.     "city": "New York",
  18.     "state": "NY",
  19.     "country": "US",
  20.     "postalCode": "10001"
  21.   },
  22.   "kyc": {
  23.     "id": "kyc-d40f6bdd-6e12-446e-a3a8-7bd3b2dbb182",
  24.     "personId": "per-3ebfa3d2-5d36-411d-984a-9e3a328011c5",
  25.     "status": "notStarted",
  26.     "reviewCode": "",
  27.     "reviewMessage": "",
  28.     "results": {
  29.       "idv": "notStarted",
  30.       "address": "notStarted",
  31.       "dateOfBirth": "notStarted",
  32.       "fraud": "notStarted"
  33.     },
  34.     "createdAt": "2021-12-14T21:25:19Z",
  35.     "modifiedAt": "2021-12-14T21:25:19Z"
  36.   },
  37.   "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  38.   "createdAt": "2021-12-14T21:25:19Z",
  39.   "modifiedAt": "2021-12-14T21:25:19Z",
  40.   "language": "en",
  41.   "metadata": {
  42.     "externalId": "usr_9HG724gvHJB378v3h",
  43.     "description": "Pro user"
  44.   },
  45.   "status": "active"
  46. }