Send Notification
The purpose of this endpoint is to initiate the dispatch of notifications.
Data Adapter APIβ
Loading...
Β
Notification Types
There are various notifications that can be dispatched via this endpoint with the notificationType enumeration being used to differentiate them.
Please be aware that all references to [AccountNickname] and internet banking only apply to the Banking Sector.
Arrangement Actionβ
Enumeration Value: ARRANGEMENT_ACTION.
This notification occurs whenever an arrangement is started, expired, amended or revoked.
Data Mappingβ
The following table provides a conversion mapping from Payload to Message.
| Related Attribute(s) | Template Variable |
|---|---|
| List of [Name] derived from looking up the name of the Principal name based on the principalId in the context of the supplied userId |
| [Sender] derived from looking up the name of the Principal name based on the principalId in the context of the supplied userId |
recipientDetails.dataRecipientBrandName | [ADR] |
from.accountDetails[] containing accountId |
|
arrangementAction.grantId | [GrantId] representing the identifier that can be used in a push notification directly load the approval page |
Messagesβ
Whilst the requestId is supplied in the payload, links within email notifications are not recommended. We provide requestId to allow for direct linking if notifications are instead implemented as in-app push notifications.
Arrangement Createdβ
Notification Recipient(s): Each User Id listed within the to[] attribute.
Condition: arrangementAction.status is STARTED.
Hi
[Name],
[Sender]has set-up a sharing arrangement with[ADR]and is sharing data from one or more of your accounts:
[For Each from.accountDetails]
[MaskedAccountNumber]-[AccountNickname]
[/For Each]What is CDR data sharing?
The Consumer Data Right is an Australian government initiative to enable the secure transfer of data held by us to accredited parties (Accredited Data Recipients).
To manage your data sharing settings please go to: https://dashboard.holder.com/.
To review our CDR Policy please visit: https://holder.com/cdr-policy.
Arrangement Amendedβ
Notification Recipient(s): Each User Id listed within the to[] attribute.
Condition: arrangementAction.status is AMENDED.
Hi
[Name],
[Sender]has amended an existing sharing arrangement with[ADR]and is sharing data from one or more of your accounts:
[For Each from.accountDetails]
[MaskedAccountNumber]-[AccountNickname]
[/For Each]What is CDR data sharing?
The Consumer Data Right is an Australian government initiative to enable the secure transfer of data held by us to accredited parties (Accredited Data Recipients).
To manage your data sharing settings please go to: https://dashboard.holder.com/.
Arrangement Expiredβ
Notification Recipient(s): Each User Id listed within the to[] attribute.
Condition: arrangementAction.status is EXPIRED.
Hi
[Name],An existing sharing arrangement for
[ADR]has expired for one or more of your accounts.
[For Each from.accountDetails]
[MaskedAccountNumber]-[AccountNickname]
[/For Each]What is CDR data sharing?
The Consumer Data Right is an Australian government initiative to enable the secure transfer of data held by us to accredited parties (Accredited Data Recipients).
To manage your data sharing settings please go to: https://dashboard.holder.com/
Arrangement Revokedβ
Notification Recipient(s): Each User Id listed within the to[] attribute
Condition: arrangementAction.status is REVOKED
Hi
[Name],An existing sharing arrangement for
[ADR]was revoked on request by[Sender]for one or more of your accounts:
[For Each from.accountDetails]
[MaskedAccountNumber]-[AccountNickname]
[/For Each]What is CDR data sharing?
The Consumer Data Right is an Australian government initiative to enable the secure transfer of data held by us to accredited parties (Accredited Data Recipients).
To manage your data sharing settings please go to: https://dashboard.holder.com/
Sample Payloadβ
This example demonstrates the dispatch of the Arrangement Start notification for an account sent to User Id's (2a9e9706-30c2-4155-98c9-18d94e523a7a and 3607fd26-81f6-4563-9e70-7e87e3d61b7d) in the context of principal (e8013e29-f1da-4055-8a13-f4ac747a9218) which has been initiated by User Id (3607fd26-81f6-4563-9e70-7e87e3d61b7d) on the account (44039b90-f5dc-4b14-9ea3-02015c25c142) for which they are considered an OWNER.
As the variation in message is primarily dependent on the arrangementAction.action field only one example payload has been provided.
{
"data": [
{
"to": [
{
"principalId": "e8013e29-f1da-4055-8a13-f4ac747a9218",
"userId": "2a9e9706-30c2-4155-98c9-18d94e523a7a"
},
{
"principalId": "e8013e29-f1da-4055-8a13-f4ac747a9218",
"userId": "3607fd26-81f6-4563-9e70-7e87e3d61b7d"
}
],
"from": {
"principalId": "e8013e29-f1da-4055-8a13-f4ac747a9218",
"userId": "3607fd26-81f6-4563-9e70-7e87e3d61b7d",
"accountDetails": [
{
"accountId": "44039b90-f5dc-4b14-9ea3-02015c25c142",
"relationship": "OWNER"
}
]
},
"recipientDetails": {
"legalEntityId": "9278f2f1-a08d-47b8-8743-79a478e63734",
"legalEntityName": "Test Legal Entity",
"softwareProductId": "9cc57c33-040a-480f-9df6-03a83d466656",
"softwareProductName": "Test Software Product",
"softwareProductDescription": "This is an example of a software product's description",
"softwareProductLogoUri": "https://biza.io/logo.png",
"softwareProductStatus": "ACTIVE",
"dataRecipientBrandName": "Test Recipient Brand",
"dataRecipientBrandStatus": "ACTIVE",
"dataRecipientAccreditationNumber": "TESTACCNO000123"
},
"notificationType": "ARRANGEMENT_ACTION",
"arrangementAction": {
"grantId": "22efd554-27b8-4e9e-a983-33f93b7e4899",
"action": "STARTED"
}
}
]
}
Sharing Requestedβ
Enumeration Value: SHARING_REQUESTED
This notification occurs when a request is made to change an account from Non-Disclosure to Pre-Approval.
Data Mappingβ
The following table provides a conversion mapping from Payload to Message.
| Related Attribute(s) | Template Variable |
|---|---|
| List of [Name] derived from looking up the name of the Principal name based on the principalId in the context of the supplied userId |
| [Sender] derived from looking up the name of the Principal name based on the principalId in the context of the supplied userId |
from.accountDetails[] containing accountId |
|
|
|
Messageβ
This message should be sent for each User Id listed in the to part of the payload
Whilst the requestId is supplied in the payload, links within email notifications are not recommended. We provide requestId to allow for direct linking if notifications are instead implemented as in-app push notifications.
Hi
[Name],
[Sender]has requested that Data Sharing be enabled on the following joint account(s):
[For Each from.accountDetails]
[MaskedAccountNumber]-[AccountNickname]
[/For Each]In order for this request to proceed, all account holders, including you, must approve the request by
[RequestExpiration].To manage this request please goto Data Sharing > Account Permissions.
What is CDR data sharing?
The Consumer Data Right is an Australian government initiative to enable the secure transfer of data held by us to accredited parties (Accredited Data Recipients).
To manage your data sharing settings please go to: https://dashboard.holder.com/
To review our CDR Policy please visit: https://holder.com/cdr-policy
Sample Payloadβ
This example demonstrates a notification to a set of User Id's (3607fd26-81f6-4563-9e70-7e87e3d61b7d and 69aabcdd-b7be-4a32-a325-c8d513646593) initiated by another user (2a9e9706-30c2-4155-98c9-18d94e523a7a) regarding an account belonging to principal (6d33f5df-d550-4b35-9618-556155e78c28) with account id (44039b90-f5dc-4b14-9ea3-02015c25c142).
{
"data": [
{
"to": [
{
"principalId": "",
"userId": "3607fd26-81f6-4563-9e70-7e87e3d61b7d",
},
{
"principalId": "",
"userId": "69aabcdd-b7be-4a32-a325-c8d513646593",
}
],
"from": {
"principalId": "6d33f5df-d550-4b35-9618-556155e78c28",
"userId": "2a9e9706-30c2-4155-98c9-18d94e523a7a"
"accountDetails": [
{
"accountId": "44039b90-f5dc-4b14-9ea3-02015c25c142",
"relationship": "OWNER"
}
]
},
"notificationType": "SHARING_REQUESTED",
"sharingRequested": {
"requestId": "3ea26443-2176-4585-a27d-4471b06fc913",
"expiry": "2022-08-24T14:15:22Z"
}
}
]
}
Sharing Request Action Singleβ
Enumeration Value: SHARING_REQUEST_ACTION_ONE
This notification occurs when a response has been received for a sharing request from a single party involved in the overall request.
Data Mappingβ
The following table provides a conversion mapping from Payload to Message.
| Related Attribute(s) | Template Variable |
|---|---|
| List of [Name] derived from looking up the name of the Principal name based on the principalId in the context of the supplied userId |
| [Sender] derived from looking up the name of the Principal name based on the principalId in the context of the supplied userId |
from.accountDetails[] containing accountId |
|
|
|
Messagesβ
Whilst the enumeration for sharingRequestAction.action contains values other than APPROVED as the other actions are terminal in nature (i.e., the request is completed) they instead trigger a SHARING_REQUEST_COMPLETE notification type. Please refer to the Sharing Request Completed notification for other combinations.
Sharing Approvedβ
Notification Recipient: User Id listed within the to[] attribute (the requestor of the change)
Condition: sharingRequestAction.action is APPROVED
Hi
[Name],
[Sender]has approved your request to enable data sharing from the following account(s):
[For Each from.accountDetails]
[MaskedAccountNumber]-[AccountNickname]
[/For Each]Data Sharing will only be enabled if all account holders approve the request by
[RequestExpiration].What is CDR data sharing?
The Consumer Data Right is an Australian government initiative to enable the secure transfer of data held by us to accredited parties (Accredited Data Recipients).
To manage your data sharing settings please go to: https://dashboard.holder.com/
To review our CDR Policy please visit: https://holder.com/cdr-policy
Sample Payloadβ
This example demonstrates a notification to the requesting User Id (3607fd26-81f6-4563-9e70-7e87e3d61b7d) indicating that another User Id (2a9e9706-30c2-4155-98c9-18d94e523a7a) has approved the sharing request regarding an account (44039b90-f5dc-4b14-9ea3-02015c25c142) belonging to principal (6d33f5df-d550-4b35-9618-556155e78c28).
{
"data": [
{
"to": [
{
"principalId": "",
"userId": "3607fd26-81f6-4563-9e70-7e87e3d61b7d",
}
],
"from": {
"principalId": "6d33f5df-d550-4b35-9618-556155e78c28",
"userId": "2a9e9706-30c2-4155-98c9-18d94e523a7a"
"accountDetails": [
{
"accountId": "44039b90-f5dc-4b14-9ea3-02015c25c142",
"relationship": "OWNER"
}
]
},
"notificationType": "SHARING_REQUEST_ACTION_ONE",
"sharingRequestAction": {
"requestId": "3ea26443-2176-4585-a27d-4471b06fc913",
"action": "APPROVED",
"expiry": "2022-08-24T14:15:22Z"
}
}
]
}
Sharing Request Completedβ
Enumeration Value: SHARING_REQUEST_COMPLETE
This notification occurs when a sharing request reaches a completion status. The following provides a list of statuses and action as follows:
APPROVED: All joint account owners have approved the requestDENIED: One joint account owner has denied the requestEXPIRED: One joint account owner has not approved before the requestexpiry
Data Mappingβ
The following table provides a conversion mapping from Payload to Message.
| Related Attribute(s) | Template Variable |
|---|---|
| List of [Name] derived from looking up the name of the Principal name based on the principalId in the context of the supplied userId |
| [Sender] derived from looking up the name of the Principal name based on the principalId in the context of the supplied userId |
from.accountDetails[] containing accountId |
|
|
|
Messagesβ
Sharing Approvedβ
Whilst this response may look similar to the APPROVED action in Sharing Request Action Single it represents all parties approval rather than one.
Notification Recipient: Each User Id listed within the to[] attribute.
Condition: sharingRequestAction.action is APPROVED.
Hi
[Name],All account holders have approved a request to enable data sharing from the following account(s):
[For Each from.accountDetails]
[MaskedAccountNumber]-[AccountNickname]
[/For Each]All account holders will now be able to share data from these account(s) at any time.
What is CDR data sharing?
The Consumer Data Right is an Australian government initiative to enable the secure transfer of data held by us to accredited parties (Accredited Data Recipients).
To manage your data sharing settings please go to: https://dashboard.holder.com/.
To review our CDR Policy please visit: https://holder.com/cdr-policy.
Sharing Deniedβ
Notification Recipient: Each User Id listed within the to[] attribute.
Condition: sharingRequestAction.action is DENIED.
Hi
[Name],
[Sender]has denied a request to enable data sharing for the following account(s):
[For Each from.accountDetails]
[MaskedAccountNumber]-[AccountNickname]
[/For Each]This means that all data sharing will remain disabled for these account(s) and no further action will be taken.
What is CDR data sharing?
The Consumer Data Right is an Australian government initiative to enable the secure transfer of data held by us to accredited parties (Accredited Data Recipients).
To manage your data sharing settings please go to: https://dashboard.holder.com/
To review our CDR Policy please visit: https://holder.com/cdr-policy
Sharing Request Expiredβ
Notification Recipient: Each User Id listed within the to[] attribute.
Condition: sharingRequestAction.action is EXPIRED.
Hi
[Name],A request to enable data sharing for the following account(s) has expired:
[For Each from.accountDetails]
[MaskedAccountNumber]-[AccountNickname]
[/For Each]This means that all data sharing will remain disabled for these account(s) and no further action will be taken.
What is CDR data sharing?
The Consumer Data Right is an Australian government initiative to enable the secure transfer of data held by us to accredited parties (Accredited Data Recipients).
To manage your data sharing settings please go to: https://dashboard.holder.com/
To review our CDR Policy please visit: https://holder.com/cdr-policy
Sample Payloadβ
This example demonstrates a notification to all account holders with User Id's (3607fd26-81f6-4563-9e70-7e87e3d61b7d, 2a9e9706-30c2-4155-98c9-18d94e523a7a) indicating that a sharing request created by User Id (2a9e9706-30c2-4155-98c9-18d94e523a7a) regarding account (44039b90-f5dc-4b14-9ea3-02015c25c142) belonging to principal (6d33f5df-d550-4b35-9618-556155e78c28) has been approved.
As the primary change in the payload is the sharingRequestAction.action field, changing only a single sample is provided.
{
"data": [
{
"to": [
{
"principalId": "",
"userId": "3607fd26-81f6-4563-9e70-7e87e3d61b7d",
},
{
"principalId": "",
"userId": "2a9e9706-30c2-4155-98c9-18d94e523a7a",
}
],
"from": {
"principalId": "6d33f5df-d550-4b35-9618-556155e78c28",
"userId": "2a9e9706-30c2-4155-98c9-18d94e523a7a"
"accountDetails": [
{
"accountId": "44039b90-f5dc-4b14-9ea3-02015c25c142",
"relationship": "OWNER"
}
]
},
"notificationType": "SHARING_REQUEST_COMPLETE",
"sharingRequestAction": {
"requestId": "3ea26443-2176-4585-a27d-4471b06fc913",
"action": "APPROVED",
"expiry": "2022-08-24T14:15:22Z"
}
}
]
}
Sharing Disabledβ
Enumeration Value: SHARING_DISABLED.
This notification occurs when one or more accounts are changed from Pre-Approval to Non-Disclosure. No approval is required to switch to this status.
Data Mappingβ
The following table provides a conversion mapping from Payload to Message.
| Related Attribute(s) | Template Variable |
|---|---|
| List of [Name] derived from looking up the name of the Principal name based on the principalId in the context of the supplied userId |
| [Sender] derived from looking up the name of the Principal name based on the principalId in the context of the supplied userId |
from.accountDetails[] containing accountId |
|
Messageβ
This message should be sent for each User Id listed in the to part of the payload.
Hi
[Name],
[Sender]has disabled all current and future data sharing from one or more of the account(s) you share:
[For Each from.accountDetails]
[MaskedAccountNumber]-[AccountNickname]
[/For Each]If you have setup data sharing arrangements with Accredited Data Recipients you may receive notifications of their cancellation.
What is CDR data sharing?
The Consumer Data Right is an Australian government initiative to enable the secure transfer of data held by us to accredited parties (Accredited Data Recipients).
To manage your data sharing settings please go to: https://dashboard.holder.com/.
To review our CDR Policy please visit: https://holder.com/cdr-policy.
Sample Payloadβ
This example demonstrates the disabling of data sharing by (2a9e9706-30c2-4155-98c9-18d94e523a7a) and the notification being sent to the account holder User Id's (2a9e9706-30c2-4155-98c9-18d94e523a7a and 3607fd26-81f6-4563-9e70-7e87e3d61b7d) regarding account (44039b90-f5dc-4b14-9ea3-02015c25c142) belonging to principal (6d33f5df-d550-4b35-9618-556155e78c28).
{
"data": [
{
"to": [
{
"principalId": "",
"userId": "3607fd26-81f6-4563-9e70-7e87e3d61b7d",
},
{
"principalId": "",
"userId": "2a9e9706-30c2-4155-98c9-18d94e523a7a",
}
],
"from": {
"principalId": "6d33f5df-d550-4b35-9618-556155e78c28",
"userId": "2a9e9706-30c2-4155-98c9-18d94e523a7a"
"accountDetails": [
{
"accountId": "44039b90-f5dc-4b14-9ea3-02015c25c142",
"relationship": "OWNER"
}
]
},
"notificationType": "SHARING_DISABLED"
}
]
}
Secondary User Instructionβ
Enumeration Value: SECONDARY_USER_INSTRUCTION_ACTION.
This notification occurs when a secondary user instruction is added or removed. To learn more about secondary user instructions please refer to the Multi Party Accounts implementation guide.
Data Mappingβ
The following table provides a conversion mapping from Payload to Message.
| Related Attribute(s) | Template Variable |
|---|---|
| List of [Name] derived from looking up the name of the Principal name based on the principalId in the context of the supplied userId |
| [Sender] derived from looking up the name of the Principal name based on the principalId in the context of the supplied userId |
secondaryUserInstructionAction.action | Whether the Secondary User Instruction was added or removed. |
| [Secondary Name] derived from looking up the name of the Principal based on the principalId in the context of the supplied userId |
Messagesβ
Instruction Addedβ
Notification Recipient(s): Each User Id listed within the to[] attribute
Condition: secondaryUserInstructionAction.action is ADDED
Hi
[Name],
[Sender]has provided an instruction to enable data sharing for a secondary user,[Secondary Name], for one or more of your account(s):
[For Each from.accountDetails]
[MaskedAccountNumber]-[AccountNickname]
[/For Each]
[Secondary Name]will be established data sharing arrangements from your account(s).What is CDR data sharing?
The Consumer Data Right is an Australian government initiative to enable the secure transfer of data held by us to accredited parties (Accredited Data Recipients).
To manage your data sharing settings please go to: https://dashboard.holder.com/
To review our CDR Policy please visit: https://holder.com/cdr-policy
Instruction Removedβ
Notification Recipient(s): Each User Id listed within the to[] attribute
Condition: secondaryUserInstructionAction.action is REMOVED
Hi
[Name],
[Sender]has removed an instruction to enable data sharing for a secondary user,[Secondary Name], for one or more of your account(s):
[For Each from.accountDetails]
[MaskedAccountNumber]-[AccountNickname]
[/For Each]
[Secondary Name]will no longer be able to share data from your account(s).What is CDR data sharing?
The Consumer Data Right is an Australian government initiative to enable the secure transfer of data held by us to accredited parties (Accredited Data Recipients).
To manage your data sharing settings please go to: https://dashboard.holder.com/.
To review our CDR Policy please visit: https://holder.com/cdr-policy.
Sample Payloadβ
This example demonstrates a notification to an account holder's with User Id's (3607fd26-81f6-4563-9e70-7e87e3d61b7d and 2a9e9706-30c2-4155-98c9-18d94e523a7a) triggered by User Id (2a9e9706-30c2-4155-98c9-18d94e523a7a) indicating that a Secondary User with User Id (15e1e36e-7f5f-453e-ab8a-2971ffcaa9d0) has been ADDED to account (44039b90-f5dc-4b14-9ea3-02015c25c142) belonging to principal (6d33f5df-d550-4b35-9618-556155e78c28).
{
"data": [
{
"to": [
{
"principalId": "",
"userId": "3607fd26-81f6-4563-9e70-7e87e3d61b7d",
},
{
"principalId": "",
"userId": "2a9e9706-30c2-4155-98c9-18d94e523a7a",
}
],
"from": {
"principalId": "6d33f5df-d550-4b35-9618-556155e78c28",
"userId": "2a9e9706-30c2-4155-98c9-18d94e523a7a"
"accountDetails": [
{
"accountId": "44039b90-f5dc-4b14-9ea3-02015c25c142",
"relationship": "OWNER"
}
]
},
"notificationType": "SECONDARY_USER_INSTRUCTION_ACTION",
"secondaryUserInstructionAction": {
"action": "ADDED",
"secondaryUser": {
"principalId": "ebfea12d-7087-455d-8d60-8e673aa5f29a",
"userId": "15e1e36e-7f5f-453e-ab8a-2971ffcaa9d0"
}
}
}
]
}
Periodic Summaryβ
Enumeration Value: PERIODIC_SUMMARY.
This notification occurs when a batch job triggers the sending of a periodic summary for the past week or month.
Data Mappingβ
The following table provides a conversion mapping from Payload to Message.
| Related Attribute(s) | Template Variable |
|---|---|
| List of [Name] derived from looking up the name of the Principal name based on the principalId in the context of the supplied userId |
period | [Period] representing the reporting period |
|
|
| [SecondaryUserName] derived from looking up the name of the Principal name based on the principalId in the context of the supplied userId |
Messageβ
Hi
[Name],Hereβs a summary of the CDR data sharing events that happened the past
[Period].
Data Sharing
[For Each sharingEvents]
[If sharingEvents.type is STARTED]On
[sharingEvents.timestamp][ActorName]started sharing with[ADR] to:
[For Each accountDetails]
-[MaskedAccountNumber]-[AccountNickname]
[/For Each accountDetails]
[Else If sharingEvents.type is AMENDED]On
[sharingEvents.timestamp][ActorName]updated sharing with[ADR] to:
[For Each accountDetails]
-[MaskedAccountNumber]-[AccountNickname]
[/For Each accountDetails]
[Else If sharingEvents.type is REVOKED]On
[sharingEvents.timestamp][ActorName]revoked sharing with[ADR] to:
[For Each accountDetails]
-[MaskedAccountNumber]-[AccountNickname]
[/For Each accountDetails]
[Else If sharingEvents.type is EXPIRED]On
[sharingEvents.timestamp]sharing expired to[ADR] to:[For Each accountDetails]-[MaskedAccountNumber]-[AccountNickname]
[/For Each accountDetails]
[/For Each sharingEvents]
[If secondaryUserInstructions]Secondary User Instructions
[For Each secondaryUserInstructions]
[If secondaryUserInstruction.type is ADDED]On
[sharingEvents.timestamp][ActorName]provided a secondary user instruction for[SecondaryUserName]:
[For Each accountDetails]
-[MaskedAccountNumber]-[AccountNickname]
[/For Each accountDetails]
[Else If secondaryUserInstruction.type is REMOVED]On
[sharingEvents.timestamp][ActorName]removed a secondary user instruction for[SecondaryUserName]:
[For Each accountDetails]
-[MaskedAccountNumber]-[AccountNickname]
[/For Each accountDetails]
[/If secondaryUserInstruction.type]
[/For Each secondaryUserInstructions]
[/If secondaryUserInstructions]What is CDR data sharing?
The Consumer Data Right is an Australian government initiative to enable the secure transfer of data held by us to accredited parties (Accredited Data Recipients).
To manage your data sharing settings please go to: https://dashboard.holder.com/.
To review our CDR Policy please visit: https://holder.com/cdr-policy.
Sample Payloadβ
{
"data": [
{
"to": [
{
"principalId": "",
"userId": "harry-smith"
}
],
"from": null,
"recipientDetails": null,
"notificationType": "PERIODIC_SUMMARY",
"arrangementAction": null,
"sharingRequested": null,
"sharingRequestAction": null,
"secondaryUserInstructionAction": null,
"otp": null,
"periodicSummary": {
"period": "WEEKLY",
"sharingEvents": [
{
"type": "STARTED",
"from": {
"principalId": "08c31a2a9016d6c517a95562228a37c0",
"userId": "harry-smith",
"accountDetails": [
{
"accountId": "bfcee02d296b1f4aee138a5b78577548",
"relationship": "OWNER"
}
]
},
"recipientDetails": {
"legalEntityId": "3e1eb552-4dd7-43fd-84dc-fe5a239e8675",
"legalEntityName": "Sandbox DR G / Accredited Data Recipient",
"softwareProductId": "e38f0ae7-63cd-46a0-ab32-c6a9b05cb09c",
"softwareProductName": "Sandbox DR G Product",
"softwareProductDescription": "This is the DR G / ADR Sandbox Software Product",
"softwareProductLogoUri": "https://biza.io/wp-content/uploads/2021/07/sticky-logo.svg",
"softwareProductStatus": "ACTIVE",
"dataRecipientBrandName": "Sandbox DR G / Accredited Data Recipient Brand",
"dataRecipientBrandStatus": "ACTIVE",
"dataRecipientAccreditationNumber": "0031826"
},
"timestamp": "2023-03-16T23:22:00.158292Z"
},
{
"type": "STARTED",
"from": {
"principalId": "08c31a2a9016d6c517a95562228a37c0",
"userId": "harry-smith",
"accountDetails": [
{
"accountId": "bfcee02d296b1f4aee138a5b78577548",
"relationship": "OWNER"
}
]
},
"recipientDetails": {
"legalEntityId": "3e1eb552-4dd7-43fd-84dc-fe5a239e8675",
"legalEntityName": "Sandbox DR G / Accredited Data Recipient",
"softwareProductId": "e38f0ae7-63cd-46a0-ab32-c6a9b05cb09c",
"softwareProductName": "Sandbox DR G Product",
"softwareProductDescription": "This is the DR G / ADR Sandbox Software Product",
"softwareProductLogoUri": "https://biza.io/wp-content/uploads/2021/07/sticky-logo.svg",
"softwareProductStatus": "ACTIVE",
"dataRecipientBrandName": "Sandbox DR G / Accredited Data Recipient Brand",
"dataRecipientBrandStatus": "ACTIVE",
"dataRecipientAccreditationNumber": "0031826"
},
"timestamp": "2023-03-16T23:26:30.122885Z"
},
{
"type": "STARTED",
"from": {
"principalId": "08c31a2a9016d6c517a95562228a37c0",
"userId": "harry-smith",
"accountDetails": [
{
"accountId": "e0531548ad92ede12972d8c220570bf6",
"relationship": "OWNER"
},
{
"accountId": "abcdefYuUwN0q3GMp0sIsxegeBAc1Jn8",
"relationship": "OWNER"
},
{
"accountId": "bfcee02d296b1f4aee138a5b78577548",
"relationship": "OWNER"
}
]
},
"recipientDetails": {
"legalEntityId": "3e1eb552-4dd7-43fd-84dc-fe5a239e8675",
"legalEntityName": "Sandbox DR G / Accredited Data Recipient",
"softwareProductId": "e38f0ae7-63cd-46a0-ab32-c6a9b05cb09c",
"softwareProductName": "Sandbox DR G Product",
"softwareProductDescription": "This is the DR G / ADR Sandbox Software Product",
"softwareProductLogoUri": "https://biza.io/wp-content/uploads/2021/07/sticky-logo.svg",
"softwareProductStatus": "ACTIVE",
"dataRecipientBrandName": "Sandbox DR G / Accredited Data Recipient Brand",
"dataRecipientBrandStatus": "ACTIVE",
"dataRecipientAccreditationNumber": "0031826"
},
"timestamp": "2023-03-17T00:57:33.781756Z"
}
],
"secondaryUserInstructions": [
{
"type": "ADDED",
"from": {
"principalId": "08c31a2a9016d6c517a95562228a37c0",
"userId": "harry-smith",
"accountDetails": [
{
"accountId": "VB9PUROti9dFXsEntqNbiWLqx9CLYK3V",
"relationship": "OWNER"
}
]
},
"secondaryUser": {
"principalId": "08c31a2a9016d6c517a95562228a37c0",
"userId": "mark-hughes"
},
"timestamp": "2023-03-17T00:56:36.494956Z"
},
{
"type": "REMOVED",
"from": {
"principalId": "08c31a2a9016d6c517a95562228a37c0",
"userId": "harry-smith",
"accountDetails": [
{
"accountId": "VB9PUROti9dFXsEntqNbiWLqx9CLYK3V",
"relationship": "OWNER"
}
]
},
"secondaryUser": {
"principalId": "08c31a2a9016d6c517a95562228a37c0",
"userId": "mark-hughes"
},
"timestamp": "2023-03-17T00:56:46.849505Z"
}
]
}
}
]
}
One Time Passwordβ
Enumeration Value: OTP.
This notification occurs when there is a requirement for a One Time Password to be dispatched by the Holder.
Data Mappingβ
The following table provides a conversion mapping from Payload to Message.
| Related Attribute(s) | Template Variable |
|---|---|
| A single value containing the principalId and userId matched to the OTP. Useful for cross referencing the OTP request. |
| [OTP] refers to the otpValue while the distribution method is based on the otpType and the appropriate attributes. |
Messageβ
Notification Recipient: Should be sent via either SMS or Email depending on the otpType.
Sample Payloadβ
This example demonstrates a notification to an account holder User Id (3607fd26-81f6-4563-9e70-7e87e3d61b7d) triggered by SYSTEM to dispatch an OTP (123456) via SMS to a specified mobile number (+61439123123).
{
"data": [
{
"to": [
{
"principalId": "e8013e29-f1da-4055-8a13-f4ac747a9218",
"userId": "3607fd26-81f6-4563-9e70-7e87e3d61b7d",
}
],
"from": {
"principalId": "SYSTEM",
"userId": "SYSTEM"
"accountDetails": []
},
"notificationType": "OTP",
"otp": {
"otpValue": "123456",
"otpType": "MOBILE",
"emailAddresses": [],
"phoneNumbers": [
{
"fullNumber": "+61439123123",
"number": "0439123123",
"isPreferred": true,
"purpose": "MOBILE"
}
]
}
}
]
}