Create an individual and execute a workflow for the given service profile

POST

https://api.uat.frankie.one/v2/individuals/new/serviceprofiles/:serviceName/workflows/:workflowName/execute

POST

/v2/individuals/new/serviceprofiles/:serviceName/workflows/:workflowName/execute

1 curl -X POST https://api.uat.frankie.one/v2/individuals/new/serviceprofiles/serviceName/workflows/workflowName/execute \
2      -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3      -H "api_key: <apiKey>" \
4      -H "Content-Type: application/json" \
5      -d '{}'

Try it

200Successful

1 {
2   "workflowResult": {
3     "createdAt": "foo",
4     "entityId": "foo",
5     "entityType": "INDIVIDUAL",
6     "requestId": "foo",
7     "result": "UNCHECKED",
8     "schemaVersion": 42,
9     "serviceProfileId": "foo",
10     "startedAt": "foo",
11     "workflowExecutionId": "foo",
12     "workflowExecutionState": "COMPLETED",
13     "workflowId": "foo",
14     "workflowName": "foo",
15     "endWorkflowId": "foo",
16     "endWorkflowName": "foo",
17     "endedAt": "foo",
18     "errors": [
19       {
20         "code": "foo",
21         "description": "foo",
22         "location": "foo"
23       }
24     ],
25     "isManual": true,
26     "issues": [
27       {
28         "category": "AML",
29         "issue": "AML_ISSUE",
30         "severity": "INFO",
31         "issueId": "foo",
32         "workflowExecutionId": "foo",
33         "stepResultId": "foo",
34         "isCleared": true,
35         "createdBy": "foo",
36         "createdAt": "foo",
37         "updatedAt": "foo",
38         "updatedBy": "foo",
39         "updatedRequestId": "foo"
40       }
41     ],
42     "lifecyclePhase": "OTHER",
43     "monitoringTypes": [
44       "foo"
45     ],
46     "notes": {},
47     "riskAssessment": {
48       "serviceProfileId": "foo",
49       "workflowId": "foo",
50       "workflowExecutionId": "foo",
51       "entityId": "foo",
52       "riskAssessmentId": "foo",
53       "schemaVersion": 42,
54       "createdAt": "foo",
55       "updatedAt": "foo",
56       "updatedBy": "foo",
57       "updatedRequestId": "foo",
58       "workflowRiskScore": 42,
59       "workflowRiskLevel": "UNKNOWN",
60       "riskScore": 42,
61       "riskLevel": "UNKNOWN",
62       "isOutdated": false,
63       "riskFactors": [
64         {
65           "riskFactorId": "foo",
66           "factor": "foo",
67           "value": "foo",
68           "score": 42,
69           "description": "foo",
70           "workflowExecutionId": "foo",
71           "stepResultId": "foo",
72           "manualOverrideScore": 42,
73           "status": "VALID",
74           "createdAt": "foo",
75           "updatedAt": "foo",
76           "updatedBy": "foo",
77           "updatedRequestId": "foo",
78           "createdServiceProfileId": "foo",
79           "createdWorkflowExecutionId": "foo",
80           "createdStepResultId": "foo"
81         }
82       ]
83     },
84     "status": "UNCHECKED",
85     "statusOverrideAt": "foo",
86     "statusOverrideBy": "foo",
87     "statusOverrideRequestId": "foo",
88     "steps": {
89       "order": [
90         "foo"
91       ],
92       "passed": [
93         "foo"
94       ],
95       "failed": [
96         "foo"
97       ],
98       "incomplete": [
99         "foo"
100       ],
101       "notApplicable": [
102         "foo"
103       ]
104     },
105     "updatedAt": "foo",
106     "updatedBy": "foo",
107     "workflowStepResults": [
108       {
109         "stepResultId": "foo",
110         "workflowExecutionId": "foo",
111         "stepName": "foo",
112         "requestId": "foo",
113         "objectType": "NAME",
114         "objectId": "foo",
115         "schemaVersion": 42,
116         "startedAt": "foo",
117         "endedAt": "foo",
118         "serviceProviders": [
119           {
120             "provider": "foo",
121             "result": "foo",
122             "order": 42,
123             "startedAt": "foo",
124             "endedAt": "foo"
125           }
126         ],
127         "result": "UNCHECKED",
128         "errors": [
129           {
130             "code": "foo",
131             "description": "foo",
132             "location": "foo"
133           }
134         ],
135         "summary": {
136           "matchedRules": [
137             {
138               "ruleName": "default",
139               "ruleOrder": 1,
140               "ruleMatches": [
141                 {
142                   "matchTypes": {},
143                   "matchCount": 2,
144                   "matchCountRequired": 1,
145                   "hasAllRequiredSourcesMatched": true,
146                   "requiredSourcesMatched": [
147                     "foo"
148                   ],
149                   "requiredSourcesNotMatched": [
150                     "foo"
151                   ],
152                   "isVerified": false,
153                   "matchDetails": [
154                     {
155                       "provider": "foo",
156                       "source": "foo",
157                       "attributesMatched": [
158                         "foo"
159                       ]
160                     }
161                   ],
162                   "nonMatchDetails": [
163                     {
164                       "provider": "foo",
165                       "source": "foo",
166                       "attributesMatched": [
167                         "foo"
168                       ]
169                     }
170                   ]
171                 }
172               ]
173             }
174           ],
175           "unmatchedRules": [
176             {
177               "ruleName": "default",
178               "ruleOrder": 1,
179               "ruleMatches": [
180                 {
181                   "matchTypes": {},
182                   "matchCount": 2,
183                   "matchCountRequired": 1,
184                   "hasAllRequiredSourcesMatched": true,
185                   "requiredSourcesMatched": [
186                     "foo"
187                   ],
188                   "requiredSourcesNotMatched": [
189                     "foo"
190                   ],
191                   "isVerified": false,
192                   "matchDetails": [
193                     {
194                       "provider": "foo",
195                       "source": "foo",
196                       "attributesMatched": [
197                         "foo"
198                       ]
199                     }
200                   ],
201                   "nonMatchDetails": [
202                     {
203                       "provider": "foo",
204                       "source": "foo",
205                       "attributesMatched": [
206                         "foo"
207                       ]
208                     }
209                   ]
210                 }
211               ]
212             }
213           ],
214           "stepName": "foo"
215         },
216         "risk": {
217           "level": "foo",
218           "contributedScore": 42,
219           "overallScore": 42,
220           "factors": [
221             {
222               "factor": "foo",
223               "score": 42,
224               "value": "foo"
225             }
226           ]
227         },
228         "notes": {},
229         "processResults": [
230           {
231             "processResultId": "foo",
232             "schemaVersion": 42,
233             "entityId": "foo",
234             "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
235             "stepName": "foo",
236             "stepType": "foo",
237             "objectType": "foo",
238             "objectId": "foo",
239             "createdAt": "foo",
240             "updatedAt": "foo",
241             "groupId": "foo",
242             "providerResult": {
243               "name": "foo",
244               "source": "foo",
245               "sourceNormalized": "foo",
246               "reference": "foo",
247               "fuzziness": {
248                 "normalized": 42,
249                 "actual": "foo"
250               },
251               "confidence": {
252                 "normalized": 42,
253                 "actual": "foo"
254               },
255               "riskScore": 42,
256               "errorCode": "foo",
257               "errorMessage": "foo"
258             },
259             "result": "MATCH",
260             "class": "KYC",
261             "supplementaryData": {
262               "type": "AML",
263               "serviceProvider": "foo",
264               "aliases": [
265                 "foo"
266               ],
267               "caseId": "foo",
268               "fuzziness": {
269                 "normalized": 42,
270                 "actual": "foo"
271               },
272               "groupingId": "foo",
273               "matchData": {
274                 "spReferenceId": "foo",
275                 "name": "foo",
276                 "strength": 42,
277                 "givenName": "foo",
278                 "otherName": "foo",
279                 "familyName": "foo",
280                 "date": "foo",
281                 "address": "foo",
282                 "countries": [
283                   {
284                     "code": "foo",
285                     "matchType": "foo"
286                   }
287                 ],
288                 "nationalId": {
289                   "idNumber": "foo",
290                   "idType": "foo",
291                   "idExpiry": "foo",
292                   "issuingCountryCode": "foo",
293                   "documentId": "foo"
294                 },
295                 "imageUrl": "foo",
296                 "isDeceased": true,
297                 "isAlias": true,
298                 "isRelated": true
299               },
300               "mediaData": [
301                 {
302                   "title": "foo",
303                   "source": "foo",
304                   "snippet": "foo",
305                   "sourceDate": "foo",
306                   "sourceCountry": "foo",
307                   "url": "foo",
308                   "isCurrent": true
309                 }
310               ],
311               "notes": {},
312               "originalStepSearchLevel": "foo",
313               "pepData": [
314                 {
315                   "countryCode": "foo",
316                   "countryName": "foo",
317                   "sourceName": "foo",
318                   "level": "foo",
319                   "sourceUrl": "foo",
320                   "position": "foo",
321                   "positionDescription": "foo",
322                   "status": "foo",
323                   "listingStart": "foo",
324                   "listingEnd": "foo",
325                   "imageUrl": "foo",
326                   "referenceDocs": [
327                     {
328                       "url": "foo",
329                       "description": "foo"
330                     }
331                   ],
332                   "additionalData": [
333                     {
334                       "key": "foo",
335                       "value": "foo"
336                     }
337                   ],
338                   "sourcePosition": "foo"
339                 }
340               ],
341               "referenceDocs": [
342                 {
343                   "url": "foo",
344                   "description": "foo"
345                 }
346               ],
347               "referenceId": "foo",
348               "relatedParties": [
349                 {
350                   "name": "foo",
351                   "relationship": "foo"
352                 }
353               ],
354               "reportUrl": "foo",
355               "sanctionData": [
356                 {
357                   "countryCode": "foo",
358                   "countryName": "foo",
359                   "sourceName": "foo",
360                   "sourceUrl": "foo",
361                   "sourceReason": "foo",
362                   "listingStart": "foo",
363                   "listingEnd": "foo",
364                   "imageUrl": "foo",
365                   "referenceDocs": [
366                     {
367                       "url": "foo",
368                       "description": "foo"
369                     }
370                   ],
371                   "additionalData": [
372                     {
373                       "key": "foo",
374                       "value": "foo"
375                     }
376                   ]
377                 }
378               ],
379               "searchId": "foo",
380               "watchlistData": [
381                 {
382                   "countryCode": "foo",
383                   "countryName": "foo",
384                   "sourceName": "foo",
385                   "sourceUrl": "foo",
386                   "sourceReason": "foo",
387                   "listingStart": "foo",
388                   "listingEnd": "foo",
389                   "imageUrl": "foo",
390                   "referenceDocs": [
391                     {
392                       "url": "foo",
393                       "description": "foo"
394                     }
395                   ],
396                   "additionalData": [
397                     {
398                       "key": "foo",
399                       "value": "foo"
400                     }
401                   ]
402                 }
403               ]
404             },
405             "errors": [
406               {
407                 "code": "foo",
408                 "description": "foo",
409                 "location": "foo"
410               }
411             ],
412             "notes": {},
413             "systemStatus": "VALID",
414             "manualStatus": "TRUE_POSITIVE",
415             "state": "IN_PROGRESS",
416             "riskFactors": [
417               {
418                 "factor": "foo",
419                 "value": "foo"
420               }
421             ],
422             "updatedBy": "foo"
423           }
424         ],
425         "createdAt": "foo",
426         "updatedAt": "foo",
427         "updatedBy": "foo"
428       }
429     ]
430   },
431   "serviceProfile": {
432     "assignee": "Ryan Gosling",
433     "country": "AUS",
434     "createdAt": "2024-01-15T02:18:11.365Z",
435     "createdBy": "Ryan Reynolds",
436     "createdRequestId": "01HMR2ERSKCYAVXKS1FKSRT2T4",
437     "currentWorkflowId": "foo",
438     "currentWorkflowName": "foo",
439     "customerReference": "foo",
440     "entityId": "foo",
441     "entityName": "foo",
442     "entityType": "foo",
443     "latestRiskAssessmentId": "foo",
444     "latestWorkflowExecutionId": "foo",
445     "organizationType": "SOLE TRADER",
446     "reviewer": "Ryan Trahan",
447     "schemaVersion": 2,
448     "serviceName": "foo",
449     "serviceProfileId": "55fc5d54-46f7-49c8-bf78-e07ec79c42fd",
450     "state": "INIT",
451     "subscriptions": [
452       {
453         "serviceProfileId": "foo",
454         "status": "ENABLED",
455         "type": "AML",
456         "workflowName": "foo",
457         "workflowId": "foo",
458         "enabledAt": "foo",
459         "enabledRequestId": "foo",
460         "enabledBy": "foo",
461         "disabledAt": "foo",
462         "disabledRequestId": "foo",
463         "disabledBy": "foo"
464       }
465     ],
466     "updatedAt": "2024-01-15T02:18:11.365Z",
467     "updatedBy": "Ryan Reynolds",
468     "updatedRequestId": "01HMR2ERSKCYAVXKS1FKSRT2T4",
469     "workflowSummaries": [
470       {
471         "schemaVersion": 42,
472         "workflowName": "foo",
473         "workflowExecutionId": "foo",
474         "workflowExecutionState": "COMPLETED",
475         "status": "UNCHECKED",
476         "statusOverrideAt": "foo",
477         "statusOverrideRequestId": "foo",
478         "statusOverrideBy": "foo",
479         "riskAssessment": {
480           "serviceProfileId": "foo",
481           "workflowId": "foo",
482           "workflowExecutionId": "foo",
483           "entityId": "foo",
484           "riskAssessmentId": "foo",
485           "schemaVersion": 42,
486           "createdAt": "foo",
487           "updatedAt": "foo",
488           "updatedBy": "foo",
489           "updatedRequestId": "foo",
490           "workflowRiskScore": 42,
491           "workflowRiskLevel": "UNKNOWN",
492           "riskScore": 42,
493           "riskLevel": "UNKNOWN",
494           "isOutdated": false,
495           "riskFactors": [
496             {
497               "riskFactorId": "foo",
498               "factor": "foo",
499               "value": "foo",
500               "score": 42,
501               "description": "foo",
502               "workflowExecutionId": "foo",
503               "stepResultId": "foo",
504               "manualOverrideScore": 42,
505               "status": "VALID",
506               "createdAt": "foo",
507               "updatedAt": "foo",
508               "updatedBy": "foo",
509               "updatedRequestId": "foo",
510               "createdServiceProfileId": "foo",
511               "createdWorkflowExecutionId": "foo",
512               "createdStepResultId": "foo"
513             }
514           ]
515         },
516         "isManual": true,
517         "steps": {
518           "order": [
519             "foo"
520           ],
521           "passed": [
522             "foo"
523           ],
524           "failed": [
525             "foo"
526           ],
527           "incomplete": [
528             "foo"
529           ],
530           "notApplicable": [
531             "foo"
532           ]
533         },
534         "startedAt": "foo",
535         "endedAt": "foo",
536         "issues": [
537           {
538             "category": "AML",
539             "issue": "AML_ISSUE",
540             "severity": "INFO",
541             "issueId": "foo",
542             "workflowExecutionId": "foo",
543             "stepResultId": "foo",
544             "isCleared": true,
545             "createdBy": "foo",
546             "createdAt": "foo",
547             "updatedAt": "foo",
548             "updatedBy": "foo",
549             "updatedRequestId": "foo"
550           }
551         ],
552         "lifecyclePhase": "OTHER",
553         "monitoringTypes": [
554           "foo"
555         ]
556       }
557     ]
558   },
559   "individual": {
560     "addresses": [
561       {
562         "country": "foo",
563         "addressId": "foo",
564         "buildingName": "foo",
565         "careOf": "foo",
566         "district": "foo",
567         "locality": "foo",
568         "longForm": "foo",
569         "neighborhood": "foo",
570         "postalCode": "foo",
571         "sourceId": "foo",
572         "status": "CURRENT",
573         "streetName": "foo",
574         "streetNumber": "foo",
575         "streetType": "foo",
576         "subdivision": "foo",
577         "type": "OTHER",
578         "typeDescription": "foo",
579         "unitNumber": "foo",
580         "unstructuredLongForm": "foo",
581         "validFrom": {
582           "day": "27",
583           "month": "03",
584           "normalized": "1990-03-31",
585           "type": "GREGORIAN",
586           "unstructured": "12 Rajab 1445 AH",
587           "year": "1990"
588         },
589         "validTo": {
590           "day": "27",
591           "month": "03",
592           "normalized": "1990-03-31",
593           "type": "GREGORIAN",
594           "unstructured": "12 Rajab 1445 AH",
595           "year": "1990"
596         }
597       }
598     ],
599     "alternateDatesOfBirth": [
600       {
601         "dateOfBirthId": "foo",
602         "day": "27",
603         "month": "03",
604         "normalized": "1990-03-31",
605         "sourceId": "foo",
606         "type": "GREGORIAN",
607         "unstructured": "12 Rajab 1445 AH",
608         "year": "1990"
609       }
610     ],
611     "alternateNames": [
612       {
613         "familyName": "Doe",
614         "nameId": "87654321-4321-4321-4321-210987654321",
615         "language": "eng",
616         "givenName": "John",
617         "middleName": "R",
618         "otherName": "foo",
619         "prefix": "Dr.",
620         "suffix": "Jr.",
621         "sourceId": "87654321-4321-4321-4321-210987654322",
622         "displayName": "John Doe",
623         "type": "OTHER"
624       }
625     ],
626     "consents": [
627       {
628         "type": "GENERAL",
629         "schemaVersion": 42,
630         "sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe"
631       }
632     ],
633     "createdAt": "foo",
634     "customAttributes": {},
635     "dateOfBirth": {
636       "dateOfBirthId": "foo",
637       "day": "27",
638       "month": "03",
639       "normalized": "1990-03-31",
640       "sourceId": "foo",
641       "type": "GREGORIAN",
642       "unstructured": "12 Rajab 1445 AH",
643       "year": "1990"
644     },
645     "documents": {
646       "REPORT": [
647         {
648           "type": "OTHER",
649           "country": "AUS",
650           "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
651           "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
652           "expiryDate": {
653             "day": "27",
654             "month": "03",
655             "normalized": "1990-03-31",
656             "type": "GREGORIAN",
657             "unstructured": "12 Rajab 1445 AH",
658             "year": "1990"
659           },
660           "issueDate": {
661             "day": "27",
662             "month": "03",
663             "normalized": "1990-03-31",
664             "type": "GREGORIAN",
665             "unstructured": "12 Rajab 1445 AH",
666             "year": "1990"
667           },
668           "primaryIdentifier": "000734130",
669           "secondaryIdentifier": "P0001975",
670           "subtype": "Photo Comparison",
671           "subdivision": "VIC",
672           "createdAt": "2024-01-15T02:18:11.365Z",
673           "updatedAt": "2025-01-16T02:18:11.365Z",
674           "validFrom": {
675             "day": "27",
676             "month": "03",
677             "normalized": "1990-03-31",
678             "type": "GREGORIAN",
679             "unstructured": "12 Rajab 1445 AH",
680             "year": "1990"
681           },
682           "validTo": {
683             "day": "27",
684             "month": "03",
685             "normalized": "1990-03-31",
686             "type": "GREGORIAN",
687             "unstructured": "12 Rajab 1445 AH",
688             "year": "1990"
689           },
690           "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
691           "supplementaryData": {
692             "type": "NATIONAL_HEALTH_ID",
693             "middleNameOnCard": "foo",
694             "nameOnCardLine1": "foo",
695             "nameOnCardLine2": "foo",
696             "nameOnCardLine3": "foo",
697             "nameOnCardLine4": "foo",
698             "reference": "1"
699           },
700           "customAttributes": {},
701           "attachments": [
702             {
703               "data": {
704                 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
705               },
706               "attachmentId": "foo",
707               "sourceId": "foo",
708               "createdAt": "foo",
709               "updatedAt": "foo",
710               "filename": "foo",
711               "mimeType": "foo",
712               "pageNumber": 42,
713               "side": "FRONT",
714               "type": "foo",
715               "location": "foo",
716               "lastMalwareScanAt": "foo",
717               "retrievalStatus": "NORMAL"
718             }
719           ]
720         }
721       ],
722       "SUPPORTING": [
723         {
724           "type": "OTHER",
725           "country": "AUS",
726           "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
727           "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
728           "expiryDate": {
729             "day": "27",
730             "month": "03",
731             "normalized": "1990-03-31",
732             "type": "GREGORIAN",
733             "unstructured": "12 Rajab 1445 AH",
734             "year": "1990"
735           },
736           "issueDate": {
737             "day": "27",
738             "month": "03",
739             "normalized": "1990-03-31",
740             "type": "GREGORIAN",
741             "unstructured": "12 Rajab 1445 AH",
742             "year": "1990"
743           },
744           "primaryIdentifier": "000734130",
745           "secondaryIdentifier": "P0001975",
746           "subtype": "Photo Comparison",
747           "subdivision": "VIC",
748           "createdAt": "2024-01-15T02:18:11.365Z",
749           "updatedAt": "2025-01-16T02:18:11.365Z",
750           "validFrom": {
751             "day": "27",
752             "month": "03",
753             "normalized": "1990-03-31",
754             "type": "GREGORIAN",
755             "unstructured": "12 Rajab 1445 AH",
756             "year": "1990"
757           },
758           "validTo": {
759             "day": "27",
760             "month": "03",
761             "normalized": "1990-03-31",
762             "type": "GREGORIAN",
763             "unstructured": "12 Rajab 1445 AH",
764             "year": "1990"
765           },
766           "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
767           "supplementaryData": {
768             "type": "NATIONAL_HEALTH_ID",
769             "middleNameOnCard": "foo",
770             "nameOnCardLine1": "foo",
771             "nameOnCardLine2": "foo",
772             "nameOnCardLine3": "foo",
773             "nameOnCardLine4": "foo",
774             "reference": "1"
775           },
776           "customAttributes": {},
777           "attachments": [
778             {
779               "data": {
780                 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
781               },
782               "attachmentId": "foo",
783               "sourceId": "foo",
784               "createdAt": "foo",
785               "updatedAt": "foo",
786               "filename": "foo",
787               "mimeType": "foo",
788               "pageNumber": 42,
789               "side": "FRONT",
790               "type": "foo",
791               "location": "foo",
792               "lastMalwareScanAt": "foo",
793               "retrievalStatus": "NORMAL"
794             }
795           ]
796         }
797       ],
798       "IDENTITY": [
799         {
800           "type": "OTHER",
801           "country": "AUS",
802           "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
803           "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
804           "expiryDate": {
805             "day": "27",
806             "month": "03",
807             "normalized": "1990-03-31",
808             "type": "GREGORIAN",
809             "unstructured": "12 Rajab 1445 AH",
810             "year": "1990"
811           },
812           "issueDate": {
813             "day": "27",
814             "month": "03",
815             "normalized": "1990-03-31",
816             "type": "GREGORIAN",
817             "unstructured": "12 Rajab 1445 AH",
818             "year": "1990"
819           },
820           "primaryIdentifier": "000734130",
821           "secondaryIdentifier": "P0001975",
822           "subtype": "Photo Comparison",
823           "subdivision": "VIC",
824           "createdAt": "2024-01-15T02:18:11.365Z",
825           "updatedAt": "2025-01-16T02:18:11.365Z",
826           "validFrom": {
827             "day": "27",
828             "month": "03",
829             "normalized": "1990-03-31",
830             "type": "GREGORIAN",
831             "unstructured": "12 Rajab 1445 AH",
832             "year": "1990"
833           },
834           "validTo": {
835             "day": "27",
836             "month": "03",
837             "normalized": "1990-03-31",
838             "type": "GREGORIAN",
839             "unstructured": "12 Rajab 1445 AH",
840             "year": "1990"
841           },
842           "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
843           "supplementaryData": {
844             "type": "NATIONAL_HEALTH_ID",
845             "middleNameOnCard": "foo",
846             "nameOnCardLine1": "foo",
847             "nameOnCardLine2": "foo",
848             "nameOnCardLine3": "foo",
849             "nameOnCardLine4": "foo",
850             "reference": "1"
851           },
852           "customAttributes": {},
853           "attachments": [
854             {
855               "data": {
856                 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
857               },
858               "attachmentId": "foo",
859               "sourceId": "foo",
860               "createdAt": "foo",
861               "updatedAt": "foo",
862               "filename": "foo",
863               "mimeType": "foo",
864               "pageNumber": 42,
865               "side": "FRONT",
866               "type": "foo",
867               "location": "foo",
868               "lastMalwareScanAt": "foo",
869               "retrievalStatus": "NORMAL"
870             }
871           ]
872         }
873       ],
874       "OTHER": [
875         {
876           "type": "OTHER",
877           "country": "AUS",
878           "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
879           "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
880           "expiryDate": {
881             "day": "27",
882             "month": "03",
883             "normalized": "1990-03-31",
884             "type": "GREGORIAN",
885             "unstructured": "12 Rajab 1445 AH",
886             "year": "1990"
887           },
888           "issueDate": {
889             "day": "27",
890             "month": "03",
891             "normalized": "1990-03-31",
892             "type": "GREGORIAN",
893             "unstructured": "12 Rajab 1445 AH",
894             "year": "1990"
895           },
896           "primaryIdentifier": "000734130",
897           "secondaryIdentifier": "P0001975",
898           "subtype": "Photo Comparison",
899           "subdivision": "VIC",
900           "createdAt": "2024-01-15T02:18:11.365Z",
901           "updatedAt": "2025-01-16T02:18:11.365Z",
902           "validFrom": {
903             "day": "27",
904             "month": "03",
905             "normalized": "1990-03-31",
906             "type": "GREGORIAN",
907             "unstructured": "12 Rajab 1445 AH",
908             "year": "1990"
909           },
910           "validTo": {
911             "day": "27",
912             "month": "03",
913             "normalized": "1990-03-31",
914             "type": "GREGORIAN",
915             "unstructured": "12 Rajab 1445 AH",
916             "year": "1990"
917           },
918           "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
919           "supplementaryData": {
920             "type": "NATIONAL_HEALTH_ID",
921             "middleNameOnCard": "foo",
922             "nameOnCardLine1": "foo",
923             "nameOnCardLine2": "foo",
924             "nameOnCardLine3": "foo",
925             "nameOnCardLine4": "foo",
926             "reference": "1"
927           },
928           "customAttributes": {},
929           "attachments": [
930             {
931               "data": {
932                 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
933               },
934               "attachmentId": "foo",
935               "sourceId": "foo",
936               "createdAt": "foo",
937               "updatedAt": "foo",
938               "filename": "foo",
939               "mimeType": "foo",
940               "pageNumber": 42,
941               "side": "FRONT",
942               "type": "foo",
943               "location": "foo",
944               "lastMalwareScanAt": "foo",
945               "retrievalStatus": "NORMAL"
946             }
947           ]
948         }
949       ]
950     },
951     "emailAddresses": [
952       {
953         "emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
954         "type": "OTHER",
955         "sourceId": "31dd15f64-5717-4562-b3fc-2c963f66234d",
956         "email": "leonardo_dc@outlook.com",
957         "isPreferred": true,
958         "linkedAddresses": [
959           {
960             "addressId": "adc215f64-5717-4562-b3fc-2c963f66222a"
961           }
962         ]
963       }
964     ],
965     "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
966     "entityType": "INDIVIDUAL",
967     "externalReferences": [
968       {
969         "name": "CUSTOMER-REFERENCE",
970         "value": "CUST-00001342",
971         "description": "This is the customer id in the core banking system",
972         "referenceId": "24de15f64-5717-4562-b3fc-2c963f66e23e",
973         "sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe",
974         "type": "CUSTOMER"
975       }
976     ],
977     "gender": {
978       "gender": "MALE",
979       "sourceId": "foo",
980       "genderId": "foo"
981     },
982     "informationSources": {},
983     "name": {
984       "familyName": "Doe",
985       "nameId": "87654321-4321-4321-4321-210987654321",
986       "language": "eng",
987       "givenName": "John",
988       "middleName": "R",
989       "otherName": "foo",
990       "prefix": "Dr.",
991       "suffix": "Jr.",
992       "sourceId": "87654321-4321-4321-4321-210987654322",
993       "displayName": "John Doe"
994     },
995     "nationality": "AUS",
996     "phoneNumbers": [
997       {
998         "phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
999         "isPreferred": true,
1000         "type": "OTHER",
1001         "sourceId": "14fd5f64-5717-4562-b3fc-2c963f66ba34",
1002         "country": "AUS",
1003         "number": "0426192340",
1004         "linkedAddresses": [
1005           {
1006             "addressId": "fa335f64-5717-4562-b3fc-2c963f66cf41"
1007           }
1008         ],
1009         "unstructuredLongForm": "foo"
1010       }
1011     ],
1012     "placeOfBirth": {
1013       "country": "USA",
1014       "addressId": "6ad15f64-5717-4562-b3fc-2c963f66abf9",
1015       "sourceId": "1da65f64-5717-4562-b3fc-2c963f669fba",
1016       "longForm": "525 Kent Dr, Harlem NY 10037, USA",
1017       "unstructuredLongForm": "3A/525 KENT DRIVE HARLEM NEW YORK 10036 USA",
1018       "unitNumber": "3A",
1019       "buildingName": "EQ Tower",
1020       "streetName": "Kent",
1021       "streetNumber": "525",
1022       "streetType": "Dr",
1023       "neighborhood": "Harlem",
1024       "locality": "Manhattan",
1025       "district": "New York County",
1026       "subdivision": "NY",
1027       "postalCode": "10037"
1028     },
1029     "relationships": {
1030       "duplicates": [
1031         {
1032           "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1033           "entityType": "INDIVIDUAL",
1034           "origin": {
1035             "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1036             "entityType": "INDIVIDUAL",
1037             "processResultId": "foo",
1038             "createdAt": "foo"
1039           }
1040         }
1041       ]
1042     },
1043     "schemaVersion": 2,
1044     "sourceId": "foo"
1045   },
1046   "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
1047 }

Create an individual and execute a workflow for the given service profile

Path parameters

serviceNamestringRequired

workflowNamestringRequired

Headers

Request

This endpoint expects an object.

individualobjectOptional

commentobjectOptional

Response

Execution request completed

workflowResultobject or null

serviceProfileobject or null

individualobject or null

requestIdstring or null

The unique request ID for the API call made.

Path parameters

Headers

Request

Response

Errors