Get all documents for an entity

GET

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

GET

/v2/individuals/:entityId/documents

1 curl https://api.uat.frankie.one/v2/individuals/entityId/documents \
2      -H "api_key: <apiKey>" \
3      -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012"

Try it

200Retrieved

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": "GREGORIAN",
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": "GREGORIAN",
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:11.365Z",
29       "updatedAt": "2025-01-16T02:18:11.365Z",
30       "validFrom": {
31         "day": "27",
32         "month": "03",
33         "normalized": "1990-03-31",
34         "type": "GREGORIAN",
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": "GREGORIAN",
43         "unstructured": "12 Rajab 1445 AH",
44         "year": "1990"
45       },
46       "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
47       "supplementaryData": {
48         "type": "NATIONAL_HEALTH_ID",
49         "middleNameOnCard": "foo",
50         "nameOnCardLine1": "foo",
51         "nameOnCardLine2": "foo",
52         "nameOnCardLine3": "foo",
53         "nameOnCardLine4": "foo",
54         "reference": "1"
55       },
56       "customAttributes": {},
57       "attachments": [
58         {
59           "data": {
60             "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
61           },
62           "attachmentId": "foo",
63           "sourceId": "foo",
64           "createdAt": "foo",
65           "updatedAt": "foo",
66           "filename": "foo",
67           "mimeType": "foo",
68           "pageNumber": 42,
69           "side": "FRONT",
70           "type": "foo",
71           "location": "foo",
72           "lastMalwareScanAt": "foo",
73           "retrievalStatus": "NORMAL"
74         }
75       ]
76     }
77   ],
78   "SUPPORTING": [
79     {
80       "type": "OTHER",
81       "country": "AUS",
82       "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
83       "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
84       "expiryDate": {
85         "day": "27",
86         "month": "03",
87         "normalized": "1990-03-31",
88         "type": "GREGORIAN",
89         "unstructured": "12 Rajab 1445 AH",
90         "year": "1990"
91       },
92       "issueDate": {
93         "day": "27",
94         "month": "03",
95         "normalized": "1990-03-31",
96         "type": "GREGORIAN",
97         "unstructured": "12 Rajab 1445 AH",
98         "year": "1990"
99       },
100       "primaryIdentifier": "000734130",
101       "secondaryIdentifier": "P0001975",
102       "subtype": "Photo Comparison",
103       "subdivision": "VIC",
104       "createdAt": "2024-01-15T02:18:11.365Z",
105       "updatedAt": "2025-01-16T02:18:11.365Z",
106       "validFrom": {
107         "day": "27",
108         "month": "03",
109         "normalized": "1990-03-31",
110         "type": "GREGORIAN",
111         "unstructured": "12 Rajab 1445 AH",
112         "year": "1990"
113       },
114       "validTo": {
115         "day": "27",
116         "month": "03",
117         "normalized": "1990-03-31",
118         "type": "GREGORIAN",
119         "unstructured": "12 Rajab 1445 AH",
120         "year": "1990"
121       },
122       "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
123       "supplementaryData": {
124         "type": "NATIONAL_HEALTH_ID",
125         "middleNameOnCard": "foo",
126         "nameOnCardLine1": "foo",
127         "nameOnCardLine2": "foo",
128         "nameOnCardLine3": "foo",
129         "nameOnCardLine4": "foo",
130         "reference": "1"
131       },
132       "customAttributes": {},
133       "attachments": [
134         {
135           "data": {
136             "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
137           },
138           "attachmentId": "foo",
139           "sourceId": "foo",
140           "createdAt": "foo",
141           "updatedAt": "foo",
142           "filename": "foo",
143           "mimeType": "foo",
144           "pageNumber": 42,
145           "side": "FRONT",
146           "type": "foo",
147           "location": "foo",
148           "lastMalwareScanAt": "foo",
149           "retrievalStatus": "NORMAL"
150         }
151       ]
152     }
153   ],
154   "IDENTITY": [
155     {
156       "type": "OTHER",
157       "country": "AUS",
158       "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
159       "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
160       "expiryDate": {
161         "day": "27",
162         "month": "03",
163         "normalized": "1990-03-31",
164         "type": "GREGORIAN",
165         "unstructured": "12 Rajab 1445 AH",
166         "year": "1990"
167       },
168       "issueDate": {
169         "day": "27",
170         "month": "03",
171         "normalized": "1990-03-31",
172         "type": "GREGORIAN",
173         "unstructured": "12 Rajab 1445 AH",
174         "year": "1990"
175       },
176       "primaryIdentifier": "000734130",
177       "secondaryIdentifier": "P0001975",
178       "subtype": "Photo Comparison",
179       "subdivision": "VIC",
180       "createdAt": "2024-01-15T02:18:11.365Z",
181       "updatedAt": "2025-01-16T02:18:11.365Z",
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       "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
199       "supplementaryData": {
200         "type": "NATIONAL_HEALTH_ID",
201         "middleNameOnCard": "foo",
202         "nameOnCardLine1": "foo",
203         "nameOnCardLine2": "foo",
204         "nameOnCardLine3": "foo",
205         "nameOnCardLine4": "foo",
206         "reference": "1"
207       },
208       "customAttributes": {},
209       "attachments": [
210         {
211           "data": {
212             "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
213           },
214           "attachmentId": "foo",
215           "sourceId": "foo",
216           "createdAt": "foo",
217           "updatedAt": "foo",
218           "filename": "foo",
219           "mimeType": "foo",
220           "pageNumber": 42,
221           "side": "FRONT",
222           "type": "foo",
223           "location": "foo",
224           "lastMalwareScanAt": "foo",
225           "retrievalStatus": "NORMAL"
226         }
227       ]
228     }
229   ],
230   "OTHER": [
231     {
232       "type": "OTHER",
233       "country": "AUS",
234       "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
235       "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
236       "expiryDate": {
237         "day": "27",
238         "month": "03",
239         "normalized": "1990-03-31",
240         "type": "GREGORIAN",
241         "unstructured": "12 Rajab 1445 AH",
242         "year": "1990"
243       },
244       "issueDate": {
245         "day": "27",
246         "month": "03",
247         "normalized": "1990-03-31",
248         "type": "GREGORIAN",
249         "unstructured": "12 Rajab 1445 AH",
250         "year": "1990"
251       },
252       "primaryIdentifier": "000734130",
253       "secondaryIdentifier": "P0001975",
254       "subtype": "Photo Comparison",
255       "subdivision": "VIC",
256       "createdAt": "2024-01-15T02:18:11.365Z",
257       "updatedAt": "2025-01-16T02:18:11.365Z",
258       "validFrom": {
259         "day": "27",
260         "month": "03",
261         "normalized": "1990-03-31",
262         "type": "GREGORIAN",
263         "unstructured": "12 Rajab 1445 AH",
264         "year": "1990"
265       },
266       "validTo": {
267         "day": "27",
268         "month": "03",
269         "normalized": "1990-03-31",
270         "type": "GREGORIAN",
271         "unstructured": "12 Rajab 1445 AH",
272         "year": "1990"
273       },
274       "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
275       "supplementaryData": {
276         "type": "NATIONAL_HEALTH_ID",
277         "middleNameOnCard": "foo",
278         "nameOnCardLine1": "foo",
279         "nameOnCardLine2": "foo",
280         "nameOnCardLine3": "foo",
281         "nameOnCardLine4": "foo",
282         "reference": "1"
283       },
284       "customAttributes": {},
285       "attachments": [
286         {
287           "data": {
288             "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
289           },
290           "attachmentId": "foo",
291           "sourceId": "foo",
292           "createdAt": "foo",
293           "updatedAt": "foo",
294           "filename": "foo",
295           "mimeType": "foo",
296           "pageNumber": 42,
297           "side": "FRONT",
298           "type": "foo",
299           "location": "foo",
300           "lastMalwareScanAt": "foo",
301           "retrievalStatus": "NORMAL"
302         }
303       ]
304     }
305   ]
306 }

Get all documents for an entity.

Path parameters

entityIdstringRequired

Headers

Response

REPORTlist of objects or null

SUPPORTINGlist of objects or null

IDENTITYlist of objects or null

OTHERlist of objects or null

Path parameters

Headers

Response

Errors