Document Analysis Webhooks

These events are sent when analysis of an uploaded client document finishes or fails. The body is JSON. source_document and category are included on the completed events only.

Estate Analysis Completed

This event is sent when estate document analysis completes.

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier for the client.
Name
ExternalId
Type
string, optional
Description
The client's external id, or null when the client has none.
Name
EventType
Type
string
Description
EsterJobCompleted
Name
Timestamp
Type
string
Description
ISO 8601 date time string
Name
Payload
Type
json
Description
Name
CorrelationId
Type
string
Description
The analysis run id returned as correlation_id on upload. Empty when the document was not started through the upload API.
Name
JobId
Type
string
Description
Identifier of the analysis job.
Name
DocumentWid
Type
string
Description
Vault id of the uploaded document.
Name
source_document
Type
json
Description
The uploaded document.
Name
vault_id
Type
string
Description
Same value as DocumentWid.
Name
name
Type
string
Description
File name. Same value Get Document returns as name.
Name
extension
Type
string
Description
File extension. Same value Get Document returns as extension.
Name
uploaded_at
Type
string
Description
ISO 8601 date time string. Same value Get Document returns as creation_date.
Name
category
Type
string
Description
estate
Name
Documents
Type
array
Description
Generated documents. Flowchart outputs are omitted. Retrieve each file with Get Document.
Name
DocumentType
Type
string
Description
One of StandardExecSummary, AdvancedExecSummary, Insights.
Name
VaultId
Type
string
Description
Vault id of the generated document.
Name
Extension
Type
string
Description
File extension of the generated document.

Estate Analysis Completed Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "ExternalId": "crm-1001",
  "EventType": "EsterJobCompleted",
  "Timestamp": "2023-04-13T06:43:12.947-07:00",
  "Payload": {
    "CorrelationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "JobId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "DocumentWid": "53ac20e4-8287-4bd7-b7e7-8f09b056325f",
    "source_document": {
      "vault_id": "53ac20e4-8287-4bd7-b7e7-8f09b056325f",
      "name": "john-doe-slat",
      "extension": "pdf",
      "uploaded_at": "2024-02-01T07:23:12Z"
    },
    "category": "estate",
    "Documents": [
      {
        "DocumentType": "StandardExecSummary",
        "VaultId": "11111111-2222-4333-8444-555555555551",
        "Extension": "md"
      },
      {
        "DocumentType": "AdvancedExecSummary",
        "VaultId": "11111111-2222-4333-8444-555555555552",
        "Extension": "md"
      },
      {
        "DocumentType": "Insights",
        "VaultId": "11111111-2222-4333-8444-555555555553",
        "Extension": "md"
      }
    ]
  }
}

Estate Analysis Completed Test 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 "ExternalId":"crm-1001" \
  -d "EventType":"EsterJobCompleted" \
  -d "Timestamp":"2023-04-13T06:43:12.947-07:00" \
  -d '"Payload":{"CorrelationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","JobId":"b2c3d4e5-f6a7-8901-bcde-f12345678901","DocumentWid":"53ac20e4-8287-4bd7-b7e7-8f09b056325f","source_document":{"vault_id":"53ac20e4-8287-4bd7-b7e7-8f09b056325f","name":"john-doe-slat","extension":"pdf","uploaded_at":"2024-02-01T07:23:12Z"},"category":"estate","Documents":[{"DocumentType":"StandardExecSummary","VaultId":"11111111-2222-4333-8444-555555555551","Extension":"md"}]}'

Estate Analysis Failed

This event is sent when estate document analysis fails. It does not include source_document or category.

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier for the client.
Name
ExternalId
Type
string, optional
Description
The client's external id, or null when the client has none.
Name
EventType
Type
string
Description
EsterJobFailed
Name
Timestamp
Type
string
Description
ISO 8601 date time string
Name
Payload
Type
json
Description
Name
CorrelationId
Type
string
Description
The analysis run id returned as correlation_id on upload.
Name
JobId
Type
string
Description
Identifier of the analysis job. Empty when a job was not started.
Name
DocumentWid
Type
string
Description
Vault id of the uploaded document.
Name
Reason
Type
string
Description
One of UploadTimeout, ProcessingFailed, DocumentTypeNotSupported, FileTooLarge, InvalidDocument.

