Organization Update

POST

/v2.1/organizations/:entityId

POST

/v2.1/organizations/:entityId

1 curl -X POST https://api.frankie.one/v2.1/organizations/entityId \
2      -H "api_key: <apiKey>" \
3      -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
4      -H "Content-Type: application/json" \
5      -d '{}'

Try it

200Successful

1 {
2   "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
3   "organization": {
4     "addresses": [
5       {
6         "country": "foo",
7         "addressId": "foo",
8         "buildingName": "foo",
9         "careOf": "foo",
10         "district": "foo",
11         "locality": "foo",
12         "longForm": "foo",
13         "neighborhood": "foo",
14         "postalCode": "foo",
15         "sourceId": "foo",
16         "status": "CURRENT",
17         "streetName": "foo",
18         "streetNumber": "foo",
19         "streetType": "foo",
20         "subdivision": "foo",
21         "type": "OTHER",
22         "typeDescription": "foo",
23         "unitNumber": "foo",
24         "unstructuredLongForm": "foo",
25         "validFrom": {
26           "day": "27",
27           "month": "03",
28           "normalized": "1990-03-31",
29           "type": "GREGORIAN",
30           "unstructured": "12 Rajab 1445 AH",
31           "year": "1990"
32         },
33         "validTo": {
34           "day": "27",
35           "month": "03",
36           "normalized": "1990-03-31",
37           "type": "GREGORIAN",
38           "unstructured": "12 Rajab 1445 AH",
39           "year": "1990"
40         }
41       }
42     ],
43     "blockingEntities": {},
44     "createdAt": "foo",
45     "customAttributes": {},
46     "details": {
47       "type": {
48         "code": "foo",
49         "description": "foo",
50         "sourceId": "foo"
51       },
52       "class": {
53         "code": "foo",
54         "description": "foo",
55         "sourceId": "foo"
56       },
57       "subClass": {
58         "code": "foo",
59         "description": "foo",
60         "sourceId": "foo"
61       },
62       "subType": {
63         "code": "foo",
64         "description": "foo",
65         "sourceId": "foo"
66       },
67       "registrationDetails": [
68         {
69           "registrationNumber": "foo",
70           "class": {
71             "code": "foo",
72             "description": "foo",
73             "sourceId": "foo"
74           },
75           "extractedDate": {
76             "day": "27",
77             "month": "03",
78             "normalized": "1990-03-31",
79             "type": "GREGORIAN",
80             "unstructured": "12 Rajab 1445 AH",
81             "year": "1990"
82           },
83           "foundationDate": {
84             "day": "27",
85             "month": "03",
86             "normalized": "1990-03-31",
87             "type": "GREGORIAN",
88             "unstructured": "12 Rajab 1445 AH",
89             "year": "1990"
90           },
91           "isCurrent": true,
92           "isSuppressed": true,
93           "registeredCountry": "foo",
94           "registeredDate": {
95             "day": "27",
96             "month": "03",
97             "normalized": "1990-03-31",
98             "type": "GREGORIAN",
99             "unstructured": "12 Rajab 1445 AH",
100             "year": "1990"
101           },
102           "registeredName": {
103             "name": "foo",
104             "type": "foo",
105             "validFrom": {
106               "day": "27",
107               "month": "03",
108               "normalized": "1990-03-31",
109               "type": "GREGORIAN",
110               "unstructured": "12 Rajab 1445 AH",
111               "year": "1990"
112             },
113             "validTo": {
114               "day": "27",
115               "month": "03",
116               "normalized": "1990-03-31",
117               "type": "GREGORIAN",
118               "unstructured": "12 Rajab 1445 AH",
119               "year": "1990"
120             },
121             "sourceId": "foo"
122           },
123           "registeredSubdivision": "foo",
124           "registrationNumberDescription": "foo",
125           "registrationNumberType": "foo",
126           "registrationStatus": {
127             "normalized": {
128               "code": "foo",
129               "description": "foo"
130             },
131             "unstructured": {
132               "code": "foo",
133               "description": "foo"
134             },
135             "sourceId": "foo"
136           },
137           "registry": "foo",
138           "registryDescription": "foo",
139           "reviewDate": {
140             "day": "27",
141             "month": "03",
142             "normalized": "1990-03-31",
143             "type": "GREGORIAN",
144             "unstructured": "12 Rajab 1445 AH",
145             "year": "1990"
146           },
147           "sourceId": "foo",
148           "status": {
149             "normalized": {
150               "code": "foo",
151               "description": "foo"
152             },
153             "unstructured": {
154               "code": "foo",
155               "description": "foo"
156             },
157             "sourceId": "foo"
158           },
159           "subClass": {
160             "code": "foo",
161             "description": "foo",
162             "sourceId": "foo"
163           },
164           "subType": {
165             "code": "foo",
166             "description": "foo",
167             "sourceId": "foo"
168           },
169           "type": {
170             "code": "foo",
171             "description": "foo",
172             "sourceId": "foo"
173           },
174           "updatedDate": {
175             "day": "27",
176             "month": "03",
177             "normalized": "1990-03-31",
178             "type": "GREGORIAN",
179             "unstructured": "12 Rajab 1445 AH",
180             "year": "1990"
181           },
182           "validFrom": {
183             "day": "27",
184             "month": "03",
185             "normalized": "1990-03-31",
186             "type": "GREGORIAN",
187             "unstructured": "12 Rajab 1445 AH",
188             "year": "1990"
189           },
190           "validTo": {
191             "day": "27",
192             "month": "03",
193             "normalized": "1990-03-31",
194             "type": "GREGORIAN",
195             "unstructured": "12 Rajab 1445 AH",
196             "year": "1990"
197           }
198         }
199       ],
200       "alternateNames": [
201         {
202           "name": "foo",
203           "type": "foo",
204           "validFrom": {
205             "day": "27",
206             "month": "03",
207             "normalized": "1990-03-31",
208             "type": "GREGORIAN",
209             "unstructured": "12 Rajab 1445 AH",
210             "year": "1990"
211           },
212           "validTo": {
213             "day": "27",
214             "month": "03",
215             "normalized": "1990-03-31",
216             "type": "GREGORIAN",
217             "unstructured": "12 Rajab 1445 AH",
218             "year": "1990"
219           },
220           "sourceId": "foo"
221         }
222       ],
223       "name": {
224         "name": "foo",
225         "type": "foo",
226         "validFrom": {
227           "day": "27",
228           "month": "03",
229           "normalized": "1990-03-31",
230           "type": "GREGORIAN",
231           "unstructured": "12 Rajab 1445 AH",
232           "year": "1990"
233         },
234         "validTo": {
235           "day": "27",
236           "month": "03",
237           "normalized": "1990-03-31",
238           "type": "GREGORIAN",
239           "unstructured": "12 Rajab 1445 AH",
240           "year": "1990"
241         },
242         "sourceId": "foo"
243       },
244       "status": {
245         "normalized": {
246           "code": "foo",
247           "description": "foo"
248         },
249         "unstructured": {
250           "code": "foo",
251           "description": "foo"
252         },
253         "sourceId": "foo"
254       },
255       "jurisdiction": {
256         "country": "foo",
257         "registry": "foo",
258         "registryDescription": "foo",
259         "subdivision": "foo"
260       },
261       "industryDeclarations": [
262         {
263           "code": "foo",
264           "description": "foo",
265           "language": "foo",
266           "sourceId": "foo"
267         }
268       ],
269       "industryCodes": [
270         {
271           "code": "foo",
272           "description": "foo",
273           "sourceId": "foo",
274           "type": "foo"
275         }
276       ]
277     },
278     "documents": {
279       "REPORT": [
280         {
281           "type": "OTHER",
282           "country": "AUS",
283           "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
284           "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
285           "expiryDate": {
286             "day": "27",
287             "month": "03",
288             "normalized": "1990-03-31",
289             "type": "GREGORIAN",
290             "unstructured": "12 Rajab 1445 AH",
291             "year": "1990"
292           },
293           "issueDate": {
294             "day": "27",
295             "month": "03",
296             "normalized": "1990-03-31",
297             "type": "GREGORIAN",
298             "unstructured": "12 Rajab 1445 AH",
299             "year": "1990"
300           },
301           "primaryIdentifier": "000734130",
302           "secondaryIdentifier": "P0001975",
303           "subtype": "Photo Comparison",
304           "subdivision": "VIC",
305           "createdAt": "2024-01-15T02:18:11.365Z",
306           "updatedAt": "2025-01-16T02:18:11.365Z",
307           "validFrom": {
308             "day": "27",
309             "month": "03",
310             "normalized": "1990-03-31",
311             "type": "GREGORIAN",
312             "unstructured": "12 Rajab 1445 AH",
313             "year": "1990"
314           },
315           "validTo": {
316             "day": "27",
317             "month": "03",
318             "normalized": "1990-03-31",
319             "type": "GREGORIAN",
320             "unstructured": "12 Rajab 1445 AH",
321             "year": "1990"
322           },
323           "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
324           "supplementaryData": {
325             "type": "NATIONAL_HEALTH_ID",
326             "middleNameOnCard": "foo",
327             "nameOnCardLine1": "foo",
328             "nameOnCardLine2": "foo",
329             "nameOnCardLine3": "foo",
330             "nameOnCardLine4": "foo",
331             "reference": "1"
332           },
333           "customAttributes": {},
334           "attachments": [
335             {
336               "data": {
337                 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
338               },
339               "attachmentId": "foo",
340               "sourceId": "foo",
341               "createdAt": "foo",
342               "updatedAt": "foo",
343               "filename": "foo",
344               "mimeType": "foo",
345               "pageNumber": 42,
346               "side": "FRONT",
347               "type": "foo",
348               "location": "foo",
349               "lastMalwareScanAt": "foo",
350               "retrievalStatus": "NORMAL"
351             }
352           ]
353         }
354       ],
355       "SUPPORTING": [
356         {
357           "type": "OTHER",
358           "country": "AUS",
359           "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
360           "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
361           "expiryDate": {
362             "day": "27",
363             "month": "03",
364             "normalized": "1990-03-31",
365             "type": "GREGORIAN",
366             "unstructured": "12 Rajab 1445 AH",
367             "year": "1990"
368           },
369           "issueDate": {
370             "day": "27",
371             "month": "03",
372             "normalized": "1990-03-31",
373             "type": "GREGORIAN",
374             "unstructured": "12 Rajab 1445 AH",
375             "year": "1990"
376           },
377           "primaryIdentifier": "000734130",
378           "secondaryIdentifier": "P0001975",
379           "subtype": "Photo Comparison",
380           "subdivision": "VIC",
381           "createdAt": "2024-01-15T02:18:11.365Z",
382           "updatedAt": "2025-01-16T02:18:11.365Z",
383           "validFrom": {
384             "day": "27",
385             "month": "03",
386             "normalized": "1990-03-31",
387             "type": "GREGORIAN",
388             "unstructured": "12 Rajab 1445 AH",
389             "year": "1990"
390           },
391           "validTo": {
392             "day": "27",
393             "month": "03",
394             "normalized": "1990-03-31",
395             "type": "GREGORIAN",
396             "unstructured": "12 Rajab 1445 AH",
397             "year": "1990"
398           },
399           "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
400           "supplementaryData": {
401             "type": "NATIONAL_HEALTH_ID",
402             "middleNameOnCard": "foo",
403             "nameOnCardLine1": "foo",
404             "nameOnCardLine2": "foo",
405             "nameOnCardLine3": "foo",
406             "nameOnCardLine4": "foo",
407             "reference": "1"
408           },
409           "customAttributes": {},
410           "attachments": [
411             {
412               "data": {
413                 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
414               },
415               "attachmentId": "foo",
416               "sourceId": "foo",
417               "createdAt": "foo",
418               "updatedAt": "foo",
419               "filename": "foo",
420               "mimeType": "foo",
421               "pageNumber": 42,
422               "side": "FRONT",
423               "type": "foo",
424               "location": "foo",
425               "lastMalwareScanAt": "foo",
426               "retrievalStatus": "NORMAL"
427             }
428           ]
429         }
430       ],
431       "IDENTITY": [
432         {
433           "type": "OTHER",
434           "country": "AUS",
435           "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
436           "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
437           "expiryDate": {
438             "day": "27",
439             "month": "03",
440             "normalized": "1990-03-31",
441             "type": "GREGORIAN",
442             "unstructured": "12 Rajab 1445 AH",
443             "year": "1990"
444           },
445           "issueDate": {
446             "day": "27",
447             "month": "03",
448             "normalized": "1990-03-31",
449             "type": "GREGORIAN",
450             "unstructured": "12 Rajab 1445 AH",
451             "year": "1990"
452           },
453           "primaryIdentifier": "000734130",
454           "secondaryIdentifier": "P0001975",
455           "subtype": "Photo Comparison",
456           "subdivision": "VIC",
457           "createdAt": "2024-01-15T02:18:11.365Z",
458           "updatedAt": "2025-01-16T02:18:11.365Z",
459           "validFrom": {
460             "day": "27",
461             "month": "03",
462             "normalized": "1990-03-31",
463             "type": "GREGORIAN",
464             "unstructured": "12 Rajab 1445 AH",
465             "year": "1990"
466           },
467           "validTo": {
468             "day": "27",
469             "month": "03",
470             "normalized": "1990-03-31",
471             "type": "GREGORIAN",
472             "unstructured": "12 Rajab 1445 AH",
473             "year": "1990"
474           },
475           "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
476           "supplementaryData": {
477             "type": "NATIONAL_HEALTH_ID",
478             "middleNameOnCard": "foo",
479             "nameOnCardLine1": "foo",
480             "nameOnCardLine2": "foo",
481             "nameOnCardLine3": "foo",
482             "nameOnCardLine4": "foo",
483             "reference": "1"
484           },
485           "customAttributes": {},
486           "attachments": [
487             {
488               "data": {
489                 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
490               },
491               "attachmentId": "foo",
492               "sourceId": "foo",
493               "createdAt": "foo",
494               "updatedAt": "foo",
495               "filename": "foo",
496               "mimeType": "foo",
497               "pageNumber": 42,
498               "side": "FRONT",
499               "type": "foo",
500               "location": "foo",
501               "lastMalwareScanAt": "foo",
502               "retrievalStatus": "NORMAL"
503             }
504           ]
505         }
506       ],
507       "OTHER": [
508         {
509           "type": "OTHER",
510           "country": "AUS",
511           "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
512           "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
513           "expiryDate": {
514             "day": "27",
515             "month": "03",
516             "normalized": "1990-03-31",
517             "type": "GREGORIAN",
518             "unstructured": "12 Rajab 1445 AH",
519             "year": "1990"
520           },
521           "issueDate": {
522             "day": "27",
523             "month": "03",
524             "normalized": "1990-03-31",
525             "type": "GREGORIAN",
526             "unstructured": "12 Rajab 1445 AH",
527             "year": "1990"
528           },
529           "primaryIdentifier": "000734130",
530           "secondaryIdentifier": "P0001975",
531           "subtype": "Photo Comparison",
532           "subdivision": "VIC",
533           "createdAt": "2024-01-15T02:18:11.365Z",
534           "updatedAt": "2025-01-16T02:18:11.365Z",
535           "validFrom": {
536             "day": "27",
537             "month": "03",
538             "normalized": "1990-03-31",
539             "type": "GREGORIAN",
540             "unstructured": "12 Rajab 1445 AH",
541             "year": "1990"
542           },
543           "validTo": {
544             "day": "27",
545             "month": "03",
546             "normalized": "1990-03-31",
547             "type": "GREGORIAN",
548             "unstructured": "12 Rajab 1445 AH",
549             "year": "1990"
550           },
551           "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
552           "supplementaryData": {
553             "type": "NATIONAL_HEALTH_ID",
554             "middleNameOnCard": "foo",
555             "nameOnCardLine1": "foo",
556             "nameOnCardLine2": "foo",
557             "nameOnCardLine3": "foo",
558             "nameOnCardLine4": "foo",
559             "reference": "1"
560           },
561           "customAttributes": {},
562           "attachments": [
563             {
564               "data": {
565                 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
566               },
567               "attachmentId": "foo",
568               "sourceId": "foo",
569               "createdAt": "foo",
570               "updatedAt": "foo",
571               "filename": "foo",
572               "mimeType": "foo",
573               "pageNumber": 42,
574               "side": "FRONT",
575               "type": "foo",
576               "location": "foo",
577               "lastMalwareScanAt": "foo",
578               "retrievalStatus": "NORMAL"
579             }
580           ]
581         }
582       ]
583     },
584     "emailAddresses": [
585       {
586         "emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
587         "type": "OTHER",
588         "sourceId": "31dd15f64-5717-4562-b3fc-2c963f66234d",
589         "email": "leonardo_dc@outlook.com",
590         "isPreferred": true,
591         "linkedAddresses": [
592           {
593             "addressId": "adc215f64-5717-4562-b3fc-2c963f66222a"
594           }
595         ]
596       }
597     ],
598     "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
599     "entityType": "INDIVIDUAL",
600     "externalReferences": [
601       {
602         "name": "CUSTOMER-REFERENCE",
603         "value": "CUST-00001342",
604         "description": "This is the customer id in the core banking system",
605         "referenceId": "24de15f64-5717-4562-b3fc-2c963f66e23e",
606         "sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe",
607         "type": "CUSTOMER"
608       }
609     ],
610     "indicators": [
611       {
612         "value": "foo",
613         "indicator": "foo",
614         "type": "foo",
615         "description": "foo",
616         "flag": "foo"
617       }
618     ],
619     "informationSources": {},
620     "jurisdictionalInformation": {
621       "registryInformation": {
622         "abnReplacedFrom": {
623           "day": "27",
624           "month": "03",
625           "normalized": "1990-03-31",
626           "type": "GREGORIAN",
627           "unstructured": "12 Rajab 1445 AH",
628           "year": "1990"
629         },
630         "charityInformation": [
631           {
632             "type": "foo",
633             "name": "foo",
634             "validFrom": {
635               "day": "27",
636               "month": "03",
637               "normalized": "1990-03-31",
638               "type": "GREGORIAN",
639               "unstructured": "12 Rajab 1445 AH",
640               "year": "1990"
641             },
642             "validTo": {
643               "day": "27",
644               "month": "03",
645               "normalized": "1990-03-31",
646               "type": "GREGORIAN",
647               "unstructured": "12 Rajab 1445 AH",
648               "year": "1990"
649             }
650           }
651         ],
652         "gst": [
653           {
654             "type": "foo",
655             "name": "foo",
656             "validFrom": {
657               "day": "27",
658               "month": "03",
659               "normalized": "1990-03-31",
660               "type": "GREGORIAN",
661               "unstructured": "12 Rajab 1445 AH",
662               "year": "1990"
663             },
664             "validTo": {
665               "day": "27",
666               "month": "03",
667               "normalized": "1990-03-31",
668               "type": "GREGORIAN",
669               "unstructured": "12 Rajab 1445 AH",
670               "year": "1990"
671             }
672           }
673         ],
674         "superannuationStatus": {
675           "complyingCode": "foo",
676           "complyingDescription": "foo",
677           "regulator": "foo",
678           "exceptionMessage": "foo"
679         },
680         "acncRegistrations": [
681           {
682             "status": "foo",
683             "validFrom": {
684               "day": "27",
685               "month": "03",
686               "normalized": "1990-03-31",
687               "type": "GREGORIAN",
688               "unstructured": "12 Rajab 1445 AH",
689               "year": "1990"
690             },
691             "validTo": {
692               "day": "27",
693               "month": "03",
694               "normalized": "1990-03-31",
695               "type": "GREGORIAN",
696               "unstructured": "12 Rajab 1445 AH",
697               "year": "1990"
698             }
699           }
700         ],
701         "dgr": [
702           {
703             "dgrEntityEndorsement": "foo",
704             "dgrItemNumber": "foo"
705           }
706         ],
707         "disclosingEntity": true,
708         "sourceId": "foo"
709       },
710       "aliases": [
711         {
712           "alias": "foo",
713           "sourceId": "foo"
714         }
715       ],
716       "vatNumber": {
717         "value": "foo",
718         "sourceId": "foo"
719       },
720       "virtualId": {
721         "value": "foo",
722         "sourceId": "foo"
723       },
724       "fiscalCode": {
725         "code": "foo",
726         "description": "foo",
727         "sourceId": "foo"
728       },
729       "legalFormDetails": {
730         "basis": "foo",
731         "capital": "foo",
732         "comments": "foo",
733         "control": "foo",
734         "incorp": "foo",
735         "partner": "foo",
736         "responsibility": "foo",
737         "stocks": "foo",
738         "sourceId": "foo"
739       },
740       "annualAccount": {
741         "lastAnnualAccountDate": {
742           "day": "27",
743           "month": "03",
744           "normalized": "1990-03-31",
745           "type": "GREGORIAN",
746           "unstructured": "12 Rajab 1445 AH",
747           "year": "1990"
748         },
749         "sourceId": "foo"
750       }
751     },
752     "linkedIndividuals": {},
753     "linkedOrganizations": {},
754     "linkedUnknownEntities": {},
755     "officials": [
756       {
757         "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
758         "entityType": "INDIVIDUAL",
759         "officialId": "foo",
760         "officialType": "OFFICIAL",
761         "role": {
762           "code": "foo",
763           "description": "foo"
764         },
765         "identification": [
766           {
767             "type": "DIRECTOR_IDENTIFICATION_NUMBER",
768             "idNumber": "foo",
769             "jurisdiction": {
770               "country": "foo",
771               "registry": "foo",
772               "registryDescription": "foo",
773               "subdivision": "foo"
774             }
775           }
776         ],
777         "status": {
778           "normalized": {
779             "code": "foo",
780             "description": "foo"
781           },
782           "unstructured": {
783             "code": "foo",
784             "description": "foo"
785           },
786           "sourceId": "foo"
787         },
788         "sourceId": "foo",
789         "appointmentDate": {
790           "day": "27",
791           "month": "03",
792           "normalized": "1990-03-31",
793           "type": "GREGORIAN",
794           "unstructured": "12 Rajab 1445 AH",
795           "year": "1990"
796         },
797         "title": "foo",
798         "directorships": [
799           {
800             "organization": {
801               "organizationName": "foo",
802               "registrationNumber": "foo",
803               "organizationStatus": {
804                 "normalized": {
805                   "code": "foo",
806                   "description": "foo"
807                 },
808                 "unstructured": {
809                   "code": "foo",
810                   "description": "foo"
811                 },
812                 "sourceId": "foo"
813               }
814             },
815             "role": {
816               "code": "foo",
817               "description": "foo"
818             },
819             "sourceId": "foo",
820             "appointmentDate": {
821               "day": "27",
822               "month": "03",
823               "normalized": "1990-03-31",
824               "type": "GREGORIAN",
825               "unstructured": "12 Rajab 1445 AH",
826               "year": "1990"
827             },
828             "nationality": "foo"
829           }
830         ],
831         "cessationDate": {
832           "day": "27",
833           "month": "03",
834           "normalized": "1990-03-31",
835           "type": "GREGORIAN",
836           "unstructured": "12 Rajab 1445 AH",
837           "year": "1990"
838         },
839         "nationality": "foo",
840         "countryOfResidence": "foo",
841         "kind": "foo",
842         "natureOfControl": [
843           "foo"
844         ],
845         "notifiedOn": {
846           "day": "27",
847           "month": "03",
848           "normalized": "1990-03-31",
849           "type": "GREGORIAN",
850           "unstructured": "12 Rajab 1445 AH",
851           "year": "1990"
852         }
853       }
854     ],
855     "otherOwners": [
856       {
857         "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
858         "entityType": "INDIVIDUAL",
859         "percentageOwned": {
860           "total": 42,
861           "isTotalNearZero": true,
862           "beneficially": 42,
863           "isBeneficialNearZero": true,
864           "nonBeneficially": 42,
865           "isNonBeneficialNearZero": true,
866           "isContainingJointOwnership": true
867         },
868         "sourceId": "foo"
869       }
870     ],
871     "ownershipPolicy": {
872       "uboThreshold": 42,
873       "blockingThreshold": 42,
874       "blockingDefinitions": [
875         "ORGANIZATION_NOT_FOUND"
876       ]
877     },
878     "phoneNumbers": [
879       {
880         "phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
881         "isPreferred": true,
882         "type": "OTHER",
883         "sourceId": "14fd5f64-5717-4562-b3fc-2c963f66ba34",
884         "country": "AUS",
885         "number": "0426192340",
886         "linkedAddresses": [
887           {
888             "addressId": "fa335f64-5717-4562-b3fc-2c963f66cf41"
889           }
890         ],
891         "unstructuredLongForm": "foo"
892       }
893     ],
894     "schemaVersion": 2,
895     "shareCapital": {
896       "totalShareCount": 42,
897       "shareStructure": [
898         {
899           "shareInterestType": "UNIT",
900           "class": "foo",
901           "classDescription": "foo",
902           "shares": 42,
903           "nominalValue": "foo",
904           "isFullyPaid": true,
905           "amountPaid": "foo",
906           "amountDue": "foo",
907           "amount": "foo",
908           "unstructuredAmount": "foo",
909           "currency": "foo",
910           "sourceId": "foo",
911           "type": "foo",
912           "status": {
913             "normalized": {
914               "code": "foo",
915               "description": "foo"
916             },
917             "unstructured": {
918               "code": "foo",
919               "description": "foo"
920             },
921             "sourceId": "foo"
922           }
923         }
924       ],
925       "capitalType": "SHARE",
926       "sourceId": "foo"
927     },
928     "shareInterests": [
929       {
930         "amount": "foo",
931         "amountDue": "foo",
932         "amountPaid": "foo",
933         "class": "foo",
934         "classDescription": "foo",
935         "currency": "foo",
936         "isFullyPaid": true,
937         "isJointlyHeld": true,
938         "isNonBeneficiallyHeld": true,
939         "members": [
940           {
941             "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
942             "entityType": "INDIVIDUAL",
943             "careOf": [
944               {
945                 "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
946                 "entityType": "INDIVIDUAL"
947               }
948             ]
949           }
950         ],
951         "nominalValue": "foo",
952         "percentage": 42,
953         "shareInterestType": "UNIT",
954         "shares": 42,
955         "sourceId": "foo",
956         "status": {
957           "normalized": {
958             "code": "foo",
959             "description": "foo"
960           },
961           "unstructured": {
962             "code": "foo",
963             "description": "foo"
964           },
965           "sourceId": "foo"
966         },
967         "type": "foo",
968         "unstructuredAmount": "foo"
969       }
970     ],
971     "shareholders": [
972       {
973         "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
974         "entityType": "INDIVIDUAL",
975         "shareholderType": "foo",
976         "totalShares": 42,
977         "totalPercentage": 42,
978         "shareholdings": [
979           {
980             "amount": "foo",
981             "amountDue": "foo",
982             "amountPaid": "foo",
983             "class": "foo",
984             "classDescription": "foo",
985             "currency": "foo",
986             "holdingType": "SHARE",
987             "isFullyPaid": true,
988             "isJointlyHeld": true,
989             "isNonBeneficiallyHeld": true,
990             "nominalValue": "foo",
991             "percentage": 42,
992             "shareInterestType": "UNIT",
993             "shares": 42,
994             "sourceId": "foo",
995             "status": {
996               "normalized": {
997                 "code": "foo",
998                 "description": "foo"
999               },
1000               "unstructured": {
1001                 "code": "foo",
1002                 "description": "foo"
1003               },
1004               "sourceId": "foo"
1005             },
1006             "type": "foo",
1007             "unstructuredAmount": "foo"
1008           }
1009         ]
1010       }
1011     ],
1012     "sourceId": "foo",
1013     "ultimateBeneficialOwners": [
1014       {
1015         "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1016         "entityType": "INDIVIDUAL",
1017         "percentageOwned": {
1018           "total": 42,
1019           "isTotalNearZero": true,
1020           "beneficially": 42,
1021           "isBeneficialNearZero": true,
1022           "nonBeneficially": 42,
1023           "isNonBeneficialNearZero": true,
1024           "isContainingJointOwnership": true
1025         },
1026         "reasons": [
1027           {
1028             "code": "foo",
1029             "description": "foo"
1030           }
1031         ],
1032         "sourceId": "foo"
1033       }
1034     ],
1035     "updatedAt": "foo",
1036     "websiteUrls": [
1037       {
1038         "websiteUrl": "foo",
1039         "sourceId": "foo"
1040       }
1041     ]
1042   }
1043 }

Update metadata associated with an organization. Note: It is not possible to override data that has been fetched from an authoritative source. If data on an organization is found to be incorrect, this needs to be fixed in consultation with the official registry before refetching, or locally accepted as a risk. This endpoint only allows modifying metadata associated with the entity.

Path parameters

entityIdstringRequired

Headers

Request

This endpoint expects an object.

externalReferenceslist of objectsOptional

Response

requestIdstring

The unique request ID for the API call made.

organizationobject or null

This is the complete Organization Model

Path parameters

Headers

Request

Response

Errors