API Manual - Alert List

Introduction

Base URL

https://public.veriscancloud.com/

The Alert list endpoints of the VeriScan API utilize a unique id field that is linked to each entry on the accounts alert list.

It is advised that the developer integrating to the VS application have a system of record that contains these unique values.

This value is also visible on the VeriScan Cloud portal by selecting the edit button on an entry to https://veriscancloud.com/Alerts.

Entries without images

/AlertList

[POST] /AlertList

Use Case: Adding an entry to a VeriScan alert list.

Request data:

{
  "firstName": "string",
  "lastName": "string",
  "idNum": "string",
  "state": "string",
  "birthday": "2025-03-19",
  "caseNumber": "string",
  "comment": "string",
  "from": "2025-03-19T20:49:28.125Z",
  "to": "2025-03-19T20:49:28.125Z",
  "groupName": "string"
}

Required Fields:

• state (string) - State of the alerted individual accepted in the USPS Official State Abbreviations (e.g. CA for California)
• group (string) - Assigns the alerted inidvidual to a VeriScan group. If the string entered does not exist as a group yet, it will be created.

Optional Fields:

• firstname (string) - First name of the alerted individual.
  • Character limit: 50.
• lastName (string) - Last name of the alerted individual.
  • Character Limit : 50.
• idNum (string) - ID Number of the alerted indivudal.
  • Character Limit : 30.
• birthday string($date) - Birthdate of the alerted individual accepted in YYYY-MM-DD format.
• caseNumber (string) - External incident case number in the client's business that can be attached to the alerted individual.
  • Character limit : 30.
• comment (string) - Optional comment to attach to the alerted individual.
• from string($date-time) - Sets the starting date/time limitation that an individual will be on an alert list.
  • Accepted in YYYY-MM-DDTHH:mm:ss.SSSZ format.
• to string($date-time) - Sets the ending date/time limitation that an individual will be on an alert list.
  • Accepted in YYYY-MM-DDTHH:mm:ss.SSSZ format.

Response data:

{
  "id": 12345678
}

• id (int) - A unique identifier tied to every alert list entry.

/AlertList/id

[POST] /AlertList/{id}

Use Case: Endpoint where the developer integrated to the VeriScan API can programatically update an alert list entry. The entry is found by the id value returned from POST /AlertList or /AlertList/WithPhoto.

Required Parameters

• id (int) - A unique identifier tied to every alert list entry.

Request data:

{
  "firstName": "string",
  "lastName": "string",
  "idNum": "string",
  "state": "string",
  "birthday": "2025-03-19",
  "caseNumber": "string",
  "comment": "string",
  "from": "2025-03-19T20:49:28.125Z",
  "to": "2025-03-19T20:49:28.125Z",
  "groupName": "string"
}

Required Fields:

• state (string) - State of the alerted individual accepted in the USPS Official State Abbreviations (e.g. CA for California) *
• group (string) - Assigns the alerted inidvidual to a VeriScan Group. If the string entered does not exist as a group yet, it will be created.

Optional Fields:

• firstname (string) - First name of the alerted individual.
  • Character limit: 50.
• lastName (string) - Last name of the alerted individual.
  • Character Limit : 50.
• idNum (string) - ID Number of the alerted indivudal.
  • Character Limit : 30.
• birthday string($date) - Birthdate of the alerted individual.
  • Accepted in YYYY-MM-DD format.
• caseNumber (string) - External incident case number in the client's business that can be attached to the alerted individual.
  • Character limit : 30.
• comment (string) - Optional comment to attach to the alerted individual.
• from string($date-time) - Sets the starting date/time limitation that an individual will be on an alert list.
  • Accepted in YYYY-MM-DDTHH:mm:ss.SSSZ format.
• to string($date-time) - Sets the ending date/time limitation that an individual will be on an alert list.
  • Accepted in YYYY-MM-DDTHH:mm:ss.SSSZ format.

Response data: None

Entries with images

AlertList/WithPhoto

[POST] /AlertList/WithPhoto

Use Case: Adding an entry to a VeriScan alert list. A PNG or JPG photo can also be attached in the request.

Required Parameters

• id (int) - A unique identifier tied to every alert list entry.

Request data:

multipart/form-data

Required Fields:

• state (string) - State of the alerted individual accepted in the USPS Official State Abbreviations (e.g. CA for California)
• group (string) - Assigns the alerted inidvidual to a VeriScan Group. If the string entered does not exist as a group yet, it will be created.

