DATA BREACH CHECK

4 min

Introduction

This API call retrieves risk scores related to data breaches for a specific patron. The call is made using a POST request to the specified URL with the required headers and data parameters in the specified format. The response is a JSON object with a result object containing the risk scores.

Sample cURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/..your-patron-id../riskscores \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"dataBreach","essentials":{"email":"...email...","mobile":"...mobile...","username":"...username...","domain":"...domain..."}}'

Parameter	Data Type	Required	Description
task	string	Yes	The task is to be performed by the API. In this case, the task is dataBreach.
essentials	object	Yes	A JSON object containing essential data parameters.
email	string	Yes	The email address associated with the user.
mobile	string	Yes	The mobile number associated with the user.
username	string	Yes	The username is associated with the user.
domain	string	Yes	The domain name is associated with the user's email address.

Sample Response

{
      "result": {
          "breachFound": true/false,
          "breachData": [
              {
                  "name": "...name...",
                  "domain": "...domain...",
                  "breachDate": "...breachDate...",
                  "breachDataCount": "...breachDataCount...",
                  "description": "...description...",
                  "breachedDataTypes": [..."breached data types"...],
                  "isVerified": true/false,
                  "isFabricated": true/false,
                  "isSpam": true/false
              }
          ]
      }
  }

Parameter Name	Data Type	Required	Description
breachFound	boolean	Yes	Indicates whether a data breach has been found or not
breachData	array	Yes	List of breached data
name	string	Yes	Name of the breached data
domain	string	Yes	The domain of the breached data
breachDate	string	Yes	Date of the breach
breachDataCount	string	Yes	Number of breached data entries
description	string	Yes	Description of the breached data
breachedDataTypes	array	Yes	List of breached data types
isVerified	boolean	Yes	Indicates whether the breached data is verified or not
isFabricated	boolean	Yes	Indicates whether the breached data is fabricated or not
isSpam	boolean	Yes	Indicates whether the breached data is spam or not