@opensanctions/followthemoney 4.5.2 → 4.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,8 +1,8 @@
1
1
  (function (global, factory) {
2
- typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('crypto')) :
3
- typeof define === 'function' && define.amd ? define(['exports', 'crypto'], factory) :
4
- (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.followthemoney = {}, global.crypto$1));
5
- })(this, (function (exports, crypto$1) { 'use strict';
2
+ typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
3
+ typeof define === 'function' && define.amd ? define(['exports'], factory) :
4
+ (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.followthemoney = {}));
5
+ })(this, (function (exports) { 'use strict';
6
6
 
7
7
  /**
8
8
  * An entity proxy which provides simplified access to the
@@ -251,6 +251,7 @@
251
251
  */
252
252
  class Property {
253
253
  constructor(schema, property) {
254
+ this.examples = null;
254
255
  this.schema = schema;
255
256
  this.name = property.name;
256
257
  this.qname = property.qname;
@@ -267,6 +268,7 @@
267
268
  this.type = schema.model.getType(property.type);
268
269
  this.hasRange = this.range !== null;
269
270
  this.hasReverse = this.range !== null && this.reverse !== null;
271
+ this.examples = property.examples || null;
270
272
  }
271
273
  getRange() {
272
274
  return this.schema.model.getSchema(this.range);
@@ -539,10 +541,7 @@
539
541
  * @returns a new UUID.
540
542
  */
541
543
  generateRandomId() {
542
- if (typeof crypto !== 'undefined' && crypto.randomUUID) {
543
- return crypto.randomUUID(); // Browser
544
- }
545
- return crypto$1.randomUUID(); // Node.js
544
+ return crypto.randomUUID();
546
545
  }
547
546
  /**
548
547
  * Make a new object with the given schema, and generate a random ID for
@@ -1273,14 +1272,6 @@
1273
1272
  qname: "Address:city",
1274
1273
  type: "string"
1275
1274
  },
1276
- country: {
1277
- label: "Country",
1278
- matchable: true,
1279
- maxLength: 16,
1280
- name: "country",
1281
- qname: "Address:country",
1282
- type: "country"
1283
- },
1284
1275
  full: {
1285
1276
  label: "Full address",
1286
1277
  matchable: true,
@@ -1328,7 +1319,7 @@
1328
1319
  type: "string"
1329
1320
  },
1330
1321
  postalCode: {
1331
- description: "Zip code or postcode.",
1322
+ description: "Zip code or postcode",
1332
1323
  label: "Postal code",
1333
1324
  maxLength: 16,
1334
1325
  name: "postalCode",
@@ -1336,7 +1327,7 @@
1336
1327
  type: "string"
1337
1328
  },
1338
1329
  region: {
1339
- description: "Also province or area.",
1330
+ description: "Also province or area",
1340
1331
  label: "Region",
1341
1332
  maxLength: 1024,
1342
1333
  name: "region",
@@ -1344,7 +1335,7 @@
1344
1335
  type: "string"
1345
1336
  },
1346
1337
  remarks: {
1347
- description: "Handling instructions, like 'care of'.",
1338
+ description: "Handling instructions, like 'care of'",
1348
1339
  label: "Remarks",
1349
1340
  maxLength: 1024,
1350
1341
  name: "remarks",
@@ -1352,7 +1343,7 @@
1352
1343
  type: "string"
1353
1344
  },
1354
1345
  state: {
1355
- description: "State or federal unit.",
1346
+ description: "State or federal unit",
1356
1347
  label: "State",
1357
1348
  maxLength: 1024,
1358
1349
  name: "state",
@@ -1645,7 +1636,7 @@
1645
1636
  ]
1646
1637
  },
1647
1638
  Associate: {
1648
- description: "Non-family association between two people",
1639
+ description: "Non-family association between two people.",
1649
1640
  edge: {
1650
1641
  caption: [
1651
1642
  "relationship"
@@ -1667,7 +1658,7 @@
1667
1658
  plural: "Associates",
1668
1659
  properties: {
1669
1660
  associate: {
1670
- description: "An associate of the subject person.",
1661
+ description: "An associate of the subject person",
1671
1662
  label: "Associate",
1672
1663
  matchable: true,
1673
1664
  maxLength: 200,
@@ -1678,7 +1669,7 @@
1678
1669
  type: "entity"
1679
1670
  },
1680
1671
  person: {
1681
- description: "The subject of the association.",
1672
+ description: "The subject of the association",
1682
1673
  label: "Person",
1683
1674
  matchable: true,
1684
1675
  maxLength: 200,
@@ -2039,7 +2030,7 @@
2039
2030
  caption: [
2040
2031
  "title"
2041
2032
  ],
2042
- description: "A public appeal issued by an authority, possibly on behalf of another, for buying a specific work, supply or service\n",
2033
+ description: "A public appeal issued by an authority, possibly on behalf of another, for buying a specific work, supply or service.\n",
2043
2034
  "extends": [
2044
2035
  "Interval",
2045
2036
  "Thing"
@@ -2165,7 +2156,7 @@
2165
2156
  type: "string"
2166
2157
  },
2167
2158
  fallsUnderGPPScope: {
2168
- description: "European Green Public Procurement (GPP) or green purchasing.",
2159
+ description: "European Green Public Procurement (GPP) or green purchasing",
2169
2160
  label: "Does this call fall under the scope of GPP?",
2170
2161
  maxLength: 1024,
2171
2162
  name: "fallsUnderGPPScope",
@@ -2373,13 +2364,13 @@
2373
2364
  },
2374
2365
  capital: {
2375
2366
  label: "Capital",
2376
- maxLength: 1024,
2367
+ maxLength: 250,
2377
2368
  name: "capital",
2378
2369
  qname: "Company:capital",
2379
- type: "string"
2370
+ type: "number"
2380
2371
  },
2381
2372
  cikCode: {
2382
- description: "US SEC Central Index Key",
2373
+ description: "US SEC Central Index Key for listed companies",
2383
2374
  label: "SEC Central Index Key",
2384
2375
  matchable: true,
2385
2376
  maxLength: 64,
@@ -2388,7 +2379,7 @@
2388
2379
  type: "identifier"
2389
2380
  },
2390
2381
  coatoCode: {
2391
- description: "Soviet classifier for territories, regions, districts, villages. Aka. SOATO and same as OKATO",
2382
+ description: "Soviet classifier for territories, regions, districts, villages. Aka. SOATO and same as OKATO.",
2392
2383
  label: "COATO / SOATO / OKATO",
2393
2384
  maxLength: 64,
2394
2385
  name: "coatoCode",
@@ -2428,6 +2419,7 @@
2428
2419
  type: "identifier"
2429
2420
  },
2430
2421
  isinCode: {
2422
+ deprecated: true,
2431
2423
  description: "International Securities Identification Number",
2432
2424
  label: "ISIN",
2433
2425
  matchable: true,
@@ -2445,16 +2437,8 @@
2445
2437
  qname: "Company:jibCode",
2446
2438
  type: "identifier"
2447
2439
  },
2448
- jurisdiction: {
2449
- label: "Jurisdiction",
2450
- matchable: true,
2451
- maxLength: 16,
2452
- name: "jurisdiction",
2453
- qname: "Company:jurisdiction",
2454
- type: "country"
2455
- },
2456
2440
  kppCode: {
2457
- description: "Russian code issued by the tax authority, identifies the reason for registration at the Federal Tax Service (Russian: КПП). A company may have multiple KPP codes (e.g. for different branches), and the codes are not unique across companies.",
2441
+ description: "(RU, КПП) Russian code issued by the tax authority, identifies the reason for registration at the Federal Tax Service. A company may have multiple KPP codes (e.g. for different branches), and the codes are not unique across companies.",
2458
2442
  label: "KPP",
2459
2443
  maxLength: 64,
2460
2444
  name: "kppCode",
@@ -2470,7 +2454,7 @@
2470
2454
  type: "identifier"
2471
2455
  },
2472
2456
  okopfCode: {
2473
- description: "Russian classifier that that categorizes different types of legal entities in Russia based on their organizational and legal structure (Russian: ОКОПФ)",
2457
+ description: "(RU, ОКОПФ) Russian classifier that categorizes different types of legal entities in Russia based on their organizational and legal structure",
2474
2458
  label: "OKOPF",
2475
2459
  maxLength: 1024,
2476
2460
  name: "okopfCode",
@@ -2478,7 +2462,7 @@
2478
2462
  type: "string"
2479
2463
  },
2480
2464
  oksmCode: {
2481
- description: "Russian (ОКСМ) countries classifier",
2465
+ description: "(RU, ОКСМ) Russian countries classifier",
2482
2466
  label: "OKSM",
2483
2467
  maxLength: 1024,
2484
2468
  name: "oksmCode",
@@ -2486,7 +2470,7 @@
2486
2470
  type: "string"
2487
2471
  },
2488
2472
  okvedCode: {
2489
- description: "Russian classifier that that categorizes businesses by their (primary and secondary) economic activities (Russian: ОКВЭД)",
2473
+ description: "(RU, ОКВЭД) Russian classifier that categorizes businesses by their (primary and secondary) economic activities",
2490
2474
  label: "OKVED(2) Classifier",
2491
2475
  maxLength: 1024,
2492
2476
  name: "okvedCode",
@@ -2494,7 +2478,7 @@
2494
2478
  type: "string"
2495
2479
  },
2496
2480
  pfrNumber: {
2497
- description: "(RU, ПФР) Pension Fund Registration number. AAA-BBB-CCCCCC, where AAA is organisation region, BBB is district, CCCCCC number at a specific branch",
2481
+ description: "(RU, ПФР) Pension Fund Registration number. AAA-BBB-CCCCCC, where AAA is organisation region, BBB is district, and CCCCCC is the number at a specific branch.",
2498
2482
  label: "PFR Number",
2499
2483
  matchable: true,
2500
2484
  maxLength: 64,
@@ -2502,14 +2486,6 @@
2502
2486
  qname: "Company:pfrNumber",
2503
2487
  type: "identifier"
2504
2488
  },
2505
- registrationNumber: {
2506
- label: "Registration number",
2507
- matchable: true,
2508
- maxLength: 64,
2509
- name: "registrationNumber",
2510
- qname: "Company:registrationNumber",
2511
- type: "identifier"
2512
- },
2513
2489
  ricCode: {
2514
2490
  label: "Reuters Instrument Code",
2515
2491
  matchable: true,
@@ -2562,7 +2538,7 @@
2562
2538
  "name",
2563
2539
  "procedureNumber"
2564
2540
  ],
2565
- description: "An contract or contract lot issued by an authority. Multiple lots may be awarded to different suppliers (see ContractAward).\n",
2541
+ description: "A contract or contract lot issued by an authority. Multiple lots may be awarded to different suppliers (see `ContractAward`).\n",
2566
2542
  "extends": [
2567
2543
  "Asset"
2568
2544
  ],
@@ -2700,6 +2676,10 @@
2700
2676
  type: "entity"
2701
2677
  },
2702
2678
  status: {
2679
+ examples: [
2680
+ "In force",
2681
+ "Annulled"
2682
+ ],
2703
2683
  label: "Status",
2704
2684
  maxLength: 1024,
2705
2685
  name: "status",
@@ -2714,7 +2694,12 @@
2714
2694
  type: "string"
2715
2695
  },
2716
2696
  type: {
2717
- description: "Type of contract. Potentially W (Works), U (Supplies), S (Services).\n",
2697
+ description: "Type of contract",
2698
+ examples: [
2699
+ "W (Works)",
2700
+ "U (Supplies)",
2701
+ "S (Services)"
2702
+ ],
2718
2703
  label: "Type",
2719
2704
  maxLength: 1024,
2720
2705
  name: "type",
@@ -3070,6 +3055,14 @@
3070
3055
  qname: "CryptoWallet:balanceDate",
3071
3056
  type: "date"
3072
3057
  },
3058
+ blockchain: {
3059
+ description: "The blockchain or distributed ledger system on which the wallet operates",
3060
+ label: "Blockchain",
3061
+ maxLength: 1024,
3062
+ name: "blockchain",
3063
+ qname: "CryptoWallet:blockchain",
3064
+ type: "string"
3065
+ },
3073
3066
  creationDate: {
3074
3067
  label: "Creation date",
3075
3068
  matchable: true,
@@ -3078,6 +3071,15 @@
3078
3071
  qname: "CryptoWallet:creationDate",
3079
3072
  type: "date"
3080
3073
  },
3074
+ cryptoAddress: {
3075
+ description: "The crypto address of the wallet",
3076
+ label: "Crypto address",
3077
+ matchable: true,
3078
+ maxLength: 512,
3079
+ name: "cryptoAddress",
3080
+ qname: "CryptoWallet:cryptoAddress",
3081
+ type: "identifier"
3082
+ },
3081
3083
  currencySymbol: {
3082
3084
  label: "Currency short code",
3083
3085
  maxLength: 1024,
@@ -3085,6 +3087,14 @@
3085
3087
  qname: "CryptoWallet:currencySymbol",
3086
3088
  type: "string"
3087
3089
  },
3090
+ custodyType: {
3091
+ description: "Type of custody arrangement for the wallet (e.g., self-custody, custodial service)",
3092
+ label: "Custody type",
3093
+ maxLength: 1024,
3094
+ name: "custodyType",
3095
+ qname: "CryptoWallet:custodyType",
3096
+ type: "string"
3097
+ },
3088
3098
  holder: {
3089
3099
  label: "Wallet holder",
3090
3100
  matchable: true,
@@ -3113,7 +3123,7 @@
3113
3123
  description: "Public key used to identify the wallet",
3114
3124
  label: "Address",
3115
3125
  matchable: true,
3116
- maxLength: 128,
3126
+ maxLength: 512,
3117
3127
  name: "publicKey",
3118
3128
  qname: "CryptoWallet:publicKey",
3119
3129
  type: "identifier"
@@ -3222,6 +3232,7 @@
3222
3232
  plural: "Directorships",
3223
3233
  properties: {
3224
3234
  director: {
3235
+ description: "The entity exercising control over another",
3225
3236
  label: "Director",
3226
3237
  matchable: true,
3227
3238
  maxLength: 200,
@@ -3610,7 +3621,7 @@
3610
3621
  "goodsDescription",
3611
3622
  "ccdNumber"
3612
3623
  ],
3613
- description: "A foreign economic activity",
3624
+ description: "A foreign economic activity.",
3614
3625
  "extends": [
3615
3626
  "Interval"
3616
3627
  ],
@@ -4092,14 +4103,6 @@
4092
4103
  label: "Event",
4093
4104
  plural: "Events",
4094
4105
  properties: {
4095
- country: {
4096
- label: "Country",
4097
- matchable: true,
4098
- maxLength: 16,
4099
- name: "country",
4100
- qname: "Event:country",
4101
- type: "country"
4102
- },
4103
4106
  important: {
4104
4107
  label: "Important",
4105
4108
  maxLength: 1024,
@@ -4156,7 +4159,7 @@
4156
4159
  }
4157
4160
  },
4158
4161
  Family: {
4159
- description: "Family relationship between two people",
4162
+ description: "Family relationship between two people.",
4160
4163
  edge: {
4161
4164
  caption: [
4162
4165
  "relationship"
@@ -4178,7 +4181,7 @@
4178
4181
  plural: "Family members",
4179
4182
  properties: {
4180
4183
  person: {
4181
- description: "The subject of the familial relation.",
4184
+ description: "The subject of the familial relation",
4182
4185
  label: "Person",
4183
4186
  matchable: true,
4184
4187
  maxLength: 200,
@@ -4189,7 +4192,11 @@
4189
4192
  type: "entity"
4190
4193
  },
4191
4194
  relationship: {
4192
- description: "Nature of the relationship, from the person's perspective eg. 'mother', where 'relative' is mother of 'person'.",
4195
+ description: "Nature of the relationship from the `person`'s perspective, e.g. 'mother', where `relative` is the mother of `person`",
4196
+ examples: [
4197
+ "mother",
4198
+ "sibling"
4199
+ ],
4193
4200
  label: "Relationship",
4194
4201
  maxLength: 1024,
4195
4202
  name: "relationship",
@@ -4197,7 +4204,7 @@
4197
4204
  type: "string"
4198
4205
  },
4199
4206
  relative: {
4200
- description: "The relative of the subject person.",
4207
+ description: "The relative of the subject person",
4201
4208
  label: "Relative",
4202
4209
  matchable: true,
4203
4210
  maxLength: 200,
@@ -4330,7 +4337,7 @@
4330
4337
  caption: [
4331
4338
  "number"
4332
4339
  ],
4333
- description: "An form of identification associated with its holder and some issuing country. This can be used for national ID cards, voter enrollments and similar instruments.\n",
4340
+ description: "A form of identification associated with its holder and some issuing country. This can be used for national ID cards, voter enrollments, and similar instruments.\n",
4334
4341
  "extends": [
4335
4342
  "Interval"
4336
4343
  ],
@@ -4346,6 +4353,7 @@
4346
4353
  plural: "Identifications",
4347
4354
  properties: {
4348
4355
  authority: {
4356
+ description: "Government body issuing the identification document",
4349
4357
  label: "Authority",
4350
4358
  maxLength: 1024,
4351
4359
  name: "authority",
@@ -4379,6 +4387,10 @@
4379
4387
  type: "identifier"
4380
4388
  },
4381
4389
  type: {
4390
+ examples: [
4391
+ "Passport",
4392
+ "Driving license"
4393
+ ],
4382
4394
  label: "Type",
4383
4395
  maxLength: 1024,
4384
4396
  name: "type",
@@ -4424,7 +4436,7 @@
4424
4436
  plural: "Images",
4425
4437
  properties: {
4426
4438
  credit: {
4427
- description: "The credit or attribution for the image.",
4439
+ description: "The credit or attribution for the image",
4428
4440
  label: "Credit",
4429
4441
  maxLength: 1024,
4430
4442
  name: "credit",
@@ -4512,6 +4524,7 @@
4512
4524
  type: "url"
4513
4525
  },
4514
4526
  date: {
4527
+ description: "Date associated with an Interval that isn't explicitly its `startDate` or `endDate` (prefer those when available)",
4515
4528
  label: "Date",
4516
4529
  matchable: true,
4517
4530
  maxLength: 32,
@@ -4527,6 +4540,7 @@
4527
4540
  type: "text"
4528
4541
  },
4529
4542
  endDate: {
4543
+ description: "The date of expiry of a document, or on which a relationship, sanctioned status, occupation, etc. ended",
4530
4544
  label: "End date",
4531
4545
  matchable: true,
4532
4546
  maxLength: 32,
@@ -4543,6 +4557,7 @@
4543
4557
  type: "text"
4544
4558
  },
4545
4559
  modifiedAt: {
4560
+ description: "The date on which the entity (like the ID document) was modified, not to be confused with an internal 'last updated'-style metadata field",
4546
4561
  label: "Modified on",
4547
4562
  matchable: true,
4548
4563
  maxLength: 32,
@@ -4584,6 +4599,7 @@
4584
4599
  type: "url"
4585
4600
  },
4586
4601
  recordId: {
4602
+ description: "Identifier of a record upon which this link is based",
4587
4603
  label: "Record ID",
4588
4604
  maxLength: 1024,
4589
4605
  name: "recordId",
@@ -4591,6 +4607,7 @@
4591
4607
  type: "string"
4592
4608
  },
4593
4609
  retrievedAt: {
4610
+ description: "Retrieval date generated by a data gathering system, not to be confused with an internal 'first found'-style metadata field",
4594
4611
  label: "Retrieved on",
4595
4612
  maxLength: 32,
4596
4613
  name: "retrievedAt",
@@ -4598,6 +4615,7 @@
4598
4615
  type: "date"
4599
4616
  },
4600
4617
  sourceUrl: {
4618
+ description: "A deep link to a source website for the profile",
4601
4619
  label: "Source link",
4602
4620
  maxLength: 4096,
4603
4621
  name: "sourceUrl",
@@ -4605,6 +4623,7 @@
4605
4623
  type: "url"
4606
4624
  },
4607
4625
  startDate: {
4626
+ description: "The date of issue of a document, or on which a relationship, sanctioned status, occupation, etc. started",
4608
4627
  label: "Start date",
4609
4628
  matchable: true,
4610
4629
  maxLength: 32,
@@ -4644,7 +4663,7 @@
4644
4663
  "phone",
4645
4664
  "registrationNumber"
4646
4665
  ],
4647
- description: "Any party to legal proceedings, such as asset ownership, corporate governance or social interactions. Often used when raw data does not specify if something is a person or company.\n",
4666
+ description: "Any party to legal proceedings, such as asset ownership, corporate governance or social interactions. Often used when raw data does not specify if something is a person, organization or company.\n",
4648
4667
  "extends": [
4649
4668
  "Thing"
4650
4669
  ],
@@ -4746,6 +4765,13 @@
4746
4765
  type: "entity"
4747
4766
  },
4748
4767
  classification: {
4768
+ description: "Classification as provided by the data source or inferred based on other provided data; prefer `sector` if relevant",
4769
+ examples: [
4770
+ "Local government (current)",
4771
+ "Banking operations license",
4772
+ "4. Priority Sector Apparel",
4773
+ "Entities Directly Serving the Defense and Security Sectors"
4774
+ ],
4749
4775
  label: "Classification",
4750
4776
  maxLength: 1024,
4751
4777
  name: "classification",
@@ -4893,7 +4919,7 @@
4893
4919
  },
4894
4920
  email: {
4895
4921
  description: "Email address",
4896
- label: "E-Mail",
4922
+ label: "Email",
4897
4923
  matchable: true,
4898
4924
  maxLength: 250,
4899
4925
  name: "email",
@@ -4982,7 +5008,7 @@
4982
5008
  type: "date"
4983
5009
  },
4984
5010
  innCode: {
4985
- description: "Russian tax identification number (Russian: ИНН). Issued to businesses and individuals in Russia",
5011
+ description: "(RU, ИНН) Russian tax identification number. Issued to businesses and individuals in Russia.",
4986
5012
  format: "inn",
4987
5013
  label: "INN",
4988
5014
  matchable: true,
@@ -4992,7 +5018,7 @@
4992
5018
  type: "identifier"
4993
5019
  },
4994
5020
  jurisdiction: {
4995
- description: "Country or region in which this entity operates",
5021
+ description: "Country or region in which this entity operates; prefer over broader `country` when relevant",
4996
5022
  label: "Jurisdiction",
4997
5023
  matchable: true,
4998
5024
  maxLength: 16,
@@ -5001,6 +5027,10 @@
5001
5027
  type: "country"
5002
5028
  },
5003
5029
  legalForm: {
5030
+ description: "Company or organization type",
5031
+ examples: [
5032
+ "Joint Stock Company"
5033
+ ],
5004
5034
  label: "Legal form",
5005
5035
  maxLength: 1024,
5006
5036
  name: "legalForm",
@@ -5027,7 +5057,7 @@
5027
5057
  type: "identifier"
5028
5058
  },
5029
5059
  mainCountry: {
5030
- description: "Primary country of this entity",
5060
+ description: "Primary country of this entity; prefer over broader `country` when relevant",
5031
5061
  label: "Country of origin",
5032
5062
  matchable: true,
5033
5063
  maxLength: 16,
@@ -5090,7 +5120,7 @@
5090
5120
  type: "identifier"
5091
5121
  },
5092
5122
  ogrnCode: {
5093
- description: "Identification number used in Russia's Unified State Register of Legal Entities (EGRUL) (Russian: ОГРН)",
5123
+ description: "(RU, ОГРН) Registration number used in Russia's Unified State Register of Legal Entities (EGRUL)",
5094
5124
  format: "ogrn",
5095
5125
  label: "OGRN",
5096
5126
  matchable: true,
@@ -5150,7 +5180,7 @@
5150
5180
  },
5151
5181
  parent: {
5152
5182
  deprecated: true,
5153
- description: "If this entity is a subsidiary, another entity (company or organisation) is its parent",
5183
+ description: "Deprecated, use `Ownership` link instead",
5154
5184
  label: "Parent company",
5155
5185
  matchable: true,
5156
5186
  maxLength: 200,
@@ -5231,6 +5261,12 @@
5231
5261
  type: "identifier"
5232
5262
  },
5233
5263
  sector: {
5264
+ description: "Industrial or trade sector as provided by the data source",
5265
+ examples: [
5266
+ "Registered Nurse",
5267
+ "Retail and wholesale",
5268
+ "Sea and coastal freight water transport"
5269
+ ],
5234
5270
  label: "Sector",
5235
5271
  maxLength: 1024,
5236
5272
  name: "sector",
@@ -5249,6 +5285,13 @@
5249
5285
  type: "entity"
5250
5286
  },
5251
5287
  status: {
5288
+ description: "A short string describing how 'active' (broadly defined) an entity is",
5289
+ examples: [
5290
+ "Current / Former / Sitting / Retired",
5291
+ "Active / Inactive",
5292
+ "Dissolved (last known activity October 2024)",
5293
+ "Liquidated on 12 November 2022"
5294
+ ],
5252
5295
  label: "Status",
5253
5296
  maxLength: 1024,
5254
5297
  name: "status",
@@ -5278,7 +5321,7 @@
5278
5321
  type: "entity"
5279
5322
  },
5280
5323
  swiftBic: {
5281
- description: "Bank identifier code",
5324
+ description: "SWIFT Bank identifier code from ISO9362",
5282
5325
  format: "bic",
5283
5326
  label: "SWIFT/BIC",
5284
5327
  matchable: true,
@@ -5308,6 +5351,10 @@
5308
5351
  type: "entity"
5309
5352
  },
5310
5353
  taxStatus: {
5354
+ examples: [
5355
+ "Non-Habitual Resident",
5356
+ "Compliant as at March 2022"
5357
+ ],
5311
5358
  label: "Tax status",
5312
5359
  maxLength: 1024,
5313
5360
  name: "taxStatus",
@@ -5325,7 +5372,7 @@
5325
5372
  type: "identifier"
5326
5373
  },
5327
5374
  uscCode: {
5328
- description: "Unified Social Credit Identifier",
5375
+ description: "Chinese Unified Social Credit Identifier",
5329
5376
  format: "uscc",
5330
5377
  label: "USCC",
5331
5378
  matchable: true,
@@ -5384,7 +5431,7 @@
5384
5431
  caption: [
5385
5432
  "name"
5386
5433
  ],
5387
- description: "A grant of land, rights or property. A type of Contract",
5434
+ description: "A grant of land, rights or property. A type of `Contract`.",
5388
5435
  "extends": [
5389
5436
  "Contract"
5390
5437
  ],
@@ -5787,13 +5834,31 @@
5787
5834
  label: "Occupancy",
5788
5835
  plural: "Occupancies",
5789
5836
  properties: {
5837
+ constituency: {
5838
+ description: "The geographic area/distict represented by the holder",
5839
+ label: "Constituency",
5840
+ maxLength: 1024,
5841
+ name: "constituency",
5842
+ qname: "Occupancy:constituency",
5843
+ type: "string"
5844
+ },
5790
5845
  declarationDate: {
5846
+ description: "If established by an asset declaration",
5791
5847
  label: "Declaration date",
5792
5848
  maxLength: 32,
5793
5849
  name: "declarationDate",
5794
5850
  qname: "Occupancy:declarationDate",
5795
5851
  type: "date"
5796
5852
  },
5853
+ electionDate: {
5854
+ description: "Election date for the position, if applicable",
5855
+ label: "Election date",
5856
+ matchable: true,
5857
+ maxLength: 32,
5858
+ name: "electionDate",
5859
+ qname: "Occupancy:electionDate",
5860
+ type: "date"
5861
+ },
5797
5862
  holder: {
5798
5863
  label: "Holder",
5799
5864
  matchable: true,
@@ -5804,6 +5869,32 @@
5804
5869
  reverse: "positionOccupancies",
5805
5870
  type: "entity"
5806
5871
  },
5872
+ periodEnd: {
5873
+ description: "End date of the period for which the position is occupied",
5874
+ label: "Period end",
5875
+ matchable: true,
5876
+ maxLength: 32,
5877
+ name: "periodEnd",
5878
+ qname: "Occupancy:periodEnd",
5879
+ type: "date"
5880
+ },
5881
+ periodStart: {
5882
+ description: "Start date of the period for which the position is occupied",
5883
+ label: "Period start",
5884
+ matchable: true,
5885
+ maxLength: 32,
5886
+ name: "periodStart",
5887
+ qname: "Occupancy:periodStart",
5888
+ type: "date"
5889
+ },
5890
+ politicalGroup: {
5891
+ description: "Caucus, faction or parliamentary group of the holder",
5892
+ label: "Political group",
5893
+ maxLength: 1024,
5894
+ name: "politicalGroup",
5895
+ qname: "Occupancy:politicalGroup",
5896
+ type: "string"
5897
+ },
5807
5898
  post: {
5808
5899
  label: "Position occupied",
5809
5900
  matchable: true,
@@ -5815,6 +5906,10 @@
5815
5906
  type: "entity"
5816
5907
  },
5817
5908
  status: {
5909
+ examples: [
5910
+ "current",
5911
+ "ended"
5912
+ ],
5818
5913
  label: "Status",
5819
5914
  maxLength: 1024,
5820
5915
  name: "status",
@@ -5850,7 +5945,7 @@
5850
5945
  "previousName",
5851
5946
  "registrationNumber"
5852
5947
  ],
5853
- description: "Any type of incorporated entity that cannot be owned by another (see Company). This might include charities, foundations or state-owned enterprises, depending on their jurisdiction.\n",
5948
+ description: "Any type of incorporated entity that cannot be owned by another (see `Company`). This might include charities, foundations or state-owned enterprises, depending on their jurisdiction.\n",
5854
5949
  "extends": [
5855
5950
  "LegalEntity"
5856
5951
  ],
@@ -6024,6 +6119,12 @@
6024
6119
  type: "entity"
6025
6120
  },
6026
6121
  ownershipType: {
6122
+ examples: [
6123
+ "beneficial",
6124
+ "direct",
6125
+ "indirect",
6126
+ "ultimate"
6127
+ ],
6027
6128
  label: "Type of ownership",
6028
6129
  maxLength: 1024,
6029
6130
  name: "ownershipType",
@@ -6253,7 +6354,7 @@
6253
6354
  "passportNumber",
6254
6355
  "number"
6255
6356
  ],
6256
- description: "An passport held by a person.\n",
6357
+ description: "A passport held by a person.\n",
6257
6358
  "extends": [
6258
6359
  "Identification"
6259
6360
  ],
@@ -6291,6 +6392,8 @@
6291
6392
  type: "gender"
6292
6393
  },
6293
6394
  givenName: {
6395
+ deprecated: true,
6396
+ description: "Deprecated, use `Identification:holder` link's `firstName` / `middleName` instead",
6294
6397
  label: "Given name",
6295
6398
  maxLength: 1024,
6296
6399
  name: "givenName",
@@ -6298,6 +6401,8 @@
6298
6401
  type: "string"
6299
6402
  },
6300
6403
  passportNumber: {
6404
+ deprecated: true,
6405
+ description: "Deprecated, use `Identification:number` instead",
6301
6406
  hidden: true,
6302
6407
  label: "Passport number",
6303
6408
  matchable: true,
@@ -6315,6 +6420,8 @@
6315
6420
  type: "identifier"
6316
6421
  },
6317
6422
  surname: {
6423
+ deprecated: true,
6424
+ description: "Deprecated, use `Identification:holder` link's `lastName` instead",
6318
6425
  label: "Surname",
6319
6426
  maxLength: 1024,
6320
6427
  name: "surname",
@@ -6565,6 +6672,7 @@
6565
6672
  type: "country"
6566
6673
  },
6567
6674
  deathDate: {
6675
+ description: "Joined the choir invisible.",
6568
6676
  label: "Death date",
6569
6677
  matchable: true,
6570
6678
  maxLength: 32,
@@ -6699,6 +6807,9 @@
6699
6807
  type: "string"
6700
6808
  },
6701
6809
  nameSuffix: {
6810
+ examples: [
6811
+ "OBE"
6812
+ ],
6702
6813
  label: "Name suffix",
6703
6814
  maxLength: 1024,
6704
6815
  name: "nameSuffix",
@@ -6762,7 +6873,7 @@
6762
6873
  },
6763
6874
  secondName: {
6764
6875
  deprecated: true,
6765
- description: "Deprecated, use one of the other more specific name properties instead.",
6876
+ description: "Deprecated, use one of the other more specific name properties instead",
6766
6877
  label: "Second name",
6767
6878
  maxLength: 1024,
6768
6879
  name: "secondName",
@@ -6857,7 +6968,7 @@
6857
6968
  caption: [
6858
6969
  "name"
6859
6970
  ],
6860
- description: "A post, role or position within an organization or body. This describes a position one or more people may occupy and not the occupation of the post by a specific individual at a specific point in time.\n'subnationalArea' should be used to further restrict the scope of the position. It should not simply represent some regional aspect of the role - e.g. the constituency of a national member of parliament - when their legislative jurisdiction is nationwide.\n",
6971
+ description: "A post, role or position within an organization or body. This describes a position one or more people may occupy and not the occupation of the post by a specific individual at a specific point in time (see `Occupancy`).\n",
6861
6972
  "extends": [
6862
6973
  "Thing"
6863
6974
  ],
@@ -6915,7 +7026,8 @@
6915
7026
  type: "entity"
6916
7027
  },
6917
7028
  subnationalArea: {
6918
- label: "Subnational jurisdiction name or code",
7029
+ description: "The name or code of a subnational jurisdiction, only when the position is geographically limited. Prefer `Occupancy:constituency` where relevant.",
7030
+ label: "Subnational area",
6919
7031
  maxLength: 1024,
6920
7032
  name: "subnationalArea",
6921
7033
  qname: "Position:subnationalArea",
@@ -6943,7 +7055,7 @@
6943
7055
  "name",
6944
7056
  "projectId"
6945
7057
  ],
6946
- description: "An activity carried out by a group of participants.\n",
7058
+ description: "An activity carried out by a group of `participants`.\n",
6947
7059
  "extends": [
6948
7060
  "Interval",
6949
7061
  "Thing",
@@ -7040,7 +7152,7 @@
7040
7152
  caption: [
7041
7153
  "role"
7042
7154
  ],
7043
- description: "An activity carried out by a group of participants.\n",
7155
+ description: "A participant in a `Project`.\n",
7044
7156
  edge: {
7045
7157
  caption: [
7046
7158
  "role"
@@ -7342,7 +7454,7 @@
7342
7454
  "reason",
7343
7455
  "status"
7344
7456
  ],
7345
- description: "A risk associated with an entity",
7457
+ description: "A risk associated with an entity.",
7346
7458
  "extends": [
7347
7459
  "Interval"
7348
7460
  ],
@@ -7432,7 +7544,7 @@
7432
7544
  caption: [
7433
7545
  "program"
7434
7546
  ],
7435
- description: "A sanction designation",
7547
+ description: "A sanction designation.",
7436
7548
  "extends": [
7437
7549
  "Interval"
7438
7550
  ],
@@ -7487,6 +7599,7 @@
7487
7599
  type: "entity"
7488
7600
  },
7489
7601
  listingDate: {
7602
+ description: "The date on which the designation is listed; distinct from the `startDate`, which is the date on which the designation goes into effect",
7490
7603
  label: "Listing date",
7491
7604
  matchable: true,
7492
7605
  maxLength: 32,
@@ -7525,6 +7638,7 @@
7525
7638
  type: "string"
7526
7639
  },
7527
7640
  reason: {
7641
+ description: "An explanation of the designation's justification.",
7528
7642
  label: "Reason",
7529
7643
  maxLength: 65000,
7530
7644
  name: "reason",
@@ -7532,6 +7646,12 @@
7532
7646
  type: "text"
7533
7647
  },
7534
7648
  status: {
7649
+ examples: [
7650
+ "Active",
7651
+ "Inactive",
7652
+ "Expired",
7653
+ "Suspended"
7654
+ ],
7535
7655
  label: "Status",
7536
7656
  maxLength: 1024,
7537
7657
  name: "status",
@@ -7539,6 +7659,7 @@
7539
7659
  type: "string"
7540
7660
  },
7541
7661
  unscId: {
7662
+ description: "Identifier issued by the UN Security Council for sanctions designations",
7542
7663
  label: "UN SC identifier",
7543
7664
  matchable: true,
7544
7665
  maxLength: 16,
@@ -7868,7 +7989,7 @@
7868
7989
  }
7869
7990
  },
7870
7991
  TaxRoll: {
7871
- description: "A tax declaration of an individual",
7992
+ description: "A tax declaration of an individual.",
7872
7993
  "extends": [
7873
7994
  "Interval"
7874
7995
  ],
@@ -7976,6 +8097,7 @@
7976
8097
  plural: "Thing",
7977
8098
  properties: {
7978
8099
  address: {
8100
+ description: "A textual description of an address linked to the entity",
7979
8101
  label: "Address",
7980
8102
  matchable: true,
7981
8103
  maxLength: 250,
@@ -7984,6 +8106,7 @@
7984
8106
  type: "address"
7985
8107
  },
7986
8108
  addressEntity: {
8109
+ description: "A reference to an `Address` entity with structured place information",
7987
8110
  label: "Address",
7988
8111
  matchable: true,
7989
8112
  maxLength: 200,
@@ -8002,6 +8125,7 @@
8002
8125
  type: "url"
8003
8126
  },
8004
8127
  alias: {
8128
+ description: "An alternative or secondary name",
8005
8129
  label: "Alias",
8006
8130
  matchable: true,
8007
8131
  maxLength: 384,
@@ -8021,6 +8145,7 @@
8021
8145
  type: "entity"
8022
8146
  },
8023
8147
  country: {
8148
+ description: "An association between the entity and a country that is not covered by a more specific property (e.g. `jurisdiction`, `birthCountry`, `mainCountry`)",
8024
8149
  label: "Country",
8025
8150
  matchable: true,
8026
8151
  maxLength: 16,
@@ -8040,6 +8165,7 @@
8040
8165
  type: "entity"
8041
8166
  },
8042
8167
  createdAt: {
8168
+ description: "The date on which the entity was created, not to be confused with an internal 'first saved'-style metadata field",
8043
8169
  label: "Created at",
8044
8170
  maxLength: 32,
8045
8171
  name: "createdAt",
@@ -8047,6 +8173,7 @@
8047
8173
  type: "date"
8048
8174
  },
8049
8175
  description: {
8176
+ description: "A longer description; see also `notes`, `summary`",
8050
8177
  label: "Description",
8051
8178
  maxLength: 65000,
8052
8179
  name: "description",
@@ -8073,6 +8200,7 @@
8073
8200
  type: "text"
8074
8201
  },
8075
8202
  keywords: {
8203
+ description: "Plain text keywords provided for the entity; prefer more specific `type`, `status`, etc. as appropriate",
8076
8204
  label: "Keywords",
8077
8205
  maxLength: 1024,
8078
8206
  name: "keywords",
@@ -8091,6 +8219,7 @@
8091
8219
  type: "entity"
8092
8220
  },
8093
8221
  modifiedAt: {
8222
+ description: "The date on which the entity was modified, not to be confused with an internal 'last updated'-style metadata field",
8094
8223
  label: "Modified on",
8095
8224
  maxLength: 32,
8096
8225
  name: "modifiedAt",
@@ -8098,6 +8227,7 @@
8098
8227
  type: "date"
8099
8228
  },
8100
8229
  name: {
8230
+ description: "The primary name of the entity",
8101
8231
  label: "Name",
8102
8232
  matchable: true,
8103
8233
  maxLength: 384,
@@ -8117,6 +8247,7 @@
8117
8247
  type: "entity"
8118
8248
  },
8119
8249
  notes: {
8250
+ description: "Narrative description of the entity; see also `description`, `summary`",
8120
8251
  label: "Notes",
8121
8252
  maxLength: 65000,
8122
8253
  name: "notes",
@@ -8124,6 +8255,7 @@
8124
8255
  type: "text"
8125
8256
  },
8126
8257
  previousName: {
8258
+ description: "A former name of the entity",
8127
8259
  label: "Previous name",
8128
8260
  matchable: true,
8129
8261
  maxLength: 384,
@@ -8132,7 +8264,7 @@
8132
8264
  type: "name"
8133
8265
  },
8134
8266
  program: {
8135
- description: "Regulatory program or sanctions list on which an entity is listed.",
8267
+ description: "Regulatory program or sanctions list on which an entity is listed",
8136
8268
  label: "Program",
8137
8269
  maxLength: 1024,
8138
8270
  name: "program",
@@ -8172,6 +8304,7 @@
8172
8304
  type: "url"
8173
8305
  },
8174
8306
  retrievedAt: {
8307
+ description: "Retrieval date generated by a data gathering system, not to be confused with an internal 'first found'-style metadata field",
8175
8308
  label: "Retrieved on",
8176
8309
  maxLength: 32,
8177
8310
  name: "retrievedAt",
@@ -8201,6 +8334,7 @@
8201
8334
  type: "entity"
8202
8335
  },
8203
8336
  sourceUrl: {
8337
+ description: "A deep link to a source website for the profile",
8204
8338
  label: "Source link",
8205
8339
  maxLength: 4096,
8206
8340
  name: "sourceUrl",
@@ -8208,6 +8342,7 @@
8208
8342
  type: "url"
8209
8343
  },
8210
8344
  summary: {
8345
+ description: "A short one-liner description; see also `description`, `notes`",
8211
8346
  label: "Summary",
8212
8347
  maxLength: 65000,
8213
8348
  name: "summary",
@@ -8215,6 +8350,12 @@
8215
8350
  type: "text"
8216
8351
  },
8217
8352
  topics: {
8353
+ description: "Controlled tags used to qualify the entity and associate it with a risk category",
8354
+ examples: [
8355
+ "sanction",
8356
+ "debarment",
8357
+ "role.pep"
8358
+ ],
8218
8359
  label: "Topics",
8219
8360
  maxLength: 64,
8220
8361
  name: "topics",
@@ -8252,6 +8393,9 @@
8252
8393
  type: "name"
8253
8394
  },
8254
8395
  wikidataId: {
8396
+ examples: [
8397
+ "Q7747"
8398
+ ],
8255
8399
  format: "wikidata",
8256
8400
  label: "Wikidata ID",
8257
8401
  matchable: true,
@@ -8431,7 +8575,7 @@
8431
8575
  properties: {
8432
8576
  email: {
8433
8577
  description: "Email address",
8434
- label: "E-Mail",
8578
+ label: "Email",
8435
8579
  matchable: true,
8436
8580
  maxLength: 250,
8437
8581
  name: "email",
@@ -8621,6 +8765,7 @@
8621
8765
  },
8622
8766
  owner: {
8623
8767
  deprecated: true,
8768
+ description: "Deprecated, use `Ownership` link instead",
8624
8769
  label: "Owner",
8625
8770
  matchable: true,
8626
8771
  maxLength: 200,
@@ -8658,6 +8803,9 @@
8658
8803
  type: "entity"
8659
8804
  },
8660
8805
  type: {
8806
+ examples: [
8807
+ "Bulk carrier"
8808
+ ],
8661
8809
  label: "Type",
8662
8810
  maxLength: 1024,
8663
8811
  name: "type",
@@ -8717,6 +8865,7 @@
8717
8865
  type: "identifier"
8718
8866
  },
8719
8867
  deadweightTonnage: {
8868
+ description: "Weight of the vessel when not carrying freight",
8720
8869
  label: "Deadweight Tonnage",
8721
8870
  maxLength: 250,
8722
8871
  name: "deadweightTonnage",
@@ -9441,6 +9590,7 @@
9441
9590
  "gov.security": "Security services",
9442
9591
  "gov.soe": "State-owned enterprise",
9443
9592
  "gov.state": "State government",
9593
+ "invest.risk": "Investment risk",
9444
9594
  "mare.detained": "Maritime detention",
9445
9595
  "mare.shadow": "Shadow fleet",
9446
9596
  "mare.sts": "Ship-to-ship transfer",
@@ -9460,8 +9610,11 @@
9460
9610
  "role.lawyer": "Lawyer",
9461
9611
  "role.lobby": "Lobbyist",
9462
9612
  "role.oligarch": "Oligarch",
9463
- "role.pep": "Politician",
9464
- "role.pol": "Non-PEP",
9613
+ "role.pep": "PEP",
9614
+ "role.pep.frmr": "Former PEP",
9615
+ "role.pep.intl": "International PEP",
9616
+ "role.pep.natl": "National PEP",
9617
+ "role.pol": "Politician",
9465
9618
  "role.rca": "Close Associate",
9466
9619
  "role.spy": "Spy",
9467
9620
  sanction: "Sanctioned entity",