Create an individual entity

POST

https://api.uat.frankie.one/v2/individuals

POST

/v2/individuals

1 curl -X POST https://api.uat.frankie.one/v2/individuals \
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

201Created

1 {
2   "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
3   "individual": {
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     "alternateDatesOfBirth": [
44       {
45         "dateOfBirthId": "foo",
46         "day": "27",
47         "month": "03",
48         "normalized": "1990-03-31",
49         "sourceId": "foo",
50         "type": "GREGORIAN",
51         "unstructured": "12 Rajab 1445 AH",
52         "year": "1990"
53       }
54     ],
55     "alternateNames": [
56       {
57         "familyName": "Doe",
58         "nameId": "87654321-4321-4321-4321-210987654321",
59         "language": "eng",
60         "givenName": "John",
61         "middleName": "R",
62         "otherName": "foo",
63         "prefix": "Dr.",
64         "suffix": "Jr.",
65         "sourceId": "87654321-4321-4321-4321-210987654322",
66         "displayName": "John Doe",
67         "type": "OTHER"
68       }
69     ],
70     "consents": [
71       {
72         "type": "GENERAL",
73         "schemaVersion": 42,
74         "sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe"
75       }
76     ],
77     "createdAt": "foo",
78     "customAttributes": {},
79     "dateOfBirth": {
80       "dateOfBirthId": "foo",
81       "day": "27",
82       "month": "03",
83       "normalized": "1990-03-31",
84       "sourceId": "foo",
85       "type": "GREGORIAN",
86       "unstructured": "12 Rajab 1445 AH",
87       "year": "1990"
88     },
89     "documents": {
90       "REPORT": [
91         {
92           "type": "OTHER",
93           "country": "AUS",
94           "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
95           "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
96           "expiryDate": {
97             "day": "27",
98             "month": "03",
99             "normalized": "1990-03-31",
100             "type": "GREGORIAN",
101             "unstructured": "12 Rajab 1445 AH",
102             "year": "1990"
103           },
104           "issueDate": {
105             "day": "27",
106             "month": "03",
107             "normalized": "1990-03-31",
108             "type": "GREGORIAN",
109             "unstructured": "12 Rajab 1445 AH",
110             "year": "1990"
111           },
112           "primaryIdentifier": "000734130",
113           "secondaryIdentifier": "P0001975",
114           "subtype": "Photo Comparison",
115           "subdivision": "VIC",
116           "createdAt": "2024-01-15T02:18:11.365Z",
117           "updatedAt": "2025-01-16T02:18:11.365Z",
118           "validFrom": {
119             "day": "27",
120             "month": "03",
121             "normalized": "1990-03-31",
122             "type": "GREGORIAN",
123             "unstructured": "12 Rajab 1445 AH",
124             "year": "1990"
125           },
126           "validTo": {
127             "day": "27",
128             "month": "03",
129             "normalized": "1990-03-31",
130             "type": "GREGORIAN",
131             "unstructured": "12 Rajab 1445 AH",
132             "year": "1990"
133           },
134           "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
135           "supplementaryData": {
136             "type": "NATIONAL_HEALTH_ID",
137             "middleNameOnCard": "foo",
138             "nameOnCardLine1": "foo",
139             "nameOnCardLine2": "foo",
140             "nameOnCardLine3": "foo",
141             "nameOnCardLine4": "foo",
142             "reference": "1"
143           },
144           "customAttributes": {},
145           "attachments": [
146             {
147               "data": {
148                 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
149               },
150               "attachmentId": "foo",
151               "sourceId": "foo",
152               "createdAt": "foo",
153               "updatedAt": "foo",
154               "filename": "foo",
155               "mimeType": "foo",
156               "pageNumber": 42,
157               "side": "FRONT",
158               "type": "foo",
159               "location": "foo",
160               "lastMalwareScanAt": "foo",
161               "retrievalStatus": "NORMAL"
162             }
163           ]
164         }
165       ],
166       "SUPPORTING": [
167         {
168           "type": "OTHER",
169           "country": "AUS",
170           "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
171           "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
172           "expiryDate": {
173             "day": "27",
174             "month": "03",
175             "normalized": "1990-03-31",
176             "type": "GREGORIAN",
177             "unstructured": "12 Rajab 1445 AH",
178             "year": "1990"
179           },
180           "issueDate": {
181             "day": "27",
182             "month": "03",
183             "normalized": "1990-03-31",
184             "type": "GREGORIAN",
185             "unstructured": "12 Rajab 1445 AH",
186             "year": "1990"
187           },
188           "primaryIdentifier": "000734130",
189           "secondaryIdentifier": "P0001975",
190           "subtype": "Photo Comparison",
191           "subdivision": "VIC",
192           "createdAt": "2024-01-15T02:18:11.365Z",
193           "updatedAt": "2025-01-16T02:18:11.365Z",
194           "validFrom": {
195             "day": "27",
196             "month": "03",
197             "normalized": "1990-03-31",
198             "type": "GREGORIAN",
199             "unstructured": "12 Rajab 1445 AH",
200             "year": "1990"
201           },
202           "validTo": {
203             "day": "27",
204             "month": "03",
205             "normalized": "1990-03-31",
206             "type": "GREGORIAN",
207             "unstructured": "12 Rajab 1445 AH",
208             "year": "1990"
209           },
210           "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
211           "supplementaryData": {
212             "type": "NATIONAL_HEALTH_ID",
213             "middleNameOnCard": "foo",
214             "nameOnCardLine1": "foo",
215             "nameOnCardLine2": "foo",
216             "nameOnCardLine3": "foo",
217             "nameOnCardLine4": "foo",
218             "reference": "1"
219           },
220           "customAttributes": {},
221           "attachments": [
222             {
223               "data": {
224                 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
225               },
226               "attachmentId": "foo",
227               "sourceId": "foo",
228               "createdAt": "foo",
229               "updatedAt": "foo",
230               "filename": "foo",
231               "mimeType": "foo",
232               "pageNumber": 42,
233               "side": "FRONT",
234               "type": "foo",
235               "location": "foo",
236               "lastMalwareScanAt": "foo",
237               "retrievalStatus": "NORMAL"
238             }
239           ]
240         }
241       ],
242       "IDENTITY": [
243         {
244           "type": "OTHER",
245           "country": "AUS",
246           "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
247           "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
248           "expiryDate": {
249             "day": "27",
250             "month": "03",
251             "normalized": "1990-03-31",
252             "type": "GREGORIAN",
253             "unstructured": "12 Rajab 1445 AH",
254             "year": "1990"
255           },
256           "issueDate": {
257             "day": "27",
258             "month": "03",
259             "normalized": "1990-03-31",
260             "type": "GREGORIAN",
261             "unstructured": "12 Rajab 1445 AH",
262             "year": "1990"
263           },
264           "primaryIdentifier": "000734130",
265           "secondaryIdentifier": "P0001975",
266           "subtype": "Photo Comparison",
267           "subdivision": "VIC",
268           "createdAt": "2024-01-15T02:18:11.365Z",
269           "updatedAt": "2025-01-16T02:18:11.365Z",
270           "validFrom": {
271             "day": "27",
272             "month": "03",
273             "normalized": "1990-03-31",
274             "type": "GREGORIAN",
275             "unstructured": "12 Rajab 1445 AH",
276             "year": "1990"
277           },
278           "validTo": {
279             "day": "27",
280             "month": "03",
281             "normalized": "1990-03-31",
282             "type": "GREGORIAN",
283             "unstructured": "12 Rajab 1445 AH",
284             "year": "1990"
285           },
286           "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
287           "supplementaryData": {
288             "type": "NATIONAL_HEALTH_ID",
289             "middleNameOnCard": "foo",
290             "nameOnCardLine1": "foo",
291             "nameOnCardLine2": "foo",
292             "nameOnCardLine3": "foo",
293             "nameOnCardLine4": "foo",
294             "reference": "1"
295           },
296           "customAttributes": {},
297           "attachments": [
298             {
299               "data": {
300                 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
301               },
302               "attachmentId": "foo",
303               "sourceId": "foo",
304               "createdAt": "foo",
305               "updatedAt": "foo",
306               "filename": "foo",
307               "mimeType": "foo",
308               "pageNumber": 42,
309               "side": "FRONT",
310               "type": "foo",
311               "location": "foo",
312               "lastMalwareScanAt": "foo",
313               "retrievalStatus": "NORMAL"
314             }
315           ]
316         }
317       ],
318       "OTHER": [
319         {
320           "type": "OTHER",
321           "country": "AUS",
322           "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
323           "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
324           "expiryDate": {
325             "day": "27",
326             "month": "03",
327             "normalized": "1990-03-31",
328             "type": "GREGORIAN",
329             "unstructured": "12 Rajab 1445 AH",
330             "year": "1990"
331           },
332           "issueDate": {
333             "day": "27",
334             "month": "03",
335             "normalized": "1990-03-31",
336             "type": "GREGORIAN",
337             "unstructured": "12 Rajab 1445 AH",
338             "year": "1990"
339           },
340           "primaryIdentifier": "000734130",
341           "secondaryIdentifier": "P0001975",
342           "subtype": "Photo Comparison",
343           "subdivision": "VIC",
344           "createdAt": "2024-01-15T02:18:11.365Z",
345           "updatedAt": "2025-01-16T02:18:11.365Z",
346           "validFrom": {
347             "day": "27",
348             "month": "03",
349             "normalized": "1990-03-31",
350             "type": "GREGORIAN",
351             "unstructured": "12 Rajab 1445 AH",
352             "year": "1990"
353           },
354           "validTo": {
355             "day": "27",
356             "month": "03",
357             "normalized": "1990-03-31",
358             "type": "GREGORIAN",
359             "unstructured": "12 Rajab 1445 AH",
360             "year": "1990"
361           },
362           "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
363           "supplementaryData": {
364             "type": "NATIONAL_HEALTH_ID",
365             "middleNameOnCard": "foo",
366             "nameOnCardLine1": "foo",
367             "nameOnCardLine2": "foo",
368             "nameOnCardLine3": "foo",
369             "nameOnCardLine4": "foo",
370             "reference": "1"
371           },
372           "customAttributes": {},
373           "attachments": [
374             {
375               "data": {
376                 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
377               },
378               "attachmentId": "foo",
379               "sourceId": "foo",
380               "createdAt": "foo",
381               "updatedAt": "foo",
382               "filename": "foo",
383               "mimeType": "foo",
384               "pageNumber": 42,
385               "side": "FRONT",
386               "type": "foo",
387               "location": "foo",
388               "lastMalwareScanAt": "foo",
389               "retrievalStatus": "NORMAL"
390             }
391           ]
392         }
393       ]
394     },
395     "emailAddresses": [
396       {
397         "emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
398         "type": "OTHER",
399         "sourceId": "31dd15f64-5717-4562-b3fc-2c963f66234d",
400         "email": "leonardo_dc@outlook.com",
401         "isPreferred": true,
402         "linkedAddresses": [
403           {
404             "addressId": "adc215f64-5717-4562-b3fc-2c963f66222a"
405           }
406         ]
407       }
408     ],
409     "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
410     "entityType": "INDIVIDUAL",
411     "externalReferences": [
412       {
413         "name": "CUSTOMER-REFERENCE",
414         "value": "CUST-00001342",
415         "description": "This is the customer id in the core banking system",
416         "referenceId": "24de15f64-5717-4562-b3fc-2c963f66e23e",
417         "sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe",
418         "type": "CUSTOMER"
419       }
420     ],
421     "gender": {
422       "gender": "MALE",
423       "sourceId": "foo",
424       "genderId": "foo"
425     },
426     "informationSources": {},
427     "name": {
428       "familyName": "Doe",
429       "nameId": "87654321-4321-4321-4321-210987654321",
430       "language": "eng",
431       "givenName": "John",
432       "middleName": "R",
433       "otherName": "foo",
434       "prefix": "Dr.",
435       "suffix": "Jr.",
436       "sourceId": "87654321-4321-4321-4321-210987654322",
437       "displayName": "John Doe"
438     },
439     "nationality": "AUS",
440     "phoneNumbers": [
441       {
442         "phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
443         "isPreferred": true,
444         "type": "OTHER",
445         "sourceId": "14fd5f64-5717-4562-b3fc-2c963f66ba34",
446         "country": "AUS",
447         "number": "0426192340",
448         "linkedAddresses": [
449           {
450             "addressId": "fa335f64-5717-4562-b3fc-2c963f66cf41"
451           }
452         ],
453         "unstructuredLongForm": "foo"
454       }
455     ],
456     "placeOfBirth": {
457       "country": "USA",
458       "addressId": "6ad15f64-5717-4562-b3fc-2c963f66abf9",
459       "sourceId": "1da65f64-5717-4562-b3fc-2c963f669fba",
460       "longForm": "525 Kent Dr, Harlem NY 10037, USA",
461       "unstructuredLongForm": "3A/525 KENT DRIVE HARLEM NEW YORK 10036 USA",
462       "unitNumber": "3A",
463       "buildingName": "EQ Tower",
464       "streetName": "Kent",
465       "streetNumber": "525",
466       "streetType": "Dr",
467       "neighborhood": "Harlem",
468       "locality": "Manhattan",
469       "district": "New York County",
470       "subdivision": "NY",
471       "postalCode": "10037"
472     },
473     "relationships": {
474       "duplicates": [
475         {
476           "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
477           "entityType": "INDIVIDUAL",
478           "origin": {
479             "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
480             "entityType": "INDIVIDUAL",
481             "processResultId": "foo",
482             "createdAt": "foo"
483           }
484         }
485       ]
486     },
487     "schemaVersion": 2,
488     "sourceId": "foo"
489   },
490   "serviceProfiles": [
491     {
492       "assignee": "Ryan Gosling",
493       "country": "AUS",
494       "createdAt": "2024-01-15T02:18:11.365Z",
495       "createdBy": "Ryan Reynolds",
496       "createdRequestId": "01HMR2ERSKCYAVXKS1FKSRT2T4",
497       "currentWorkflowId": "foo",
498       "currentWorkflowName": "foo",
499       "customerReference": "foo",
500       "entityId": "foo",
501       "entityName": "foo",
502       "entityType": "foo",
503       "latestRiskAssessmentId": "foo",
504       "latestWorkflowExecutionId": "foo",
505       "organizationType": "SOLE TRADER",
506       "reviewer": "Ryan Trahan",
507       "schemaVersion": 2,
508       "serviceName": "foo",
509       "serviceProfileId": "55fc5d54-46f7-49c8-bf78-e07ec79c42fd",
510       "state": "INIT",
511       "subscriptions": [
512         {
513           "serviceProfileId": "foo",
514           "status": "ENABLED",
515           "type": "AML",
516           "workflowName": "foo",
517           "workflowId": "foo",
518           "enabledAt": "foo",
519           "enabledRequestId": "foo",
520           "enabledBy": "foo",
521           "disabledAt": "foo",
522           "disabledRequestId": "foo",
523           "disabledBy": "foo"
524         }
525       ],
526       "updatedAt": "2024-01-15T02:18:11.365Z",
527       "updatedBy": "Ryan Reynolds",
528       "updatedRequestId": "01HMR2ERSKCYAVXKS1FKSRT2T4",
529       "workflowSummaries": [
530         {
531           "schemaVersion": 42,
532           "workflowName": "foo",
533           "workflowExecutionId": "foo",
534           "workflowExecutionState": "COMPLETED",
535           "status": "UNCHECKED",
536           "statusOverrideAt": "foo",
537           "statusOverrideRequestId": "foo",
538           "statusOverrideBy": "foo",
539           "riskAssessment": {
540             "serviceProfileId": "foo",
541             "workflowId": "foo",
542             "workflowExecutionId": "foo",
543             "entityId": "foo",
544             "riskAssessmentId": "foo",
545             "schemaVersion": 42,
546             "createdAt": "foo",
547             "updatedAt": "foo",
548             "updatedBy": "foo",
549             "updatedRequestId": "foo",
550             "workflowRiskScore": 42,
551             "workflowRiskLevel": "UNKNOWN",
552             "riskScore": 42,
553             "riskLevel": "UNKNOWN",
554             "isOutdated": false,
555             "riskFactors": [
556               {
557                 "riskFactorId": "foo",
558                 "factor": "foo",
559                 "value": "foo",
560                 "score": 42,
561                 "description": "foo",
562                 "workflowExecutionId": "foo",
563                 "stepResultId": "foo",
564                 "manualOverrideScore": 42,
565                 "status": "VALID",
566                 "createdAt": "foo",
567                 "updatedAt": "foo",
568                 "updatedBy": "foo",
569                 "updatedRequestId": "foo",
570                 "createdServiceProfileId": "foo",
571                 "createdWorkflowExecutionId": "foo",
572                 "createdStepResultId": "foo"
573               }
574             ]
575           },
576           "isManual": true,
577           "steps": {
578             "order": [
579               "foo"
580             ],
581             "passed": [
582               "foo"
583             ],
584             "failed": [
585               "foo"
586             ],
587             "incomplete": [
588               "foo"
589             ],
590             "notApplicable": [
591               "foo"
592             ]
593           },
594           "startedAt": "foo",
595           "endedAt": "foo",
596           "issues": [
597             {
598               "category": "AML",
599               "issue": "AML_ISSUE",
600               "severity": "INFO",
601               "issueId": "foo",
602               "workflowExecutionId": "foo",
603               "stepResultId": "foo",
604               "isCleared": true,
605               "createdBy": "foo",
606               "createdAt": "foo",
607               "updatedAt": "foo",
608               "updatedBy": "foo",
609               "updatedRequestId": "foo"
610             }
611           ],
612           "lifecyclePhase": "OTHER",
613           "monitoringTypes": [
614             "foo"
615           ]
616         }
617       ]
618     }
619   ]
620 }

Creates an Individual entity object which can be used to store data about an individual. You can optionally include documents, attachments, references etc. to the entity. Information stored in an entity object can be used to verify the individual against external data sources for the purposes of eKYC, or in other verifications supported by FrankieOne.

Headers

Request

Create an individual

individualobjectOptional

serviceNamestringOptional

workflowNamestringOptional

commentobjectOptional

Response

Created

requestIdstring

The unique request ID for the API call made.

individualobject or null

serviceProfileslist of objects or null

Headers

Request

Response

Errors