Optional Fields:

• firstname (string) - First name of the alerted individual.
  • Character limit: 50.
• lastName (string) - Last name of the alerted individual.
  • Character Limit : 50.
• idNum (string) - ID Number of the alerted indivudal.
  • Character Limit : 30.
• birthday string($date) - Birthdate of the alerted individual.
  • Accepted in YYYY-MM-DD format.
• caseNumber (string) - External incident case number in the client's business that can be attached to the alerted individual.
  • Character limit : 30.
• comment (string) - Optional comment to attach to the alerted individual.
• from string($date-time) - Sets the starting date/time limitation that an individual will be on an alert list.
  • Accepted in YYYY-MM-DDTHH:mm:ss.SSSZ format.
• to string($date-time) - Sets the ending date/time limitation that an individual will be on an alert list.
  • Accepted in YYYY-MM-DDTHH:mm:ss.SSSZ format.
• photo (png/jpg) - A photo that can be attached to the individual that appears in the VeriScan application.

Response data:

{
  "id": 12345678
}

• id (int) - A unique identifier tied to every alert list entry.

AlertList/WithPhoto/id

[POST] /AlertList/WithPhoto/{id}

Endpoint where the developer integrated to the VeriScan API can programatically update an alert list entry.

The entry is found by the id value returned from POST /AlertList or /AlertList/WithPhoto. A PNG or JPG photo can also be attached in the request.

Request data:

multipart/form-data

Required Fields:

• state (string) - State of the alerted individual accepted in the USPS Official State Abbreviations (e.g. CA for California)
• group (string) - Assigns the alerted inidvidual to a VeriScan Group. If the string entered does not exist as a group yet, it will be created.

Optional Fields:

• firstname (string) - First name of the alerted individual.
  • Character limit: 50.
• lastName (string) - Last name of the alerted individual.
  • Character Limit : 50.
• idNum (string) - ID Number of the alerted indivudal.
  • Character Limit : 30.
• birthday string($date) - Birthdate of the alerted individual
  • Accepted in YYYY-MM-DD format.
• caseNumber (string) - External incident case number in the client's business that can be attached to the alerted individual.
  • Character limit : 30.
• comment (string) - Optional comment to attach to the alerted individual.
• from string($date-time) - Sets the starting date/time limitation that an individual will be on an alert list.
  • Accepted in YYYY-MM-DDTHH:mm:ss.SSSZ format.
• to string($date-time) - Sets the ending date/time limitation that an individual will be on an alert list.
  • Accepted in YYYY-MM-DDTHH:mm:ss.SSSZ format.
• photo (png/jpg) - A photo that can be attached to the individual that appears in the VeriScan application.

Response data: None

Entry Retrieval

[GET] /AlertList/{id}

Use Case: Pulling down an alert list entry via the id value.

Required Parameters

• id (int) - A unique identifier tied to every alert list entry.

Request data: None

Response data:

{
  "firstName": "string",
  "lastName": "string",
  "idNum": "string",
  "state": "string",
  "birthday": "2025-04-11",
  "caseNumber": "string",
  "comment": "string",
  "from": "2025-04-11T15:16:49.075Z",
  "to": "2025-04-11T15:16:49.075Z",
  "groupName": "string"
}

• firstname (string) - First name of the alerted individual.
  • Character limit: 50.
• lastName (string) - Last name of the alerted individual.
  • Character Limit : 50.
• idNum (string) - ID Number of the alerted indivudal.
  • Character Limit : 30.
• birthday string($date) - Birthdate of the alerted individual in YYYY-MM-DD format.
• caseNumber (string) - External incident case number in the client's business that can be attached to the alerted individual.
  • Character limit : 30.
• comment (string) - Optional comment attached to the alerted individual.
• from string($date-time) - The starting date/time limitation that an individual will be on an alert list.
  • YYYY-MM-DDTHH:mm:ss.SSSZ format.
• to string($date-time) - The ending date/time limitation that an individual will be on an alert list.
  • YYYY-MM-DDTHH:mm:ss.SSSZ format.
• groupName - Assigned VeriScan group.

Entry Deletion

/AlertList/id

[DELETE] /AlertList/{id}

Use Case: Deleting an alert list entry from the VeriScan account.

Required Parameters

• id (int) - A unique identifier tied to every alert list entry.

Request data: None

Response data: None