API Manual - History
Introduction
Base URL
https://public.veriscancloud.com/
/History
[GET] /History
Use Case: Pulling a history of scan entries on the VeriScan account. The returned results are based on the parameters filtered in the API request.
Required Parameters
From string($date-time) - Sets the starting date/time filter period for the scan history.
- Accepted in YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ format
To string($date-time) - Sets the ending date/time filter period for the scan history.
- Accepted in YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ format
Optional Parameters
- Page (int) - The page of the history to search and return.The developer integrating to the VeriScan API can change this value to cycle through each page on the parameter filters.
- Minimum: 1
- PageSize (int) - Sets the amount of scan entries on each page. The developer integrating to the VeriScan API can change this value crease the number of entries on each page.
- Minimum :10
- Page (int) - The page of the history to search and return.The developer integrating to the VeriScan API can change this value to cycle through each page on the parameter filters.
Request data: None
Response data:
"{
"page": 0,
"pageSize": 0,
"total": 0,
"totalPages": 0,
"items": [
{
"id": 0,
"scannedUtc": "2025-03-21T20:08:54.870Z",
"scannedLocal": "2025-03-21T20:08:54.870Z",
"timeZoneId": "string",
"idNumber": "string",
"hashId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"documentType": "string",
"jurisdictionCode": "string",
"birthDate": "2025-03-21T20:08:54.870Z",
"age": 0,
"expirationDate": "2025-03-21T20:08:54.870Z",
"postalCode": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"address": "string",
"addressLine1": "string",
"addressLine2": "string",
"sex": "string",
"phone": "string",
"email": "string",
"groupName": "string",
"groupComment": "string",
"comment": "string",
"deviceId": 0,
"deviceName": "string",
"locationId": 0,
"locationName": "string",
"tags": [
"string"
],
"customFieldValues": [
{
"name": "string",
"value": "string"
}
],
"alerts": [
{
"status": "string",
"type": "string",
"message": "string"
}
],
"authenticationStatus": "string",
"scanStatus": "string"
}
]
}"
- page (int) - The page number returned from filtered history.This is based on the Page request parameter.
- pageSize (int) - The amount of entries in the specific page. This is based on the PageSize request parameter.
- total (int) - The total amount of entries that the history filter contains.
- totalPage (int) - The total amount of pages that the history filter contains.
- items (object) - Object contains information about the indivudal such as:
- Document data.
- VeriScan Group.
- Comments.
- Tags.
- Scanned Location.
- Scanned VeriScan device.
- customFieldValues (object) - Object that presents values if the scan entry had any custom fields added in the VeriScan application at time of scan.
- alerts (object) - Object that reports any client/server side alerts that occured at the time of scan. (e.g. Passing/failing a third party check or failing an Age Check)
- authenticationStatus (string) - If the scan entry was performed with authentication on VeriScan for Windows, the overall status will populate in this field.
- scanStatus (string) - Overall status of the scan that took place in the VeriScan applicaiton.
/History/id
[GET] /History{id}
Use Case: Pulling a specific scan entry on the VeriScan account.
Required Parameters
- id (int) - The Scan ID of the entry. This is a unique value in VeriScan that every scan has and can be found on the entries in https://veriscancloud.com/History.
Request data: None
Response data:
"{
"items": [
{
"id": 0,
"scannedUtc": "2025-03-21T20:08:54.870Z",
"scannedLocal": "2025-03-21T20:08:54.870Z",
"timeZoneId": "string",
"idNumber": "string",
"hashId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"fullName": "string",
"documentType": "string",
"jurisdictionCode": "string",
"birthDate": "2025-03-21T20:08:54.870Z",
"age": 0,
"expirationDate": "2025-03-21T20:08:54.870Z",
"postalCode": "string",
"city": "string",
"country": "string",
"countryCode": "string",
"address": "string",
"addressLine1": "string",
"addressLine2": "string",
"sex": "string",
"phone": "string",
"email": "string",
"groupName": "string",
"groupComment": "string",
"comment": "string",
"deviceId": 0,
"deviceName": "string",
"locationId": 0,
"locationName": "string",
"tags": [
"string"
],
"customFieldValues": [
{
"name": "string",
"value": "string"
}
],
"alerts": [
{
"status": "string",
"type": "string",
"message": "string"
}
],
"authenticationStatus": "string",
"scanStatus": "string"
}
]
}"
- items (object) - Object contains information about the indivudal such as:
- Document data.
- VeriScan Group.
- Comments.
- Tags.
- Scanned Location.
- Scanned VeriScan device.
- customFieldValues (object) - Object that presents values if the scan entry had any custom fields added in the VeriScan application at time of scan.
- alerts (object) - Object that reports any client/server side alerts that occured at the time of scan. (e.g. Passing/failing a third party check or failing an Age Check)
- authenticationStatus (string) - If the scan entry was performed with authentication on VeriScan for Windows, the overall status will populate in this field.
- scanStatus (string) - Overall status of the scan that took place in the VeriScan applicaiton.