Skip to main content
POST
Use this endpoint immediately before creating an account. During private beta, send email as the primary signal; IP input is accepted but not yet evaluated.
/api/v1/check remains available as a compatibility route. New integrations should use the canonical /v1/check path.

Authorizations

​
Authorization
string
header
required

Use an sg_test_... or sg_live_... key from the SignupBear dashboard.

Body

application/json
​
email
string<email>
required

The signup email address to evaluate.

Maximum string length: 254
​
ip
string<ip>

Optional IPv4 or IPv6 address. Accepted but not evaluated during private beta.

Response

The check completed, partially completed, or returned no currently available coverage.

​
success
boolean
required
​
request_id
string<uuid>
required
​
status
enum<string>
required
Available options:
complete,
partial,
failed
​
risk_level
enum<string>
required
Available options:
low,
medium,
high,
unknown
​
recommended_action
enum<string>
required
Available options:
allow,
flag,
review,
block
​
decision_source
string
required
Allowed value: "signupbear_policy"
​
policy_version
string
required
​
checked_at
string<date-time>
required
​
processing_ms
integer
required
Required range: x >= 0
​
coverage
object
required
​
email
object | null
required
​
ip
object | null
required
​
reasons
object[]
required