Add Identities to Monitoring

Add identities to monitoring

post

Allows you to set up a new alert subscription for one or more individual identities. This can include many aspects of an individual's PII, such as name, physical address, phone numbers, government IDs, email addresses, credit cards, etc.

Authorizations

enzoic_auth

AuthorizationstringRequired

The Enzoic API uses a basic auth scheme where the username is your API key and the password is your API secret.
See https://docs.enzoic.com/enzoic-api-developer-documentation/using-the-enzoic-api#api-authentication for more details.

Body

application/json

Responses

201

The call was successful. Your webhook will now be called whenever one of the submitted identities is involved in a new breach.

application/json

post

/identity-monitoring

HTTPcURLJavaScriptPython

POST /v1/identity-monitoring HTTP/1.1
Host: api.enzoic.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 718

{
  "monitoredIdentities": [
    {
      "tag": "56d6d566-82e6-426c-ae47-528a0fb64808",
      "firstName": "John",
      "lastName": "Doe",
      "country": "US",
      "address1": "1234 Main St",
      "address2": "Suite 100",
      "city": "New York",
      "province": "NY",
      "postalCode": 12345,
      "governmentID": {
        "country": "US",
        "value": "123-12-1234"
      },
      "emails": [
        "[email protected]"
      ],
      "phoneNumbers": [
        {
          "country": "text",
          "value": "text"
        }
      ],
      "creditCards": [
        "4111-1111-1111-1111"
      ],
      "cryptocurrencyWallets": [
        "34xp4vRoCGJym3xR7yCVPFHoCNxv4Twseo"
      ],
      "urls": [
        "https://www.enzoic.com"
      ],
      "ip4Addresses": [
        "134.88.23.1"
      ],
      "ip6Addresses": [
        "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
      ],
      "secondaryMatchItems": [
        {
          "description": "Bank of America Checking Account",
          "value": 90082323215
        }
      ],
      "webhookID": "66766957431c9acc8cea2d6d"
    }
  ]
}

201

The call was successful. Your webhook will now be called whenever one of the submitted identities is involved in a new breach.

{
  "added": 1,
  "alreadyExisted": 0
}