Create a new document for an individual. (v2.0.0) — FrankieOne

Add a new document to an entity.

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

Headers

X-Frankie-CustomerIDstringRequired

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstringOptional

Your Customer Child ID provided by FrankieOne

X-Frankie-ChannelstringOptional

Open string that can be used to define the “channel” the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

X-Frankie-UsernamestringOptional

Username provided by API caller

Query parameters

levelenumOptionalDefaults to meta

Determines what level of detail to return in the response

id: Return just an id
meta: Return all metadata only, no links or base64 data
base64: Return all metadata and data in base64 format

Allowed values: idmetabase64

Request

This endpoint expects an object.

documentobjectOptional

commentobjectOptional

Response

Created

requestIdstring

The unique request ID for the API call made.

entitystringOptional

Entity’s are assigned an auto-generated UUID to ensure global uniqueness, represented as an entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request call.

documentobjectOptional

1 curl -X POST https://api.uat.frankie.one/v2/individuals/entityId/documents \ 2 -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \ 3 -H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \ 4 -H "X-Frankie-Username: fred.flintstone@frankieone.com" \ 5 -H "api_key: <apiKey>" \ 6 -H "Content-Type: application/json" \ 7 -d '{}'

1 { 2 "requestId": "01HN9XHZN6MGXM9JXG50K59Q85", 3 "entity": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4 "document": { 5 "type": "OTHER", 6 "country": "AUS", 7 "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7", 8 "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 9 "expiryDate": { 10 "day": "27", 11 "month": "03", 12 "normalized": "1990-03-31", 13 "type": "BUDDHIST", 14 "unstructured": "12 Rajab 1445 AH", 15 "year": "1990" 16 }, 17 "issueDate": { 18 "day": "27", 19 "month": "03", 20 "normalized": "1990-03-31", 21 "type": "BUDDHIST", 22 "unstructured": "12 Rajab 1445 AH", 23 "year": "1990" 24 }, 25 "primaryIdentifier": "000734130", 26 "secondaryIdentifier": "P0001975", 27 "subtype": "Photo Comparison", 28 "subdivision": "VIC", 29 "createdAt": "2024-01-15T02:18:11Z", 30 "updatedAt": "2025-01-16T02:18:11Z", 31 "validFrom": { 32 "day": "27", 33 "month": "03", 34 "normalized": "1990-03-31", 35 "type": "BUDDHIST", 36 "unstructured": "12 Rajab 1445 AH", 37 "year": "1990" 38 }, 39 "validTo": { 40 "day": "27", 41 "month": "03", 42 "normalized": "1990-03-31", 43 "type": "BUDDHIST", 44 "unstructured": "12 Rajab 1445 AH", 45 "year": "1990" 46 }, 47 "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1", 48 "supplementaryData": { 49 "type": "BIRTH_CERT", 50 "dateOfPrint": "2000", 51 "familyName": "supplementaryData", 52 "givenName": "supplementaryData", 53 "otherNames": "supplementaryData", 54 "registrationDate": "2000", 55 "registrationDistrict": "Sydney" 56 }, 57 "customAttributes": { 58 "key": { 59 "type": "type", 60 "value": "value" 61 } 62 }, 63 "attachments": [ 64 { 65 "data": { 66 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg" 67 }, 68 "attachmentId": "attachmentId", 69 "sourceId": "sourceId", 70 "createdAt": "2024-01-15T09:30:00Z", 71 "updatedAt": "2024-01-15T09:30:00Z", 72 "filename": "filename", 73 "mimeType": "mimeType", 74 "pageNumber": 1, 75 "side": "FRONT", 76 "type": "type", 77 "location": "location", 78 "lastMalwareScanAt": "2024-01-15T09:30:00Z", 79 "retrievalStatus": "NORMAL" 80 } 81 ] 82 } 83 }

1	curl -X POST https://api.uat.frankie.one/v2/individuals/entityId/documents \
2	-H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3	-H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4	-H "X-Frankie-Username: fred.flintstone@frankieone.com" \
5	-H "api_key: <apiKey>" \
6	-H "Content-Type: application/json" \
7	-d '{}'

1	{
2	"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
3	"entity": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4	"document": {
5	"type": "OTHER",
6	"country": "AUS",
7	"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
8	"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
9	"expiryDate": {
10	"day": "27",
11	"month": "03",
12	"normalized": "1990-03-31",
13	"type": "BUDDHIST",
14	"unstructured": "12 Rajab 1445 AH",
15	"year": "1990"
16	},
17	"issueDate": {
18	"day": "27",
19	"month": "03",
20	"normalized": "1990-03-31",
21	"type": "BUDDHIST",
22	"unstructured": "12 Rajab 1445 AH",
23	"year": "1990"
24	},
25	"primaryIdentifier": "000734130",
26	"secondaryIdentifier": "P0001975",
27	"subtype": "Photo Comparison",
28	"subdivision": "VIC",
29	"createdAt": "2024-01-15T02:18:11Z",
30	"updatedAt": "2025-01-16T02:18:11Z",
31	"validFrom": {
32	"day": "27",
33	"month": "03",
34	"normalized": "1990-03-31",
35	"type": "BUDDHIST",
36	"unstructured": "12 Rajab 1445 AH",
37	"year": "1990"
38	},
39	"validTo": {
40	"day": "27",
41	"month": "03",
42	"normalized": "1990-03-31",
43	"type": "BUDDHIST",
44	"unstructured": "12 Rajab 1445 AH",
45	"year": "1990"
46	},
47	"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
48	"supplementaryData": {
49	"type": "BIRTH_CERT",
50	"dateOfPrint": "2000",
51	"familyName": "supplementaryData",
52	"givenName": "supplementaryData",
53	"otherNames": "supplementaryData",
54	"registrationDate": "2000",
55	"registrationDistrict": "Sydney"
56	},
57	"customAttributes": {
58	"key": {
59	"type": "type",
60	"value": "value"
61	}
62	},
63	"attachments": [
64	{
65	"data": {
66	"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
67	},
68	"attachmentId": "attachmentId",
69	"sourceId": "sourceId",
70	"createdAt": "2024-01-15T09:30:00Z",
71	"updatedAt": "2024-01-15T09:30:00Z",
72	"filename": "filename",
73	"mimeType": "mimeType",
74	"pageNumber": 1,
75	"side": "FRONT",
76	"type": "type",
77	"location": "location",
78	"lastMalwareScanAt": "2024-01-15T09:30:00Z",
79	"retrievalStatus": "NORMAL"
80	}
81	]
82	}
83	}