openapi-directory/api/neutrinoapi.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"email":"ops@neutrinoapi.com","name":"Neutrino API","url":"https://www.neutrinoapi.com/"},"description":"The general-purpose API","license":{"name":"MIT","url":"https://www.neutrinoapi.com/api/LICENSE-MIT.txt"},"title":"NeutrinoAPI","version":"3.3.5","x-apisguru-categories":["email","messaging","telecom","location","text"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://www.neutrinoapi.com/img/NEUTRINO_LOGO_NOBG_126x65.png"},"x-origin":[{"format":"swagger","url":"https://www.neutrinoapi.com/api/swagger.json","version":"2.0"}],"x-providerName":"neutrinoapi.com"},"paths":{"/bad-word-filter":{"post":{"description":"Detect bad words, swear words and profanity in a given text","operationId":"BadWordFilterPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"content":{"description":"The text content to check. This can be either a URL to load content from or an actual content string","type":"string"},"censor-character":{"description":"The character to use to censor out the bad words found","type":"string"}},"required":["content"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadWordFilterResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"Bad Word Filter","tags":["Data Tools"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/bin-lookup":{"post":{"description":"Perform a BIN (Bank Identification Number) or IIN (Issuer Identification Number) lookup. See: https://www.neutrinoapi.com/api/bin-lookup/","operationId":"BinLookupPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"bin-number":{"description":"The BIN or IIN number (the first 6 digits of a credit card number)","type":"string"},"customer-ip":{"description":"Pass in a customers remote IP address. The API will then determine the country of the IP address and match it against the BIN country. This feature is designed for fraud prevention and detection checks.","type":"string"}},"required":["bin-number"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BinLookupResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"BIN Lookup","tags":["E-commerce"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/code-highlight":{"post":{"description":"Code highlight will take raw source code and convert into nicely formatted HTML with syntax and keyword highlighting","operationId":"CodeHighlightPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"content":{"description":"The source content. This can be either a URL to load from or an actual content string","type":"string"},"type":{"description":"The code type. See the API docs for all supported types","type":"string"},"add-keyword-links":{"description":"Add links on source code keywords to the relevant language documentation","type":"boolean","default":false}},"required":["content","type"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"format":"binary","type":"string"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"Code Highlight","tags":["Data Tools"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/convert":{"post":{"description":"A powerful unit and currency conversion tool","operationId":"ConvertPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"from-value":{"description":"The value to convert from","type":"string"},"from-type":{"description":"The type of the value to convert from","type":"string"},"to-type":{"description":"The type to convert to","type":"string"}},"required":["from-value","from-type","to-type"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"Convert","tags":["Data Tools"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/email-validate":{"post":{"description":"Parse, validate and clean an email address","operationId":"EmailValidatePost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"email":{"description":"The email address","type":"string"},"fix-typos":{"description":"Automatically attempt to fix typos in the address","type":"boolean","default":false}},"required":["email"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailValidateResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"Email Validate","tags":["Data Tools"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/email-verify":{"post":{"description":"SMTP based email address verification","operationId":"EmailVerifyPost","parameters":[{"description":"An email address","in":"query","name":"email","required":true,"schema":{"type":"string"}},{"description":"Automatically attempt to fix typos in the address","in":"query","name":"fix-typos","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailVerifyResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"Email Verify","tags":["Security and Networking"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/geocode-address":{"post":{"description":"Geocode an address, partial address or the name of a location","operationId":"GeocodeAddressPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"address":{"description":"The address or partial address to try and locate","type":"string"},"country-code":{"description":"The ISO 2-letter country code to be biased towards (default is no country bias)","type":"string"},"language-code":{"description":"The language to display results in, available languages are: de, en, es, fr, it, pt, ru","type":"string","default":"en"},"fuzzy-search":{"description":"If no matches are found for the given address, start performing a recursive fuzzy search until a geolocation is found. We use a combination of approximate string matching and data cleansing to find possible location matches","type":"boolean","default":false}},"required":["address"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeocodeAddressResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"Geocode Address","tags":["Geolocation"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/geocode-reverse":{"post":{"description":"Convert a geographic coordinate (latitude and longitude) into a real world address or location.","operationId":"GeocodeReversePost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"latitude":{"description":"The location latitude","type":"number","format":"double"},"longitude":{"description":"The location longitude","type":"number","format":"double"},"language-code":{"description":"The language to display results in, available languages are: de, en, es, fr, it, pt, ru","type":"string","default":"en"}},"required":["latitude","longitude"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeocodeReverseResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"Geocode Reverse","tags":["Geolocation"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/hlr-lookup":{"post":{"description":"Connect to the global mobile cellular network and retrieve the status of a mobile device","operationId":"HlrLookupPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"number":{"description":"A phone number","type":"string"},"country-code":{"description":"ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)","type":"string"}},"required":["number"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HlrLookupResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"HLR Lookup","tags":["Telephony"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/host-reputation":{"post":{"description":"Check the reputation of an IP address or domain against a comprehensive list of blacklists and blocklists (DNSBLs)","operationId":"HostReputationPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"host":{"description":"An IPv4 address or a domain name. If you supply a domain name it will be checked against the URI DNSBL list","type":"string"}},"required":["host"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostReputationResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"Host Reputation","tags":["Security and Networking"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/html-clean":{"post":{"description":"Clean and sanitize untrusted HTML","operationId":"HtmlCleanPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"content":{"description":"The HTML content. This can be either a URL to load HTML from or an actual HTML content string","type":"string"},"output-type":{"description":"The level of sanitization, possible values are: plain-text, simple-text, basic-html, basic-html-with-images, advanced-html","type":"string"}},"required":["content","output-type"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"format":"binary","type":"string"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"HTML Clean","tags":["Data Tools"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/html-extract-tags":{"post":{"description":"Extract specific HTML tag contents or attributes from complex HTML or XHTML content","operationId":"HtmlExtractTagsPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"content":{"description":"The HTML content. This can be either a URL to load HTML from or an actual HTML content string","type":"string"},"tag":{"description":"The HTML tag(s) to extract data from. This can just be a simple tag name like 'img' OR a CSS/jQuery style selector","type":"string"},"attribute":{"description":"If set, then extract data from the specified tag attribute. If not set, then data will be extracted from the tags inner content","type":"string"},"base-url":{"description":"The base URL to replace into realive links","type":"string"}},"required":["content","tag"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HtmlExtractResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"HTML Extract","tags":["Data Tools"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/html5-render":{"post":{"description":"Render HTML and HTML5 content to PDF, JPG or PNG","operationId":"Html5RenderPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"content":{"description":"The HTML content. This can be either a URL to load HTML from or an actual HTML content string","type":"string"},"format":{"description":"Which format to output, available options are: PDF, PNG, JPG","type":"string","default":"PDF"},"page-size":{"description":"Set the document page size, can be one of: A0 - A9, B0 - B10, Comm10E, DLE or Letter","type":"string","default":"A4"},"title":{"description":"The document title","type":"string"},"margin":{"description":"The document margin (in mm)","type":"integer","format":"int32","default":0},"margin-left":{"description":"The document left margin (in mm)","type":"integer","format":"int32","default":0},"margin-right":{"description":"The document right margin (in mm)","type":"integer","format":"int32","default":0},"margin-top":{"description":"The document top margin (in mm)","type":"integer","format":"int32","default":0},"margin-bottom":{"description":"The document bottom margin (in mm)","type":"integer","format":"int32","default":0},"landscape":{"description":"Set the document to lanscape orientation","type":"boolean","default":false},"zoom":{"description":"Set the zoom factor when rendering the page (2.0 for double size, 0.5 for half size)","type":"number","format":"double","default":1},"grayscale":{"description":"Render the final document in grayscale","type":"boolean","default":false},"media-print":{"description":"Use @media print CSS styles to render the document","type":"boolean","default":false},"media-queries":{"description":"Activate all @media queries before rendering. This can be useful if you wan't to render the mobile version of a responsive website","type":"boolean","default":false},"forms":{"description":"Generate real (fillable) PDF forms from HTML forms","type":"boolean","default":false},"css":{"description":"Inject custom CSS into the HTML. e.g. 'body { background-color: red;}'","type":"string"},"image-width":{"description":"If rendering to an image format (PNG or JPG) use this image width (in pixels)","type":"integer","format":"int32","default":1024},"image-height":{"description":"If rendering to an image format (PNG or JPG) use this image height (in pixels). The default is automatic which dynamically sets the image height based on the content","type":"integer","format":"int32"}},"required":["content"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"format":"binary","type":"string"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"HTML5 Render","tags":["Imaging"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/image-resize":{"post":{"description":"Resize an image and output as either JPEG or PNG. See: https://www.neutrinoapi.com/api/image-resize/","operationId":"ImageResizePost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"image-url":{"description":"The URL to the source image","type":"string"},"width":{"description":"Width to resize to (in px)","type":"integer","format":"int32"},"height":{"description":"Height to resize to (in px)","type":"integer","format":"int32"},"format":{"description":"The output image format, can be either png or jpg","type":"string","default":"png"}},"required":["image-url","width","height"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"format":"binary","type":"string"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"Image Resize","tags":["Imaging"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/image-watermark":{"post":{"description":"Watermark one image with another image. See: https://www.neutrinoapi.com/api/image-watermark/","operationId":"ImageWatermarkPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"image-url":{"description":"The URL to the source image","type":"string"},"watermark-url":{"description":"The URL to the watermark image","type":"string"},"opacity":{"description":"The opacity of the watermark (0 to 100)","type":"integer","format":"int32","default":50},"format":{"description":"The output image format, can be either png or jpg","type":"string","default":"png"},"position":{"description":"The position of the watermark image, possible values are: center, top-left, top-center, top-right, bottom-left, bottom-center, bottom-right","type":"string","default":"center"},"width":{"description":"If set resize the resulting image to this width (preserving aspect ratio)","type":"integer","format":"int32"},"height":{"description":"If set resize the resulting image to this height (preserving aspect ratio)","type":"integer","format":"int32"}},"required":["image-url","watermark-url"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"format":"binary","type":"string"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"Image Watermark","tags":["Imaging"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/ip-blocklist":{"post":{"description":"The IP Blocklist API will detect potentially malicious or dangerous IP addresses","operationId":"IpBlocklistPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"ip":{"description":"An IPv4 address","type":"string"}},"required":["ip"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpBlocklistResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"IP Blocklist","tags":["Security and Networking"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/ip-info":{"post":{"description":"Get location information about an IP address and do reverse DNS (PTR) lookups.","operationId":"IpInfoPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"ip":{"description":"The IP address","type":"string"},"reverse-lookup":{"description":"Do a reverse DNS (PTR) lookup. This option can add extra delay to the request so only use it if you need it","type":"boolean","default":false}},"required":["ip"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpInfoResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"IP Info","tags":["Geolocation"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/ip-probe":{"post":{"description":"Analyze and extract provider information for an IP address","operationId":"IpProbePost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"ip":{"description":"IPv4 or IPv6 address","type":"string"}},"required":["ip"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpProbeResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"IP Probe","tags":["Security and Networking"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/phone-playback":{"post":{"description":"Make an automated call to any valid phone number and playback an audio message","operationId":"PhonePlaybackPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"number":{"description":"The phone number to call. Must be valid international format","type":"string"},"audio-url":{"description":"A URL to a valid audio file. Accepted audio formats are: MP3, WAV, OGG","type":"string"}},"required":["number","audio-url"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhonePlaybackResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"Phone Playback","tags":["Telephony"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/phone-validate":{"post":{"description":"Parse, validate and get location information about a phone number","operationId":"PhoneValidatePost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"number":{"description":"The phone number","type":"string"},"country-code":{"description":"ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)","type":"string"},"ip":{"description":"Pass in a users IP address and we will assume numbers are based in the country of the IP address","type":"string"}},"required":["number"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneValidateResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"Phone Validate","tags":["Data Tools"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/phone-verify":{"post":{"description":"Make an automated call to any valid phone number and playback a unique security code","operationId":"PhoneVerifyPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"number":{"description":"The phone number to send the verification code to","type":"string"},"code-length":{"description":"The number of digits to use in the security code (between 4 and 12)","type":"integer","format":"int32","default":6},"security-code":{"description":"Pass in your own security code. This is useful if you have implemented TOTP or similar 2FA methods. If not set then we will generate a secure random code (only numerical security codes are currently supported)","type":"integer","format":"int32"},"playback-delay":{"description":"The delay in milliseconds between the playback of each security code","type":"integer","format":"int32","default":800},"country-code":{"description":"ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)","type":"string"},"language-code":{"description":"The language to playback the verification code in, available languages are: de - German, en - English, es - Spanish, fr - Fench, it - Italian, pt - Portuguese, ru - Russian","type":"string","default":"en"}},"required":["number"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneVerifyResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"Phone Verify","tags":["Telephony"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/qr-code":{"post":{"description":"Generate a QR code as a PNG image. See: https://www.neutrinoapi.com/api/qr-code/","operationId":"QrCodePost","parameters":[{"description":"The width of the QR code (in px)","in":"query","name":"width","required":false,"schema":{"type":"integer","format":"int32","default":250}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"content":{"description":"The content to encode into the QR code (e.g. a URL or a phone number)","type":"string"},"height":{"description":"The height of the QR code (in px)","type":"integer","format":"int32","default":250},"fg-color":{"description":"The QR code foreground color (you should always use a dark color for this)","type":"string","default":"#000000"},"bg-color":{"description":"The QR code background color (you should always use a light color for this)","type":"string","default":"#ffffff"}},"required":["content"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"format":"binary","type":"string"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"QR Code","tags":["Imaging"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/sms-verify":{"post":{"description":"Send a unique security code to any mobile device via SMS","operationId":"SmsVerifyPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"number":{"description":"The phone number to send a verification code to","type":"string"},"code-length":{"description":"The number of digits to use in the security code (must be between 4 and 12)","type":"integer","format":"int32","default":5},"security-code":{"description":"ass in your own security code. This is useful if you have implemented TOTP or similar 2FA methods. If not set then we will generate a secure random code (only numerical security codes are currently supported)","type":"integer","format":"int32"},"country-code":{"description":"ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)","type":"string"},"language-code":{"description":"The language to send the verification code in, available languages are: de - German, en - English, es - Spanish, fr - Fench, it - Italian, pt - Portuguese, ru - Russian","type":"string","default":"en"}},"required":["number"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsVerifyResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"SMS Verify","tags":["Telephony"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/url-info":{"post":{"description":"Parse, analyze and retrieve content from the supplied URL","operationId":"UrlInfoPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"url":{"description":"The URL to process","type":"string"},"fetch-content":{"description":"If this URL responds with html, text, json or xml then return the response. This option is useful if you want to perform further processing on the URL content","type":"boolean"}},"required":["url","fetch-content"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UrlInfoResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"URL Info","tags":["Security and Networking"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/user-agent-info":{"post":{"description":"Parse, validate and get detailed user-agent information from a user agent string","operationId":"UserAgentInfoPost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"user-agent":{"description":"A user-agent string","type":"string"}},"required":["user-agent"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAgentInfoResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"User Agent Info","tags":["Data Tools"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}},"/verify-security-code":{"post":{"description":"Check if a security code from one of the verify APIs is valid","operationId":"VerifySecurityCodePost","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"output-case":{"type":"string","enum":["camel"]},"security-code":{"description":"The security code to verify","type":"integer","format":"int32"}},"required":["security-code"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifySecurityCodeResponse"}}}},"400":{"description":"Your API request has been rejected. Check the error code for details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"You have failed to authenticate or are using an invalid API path"},"default":{"description":"We messed up, sorry! Your request has caused a fatal exception"}},"security":[{"api-key":[],"user-id":[]}],"summary":"Verify Security Code","tags":["Telephony"],"x-operation-settings":{"AllowDynamicFormParameters":false,"AllowDynamicQueryParameters":false,"CollectParameters":false,"IsMultiContentStreaming":false},"x-unitTests":[]}}},"servers":[{"url":"https://neutrinoapi.com/"}],"components":{"securitySchemes":{"api-key":{"description":"Your API key","in":"query","name":"api-key","type":"apiKey","x-skip-client-authentication":false,"x-testValue":""},"user-id":{"description":"Your user ID","in":"query","name":"user-id","type":"apiKey","x-skip-client-authentication":false,"x-testValue":""}},"schemas":{"ApiError":{"properties":{"apiError":{"description":"API error code. If set and > 0 then an API error has occurred your request could not be completed","format":"int32","type":"integer"},"apiErrorMsg":{"description":"API error message","type":"string"}},"required":["apiError","apiErrorMsg"],"title":"API Error","type":"object"},"BadWordFilterResponse":{"properties":{"badWordsList":{"description":"Array of the bad words found","items":{"type":"string"},"type":"array"},"badWordsTotal":{"description":"Total number of bad words detected","format":"int32","type":"integer"},"censoredContent":{"description":"The censored content (only set if censor-character has been set)","type":"string"},"isBad":{"description":"Does the text contain bad words","type":"boolean"}},"required":["badWordsList","badWordsTotal","censoredContent","isBad"],"title":"Bad Word Filter Response","type":"object"},"BinLookupResponse":{"properties":{"cardBrand":{"description":"The card brand (e.g. Visa or Mastercard)","type":"string"},"cardCategory":{"description":"The card category (if known)","type":"string"},"cardType":{"description":"The card type, will always be one of: DEBIT, CREDIT, CHARGE CARD","type":"string"},"country":{"description":"Full country name of the issuer","type":"string"},"countryCode":{"description":"ISO 2-letter country code of the issuer","type":"string"},"ipBlocklisted":{"description":"True if the customer IP is listed on one of our blocklists, see the IP Blocklist API for more details","type":"boolean"},"ipBlocklists":{"description":"An array of strings indicating which blocklists this IP is listed on","items":{"type":"string"},"type":"array"},"ipCity":{"description":"The city name (if detectable) from the customer IP","type":"string"},"ipCountry":{"description":"The country detected from the customer IP","type":"string"},"ipCountryCode":{"description":"The ISO 2-letter country code detected from the customer IP","type":"string"},"ipMatchesBin":{"description":"True if the customer IP address country matches the BIN country","type":"boolean"},"ipRegion":{"description":"The region name (if detectable) from the customer IP","type":"string"},"issuer":{"description":"The card issuer (if known)","type":"string"},"issuerPhone":{"description":"The card issuer phone number (if known)","type":"string"},"issuerWebsite":{"description":"The card issuer website (if known)","type":"string"},"valid":{"description":"Is this a valid BIN or IIN number","type":"boolean"}},"required":["country","ipCity","ipMatchesBin","cardType","cardCategory","ipCountryCode","ipCountry","issuer","ipBlocklisted","valid","ipBlocklists","issuerWebsite","countryCode","ipRegion","cardBrand","issuerPhone"],"title":"BIN Lookup Response","type":"object"},"Blacklist":{"properties":{"isListed":{"description":"true if listed, false if not","type":"boolean"},"listHost":{"description":"the domain/hostname of the DNSBL","type":"string"},"listName":{"description":"the name of the DNSBL","type":"string"},"listRating":{"description":"the list rating [1-3] with 1 being the best rating and 3 the lowest rating","format":"int32","type":"integer"},"responseTime":{"description":"the DNSBL server response time in milliseconds","format":"int32","type":"integer"},"txtRecord":{"description":"the TXT record returned for this listing (if listed)","type":"string"}},"required":["isListed","listHost","listRating","listName","txtRecord","responseTime"],"title":"Blacklist","type":"object"},"ConvertResponse":{"properties":{"fromType":{"description":"The type of the value being converted from","type":"string"},"fromValue":{"description":"The value being converted from","type":"string"},"result":{"description":"The result of the conversion","type":"string"},"toType":{"description":"The type being converted to","type":"string"},"valid":{"description":"Was the coversion successful and produced a valid result","type":"boolean"}},"required":["valid","result","fromValue","toType","fromType"],"title":"Convert Response","type":"object"},"EmailValidateResponse":{"properties":{"domain":{"description":"The email domain","type":"string"},"domainError":{"description":"True if this address has a domain error (e.g. no valid mail server records)","type":"boolean"},"email":{"description":"The full email address (this could be different to the supplied address if fix-typos is used)","type":"string"},"isDisposable":{"description":"True if this address is a disposable, temporary or darknet related email address","type":"boolean"},"isFreemail":{"description":"True if this address is a free-mail address","type":"boolean"},"isPersonal":{"description":"True if this address belongs to a person. False if this is a role based address, e.g. admin@, help@, office@, etc.","type":"boolean"},"provider":{"description":"The email service provider domain","type":"string"},"syntaxError":{"description":"True if this address has a syntax error","type":"boolean"},"typosFixed":{"description":"True if typos have been fixed","type":"boolean"},"valid":{"description":"Is this a valid email","type":"boolean"}},"required":["valid","syntaxError","domain","domainError","isFreemail","email","isDisposable","typosFixed","isPersonal","provider"],"title":"Email Validate Response","type":"object"},"EmailVerifyResponse":{"properties":{"domain":{"description":"The email domain","type":"string"},"domainError":{"description":"True if this address has a domain error (e.g. no valid mail server records)","type":"boolean"},"email":{"description":"The full email address (this could be different to the supplied address if typos-fixed is true)","type":"string"},"isCatchAll":{"description":"True if this email domain has a catch-all policy (it will accept mail for any username)","type":"boolean"},"isDisposable":{"description":"True if this address is a disposable, temporary or darknet related email address","type":"boolean"},"isFreemail":{"description":"True if this address is a free-mail address","type":"boolean"},"isPersonal":{"description":"True if this address is for a person. False if this is a role based address, e.g. admin@, help@, office@, etc.","type":"boolean"},"provider":{"description":"The email service provider domain","type":"string"},"smtpResponse":{"description":"The raw SMTP response message received during verification","type":"string"},"smtpStatus":{"description":"The SMTP verification status for the address (see API docs for full details)","type":"string"},"syntaxError":{"description":"True if this address has a syntax error","type":"boolean"},"typosFixed":{"description":"True if typos have been fixed","type":"boolean"},"valid":{"description":"Is this a valid email address (syntax and domain is valid)","type":"boolean"},"verified":{"description":"True if this address has passed SMTP verification. Check the smtp-status and smtp-response fields for specific verification details","type":"boolean"}},"required":["valid","verified","email","typosFixed","syntaxError","domainError","domain","provider","isFreemail","isDisposable","isPersonal","smtpStatus","smtpResponse","isCatchAll"],"title":"Email Verify Response","type":"object"},"GeocodeAddressResponse":{"properties":{"found":{"description":"The number of possible matching locations found","format":"int32","type":"integer"},"locations":{"description":"Array of matching location objects","items":{"$ref":"#/components/schemas/Location"},"type":"array"}},"required":["found","locations"],"title":"Geocode Address Response","type":"object"},"GeocodeReverseResponse":{"properties":{"address":{"description":"The fully formatted address","type":"string"},"addressComponents":{"additionalProperties":{"type":"string"},"description":"The components which make up the address such as road, city, state etc. May also include additional metadata about the address","type":"object"},"city":{"description":"The city of the location","type":"string"},"country":{"description":"The country of the location","type":"string"},"countryCode":{"description":"The ISO 2-letter country code of the location","type":"string"},"found":{"description":"True if these coordinates map to a real location","type":"boolean"},"postalCode":{"description":"The postal code for the location","type":"string"},"state":{"description":"The state of the location","type":"string"}},"required":["country","found","address","city","countryCode","postalCode","state","addressComponents"],"title":"Geocode Reverse Response","type":"object"},"HlrLookupResponse":{"properties":{"country":{"description":"The phone number country","type":"string"},"countryCode":{"description":"Number location ISO 2-letter country code","type":"string"},"hlrStatus":{"description":"The HLR lookup status. See API docs for specific status details","type":"string"},"hlrValid":{"description":"Was the HLR lookup successful. If true then this is a working and registered cell-phone or mobile device (SMS and phone calls will be delivered)","type":"boolean"},"imsi":{"description":"The mobile IMSI number (only set if HLR lookup valid)","type":"string"},"internationalCallingCode":{"description":"Numbers international calling code","type":"string"},"internationalNumber":{"description":"Number represented in international format","type":"string"},"isMobile":{"description":"Is this a mobile number","type":"boolean"},"isPorted":{"description":"Has this number been ported to another network","type":"boolean"},"isRoaming":{"description":"Is this number currently roaming from its origin country","type":"boolean"},"localNumber":{"description":"Number represented in local format","type":"string"},"location":{"description":"Number location (could be a city, region or country)","type":"string"},"mc