API-Key header as user-id:api-key, which is the form Neutrino documents, so neither lands in a query string.
Set both before the first call, for example pnpm corsair setup --plugin=neutrino --tenant=acme api_key=<key> user_id=<id>, or pass key and userId in the plugin options.
What each group does:
- IP.
ip.infogeolocates an address,ip.blocklistchecks the blocklists Neutrino tracks with a flag per threat type, andip.probereports the hosting provider rather than the place. - Email.
email.validatechecks syntax, domain and MX without contacting the mailbox.email.verifyadds an SMTP probe and reportsverifiedseparately fromvalid, because a server can accept a domain and still refuse the mailbox check. - Phone.
phone.validateparses a number into its international and local forms with the carrier prefix.phone.hlrLookupqueries the carrier’s home location register for whether the number is live and whether it was ported. - Web.
web.uaLookupparses a User-Agent,web.domainLookupreads domain facts and blocklists,web.hostReputationchecks a host against many DNSBLs,web.urlInfoinspects a URL, andweb.browserBotloads a page in a real browser and can run JavaScript on it. - Text.
text.badWordFilterfinds profanity in text and returns a censored copy. - Geocode, commerce. Forward and reverse geocoding, card BIN facts, and unit and currency conversion.
- Messaging.
messaging.smsVerifytexts a security code andmessaging.phoneVerifyreads one out in a call;messaging.verifySecurityCodechecks the code the person types.
web.urlInfoand the phone HLR lookup make Neutrino do outside work. The first fetches the page themselves, and the second queries a carrier, so both cost more and can fail on a target that refuses them.messaging.smsVerifyandmessaging.phoneVerifyreach a real person and spend credits, so both aredestructive. Neutrino keeps the code it sent, andmessaging.verifySecurityCodechecks what the person types. A 5xx on these routes is never retried, because the message or call may already have gone out.messaging.verifySecurityCodeiswrite. WithlimitBy, each failed check counts toward a lockout for that identifier.web.browserBotiswrite. Loading a page only reads, but itsexecstatements run on the third-party page and can click or submit forms there.- Parameters are hyphenated.
country-code,bin-number,from-value,fetch-content,code-length. The plugin maps its own camelCase inputs onto those names, so a caller writescountryCodeandbinNumber. - A convert result comes twice.
resultis a string andresult-floata number; use the one the surrounding code needs rather than parsing the first.
{ "api-error": <number>, "api-error-msg": "..." }. Code 43 is the credential check, and it is the only code that means a bad user id or key; a 403 with another code is a plan or permission limit. A route that does not exist answers 400 with code 45 even without credentials.
What you get:
- 20 typed API operations
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the Neutrino API API key before the first call: More: API Key
pnpm corsair setup --plugin=neutrino --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.4
Connect a tenant
Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.
Example API calls
Geolocate a public addressWhat’s next
API reference
Every
neutrino.api.* operation with input and output types.Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.