secuveriAPI docs
OpenAPIMarkdown

Block or allow one value

POST/v1/lists

A blocked value declines a verification that presents it (LIST_BLOCK; a workflow can send it to review instead). An allowed value skips the velocity, IP-country and risky-contact holds. The value is normalized first (emails lower-cased, phones as E.164, IPs and CIDR ranges, two-letter countries); adding an active value returns the existing entry with 200. An expired matching entry is reactivated with the requested expiry and returned with 200. Needs the lists:write scope.

Send your API key in the x-api-key header.

Request bodyapplication/jsonrequired

  • kindstringrequired

    One ofblockallow

  • typestringrequired

    installation is the device id from a verification report; vendor_data is your id for the person; country is the document's issuing country (ISO alpha-2).

    One ofemailphoneipinstallationvendor_datacountry

  • valuestring1–320 charsrequired

    For ip, an address or a CIDR range.

  • reasonstring≤ 1000 chars
  • expires_atstring | nulldate-time

    Must be in the future.

Responses

  • 200Already listed; the existing entry.
    • entryListEntry | null
      Show 8 child properties
      • idstringuuid
      • kindstring

        One ofblockallow

      • entry_typestring

        One ofemailphoneipinstallationvendor_datacountry

      • hintstring

        A masked hint for emails, phones, devices and vendor_data; the address or range for ip, the code for country.

      • reasonstring
      • source_verification_idstring | null

        Set when blocked from a verification.

      • created_atstringdate-time
      • expires_atstring | nulldate-time
    • createdboolean
  • 201Added.
    • entryListEntry | null
      Show 8 child properties
      • idstringuuid
      • kindstring

        One ofblockallow

      • entry_typestring

        One ofemailphoneipinstallationvendor_datacountry

      • hintstring

        A masked hint for emails, phones, devices and vendor_data; the address or range for ip, the code for country.

      • reasonstring
      • source_verification_idstring | null

        Set when blocked from a verification.

      • created_atstringdate-time
      • expires_atstring | nulldate-time
    • createdboolean
  • 400Invalid value, or an expiry that is not in the future.
  • 401Missing, unknown or expired API key.
  • 403The key lacks the scope this call needs, or its IP allowlist refuses the caller.
  • 429More than 300 list calls in a minute.
  • 503Lists are not available right now.
curl -X POST https://api-verify.secuveri.com/v1/lists \
  -H "x-api-key: $SECUVERI_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "kind": "block",
  "type": "email",
  "value": "jane@example.com"
}'
Response · 200
{
  "entry": {
    "id": "0b8f4f5e-3c2a-4d1b-9e7f-6a5c4b3d2e1f",
    "kind": "block",
    "entry_type": "email",
    "hint": "j***@example.com",
    "reason": "Confirmed fraud",
    "source_verification_id": "VRF-7KQ2M9XA",
    "created_at": "2026-10-23T09:12:44.120Z",
    "expires_at": "2026-10-23T09:12:44.120Z"
  },
  "created": true
}