-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathchangelog.html
More file actions
469 lines (409 loc) · 21.5 KB
/
Copy pathchangelog.html
File metadata and controls
469 lines (409 loc) · 21.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Change Log</title>
<link rel="icon" type="image/svg+xml" sizes="32x32" href="/assets/images/badge--amiqus.svg">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href="/assets/css/main.css" rel="stylesheet"/>
<meta name="description" content="Stay updated with our API developments through Amiqus' API Changelog. We provide a detailed log of changes, updates, and improvements made to the API, ensuring you're always aware of the latest modifications." />
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-9F1QR3VQFW"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-9F1QR3VQFW');
</script>
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
</head>
<body>
<a id="top"></a>
<div class="nav-container">
<a class="logo" href="/index.html" title="Amiqus API Documentation">
<img src="/assets/images/logos/amiqus-full.png" alt="Amiqus Logo" width="200" />
</a>
<ul class="navigation">
<li><a href="/aqid/api-reference.html">API Reference</a></li>
<li><a href="/sdk/sdk-api-reference.html">SDK API Reference</a></li>
<li><a href="/guide/">Guides</a></li>
</ul>
</div>
<div id="main-container" class="changelog-container">
<h1 id="api-changelog">API Changelog</h1>
<h2 id="august-14-2023"><a href="#august-14-2023">August 14 2023</a></h2>
<ul>
<li>Updated <em>Delete an assignee for a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
<li>Updated query parameter descriptions</li>
</ul>
</li>
<li>Updated <em>List all assignees for a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
<li>Updated description</li>
</ul>
</li>
<li>Updated <em>Set assignees for a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">422</code> response</li>
<li>Updated query parameter descriptions</li>
</ul>
</li>
<li>Updated <em>Update assignees for a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">422</code> response</li>
<li>Updated query parameter descriptions</li>
</ul>
</li>
<li>Updated <em>Delete assignees for a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
</ul>
</li>
</ul>
<h2 id="august-9-2023"><a href="#august-9-2023">August 9 2023</a></h2>
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">address</code> object property descriptions</li>
<li>Updated <em>Retrieve address for a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
<li>Updated description</li>
</ul>
</li>
<li>Updated <em>Replace an address for a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">422</code> response</li>
<li>Updated description</li>
</ul>
</li>
</ul>
<h2 id="august-3-2023"><a href="#august-3-2023">August 3 2023</a></h2>
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">client</code> object property descriptions</li>
<li>Updated <em>List all clients</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Updated description</li>
</ul>
</li>
<li>Updated <em>Create a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">422</code> response</li>
<li>Updated description</li>
</ul>
</li>
<li>Updated <em>Retrieve a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
<li>Updated description</li>
</ul>
</li>
<li>Updated <em>Update a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">422</code> response</li>
<li>Updated description</li>
</ul>
</li>
</ul>
<h2 id="august-2-2023"><a href="#august-2-2023">August 2 2023</a></h2>
<ul>
<li>Deprecated <em>Archive a record</em> endpoint. Replaced by <em>Update a record</em> endpoint.</li>
</ul>
<h2 id="july-31-2023"><a href="#july-31-2023">July 31 2023</a></h2>
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">perform_link</code> to <code class="language-plaintext highlighter-rouge">record</code> object</li>
</ul>
<h2 id="july-26-2023"><a href="#july-31-2023">July 26 2023</a></h2>
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">is_reviewed</code> property to <em>Update a record</em> endpoint. Allows toggling a record’s reviewed state.</li>
</ul>
<h2 id="july-21-2023"><a href="#july-31-2023">July 21 2023</a></h2>
<ul>
<li>Added <em>Update a record</em> endpoint</li>
</ul>
<h2 id="july-14-2023"><a href="#july-14-2023">July 14 2023</a></h2>
<ul>
<li>Updated <em>List all records</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">page</code>, <code class="language-plaintext highlighter-rouge">limit</code>, <code class="language-plaintext highlighter-rouge">status</code>, <code class="language-plaintext highlighter-rouge">creator</code> and <code class="language-plaintext highlighter-rouge">assignee</code> query parameters</li>
</ul>
</li>
</ul>
<h2 id="july-6-2023"><a href="#july-6-2023">July 6 2023</a></h2>
<ul>
<li>Updated <em>Delete organisation for a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
</ul>
</li>
<li>Updated <em>Delete organisations for a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
</ul>
</li>
<li>Updated <em>List all organisations for a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
<li>Updated description</li>
</ul>
</li>
<li>Updated <em>Update organisations for a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
<li>Updated description</li>
</ul>
</li>
<li>Updated <em>Replace organisations for a client</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
</ul>
</li>
</ul>
<h2 id="july-4-2023"><a href="#july-4-2023">July 4 2023</a></h2>
<ul>
<li>Updated <em>Create an organisation</em> and <em>Update an organisation</em> properties
<ul>
<li>Updated <code class="language-plaintext highlighter-rouge">jurisdiction</code> description with details of requirement</li>
</ul>
</li>
<li>Added request code samples</li>
</ul>
<h2 id="june-28-2023"><a href="#june-28-2023">June 28 2023</a></h2>
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">template</code> property to <em>Create a record</em> endpoint. Allows creation of records using a record template.</li>
</ul>
<h2 id="june-26-2023"><a href="#june-26-2023">June 26 2023</a></h2>
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">expand</code> query parameter examples for <em>List all steps for a record</em> endpoint</li>
</ul>
<h2 id="june-20-2023"><a href="#june-20-2023">June 20 2023</a></h2>
<ul>
<li>Added <em>Create an attachment</em> endpoint</li>
</ul>
<h2 id="june-13-2023"><a href="#june-13-2023">June 13 2023</a></h2>
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">organisation</code> object property descriptions</li>
<li>Updated <em>Retrieve all organisations</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Updated description</li>
</ul>
</li>
<li>Updated <em>Create an organisation</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">422</code> response</li>
<li>Updated description</li>
</ul>
</li>
<li>Updated <em>Retrieve an organisation</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
</ul>
</li>
<li>Updated <em>Update an organisation</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">404</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">422</code> response</li>
<li>Updated description</li>
</ul>
</li>
</ul>
<h2 id="june-1-2023"><a href="#june-1-2023">June 1 2023</a></h2>
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">status</code> enum values to <em>Create a client</em> and <em>Update a client</em> endpoints</li>
<li>Added <code class="language-plaintext highlighter-rouge">user</code> object property descriptions</li>
<li>Updated <code class="language-plaintext highlighter-rouge">422 Unprocessable Content</code> response description with examples</li>
<li>Updated <em>Check service status</em> endpoint
<ul>
<li>Removed <code class="language-plaintext highlighter-rouge">403</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Updated description</li>
</ul>
</li>
<li>Updated <em>Retrieve user account</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Updated description</li>
</ul>
</li>
<li>Updated <em>Update user account</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Added <code class="language-plaintext highlighter-rouge">422</code> response</li>
<li>Updated description</li>
</ul>
</li>
<li>Updated <em>List all my teams</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Updated description</li>
</ul>
</li>
<li>Updated <em>Retrieve team membership</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
<li>Updated description</li>
</ul>
</li>
<li>Updated <em>Retrieve a team member</em> endpoint
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">401</code> response</li>
</ul>
</li>
</ul>
<h2 id="may-31-2023"><a href="#may-31-2023">May 31 2023</a></h2>
<ul>
<li>Changed <code class="language-plaintext highlighter-rouge">403</code> responses
<ul>
<li>Updated response from <code class="language-plaintext highlighter-rouge">403 Unauthorized</code> to <code class="language-plaintext highlighter-rouge">403 Forbidden</code></li>
<li>Removed <code class="language-plaintext highlighter-rouge">error</code> property</li>
<li>Added <code class="language-plaintext highlighter-rouge">message</code> property</li>
</ul>
</li>
</ul>
<h2 id="may-29-2023"><a href="#may-29-2023">May 29 2023</a></h2>
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">secret</code> property to <code class="language-plaintext highlighter-rouge">webhook</code> object</li>
<li>Added <code class="language-plaintext highlighter-rouge">201 Created</code> success responses to <em>Update assignees for a record</em> and <em>Update assignees for a client</em> endpoints</li>
</ul>
<h2 id="may-26-2023"><a href="#may-26-2023">May 26 2023</a></h2>
<p>⚠️ This release includes breaking changes.</p>
<ul>
<li>Changed Document Transfer record step preferences
<ul>
<li>Added required <code class="language-plaintext highlighter-rouge">attachment</code> property to “New Document” type</li>
</ul>
</li>
</ul>
<h2 id="may-22-2023"><a href="#may-22-2023">May 22 2023</a></h2>
<ul>
<li>Changed HSCNI Access NI record step preferences
<ul>
<li>Updated <code class="language-plaintext highlighter-rouge">barring_adults</code> and <code class="language-plaintext highlighter-rouge">barring_children</code> description with details of requirement</li>
<li>Changed <code class="language-plaintext highlighter-rouge">false</code> as default value for <code class="language-plaintext highlighter-rouge">barring_adults</code> and <code class="language-plaintext highlighter-rouge">barring_children</code> properties</li>
</ul>
</li>
<li>Changed Watchlist record step preferences
<ul>
<li>Changed <code class="language-plaintext highlighter-rouge">true</code> as default value for <code class="language-plaintext highlighter-rouge">silent</code> property</li>
<li>Updated <code class="language-plaintext highlighter-rouge">silent</code> description with details of availability</li>
</ul>
</li>
</ul>
<h2 id="may-18-2023"><a href="#may-18-2023">May 18 2023</a></h2>
<p>⚠️ This release includes breaking changes.</p>
<ul>
<li>Changed Dummy record step preferences
<ul>
<li><code class="language-plaintext highlighter-rouge">preferences</code> is no longer a required property</li>
<li>Changed <code class="language-plaintext highlighter-rouge">payment_amount</code> from <code class="language-plaintext highlighter-rouge">float</code> to <code class="language-plaintext highlighter-rouge">integer</code></li>
<li>Updated <code class="language-plaintext highlighter-rouge">payment_amount</code> description with details of value format</li>
<li>Changed minimum and maximum value of <code class="language-plaintext highlighter-rouge">payment_amount</code> to <code class="language-plaintext highlighter-rouge">0</code> – <code class="language-plaintext highlighter-rouge">10000</code></li>
<li>Changed minimum and maximum value of <code class="language-plaintext highlighter-rouge">credit_cost</code> to <code class="language-plaintext highlighter-rouge">0</code> – <code class="language-plaintext highlighter-rouge">100</code></li>
</ul>
</li>
</ul>
<h2 id="may-17-2023"><a href="#may-17-2023">May 17 2023</a></h2>
<p>⚠️ This release includes breaking changes.</p>
<ul>
<li>Changed Banking Information record step preferences
<ul>
<li>Renamed step type <code class="language-plaintext highlighter-rouge">check.open_banking</code> to <code class="language-plaintext highlighter-rouge">check.banking_information</code></li>
<li><code class="language-plaintext highlighter-rouge">preferences</code> is no longer a required property</li>
<li>Added <code class="language-plaintext highlighter-rouge">false</code> as default value for <code class="language-plaintext highlighter-rouge">balance</code> and <code class="language-plaintext highlighter-rouge">transactions</code> properties</li>
</ul>
</li>
<li>Changed Criminal Record step preferences
<ul>
<li><code class="language-plaintext highlighter-rouge">free_volunteer</code> property for DBS: Standard and DBS: Enhanced types is now <strong>read only</strong></li>
</ul>
</li>
<li>Changed Document Transfer step preferences
<ul>
<li>Renamed property <code class="language-plaintext highlighter-rouge">confirmed</code> to <code class="language-plaintext highlighter-rouge">require_confirmation</code></li>
<li>Renamed property <code class="language-plaintext highlighter-rouge">returned</code> to <code class="language-plaintext highlighter-rouge">require_return</code></li>
</ul>
</li>
<li>Changed Photo ID step preferences
<ul>
<li><code class="language-plaintext highlighter-rouge">face</code> and <code class="language-plaintext highlighter-rouge">liveness</code> properties for <code class="language-plaintext highlighter-rouge">standard</code> report type are now <strong>read only</strong></li>
<li>Added <code class="language-plaintext highlighter-rouge">issuing_countries</code> property for <code class="language-plaintext highlighter-rouge">standard</code> and <code class="language-plaintext highlighter-rouge">biometric</code> report types</li>
<li>Updated <code class="language-plaintext highlighter-rouge">facial_similarity</code> description for <code class="language-plaintext highlighter-rouge">standard</code> report type with details of cost changes</li>
</ul>
</li>
<li>Changed Photo ID step preferences
<ul>
<li>Added <code class="language-plaintext highlighter-rouge">1</code> and <code class="language-plaintext highlighter-rouge">3</code> options to <code class="language-plaintext highlighter-rouge">monitor</code> property</li>
<li>Added <code class="language-plaintext highlighter-rouge">false</code> as default value for <code class="language-plaintext highlighter-rouge">silent</code> and <code class="language-plaintext highlighter-rouge">monitor</code> properties</li>
<li>Updated <code class="language-plaintext highlighter-rouge">silent</code> and <code class="language-plaintext highlighter-rouge">monitor</code> descriptions with details of availability and cost changes</li>
</ul>
</li>
<li>Changed <code class="language-plaintext highlighter-rouge">record_document</code> object
<ul>
<li>Renamed config choice headings
<ul>
<li>“Sent” to “Document Transfer”</li>
<li>“Requested” to “Document Request”</li>
</ul>
</li>
<li>Renamed property <code class="language-plaintext highlighter-rouge">description</code> to <code class="language-plaintext highlighter-rouge">instructions</code></li>
<li>Renamed property <code class="language-plaintext highlighter-rouge">instructions</code> to <code class="language-plaintext highlighter-rouge">return_message</code></li>
<li>Added <code class="language-plaintext highlighter-rouge">return_message</code> description</li>
</ul>
</li>
<li>Removed <code class="language-plaintext highlighter-rouge">link</code> and <code class="language-plaintext highlighter-rouge">in_person</code> notification types from <em>Create a record</em> endpoint</li>
<li>Added <code class="language-plaintext highlighter-rouge">false</code> notification type to <em>Create a record</em> endpoint</li>
</ul>
<h2 id="may-12-2023"><a href="#may-12-2023">May 12 2023</a></h2>
<p>⚠️ This release includes breaking changes.</p>
<ul>
<li>Changed success response codes from <code class="language-plaintext highlighter-rouge">200 OK</code> to <code class="language-plaintext highlighter-rouge">201 Created</code> for endpoints:
<ul>
<li><em>Create a client</em></li>
<li><em>Set assignees for a client</em></li>
<li><em>Create an organisation</em></li>
<li><em>Create a record</em></li>
<li><em>Set assignees for a record</em></li>
<li><em>Create a webhook</em></li>
</ul>
</li>
</ul>
<h2 id="may-11-2023"><a href="#may-11-2023">May 11 2023</a></h2>
<ul>
<li>Changed maximum length of <code class="language-plaintext highlighter-rouge">message</code> property to <code class="language-plaintext highlighter-rouge">5000</code> for <em>Create a record</em> endpoint</li>
</ul>
<h2 id="may-10-2023"><a href="#may-10-2023">May 10 2023</a></h2>
<ul>
<li>Removed <code class="language-plaintext highlighter-rouge">enabled</code> query parameter from <em>List all forms for a client</em> endpoint</li>
</ul>
</div>
<footer>
©2023 Amiqus Resolution Ltd. | Company Registration Number: SC511150 | Data Protection Registration Number: ZA136760
</footer>
<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
<a href="#top" id="back-to-top">Back to top</a>
</body>
</html>