Estate Analysis Failed Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "ExternalId": "crm-1001",
  "EventType": "EsterJobFailed",
  "Timestamp": "2023-04-13T06:43:12.947-07:00",
  "Payload": {
    "CorrelationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "JobId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "DocumentWid": "53ac20e4-8287-4bd7-b7e7-8f09b056325f",
    "Reason": "ProcessingFailed"
  }
}

Estate Analysis Failed Test 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 "ExternalId":"crm-1001" \
  -d "EventType":"EsterJobFailed" \
  -d "Timestamp":"2023-04-13T06:43:12.947-07:00" \
  -d '"Payload":{"CorrelationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","JobId":"b2c3d4e5-f6a7-8901-bcde-f12345678901","DocumentWid":"53ac20e4-8287-4bd7-b7e7-8f09b056325f","Reason":"ProcessingFailed"}'

Estate Analysis Requires Review

This event is sent when an uploaded file contains more than one estate document and needs review before analysis can finish.

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier for the client.
Name
ExternalId
Type
string, optional
Description
The client's external id, or null when the client has none.
Name
EventType
Type
string
Description
EsterMultiDocumentRequiresReview
Name
Timestamp
Type
string
Description
ISO 8601 date time string
Name
Payload
Type
json
Description
Name
CorrelationId
Type
string
Description
The analysis run id returned as correlation_id on upload.
Name
JobId
Type
string
Description
Identifier of the analysis job. Empty when a job was not started.
Name
DocumentWid
Type
string
Description
Vault id of the uploaded document.
Name
VaultLink
Type
string
Description
Path to the document in Wealth.com.
Name
DetectedDocumentCount
Type
integer
Description
Number of documents detected in the uploaded file.

Estate Analysis Requires Review Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "ExternalId": "crm-1001",
  "EventType": "EsterMultiDocumentRequiresReview",
  "Timestamp": "2023-04-13T06:43:12.947-07:00",
  "Payload": {
    "CorrelationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "JobId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "DocumentWid": "53ac20e4-8287-4bd7-b7e7-8f09b056325f",
    "VaultLink": "/advisor/client/ec5c1cda-2e6b-45b9-b66f-f67560d708b2/vault?documentId=53ac20e4-8287-4bd7-b7e7-8f09b056325f",
    "DetectedDocumentCount": 2
  }
}

Estate Analysis Requires Review Test 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 "ExternalId":"crm-1001" \
  -d "EventType":"EsterMultiDocumentRequiresReview" \
  -d "Timestamp":"2023-04-13T06:43:12.947-07:00" \
  -d '"Payload":{"CorrelationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","JobId":"b2c3d4e5-f6a7-8901-bcde-f12345678901","DocumentWid":"53ac20e4-8287-4bd7-b7e7-8f09b056325f","VaultLink":"/advisor/client/ec5c1cda-2e6b-45b9-b66f-f67560d708b2/vault?documentId=53ac20e4-8287-4bd7-b7e7-8f09b056325f","DetectedDocumentCount":2}'

Tax Analysis Completed

This event is sent when tax document analysis completes. It does not include a Documents array. The generated tax artifact stays on the uploaded document and is returned by Get Document.

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier for the client.
Name
ExternalId
Type
string, optional
Description
The client's external id, or null when the client has none.
Name
EventType
Type
string
Description
TaxJobCompleted
Name
Timestamp
Type
string
Description
ISO 8601 date time string
Name
Payload
Type
json
Description
Name
CorrelationId
Type
string
Description
The analysis run id returned as correlation_id when the job was started with start_tax_job.
Name
JobId
Type
string
Description
Identifier of the analysis job.
Name
DocumentWid
Type
string
Description
Vault id of the uploaded document.
Name
source_document
Type
json
Description
The uploaded document.
Name
vault_id
Type
string
Description
Same value as DocumentWid.
Name
name
Type
string
Description
File name. Same value Get Document returns as name.
Name
extension
Type
string
Description
File extension. Same value Get Document returns as extension.
Name
uploaded_at
Type
string
Description
ISO 8601 date time string. Same value Get Document returns as creation_date.
Name
category
Type
string
Description
tax
Name
PresentationStatus
Type
string
Description
One of filed, insightsUnavailable.

