Have I Been Pwnd Connector

Documentation

Base Url

Get leaks by email

v1

http://lzrconnector-haveibeenpwnd.lazarustechservices.com/v1/get-leaks-by-email/:email

• Method: GET
• URL: /v1/get-leaks-by-email/:email
• Description: Returns an object with the leaks related to that email
• Response: JSON

Params

• email (required)

Response

Returns a JSON with the information about the leaks associated with the given email.
Successful response:

• The response includes a cache field to indicate whether the HIBP response is cached, which helps save tokens.

{
    "status": "success",
    "cache": "boolean",
    "data": [
        {
            "Name": "string",
            "Title": "string",
            "Domain": "string",
            "BreachDate": "string",
            "AddedDate": "string",
            "ModifiedDate": "string",
            "PwnCount": "number",
            "Description": "string",
            "LogoPath": "string",
            "DataClasses": "string[]",
            "IsVerified": "boolean",
            "IsFabricated": "boolean",
            "IsSensitive": "boolean",
            "IsRetired": "boolean",
            "IsSpamList": "boolean",
            "IsMalware": "boolean",
            "IsSubscriptionFree": "boolean",
            "IsStealerLog": "boolean"
        }
    ]
}

The account has no leaks
By default, Have I Been Pwned returns a 404 with no body when there are no breaches found for an email. This connector patches that behavior and returns a 200 with an error message:

{
    "status": "success",
    "cache": "boolean",
    "data": []
}

Error

Return error message

• Si el proveedor ha llegado a su limite de concurrencia el error devolvera un string con el parametro retry_after incluido: "retry_after:${retryAfter}, reason:Too Many Requests"

{
    "status": "error",
    "error": "string"
}

Get last analyzed business leaks

v1

http://lzrconnector-haveibeenpwnd.lazarustechservices.com/v1/get-last-business-leaked

• Method: GET
• URL: /v1/get-last-business-leaked
• Description: Returns an object with the most recently leaked companies
• Response: JSON

Params

• No parameters required, just returns data

Response

Returns a JSON with the most recent breaches:

{
    data:[
        {
            "Name": "string",
            "Title": "string",
            "Domain": "string",
            "BreachDate": "string",
            "AddedDate": "string",
            "ModifiedDate": "string",
            "PwnCount": "number",
            "Description": "string",
            "LogoPath": "string",
            "DataClasses": "string[]",
            "IsVerified": "boolean",
            "IsFabricated": "boolean",
            "IsSensitive": "boolean",
            "IsRetired": "boolean",
            "IsSpamList": "boolean",
            "IsMalware": "boolean",
            "IsSubscriptionFree": "boolean",
            "IsStealerLog": "boolean"
        }
    ]
}

Error

Return error message

{
    "error": "string"
}