Screenings

Risk signals for an email, a phone and an IP address

Evaluates an email, a phone number and an IP address and returns explained risk signals, with no customer and no stored record. Send at least one of the three.

  • Email: syntax, disposable mailbox services and, for a business, the domain itself (exists, mail server, SPF/DMARC, registration age, related to the company name). The domain of an individual is never looked up on the network.
  • Phone: valid number for the declared country, virtual, toll-free or premium-rate lines, and a calling code from another country.
  • IP address: Tor exit nodes, cloud or hosting networks, and an address block registered to a country other than the declared one. The address is never returned, not even masked.

checks says what happened to each input: evaluated, unavailable (it could not run now) or not_provided. A check that could not run never counts as "nothing found": it holds suggested_decision at review. When none of the inputs sent could be evaluated, the answer is 503 SIGNALS_UNAVAILABLE and the charge is refunded; retry.

suggested_decision is review on any high signal or on any unavailable check, and clear otherwise. No signal approves anything.

A private, loopback or reserved address is 400 INVALID_IP_ADDRESS; the charge is refunded.

Send an Idempotency-Key to retry safely: the same key and body return the same answer and are not charged again.

post/signals

Request

  • Base URL
    https://developers.ozav.io/v2
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Headers

Idempotency-Keystring

Optional idempotency key (16-256 characters of [A-Za-z0-9_-]); same semantics as on money-moving operations.

Request body

type'individual' | 'business' required

Whether the contact belongs to a person or a company. Only a company's email domain is looked up on the network.

namestring

The company name, compared with its email domain. Optional.

countrystring

Declared country (ISO 3166-1 alpha-2), for the phone and the IP address. Optional.

emailstring
phonestring

International format (+55 11 ...), or national with country.

ip_addressstring

A public IPv4 or IPv6 address. Never returned.

Response

The signals.

object'signals' required
type'individual' | 'business' required
suggested_decision'clear' | 'review' required

review on any high signal or any unavailable check; clear otherwise.

rule_versionstring required

Version of the rules that produced this answer.

Changes

No recorded changes to this operation across all 1 revision of this API.