- List assessments GET
- Assess an event POST
- Retrieve an assessment GET
- Report an assessment's outcome POST
- List allow and block list entries GET
- Add an allow or block list entry POST
- Retrieve a list entry GET
- Remove a list entry DELETE
- Forget a user DELETE
- Retrieve the risk settings GET
- Update the risk settings PATCH
- Retrieve the calibration GET
- List rules GET
- Create a rule POST
- Retrieve a rule GET
- Update a rule PATCH
- Delete a rule DELETE
- Check an email address POST
- Check an IP address POST
- Check a phone number POST
- Classify content POST
- Check a rate limit POST
- List rate limit buckets GET
- Create a rate limit bucket POST
- Retrieve a rate limit bucket GET
- Update a rate limit bucket PATCH
- Delete a rate limit bucket DELETE
Add an allow or block list entry
Adds an email address (matched by mailbox), domain (with its subdomains), IP address or CIDR range, AS number, country or user id to the environment's allow or block list. An allow-list match makes the decision allow whatever else fired; a block-list match makes it block. Adding an entry that already exists returns it with status 200.
bearerAuthAuthorizationBearer <token>A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.
Coss-Version?"2026-10-10"The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.
"2026-10-10"application/json- body
- body
- …
list*RiskListWhich list: allow or block.
"allow""block"type*RiskListEntryTypeemail (matched by mailbox, dots and +tags folded), domain (subdomains included), ip (an address or CIDR range), asn, country (ISO 3166-1 alpha-2), user (your user id).
"email""domain""ip""asn""country""user"value*stringWhat to match: the address, domain, IP, CIDR range, ASN or other value of its type.
1 <= length <= 320note?stringYour note about it.
length <= 500expires_at?stringThe entry stops matching at this time (it is kept until deleted).
date-timeThe entry already existed.
application/json- response
- response
- …
object*"risk_list_entry""risk_list_entry"id*stringlist*RiskListWhich list: allow or block.
"allow""block"type*RiskListEntryTypeemail (matched by mailbox, dots and +tags folded), domain (subdomains included), ip (an address or CIDR range), asn, country (ISO 3166-1 alpha-2), user (your user id).
"email""domain""ip""asn""country""user"value*stringNormalized: emails as their mailbox, CIDR ranges canonical, ASNs as numbers.
note*|Your note about it. null: none.
expires_at*|When it stops matching. null: never.
date-timecreated_at*stringdate-timeimport { Coss } from "coss";const coss = new Coss({ apiKey: process.env.COSS_API_KEY, baseUrl: "https://api.coss.com",});const { data, error } = await coss.risk.lists.add("block", { domain: "evil.example", note: "Card testing",});{ "object": "risk_list_entry", "id": "rskle_01k7c8m4q2f3e9v6t5r1n0p8yz", "list": "block", "type": "domain", "value": "evil.example", "note": "Card testing", "expires_at": null, "created_at": "2026-01-15T09:30:00.000Z"}