Add deceased API spec (#1426)

DFE-Digital · Jul 19, 2024 · 74668d3 · 74668d3
1 parent 9d7d0d0
commit 74668d3
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/docs/api-designs/deceased.md b/docs/api-designs/deceased.md
@@ -0,0 +1,18 @@
+# Deceased API
+
+## `PUT` `/persons/deceased/<trn>`
+
+Where `<trn>` is the person's TRN.
+
+Request body structure:
+```json
+{
+  "dateOfDeath": ""
+}
+```
+
+The `dateOfDeath` property is mandatory and should be formatted `yyyy-MM-dd`.
+
+If no record exists with the specified TRN, a `404 Not Found` status code will be returned.
+
+If the request is valid, a `204 No Content` status code will be returned.