Get all documents for an entity (v2.0.0) — FrankieOne

Get all documents for 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

Response

REPORTlist of objectsOptional

SUPPORTINGlist of objectsOptional

IDENTITYlist of objectsOptional

OTHERlist of objectsOptional

1 curl 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>"

1 { 2 "REPORT": [ 3 { 4 "type": "OTHER", 5 "country": "AUS", 6 "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7", 7 "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 8 "expiryDate": { 9 "day": "27", 10 "month": "03", 11 "normalized": "1990-03-31", 12 "type": "BUDDHIST", 13 "unstructured": "12 Rajab 1445 AH", 14 "year": "1990" 15 }, 16 "issueDate": { 17 "day": "27", 18 "month": "03", 19 "normalized": "1990-03-31", 20 "type": "BUDDHIST", 21 "unstructured": "12 Rajab 1445 AH", 22 "year": "1990" 23 }, 24 "primaryIdentifier": "000734130", 25 "secondaryIdentifier": "P0001975", 26 "subtype": "Photo Comparison", 27 "subdivision": "VIC", 28 "createdAt": "2024-01-15T02:18:11Z", 29 "updatedAt": "2025-01-16T02:18:11Z", 30 "validFrom": { 31 "day": "27", 32 "month": "03", 33 "normalized": "1990-03-31", 34 "type": "BUDDHIST", 35 "unstructured": "12 Rajab 1445 AH", 36 "year": "1990" 37 }, 38 "validTo": { 39 "day": "27", 40 "month": "03", 41 "normalized": "1990-03-31", 42 "type": "BUDDHIST", 43 "unstructured": "12 Rajab 1445 AH", 44 "year": "1990" 45 }, 46 "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1", 47 "supplementaryData": { 48 "type": "BIRTH_CERT", 49 "dateOfPrint": "2000", 50 "familyName": "supplementaryData", 51 "givenName": "supplementaryData", 52 "otherNames": "supplementaryData", 53 "registrationDate": "2000", 54 "registrationDistrict": "Sydney" 55 }, 56 "customAttributes": { 57 "key": { 58 "type": "type", 59 "value": "value" 60 } 61 }, 62 "attachments": [ 63 { 64 "data": { 65 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg" 66 }, 67 "attachmentId": "attachmentId", 68 "sourceId": "sourceId", 69 "createdAt": "2024-01-15T09:30:00Z", 70 "updatedAt": "2024-01-15T09:30:00Z", 71 "filename": "filename", 72 "mimeType": "mimeType", 73 "pageNumber": 1, 74 "side": "FRONT", 75 "type": "type", 76 "location": "location", 77 "lastMalwareScanAt": "2024-01-15T09:30:00Z", 78 "retrievalStatus": "NORMAL" 79 } 80 ] 81 } 82 ], 83 "SUPPORTING": [ 84 { 85 "type": "OTHER", 86 "country": "AUS", 87 "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7", 88 "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 89 "expiryDate": { 90 "day": "27", 91 "month": "03", 92 "normalized": "1990-03-31", 93 "type": "BUDDHIST", 94 "unstructured": "12 Rajab 1445 AH", 95 "year": "1990" 96 }, 97 "issueDate": { 98 "day": "27", 99 "month": "03", 100 "normalized": "1990-03-31", 101 "type": "BUDDHIST", 102 "unstructured": "12 Rajab 1445 AH", 103 "year": "1990" 104 }, 105 "primaryIdentifier": "000734130", 106 "secondaryIdentifier": "P0001975", 107 "subtype": "Photo Comparison", 108 "subdivision": "VIC", 109 "createdAt": "2024-01-15T02:18:11Z", 110 "updatedAt": "2025-01-16T02:18:11Z", 111 "validFrom": { 112 "day": "27", 113 "month": "03", 114 "normalized": "1990-03-31", 115 "type": "BUDDHIST", 116 "unstructured": "12 Rajab 1445 AH", 117 "year": "1990" 118 }, 119 "validTo": { 120 "day": "27", 121 "month": "03", 122 "normalized": "1990-03-31", 123 "type": "BUDDHIST", 124 "unstructured": "12 Rajab 1445 AH", 125 "year": "1990" 126 }, 127 "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1", 128 "supplementaryData": { 129 "type": "BIRTH_CERT", 130 "dateOfPrint": "2000", 131 "familyName": "supplementaryData", 132 "givenName": "supplementaryData", 133 "otherNames": "supplementaryData", 134 "registrationDate": "2000", 135 "registrationDistrict": "Sydney" 136 }, 137 "customAttributes": { 138 "key": { 139 "type": "type", 140 "value": "value" 141 } 142 }, 143 "attachments": [ 144 { 145 "data": { 146 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg" 147 }, 148 "attachmentId": "attachmentId", 149 "sourceId": "sourceId", 150 "createdAt": "2024-01-15T09:30:00Z", 151 "updatedAt": "2024-01-15T09:30:00Z", 152 "filename": "filename", 153 "mimeType": "mimeType", 154 "pageNumber": 1, 155 "side": "FRONT", 156 "type": "type", 157 "location": "location", 158 "lastMalwareScanAt": "2024-01-15T09:30:00Z", 159 "retrievalStatus": "NORMAL" 160 } 161 ] 162 } 163 ], 164 "IDENTITY": [ 165 { 166 "type": "OTHER", 167 "country": "AUS", 168 "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7", 169 "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 170 "expiryDate": { 171 "day": "27", 172 "month": "03", 173 "normalized": "1990-03-31", 174 "type": "BUDDHIST", 175 "unstructured": "12 Rajab 1445 AH", 176 "year": "1990" 177 }, 178 "issueDate": { 179 "day": "27", 180 "month": "03", 181 "normalized": "1990-03-31", 182 "type": "BUDDHIST", 183 "unstructured": "12 Rajab 1445 AH", 184 "year": "1990" 185 }, 186 "primaryIdentifier": "000734130", 187 "secondaryIdentifier": "P0001975", 188 "subtype": "Photo Comparison", 189 "subdivision": "VIC", 190 "createdAt": "2024-01-15T02:18:11Z", 191 "updatedAt": "2025-01-16T02:18:11Z", 192 "validFrom": { 193 "day": "27", 194 "month": "03", 195 "normalized": "1990-03-31", 196 "type": "BUDDHIST", 197 "unstructured": "12 Rajab 1445 AH", 198 "year": "1990" 199 }, 200 "validTo": { 201 "day": "27", 202 "month": "03", 203 "normalized": "1990-03-31", 204 "type": "BUDDHIST", 205 "unstructured": "12 Rajab 1445 AH", 206 "year": "1990" 207 }, 208 "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1", 209 "supplementaryData": { 210 "type": "BIRTH_CERT", 211 "dateOfPrint": "2000", 212 "familyName": "supplementaryData", 213 "givenName": "supplementaryData", 214 "otherNames": "supplementaryData", 215 "registrationDate": "2000", 216 "registrationDistrict": "Sydney" 217 }, 218 "customAttributes": { 219 "key": { 220 "type": "type", 221 "value": "value" 222 } 223 }, 224 "attachments": [ 225 { 226 "data": { 227 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg" 228 }, 229 "attachmentId": "attachmentId", 230 "sourceId": "sourceId", 231 "createdAt": "2024-01-15T09:30:00Z", 232 "updatedAt": "2024-01-15T09:30:00Z", 233 "filename": "filename", 234 "mimeType": "mimeType", 235 "pageNumber": 1, 236 "side": "FRONT", 237 "type": "type", 238 "location": "location", 239 "lastMalwareScanAt": "2024-01-15T09:30:00Z", 240 "retrievalStatus": "NORMAL" 241 } 242 ] 243 } 244 ], 245 "OTHER": [ 246 { 247 "type": "OTHER", 248 "country": "AUS", 249 "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7", 250 "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 251 "expiryDate": { 252 "day": "27", 253 "month": "03", 254 "normalized": "1990-03-31", 255 "type": "BUDDHIST", 256 "unstructured": "12 Rajab 1445 AH", 257 "year": "1990" 258 }, 259 "issueDate": { 260 "day": "27", 261 "month": "03", 262 "normalized": "1990-03-31", 263 "type": "BUDDHIST", 264 "unstructured": "12 Rajab 1445 AH", 265 "year": "1990" 266 }, 267 "primaryIdentifier": "000734130", 268 "secondaryIdentifier": "P0001975", 269 "subtype": "Photo Comparison", 270 "subdivision": "VIC", 271 "createdAt": "2024-01-15T02:18:11Z", 272 "updatedAt": "2025-01-16T02:18:11Z", 273 "validFrom": { 274 "day": "27", 275 "month": "03", 276 "normalized": "1990-03-31", 277 "type": "BUDDHIST", 278 "unstructured": "12 Rajab 1445 AH", 279 "year": "1990" 280 }, 281 "validTo": { 282 "day": "27", 283 "month": "03", 284 "normalized": "1990-03-31", 285 "type": "BUDDHIST", 286 "unstructured": "12 Rajab 1445 AH", 287 "year": "1990" 288 }, 289 "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1", 290 "supplementaryData": { 291 "type": "BIRTH_CERT", 292 "dateOfPrint": "2000", 293 "familyName": "supplementaryData", 294 "givenName": "supplementaryData", 295 "otherNames": "supplementaryData", 296 "registrationDate": "2000", 297 "registrationDistrict": "Sydney" 298 }, 299 "customAttributes": { 300 "key": { 301 "type": "type", 302 "value": "value" 303 } 304 }, 305 "attachments": [ 306 { 307 "data": { 308 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg" 309 }, 310 "attachmentId": "attachmentId", 311 "sourceId": "sourceId", 312 "createdAt": "2024-01-15T09:30:00Z", 313 "updatedAt": "2024-01-15T09:30:00Z", 314 "filename": "filename", 315 "mimeType": "mimeType", 316 "pageNumber": 1, 317 "side": "FRONT", 318 "type": "type", 319 "location": "location", 320 "lastMalwareScanAt": "2024-01-15T09:30:00Z", 321 "retrievalStatus": "NORMAL" 322 } 323 ] 324 } 325 ] 326 }

