logoOPG Event Store

letter-requested
v0.0.1

A letter is requested to be sent

Context

Make and Register will send reminders to the various actors involved in the creation of an LPA. If the actor is acting on paper this will be a letter, which will be sent from Sirius.

Trigger

Make and Register needs a letter to be sent to an actor due to certain conditions being met which vary depending on what letter and to which recipient.

Details

Send the specified letter to the correspondent given.

Consumer / Producer Diagram

Open in Visualiser →

Examples

1{
2  "uid": "M-1234-5678-9012",
3  "letterType": "INFORM_DONOR_CERTIFICATE_PROVIDER_HAS_NOT_ACTED",
4  "actorType": "donor",
5  "actorUID": "8402681d-ec7d-40da-9a5a-76e0b09cb710"
6}
7
letter-requested Schema (json)
{
  "$id": "https://opg.service.justice.gov.uk/opg.poas.sirius/letter-requested.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "opg.poas.sirius/letter-requested",
  "type": "object",
  "properties": {
    "uid": {
      "type": "string",
      "description": "The UID of the LPA",
      "pattern": "^M(-[A-Z0-9]{4}){3}$"
    },
    "letterType": {
      "description": "The type of letter to send",
      "enum": [
        "ADVISE_CERTIFICATE_PROVIDER_TO_SIGN_OR_OPT_OUT",
        "INFORM_DONOR_CERTIFICATE_PROVIDER_HAS_NOT_ACTED"
      ]
    },
    "actorType": {
      "type": "string",
      "description": "The type of actor to send the letter to",
      "enum": ["donor", "correspondent", "certificateProvider", "attorney", "replacementAttorney", "trustCorporation", "replacementTrustCorporation"]
    },
    "actorUID": {
      "type": "string",
      "description": "The UID of the actor to send the letter to",
      "pattern": "^([a-z0-9]{8}-)([a-z0-9]{4}-){3}([a-z0-9]{12})$"
    }
  },
  "required": ["uid", "letterType", "actorType", "actorUID"]
}
Edit this pageLast updated on 2024/12/18