Document Analyses Results

GET

/v2/organizations/:entityId/documents/:documentId/analyses

GET

/experimental/v2/organizations/:entityId/documents/:documentId/analyses

1 curl https://api.frankie.one/experimental/v2/organizations/entityId/documents/documentId/analyses \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "analyses": [
4     {
5       "analysisId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6       "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
7       "documentInformation": {
8         "type": "TRUST_DOCUMENT",
9         "trust": {
10           "name": {
11             "value": "foo",
12             "referenceIds": [
13               "foo"
14             ]
15           },
16           "establishment": {
17             "date": {
18               "year": "1990",
19               "month": "03",
20               "day": "27",
21               "unstructured": "12 Rajab 1445 AH",
22               "type": "GREGORIAN",
23               "normalized": "1990-03-31",
24               "referenceIds": [
25                 "foo"
26               ]
27             },
28             "country": {
29               "value": "foo",
30               "referenceIds": [
31                 "foo"
32               ]
33             },
34             "subdivision": {
35               "value": "foo",
36               "referenceIds": [
37                 "foo"
38               ]
39             }
40           },
41           "certification": {
42             "date": {
43               "year": "1990",
44               "month": "03",
45               "day": "27",
46               "unstructured": "12 Rajab 1445 AH",
47               "type": "GREGORIAN",
48               "normalized": "1990-03-31",
49               "referenceIds": [
50                 "foo"
51               ]
52             }
53           },
54           "execution": {
55             "date": {
56               "year": "1990",
57               "month": "03",
58               "day": "27",
59               "unstructured": "12 Rajab 1445 AH",
60               "type": "GREGORIAN",
61               "normalized": "1990-03-31",
62               "referenceIds": [
63                 "foo"
64               ]
65             }
66           },
67           "linkedIndividuals": {},
68           "linkedOrganizations": {},
69           "linkedUnknownEntities": {},
70           "settlors": [
71             {
72               "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
73               "entityType": "INDIVIDUAL",
74               "referenceIds": [
75                 "foo"
76               ]
77             }
78           ],
79           "trustees": [
80             {
81               "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
82               "entityType": "INDIVIDUAL",
83               "referenceIds": [
84                 "foo"
85               ]
86             }
87           ],
88           "type": {
89             "provided": "DISCRETIONARY",
90             "detected": "DISCRETIONARY"
91           },
92           "typeInformation": {
93             "type": "DISCRETIONARY",
94             "discretionary": {
95               "specifiedBeneficiaries": [
96                 {
97                   "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
98                   "entityType": "INDIVIDUAL",
99                   "referenceIds": [
100                     "foo"
101                   ]
102                 }
103               ],
104               "generalBeneficiaries": [
105                 {
106                   "value": "foo",
107                   "referenceIds": [
108                     "foo"
109                   ]
110                 }
111               ],
112               "appointors": [
113                 {
114                   "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
115                   "entityType": "INDIVIDUAL",
116                   "referenceIds": [
117                     "foo"
118                   ]
119                 }
120               ],
121               "protectors": [
122                 {
123                   "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
124                   "entityType": "INDIVIDUAL",
125                   "referenceIds": [
126                     "foo"
127                   ]
128                 }
129               ]
130             }
131           }
132         }
133       },
134       "errors": [
135         {
136           "errorCode": "foo",
137           "errorMsg": "foo",
138           "details": [
139             {
140               "issue": "foo",
141               "issueLocation": "foo",
142               "issueType": "foo"
143             }
144           ]
145         }
146       ],
147       "references": {},
148       "status": "PROCESSING"
149     }
150   ],
151   "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
152 }

Get Document Analyses Results

Path parameters

entityIdstringRequired

documentIdstringRequired

Response

entityIdstring or null

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.

analyseslist of objects or null

requestIdstring or null

The unique request ID for the API call made.

Document Analyses Results

Path parameters

Headers

Response

Errors