Webhook Payload

By default, Veriscan Cloud sends an HTTP POST request with the data in the body serialized using JSON.

 {
  "Created": "2025-10-27T20:46:06.889626Z",
  "Sent": "2025-10-27T20:46:06.9069138Z",
  "EventId": 593464439,
  "WebHookId": 1176376359,
  "Type": "CreateCard",
  "WebHookTypeId": 2,
  "Data": {
    "HistoryLogId": 683291825,
    "Scanned": "2025-10-27T20:46:06.71",
    "IdNum": "0123456789",
    "FirstName": "FIRST",
    "MiddleName": "MIDDLE
    "LastName": "LAST",
    "BirthDate": "1999-01-01T00:00:00",
    "ExpDate": "2027-01-01T00:00:00",
    "State": "LA",
    "PostalCode": "70065-5348",
    "City": "KENNER",
    "Address": "123 TEST STREET",
    "Gender": "Male",
    "Comments": null,
    "ProfileComments": null,
    "Phone": null,
    "Email": null,
    "GroupId": null,
    "GroupComment": null,
    "DeviceId": 12345,
    "LocationId": 54321,
    "HashId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "PhotoBase64": null,
    "Latitude": 30.11849,
    "Longitude": -90.25028,
    "IsGeoUpdated": true,
    "Tags": null,
    "Country": "United States of America",
    "ScanLatitude": null,
    "ScanLongitude": null,
    "CountryCode": "USA",
    "DocumentType": "DL",
    "LocationName": "Location 1",
    "GroupName": null,
    "DeviceName": "myDevice",
    "DeviceLogin": "myLogin",
    "CompletedSurvey": null,
    "JurisdictionCode": "LA",
    "AttachmentLinks": [],
    "SignatureLink": "",
    "ImageLink": "{link}",
    "DocumentIsValid": true,
    "AuthenticationStatus": "Passed",
    "ScanStatus": "Flagged",
    "CustomFields": null,
    "ScannerInfo": null,
    "UserAgent": "IDS.VeriScan Cloud/3.10.3-Handheld (samsung; SM-G960U; Android 10)"
  }
}

• Created: The date and time the webhook event was created.
• Sent: The date and time the webhook event was sent.
• EventId: The unique identifier for the webhook event.
• WebHookId: The unique identifier for the webhook configuration.
• Type: The type of webhook event (e.g., CreateCard).
• IdNum: The identification number extracted from the document.
• FirstName: The first name extracted from the document.
• MiddleName: The middle name extracted from the document.
• LastName: The last name extracted from the document.
• BirthDate: The birth date extracted from the document.
• ExpDate: The expiration date extracted from the document.
• State: The state or province extracted from the document.
• PostalCode: The postal code extracted from the document.
• City: The city extracted from the document.
• Address: The address extracted from the document.
• Gender: The gender extracted from the document.
• Comments: Any comments associated with the scan left by the user of the VeriScan application. These comments are for this scan only.
• ProfileComments: Any comments associated with the profile used during the scan. These comments are persistent across scans.
• Phone: The phone number attached to the scan, if any.
• Email: The email address attached to the scan, if any.
• GroupId: The group ID attached to the scan, if any.
• GroupComment: The group comment attached to the scan, if any.
• DeviceId: The device ID of the scanner used for the scan.
• LocationId: The location ID where the scan took place.
• HashId: The unique hash ID for the scan.
• PhotoBase64: The base64 encoded photo extracted from the document, if available.
• Latitude: The latitude coordinate where the scan took place.
• Longitude: The longitude coordinate where the scan took place.
• isGeoUpdated: A boolean indicating whether the geolocation data was updated.
• Tags: Any tags associated with the scan, if any.
• Country: The country extracted from the document.
• ScanLatitude: The latitude coordinate of the scan, if available.
• ScanLongitude: The longitude coordinate of the scan, if available.
• CountryCode: The country code extracted from the document.
• DocumentType: The type of document scanned (e.g., DL for Driver's License).
• LocationName: The name of the location where the scan took place.
• GroupName: The name of the group associated with the scan, if any.
• DeviceName: The name of the device used for the scan.
• DeviceLogin: The login name of the device used for the scan.
• CompletedSurvey: Any survey data completed during the scan, if any.
• JurisdictionCode: The jurisdiction code extracted from the document.
• AttachmentLinks: An array of links to any attachments associated with the scan.
• SignatureLink: A link to the signature image associated with the scan, if available.
• ImageLink: A link to the main image of the scanned document.
• DocumentIsValid: A boolean indicating whether the document is valid.
• AuthenticationStatus: The authentication status of the document (e.g., Passed, Failed).
• ScanStatus: �The scan status takes into account results of authentication tests as well as attributes such as group assignment and alert list, which can cause Flagged scan status, and document expiration, which can cause Failed scan status, even for an otherwise valid document.
• CustomFields: Any custom fields associated with the scan, if any.
• ScannerInfo: Information about the scanner used for the scan, if available.
• UserAgent: The user agent string of the device used for the scan.

Linked Content

The webhook data contains the following fields Attachments, ImageLink and SignatureLink where each contain a link to BLOB content. All three links are active within 24 hours after the webhook request has been sent.