Document Webhooks

Document webhooks can be used to track client progress completing estate documents.

Client Started Document Event

This event is sent when a client starts a new document.

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier for the client.
Name
EventType
Type
string
Description
DocumentStarted
Name
Timestamp
Type
string
Description
ISO 8601 date time string
Name
IsRecommendedDocument
Type
boolean
Description
True if the document is recommended on client's selected plan, false otherwise.
Name
DocumentName
Type
string
Description
Name of the document started. One of Supported Documents
Name
DocumentProgressPercentage
Type
integer
Description
Overall document filling progress as a percentage [0-100].
Name
WasCompletedBefore
Type
boolean
Description
True if the document was already completed before by the client, false otherwise.
Name
UserTier
Type
string
Description
Code of the client's estate plan. One of Estate Plan Values
Name
DocumentOwnerInfo
Type
json
Description
Information about the document owner. Contains the following properties:
Name
FirstName
Type
string
Description
First name of the person that started the document (can be client or their partner).
Name
LastName
Type
string
Description
Last name of the person that started the document (can be client or their partner).
Name
LegalName
Type
string
Description
Legal full name of the person that started the document (can be client or their partner).
Name
ContactType
Type
string
Description
Individual
Name
IsPrimary
Type
boolean
Description
True if document owner is the client themselves, false otherwise.

Client Started Document Event Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "EventType": "DocumentStarted",
  "DocumentName":"Last Will and Testament",
  "Timestamp":"2023-04-13T06:43:12.947-07:00",
  "IsRecommendedDocument":true,
  "DocumentProgressPercentage":0,
  "WasCompletedBefore":false,
  "UserTier":"individual_will",
  "DocumentOwnerInfo": {
    "FirstName":"John",
    "LastName":"Smith",
    "LegalName":"John Smith",
    "ContactType":"Individual",
    "IsPrimary":true
}
}

Client Started Document Event Payload

curl 'https://[URL-OF-WEBHOOK_TARGET]' \
-X POST \
-H "Content-Type: application/json" \
-H "wealth-api-key: 123456" \
-d "Wid":"ec5c1cda-2e6b-45b9-b66f-f67560d708b2" \
-d "EventType":"DocumentStarted" \
-d "DocumentName":"Last Will and Testament" \
-d "Timestamp":"2023-04-13T06:43:12.947-07:00" \
-d "IsRecommendedDocument":true \
-d "DocumentProgressPercentage":0 \
-d "WasCompletedBefore":false \
-d "UserTier":"individual_will" \
-d '"DocumentOwnerInfo":{"FirstName":"John","LastName":"Smith","LegalName":"John Smith","ContactType":"Individual","IsPrimary":true}'

Client Document Pending Validation Event

This event is sent when client finished filling up document, and it's ready for validation.

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier for the client.
Name
EventType
Type
string
Description
DocumentPendingValidation
Name
Timestamp
Type
string
Description
ISO 8601 date time string
Name
IsRecommendedDocument
Type
boolean
Description
True if the document is recommended on client's selected plan, false otherwise.
Name
DocumentName
Type
string
Description
Name of the document started. One of Supported Documents
Name
DocumentProgressPercentage
Type
integer
Description
Overall document filling progress as a percentage [0-100].
Name
UserTier
Type
string
Description
Code of the client's estate plan. One of Estate Plan Values
Name
DocumentOwnerInfo
Type
json
Description
Information about the document owner. Contains the following properties:
Name
FirstName
Type
string
Description
First name of the person that started the document (can be client or their partner).
Name
LastName
Type
string
Description
Last name of the person that started the document (can be client or their partner).
Name
LegalName
Type
string
Description
Legal full name of the person that started the document (can be client or their partner).
Name
ContactType
Type
string
Description
Individual
Name
IsPrimary
Type
boolean
Description
True if document owner is the client themselves, false otherwise.

