Webhook Payload

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

{
  "Created": "2018-01-01T01:01:01.0000001Z",
  "Sent": "2018-01-01T01:01:01.0000001Z",
  "EventId": 0,
  "WebHookId": 0,
  "Type": "CreateCard",
  "WebHookTypeId": 2,
  "Data": {
    "HistoryLogId": 0,
    "Scanned": "2018-01-01T01:01:01.1",
    "IdNum": "IdNum",
    "FirstName": "FirstName",
    "MiddleName": "MiddleName",
    "LastName": "LastName",
    "BirthDate": "1960-01-01T01:00:00",
    "ExpDate": "2020-01-01T01:00:00",
    "State": "TN",
    "PostalCode": "99999-0000",
    "City": "City",
    "Address": "Address",
    "Gender": "Male",
    "Comments": null,
    "Phone": null,
    "Email": null,
    "GroupId": null,
    "GroupComment": null,
    "DeviceId": 9999,
    "LocationId": 999,
    "HashId": "00000000-0000-0000-0000-000000000000",
    "PhotoBase64": null,
    "Latitude": null,
    "Longitude": null,
    "IsGeoUpdated": null,
    "Tags": null,
    "Country": "UNITED STATES",
    "ScanLatitude": 0.00001,
    "ScanLongitude": -0.00001,
    "CountryCode": "USA",
    "DocumentType": "DL",
    "LocationName": "LocationName",
    "GroupName": null,
    "DeviceName": "DeviceName",
    "DeviceLogin": "DeviceLogin",
    "CompletedSurvey": null,
    "AttachmentLinks": ["link", "link"],
    "ImageLink": "",
    "SignatureLink": "",
    "DocumentIsValid": true,
    "ScanStatus": "Passed"
  }
}

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.