Tax Analysis Completed Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "ExternalId": "crm-1001",
  "EventType": "TaxJobCompleted",
  "Timestamp": "2023-04-13T06:43:12.947-07:00",
  "Payload": {
    "CorrelationId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "JobId": "d4e5f6a7-b8c9-0123-def0-234567890123",
    "DocumentWid": "67bd31f5-9398-5ce8-cd39-2e4041e8db7b",
    "source_document": {
      "vault_id": "67bd31f5-9398-5ce8-cd39-2e4041e8db7b",
      "name": "jones-betty-1040",
      "extension": "pdf",
      "uploaded_at": "2024-02-01T07:23:12Z"
    },
    "category": "tax",
    "PresentationStatus": "filed"
  }
}

Tax Analysis Completed Test 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 "ExternalId":"crm-1001" \
  -d "EventType":"TaxJobCompleted" \
  -d "Timestamp":"2023-04-13T06:43:12.947-07:00" \
  -d '"Payload":{"CorrelationId":"c3d4e5f6-a7b8-9012-cdef-123456789012","JobId":"d4e5f6a7-b8c9-0123-def0-234567890123","DocumentWid":"67bd31f5-9398-5ce8-cd39-2e4041e8db7b","source_document":{"vault_id":"67bd31f5-9398-5ce8-cd39-2e4041e8db7b","name":"jones-betty-1040","extension":"pdf","uploaded_at":"2024-02-01T07:23:12Z"},"category":"tax","PresentationStatus":"filed"}'

Tax Analysis Failed

This event is sent when tax document analysis fails. It does not include source_document or category.

Name
Wid
Type
string (Max 64)
Description
Wealth’s unique identifier for the client.
Name
ExternalId
Type
string, optional
Description
The client's external id, or null when the client has none.
Name
EventType
Type
string
Description
TaxJobFailed
Name
Timestamp
Type
string
Description
ISO 8601 date time string
Name
Payload
Type
json
Description
Name
CorrelationId
Type
string
Description
The analysis run id returned as correlation_id on upload.
Name
JobId
Type
string
Description
Identifier of the analysis job. Empty when a job was not started.
Name
DocumentWid
Type
string
Description
Vault id of the uploaded document.
Name
Reason
Type
string
Description
One of UploadTimeout, VaultFailed, NoTaxReturnFound, IncompleteReturn, ProcessingFailed, ReportUnavailable, TimedOut.

Tax Analysis Failed Payload

{
  "Wid": "ec5c1cda-2e6b-45b9-b66f-f67560d708b2",
  "ExternalId": "crm-1001",
  "EventType": "TaxJobFailed",
  "Timestamp": "2023-04-13T06:43:12.947-07:00",
  "Payload": {
    "CorrelationId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "JobId": "d4e5f6a7-b8c9-0123-def0-234567890123",
    "DocumentWid": "67bd31f5-9398-5ce8-cd39-2e4041e8db7b",
    "Reason": "ProcessingFailed"
  }
}

Tax Analysis Failed Test 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 "ExternalId":"crm-1001" \
  -d "EventType":"TaxJobFailed" \
  -d "Timestamp":"2023-04-13T06:43:12.947-07:00" \
  -d '"Payload":{"CorrelationId":"c3d4e5f6-a7b8-9012-cdef-123456789012","JobId":"d4e5f6a7-b8c9-0123-def0-234567890123","DocumentWid":"67bd31f5-9398-5ce8-cd39-2e4041e8db7b","Reason":"ProcessingFailed"}'