Skip to main content
Soryxa developer docs

Soryxa API Docs

Build email validation into signup, CRM intake, and workflow decisioning with a public API reference for requests, response fields, reason codes, errors, and usage limits.

Core response contract

decision
Returns allow, block, or review.
reason_code
Machine-readable code for rule handling and analytics.
checks
Validation signals such as syntax, domain, disposable, role, catch-all, and mail-server status where available.
usage
Remaining validation allowance and plan limit after the request.

Use server-side calls

Keep API keys on your backend. Trigger Soryxa from signup handlers, CRM intake jobs, or workflow services.

Store decisions, not secrets

Persist decision, reason code, score, and relevant check names when your downstream workflow needs auditability.

Route review outcomes

Treat review as a separate state so legitimate addresses are not silently discarded when signals are mixed or temporarily unavailable.

Implementation workflow

Soryxa documentation is organized around the operational path most teams need: validate one address, interpret the decision, handle errors, then monitor credits as the workflow scales.

Validate at the point of entry

Call Soryxa from the backend path that receives a signup, form submission, CRM import, or workflow event. The API is most useful before a questionable address becomes a record that other systems trust.

Save the decision fields

Store the decision, reason code, score, and relevant check names when the outcome will affect onboarding, review queues, CRM updates, or later support decisions.

Route review separately

Do not treat review as a quiet allow or block. Review gives your team a separate fallback path for mixed signals, temporary service issues, or addresses that need manual judgment.

Monitor usage before limits

Read usage fields after each validation and alert your team before remaining allowance reaches zero. Usage handling should be an account state, not an email quality decision.

Add email validation decisions to your workflow.

Create an API key, send a validation request, and map the returned decision and reason code to your signup or CRM rules.