Client Document Pending Validation Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "EventType": "DocumentPendingValidation",
  "DocumentName":"Last Will and Testament",
  "Timestamp":"2023-04-13T06:43:12.947-07:00",
  "IsRecommendedDocument":true,
  "DocumentProgressPercentage":99,
  "UserTier":"individual_will",
  "DocumentOwnerInfo": {
    "FirstName":"John",
    "LastName":"Smith",
    "LegalName":"John Smith",
    "ContactType":"Individual",
    "IsPrimary":true
}
}

Client Document Pending Validation Payload

curl 'https://[URL-OF-WEBHOOK_TARGET]' \
-X POST \
-H "Content-Type: application/json" \
-H "wealth-api-key: 123456" \
-d "Wid":"ec5c1cda-2e6b-45b9-b66f-f67560d708b2" \
-d "EventType":"DocumentPendingValidation" \
-d "DocumentName":"Last Will and Testament" \
-d "Timestamp":"2023-04-13T06:43:12.947-07:00" \
-d "IsRecommendedDocument":true \
-d "DocumentProgressPercentage":99 \
-d "UserTier":"individual_will" \
-d '"DocumentOwnerInfo":{"FirstName":"John","LastName":"Smith","LegalName":"John Smith","ContactType":"Individual","IsPrimary":true}'

Client Completed Document Event

This event is sent when client completed and validated document.

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier for the client.
Name
EventType
Type
string
Description
DocumentCompleted
Name
Timestamp
Type
string
Description
ISO 8601 date time string
Name
IsRecommendedDocument
Type
boolean
Description
True if the document is recommended on client's selected plan, false otherwise.
Name
DocumentName
Type
string
Description
Name of the document started. One of Supported Documents
Name
DocumentProgressPercentage
Type
integer
Description
Overall document filling progress as a percentage [0-100].
Name
UserTier
Type
string
Description
Code of the client's estate plan. One of Estate Plan Values
Name
DocumentOwnerInfo
Type
json
Description
Information about the document owner. Contains the following properties:
Name
FirstName
Type
string
Description
First name of the person that started the document (can be client or their partner).
Name
LastName
Type
string
Description
Last name of the person that started the document (can be client or their partner).
Name
LegalName
Type
string
Description
Legal full name of the person that started the document (can be client or their partner).
Name
ContactType
Type
string
Description
Individual
Name
IsPrimary
Type
boolean
Description
True if document owner is the client themselves, false otherwise.

Client Document Completed Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "EventType": "DocumentCompleted",
  "DocumentName":"Last Will and Testament",
  "Timestamp":"2023-04-13T06:43:12.947-07:00",
  "IsRecommendedDocument":true,
  "DocumentProgressPercentage":100,
  "UserTier":"individual_will",
  "DocumentOwnerInfo": {
    "FirstName":"John",
    "LastName":"Smith",
    "LegalName":"John Smith",
    "ContactType":"Individual",
    "IsPrimary":true
}
}

Client Document Completed Payload

curl 'https://[URL-OF-WEBHOOK_TARGET]' \
-X POST \
-H "Content-Type: application/json" \
-H "wealth-api-key: 123456" \
-d "Wid":"ec5c1cda-2e6b-45b9-b66f-f67560d708b2" \
-d "EventType":"DocumentCompleted" \
-d "DocumentName":"Last Will and Testament" \
-d "Timestamp":"2023-04-13T06:43:12.947-07:00" \
-d "IsRecommendedDocument":true \
-d "DocumentProgressPercentage":100 \
-d "UserTier":"individual_will" \
-d '"DocumentOwnerInfo":{"FirstName":"John","LastName":"Smith","LegalName":"John Smith","ContactType":"Individual","IsPrimary":true}'

Supported documents

All supported document names:

Individual Revocable Trust
Advance Health Care Directive
Financial Power of Attorney
Last Will and Testament
Joint Revocable Trust
Nomination of Guardianship