Add a blocklist entry | CONFIRM Docs

Adds an entry to your organization's blocklist. Returns 409 if an equivalent entry already exists.

AuthorizationBearer

Supabase-issued user JWT. Send as Authorization Bearer header. Dedicated API keys are planned for a future release.

This endpoint expects an object.

match_typeenumRequired

Allowed values:

match_valuestringRequired

The value to match (email address, phone number, name, or email domain).

reasonstringOptional

expires_atdatetimeOptional

Optional expiry. Omit for a permanent entry.

Blocklist entry created.

blocklist_idstringOptionalformat: "uuid"

org_idstringOptionalformat: "uuid"

match_typeenumOptional

match_valuestringOptional

reasonstring or nullOptional

expires_atdatetime or nullOptional

created_atdatetimeOptional

400

Bad Request Error

401

Unauthorized Error

$	curl -X POST https://api.confirm.global/api/v1/candidates/blocklist \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"match_type": "email",
>	"match_value": "string"
>	}'