1	curl 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>"

1	{
2	"REPORT": [
3	{
4	"type": "OTHER",
5	"country": "AUS",
6	"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
7	"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
8	"expiryDate": {
9	"day": "27",
10	"month": "03",
11	"normalized": "1990-03-31",
12	"type": "BUDDHIST",
13	"unstructured": "12 Rajab 1445 AH",
14	"year": "1990"
15	},
16	"issueDate": {
17	"day": "27",
18	"month": "03",
19	"normalized": "1990-03-31",
20	"type": "BUDDHIST",
21	"unstructured": "12 Rajab 1445 AH",
22	"year": "1990"
23	},
24	"primaryIdentifier": "000734130",
25	"secondaryIdentifier": "P0001975",
26	"subtype": "Photo Comparison",
27	"subdivision": "VIC",
28	"createdAt": "2024-01-15T02:18:11Z",
29	"updatedAt": "2025-01-16T02:18:11Z",
30	"validFrom": {
31	"day": "27",
32	"month": "03",
33	"normalized": "1990-03-31",
34	"type": "BUDDHIST",
35	"unstructured": "12 Rajab 1445 AH",
36	"year": "1990"
37	},
38	"validTo": {
39	"day": "27",
40	"month": "03",
41	"normalized": "1990-03-31",
42	"type": "BUDDHIST",
43	"unstructured": "12 Rajab 1445 AH",
44	"year": "1990"
45	},
46	"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
47	"supplementaryData": {
48	"type": "BIRTH_CERT",
49	"dateOfPrint": "2000",
50	"familyName": "supplementaryData",
51	"givenName": "supplementaryData",
52	"otherNames": "supplementaryData",
53	"registrationDate": "2000",
54	"registrationDistrict": "Sydney"
55	},
56	"customAttributes": {
57	"key": {
58	"type": "type",
59	"value": "value"
60	}
61	},
62	"attachments": [
63	{
64	"data": {
65	"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
66	},
67	"attachmentId": "attachmentId",
68	"sourceId": "sourceId",
69	"createdAt": "2024-01-15T09:30:00Z",
70	"updatedAt": "2024-01-15T09:30:00Z",
71	"filename": "filename",
72	"mimeType": "mimeType",
73	"pageNumber": 1,
74	"side": "FRONT",
75	"type": "type",
76	"location": "location",
77	"lastMalwareScanAt": "2024-01-15T09:30:00Z",
78	"retrievalStatus": "NORMAL"
79	}
80	]
81	}
82	],
83	"SUPPORTING": [
84	{
85	"type": "OTHER",
86	"country": "AUS",
87	"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
88	"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
89	"expiryDate": {
90	"day": "27",
91	"month": "03",
92	"normalized": "1990-03-31",
93	"type": "BUDDHIST",
94	"unstructured": "12 Rajab 1445 AH",
95	"year": "1990"
96	},
97	"issueDate": {
98	"day": "27",
99	"month": "03",
100	"normalized": "1990-03-31",
101	"type": "BUDDHIST",
102	"unstructured": "12 Rajab 1445 AH",
103	"year": "1990"
104	},
105	"primaryIdentifier": "000734130",
106	"secondaryIdentifier": "P0001975",
107	"subtype": "Photo Comparison",
108	"subdivision": "VIC",
109	"createdAt": "2024-01-15T02:18:11Z",
110	"updatedAt": "2025-01-16T02:18:11Z",
111	"validFrom": {
112	"day": "27",
113	"month": "03",
114	"normalized": "1990-03-31",
115	"type": "BUDDHIST",
116	"unstructured": "12 Rajab 1445 AH",
117	"year": "1990"
118	},
119	"validTo": {
120	"day": "27",
121	"month": "03",
122	"normalized": "1990-03-31",
123	"type": "BUDDHIST",
124	"unstructured": "12 Rajab 1445 AH",
125	"year": "1990"
126	},
127	"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
128	"supplementaryData": {
129	"type": "BIRTH_CERT",
130	"dateOfPrint": "2000",
131	"familyName": "supplementaryData",
132	"givenName": "supplementaryData",
133	"otherNames": "supplementaryData",
134	"registrationDate": "2000",
135	"registrationDistrict": "Sydney"
136	},
137	"customAttributes": {
138	"key": {
139	"type": "type",
140	"value": "value"
141	}
142	},
143	"attachments": [
144	{
145	"data": {
146	"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
147	},
148	"attachmentId": "attachmentId",
149	"sourceId": "sourceId",
150	"createdAt": "2024-01-15T09:30:00Z",
151	"updatedAt": "2024-01-15T09:30:00Z",
152	"filename": "filename",
153	"mimeType": "mimeType",
154	"pageNumber": 1,
155	"side": "FRONT",
156	"type": "type",
157	"location": "location",
158	"lastMalwareScanAt": "2024-01-15T09:30:00Z",
159	"retrievalStatus": "NORMAL"
160	}
161	]
162	}
163	],
164	"IDENTITY": [
165	{
166	"type": "OTHER",
167	"country": "AUS",
168	"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
169	"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
170	"expiryDate": {
171	"day": "27",
172	"month": "03",
173	"normalized": "1990-03-31",
174	"type": "BUDDHIST",
175	"unstructured": "12 Rajab 1445 AH",
176	"year": "1990"
177	},
178	"issueDate": {
179	"day": "27",
180	"month": "03",
181	"normalized": "1990-03-31",
182	"type": "BUDDHIST",
183	"unstructured": "12 Rajab 1445 AH",
184	"year": "1990"
185	},
186	"primaryIdentifier": "000734130",
187	"secondaryIdentifier": "P0001975",
188	"subtype": "Photo Comparison",
189	"subdivision": "VIC",
190	"createdAt": "2024-01-15T02:18:11Z",
191	"updatedAt": "2025-01-16T02:18:11Z",
192	"validFrom": {
193	"day": "27",
194	"month": "03",
195	"normalized": "1990-03-31",
196	"type": "BUDDHIST",
197	"unstructured": "12 Rajab 1445 AH",
198	"year": "1990"
199	},
200	"validTo": {
201	"day": "27",
202	"month": "03",
203	"normalized": "1990-03-31",
204	"type": "BUDDHIST",
205	"unstructured": "12 Rajab 1445 AH",
206	"year": "1990"
207	},
208	"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
209	"supplementaryData": {
210	"type": "BIRTH_CERT",
211	"dateOfPrint": "2000",
212	"familyName": "supplementaryData",
213	"givenName": "supplementaryData",
214	"otherNames": "supplementaryData",
215	"registrationDate": "2000",
216	"registrationDistrict": "Sydney"
217	},
218	"customAttributes": {
219	"key": {
220	"type": "type",
221	"value": "value"
222	}
223	},
224	"attachments": [
225	{
226	"data": {
227	"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
228	},
229	"attachmentId": "attachmentId",
230	"sourceId": "sourceId",
231	"createdAt": "2024-01-15T09:30:00Z",
232	"updatedAt": "2024-01-15T09:30:00Z",
233	"filename": "filename",
234	"mimeType": "mimeType",
235	"pageNumber": 1,
236	"side": "FRONT",
237	"type": "type",
238	"location": "location",
239	"lastMalwareScanAt": "2024-01-15T09:30:00Z",
240	"retrievalStatus": "NORMAL"
241	}
242	]
243	}
244	],
245	"OTHER": [
246	{
247	"type": "OTHER",
248	"country": "AUS",
249	"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
250	"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
251	"expiryDate": {
252	"day": "27",
253	"month": "03",
254	"normalized": "1990-03-31",
255	"type": "BUDDHIST",
256	"unstructured": "12 Rajab 1445 AH",
257	"year": "1990"
258	},
259	"issueDate": {
260	"day": "27",
261	"month": "03",
262	"normalized": "1990-03-31",
263	"type": "BUDDHIST",
264	"unstructured": "12 Rajab 1445 AH",
265	"year": "1990"
266	},
267	"primaryIdentifier": "000734130",
268	"secondaryIdentifier": "P0001975",
269	"subtype": "Photo Comparison",
270	"subdivision": "VIC",
271	"createdAt": "2024-01-15T02:18:11Z",
272	"updatedAt": "2025-01-16T02:18:11Z",
273	"validFrom": {
274	"day": "27",
275	"month": "03",
276	"normalized": "1990-03-31",
277	"type": "BUDDHIST",
278	"unstructured": "12 Rajab 1445 AH",
279	"year": "1990"
280	},
281	"validTo": {
282	"day": "27",
283	"month": "03",
284	"normalized": "1990-03-31",
285	"type": "BUDDHIST",
286	"unstructured": "12 Rajab 1445 AH",
287	"year": "1990"
288	},
289	"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
290	"supplementaryData": {
291	"type": "BIRTH_CERT",
292	"dateOfPrint": "2000",
293	"familyName": "supplementaryData",
294	"givenName": "supplementaryData",
295	"otherNames": "supplementaryData",
296	"registrationDate": "2000",
297	"registrationDistrict": "Sydney"
298	},
299	"customAttributes": {
300	"key": {
301	"type": "type",
302	"value": "value"
303	}
304	},
305	"attachments": [
306	{
307	"data": {
308	"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
309	},
310	"attachmentId": "attachmentId",
311	"sourceId": "sourceId",
312	"createdAt": "2024-01-15T09:30:00Z",
313	"updatedAt": "2024-01-15T09:30:00Z",
314	"filename": "filename",
315	"mimeType": "mimeType",
316	"pageNumber": 1,
317	"side": "FRONT",
318	"type": "type",
319	"location": "location",
320	"lastMalwareScanAt": "2024-01-15T09:30:00Z",
321	"retrievalStatus": "NORMAL"
322	}
323	]
324	}
325	]
326	}