{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:neutrinoapi/bad-word-filter":{"post":{"operationId":"communication_neutrinoapi_bad_word_filter","summary":"Bad Word Filter","description":"POST /bad-word-filter","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/binlist-download":{"get":{"operationId":"communication_neutrinoapi_binlist_download","summary":"BIN List Download","description":"GET /bin-list-download","tags":["communication"],"parameters":[{"name":"include-iso3","in":"query","required":false,"description":"Include ISO 3-letter country codes and ISO 3-letter currency codes in the data. These will be added to columns 10 and 11 respectively","schema":{"type":"boolean","default":false,"description":"Include ISO 3-letter country codes and ISO 3-letter currency codes in the data. These will be added to columns 10 and 11 respectively"}},{"name":"include-8digit","in":"query","required":false,"description":"Include 8-digit and higher BIN codes. This option includes all 6-digit BINs and all 8-digit and higher BINs (including some 9, 10 and 11…","schema":{"type":"boolean","default":false,"description":"Include 8-digit and higher BIN codes. This option includes all 6-digit BINs and all 8-digit and higher BINs (including some 9, 10 and 11…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/binlookup":{"get":{"operationId":"communication_neutrinoapi_binlookup","summary":"BIN Lookup","description":"GET /bin-lookup","tags":["communication"],"parameters":[{"name":"bin-number","in":"query","required":true,"description":"The BIN or IIN number. This is the first 6, 8 or 10 digits of a card number, use 8 (or more) digits for the highest level of accuracy","schema":{"type":"string","description":"The BIN or IIN number. This is the first 6, 8 or 10 digits of a card number, use 8 (or more) digits for the highest level of accuracy"}},{"name":"customer-ip","in":"query","required":false,"description":"Pass in the customers IP address and we will return some extra information about them","schema":{"type":"string","description":"Pass in the customers IP address and we will return some extra information about them"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/browser-bot":{"post":{"operationId":"communication_neutrinoapi_browser_bot","summary":"Browser Bot","description":"POST /browser-bot","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/convert":{"get":{"operationId":"communication_neutrinoapi_convert","summary":"Convert","description":"GET /convert","tags":["communication"],"parameters":[{"name":"from-value","in":"query","required":true,"description":"The value to convert from (e.g. 10.95)","schema":{"type":"string","description":"The value to convert from (e.g. 10.95)"}},{"name":"from-type","in":"query","required":true,"description":"The type of the value to convert from (e.g. USD)","schema":{"type":"string","description":"The type of the value to convert from (e.g. USD)"}},{"name":"to-type","in":"query","required":true,"description":"The type to convert to (e.g. EUR)","schema":{"type":"string","description":"The type to convert to (e.g. EUR)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/domain-lookup":{"get":{"operationId":"communication_neutrinoapi_domain_lookup","summary":"Domain Lookup","description":"GET /domain-lookup","tags":["communication"],"parameters":[{"name":"host","in":"query","required":true,"description":"A domain name, hostname, FQDN, URL, HTML link or email address to lookup","schema":{"type":"string","description":"A domain name, hostname, FQDN, URL, HTML link or email address to lookup"}},{"name":"live","in":"query","required":false,"description":"For domains that we have never seen before then perform various live checks and realtime reconnaissance. NOTE: this option may add…","schema":{"type":"boolean","default":true,"description":"For domains that we have never seen before then perform various live checks and realtime reconnaissance. NOTE: this option may add…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/email-validate":{"get":{"operationId":"communication_neutrinoapi_email_validate","summary":"Email Validate","description":"GET /email-validate","tags":["communication"],"parameters":[{"name":"email","in":"query","required":true,"description":"An email address","schema":{"type":"string","description":"An email address"}},{"name":"fix-typos","in":"query","required":false,"description":"Automatically attempt to fix typos in the address","schema":{"type":"boolean","default":false,"description":"Automatically attempt to fix typos in the address"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/email-verify":{"get":{"operationId":"communication_neutrinoapi_email_verify","summary":"Email Verify","description":"GET /email-verify","tags":["communication"],"parameters":[{"name":"email","in":"query","required":true,"description":"An email address","schema":{"type":"string","description":"An email address"}},{"name":"fix-typos","in":"query","required":false,"description":"Automatically attempt to fix typos in the address","schema":{"type":"boolean","default":false,"description":"Automatically attempt to fix typos in the address"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/geocode-address":{"get":{"operationId":"communication_neutrinoapi_geocode_address","summary":"Geocode Address","description":"GET /geocode-address","tags":["communication"],"parameters":[{"name":"address","in":"query","required":false,"description":"The full address, partial address or name of a place to try and locate. Comma separated address components are preferred.","schema":{"type":"string","description":"The full address, partial address or name of a place to try and locate. Comma separated address components are preferred."}},{"name":"house-number","in":"query","required":false,"description":"The house/building number to locate","schema":{"type":"string","description":"The house/building number to locate"}},{"name":"street","in":"query","required":false,"description":"The street/road name to locate","schema":{"type":"string","description":"The street/road name to locate"}},{"name":"city","in":"query","required":false,"description":"The city/town name to locate","schema":{"type":"string","description":"The city/town name to locate"}},{"name":"county","in":"query","required":false,"description":"The county/region name to locate","schema":{"type":"string","description":"The county/region name to locate"}},{"name":"state","in":"query","required":false,"description":"The state name to locate","schema":{"type":"string","description":"The state name to locate"}},{"name":"postal-code","in":"query","required":false,"description":"The postal code to locate","schema":{"type":"string","description":"The postal code to locate"}},{"name":"country-code","in":"query","required":false,"description":"Limit result to this country (the default is no country bias)","schema":{"type":"string","description":"Limit result to this country (the default is no country bias)"}},{"name":"language-code","in":"query","required":false,"description":"The language to display results in, available languages are: de, en, es, fr, it, pt, ru, zh","schema":{"type":"string","default":"en","description":"The language to display results in, available languages are: de, en, es, fr, it, pt, ru, zh"}},{"name":"fuzzy-search","in":"query","required":false,"description":"If no matches are found for the given address, start performing a recursive fuzzy search until a geolocation is found. This option is…","schema":{"type":"boolean","default":false,"description":"If no matches are found for the given address, start performing a recursive fuzzy search until a geolocation is found. This option is…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/geocode-reverse":{"get":{"operationId":"communication_neutrinoapi_geocode_reverse","summary":"Geocode Reverse","description":"GET /geocode-reverse","tags":["communication"],"parameters":[{"name":"latitude","in":"query","required":true,"description":"The location latitude in decimal degrees format","schema":{"type":"string","description":"The location latitude in decimal degrees format"}},{"name":"longitude","in":"query","required":true,"description":"The location longitude in decimal degrees format","schema":{"type":"string","description":"The location longitude in decimal degrees format"}},{"name":"language-code","in":"query","required":false,"description":"The language to display results in, available languages are: de, en, es, fr, it, pt, ru","schema":{"type":"string","default":"en","description":"The language to display results in, available languages are: de, en, es, fr, it, pt, ru"}},{"name":"zoom","in":"query","required":false,"description":"The zoom level to respond with: address - the most precise address available street - the street level city - the city level state - the…","schema":{"type":"string","default":"address","description":"The zoom level to respond with: address - the most precise address available street - the street level city - the city level state - the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/hlrlookup":{"get":{"operationId":"communication_neutrinoapi_hlrlookup","summary":"HLR Lookup","description":"GET /hlr-lookup","tags":["communication"],"parameters":[{"name":"number","in":"query","required":true,"description":"A phone number","schema":{"type":"string","description":"A phone number"}},{"name":"country-code","in":"query","required":false,"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…","schema":{"type":"string","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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/host-reputation":{"get":{"operationId":"communication_neutrinoapi_host_reputation","summary":"Host Reputation","description":"GET /host-reputation","tags":["communication"],"parameters":[{"name":"host","in":"query","required":true,"description":"An IP address, domain name, FQDN or URL. If you supply a domain/URL it will be checked against the URI DNSBL lists","schema":{"type":"string","description":"An IP address, domain name, FQDN or URL. If you supply a domain/URL it will be checked against the URI DNSBL lists"}},{"name":"list-rating","in":"query","required":false,"description":"Only check lists with this rating or better","schema":{"type":"integer","default":3,"description":"Only check lists with this rating or better"}},{"name":"zones","in":"query","required":false,"description":"Only check these DNSBL zones/hosts. Multiple zones can be supplied as comma-separated values","schema":{"type":"string","description":"Only check these DNSBL zones/hosts. Multiple zones can be supplied as comma-separated values"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/htmlclean":{"post":{"operationId":"communication_neutrinoapi_htmlclean","summary":"HTML Clean","description":"POST /html-clean","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/htmlrender":{"post":{"operationId":"communication_neutrinoapi_htmlrender","summary":"HTML Render","description":"POST /html-render","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/image-resize":{"post":{"operationId":"communication_neutrinoapi_image_resize","summary":"Image Resize","description":"POST /image-resize","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/image-watermark":{"post":{"operationId":"communication_neutrinoapi_image_watermark","summary":"Image Watermark","description":"POST /image-watermark","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/ipblocklist":{"get":{"operationId":"communication_neutrinoapi_ipblocklist","summary":"IP Blocklist","description":"GET /ip-blocklist","tags":["communication"],"parameters":[{"name":"ip","in":"query","required":true,"description":"An IPv4 or IPv6 address. Accepts standard IP notation (with or without port number), CIDR notation and IPv6 compressed notation. If…","schema":{"type":"string","description":"An IPv4 or IPv6 address. Accepts standard IP notation (with or without port number), CIDR notation and IPv6 compressed notation. If…"}},{"name":"vpn-lookup","in":"query","required":false,"description":"Include public VPN provider IP addresses. NOTE : For more advanced VPN detection including the ability to identify private and stealth…","schema":{"type":"boolean","default":false,"description":"Include public VPN provider IP addresses. NOTE : For more advanced VPN detection including the ability to identify private and stealth…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/ipblocklist-download":{"get":{"operationId":"communication_neutrinoapi_ipblocklist_download","summary":"IP Blocklist Download","description":"GET /ip-blocklist-download","tags":["communication"],"parameters":[{"name":"format","in":"query","required":false,"description":"The data format. Can be either CSV or TXT","schema":{"type":"string","default":"csv","description":"The data format. Can be either CSV or TXT"}},{"name":"include-vpn","in":"query","required":false,"description":"Include public VPN provider addresses, this option is only available for Tier 3 or higher accounts. Adds any IPs which are solely listed…","schema":{"type":"boolean","default":false,"description":"Include public VPN provider addresses, this option is only available for Tier 3 or higher accounts. Adds any IPs which are solely listed…"}},{"name":"cidr","in":"query","required":false,"description":"Output IPs using CIDR notation. This option should be preferred but is off by default for backwards compatibility","schema":{"type":"boolean","default":false,"description":"Output IPs using CIDR notation. This option should be preferred but is off by default for backwards compatibility"}},{"name":"ip6","in":"query","required":false,"description":"Output the IPv6 version of the blocklist, the default is to output IPv4 only. Note that this option enables CIDR notation too as this is…","schema":{"type":"boolean","default":false,"description":"Output the IPv6 version of the blocklist, the default is to output IPv4 only. Note that this option enables CIDR notation too as this is…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/ipinfo":{"get":{"operationId":"communication_neutrinoapi_ipinfo","summary":"IP Info","description":"GET /ip-info","tags":["communication"],"parameters":[{"name":"ip","in":"query","required":true,"description":"IPv4 or IPv6 address","schema":{"type":"string","description":"IPv4 or IPv6 address"}},{"name":"reverse-lookup","in":"query","required":false,"description":"Do a reverse DNS (PTR) lookup. This option can add extra delay to the request so only use it if you need it","schema":{"type":"boolean","default":false,"description":"Do a reverse DNS (PTR) lookup. This option can add extra delay to the request so only use it if you need it"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/ipprobe":{"get":{"operationId":"communication_neutrinoapi_ipprobe","summary":"IP Probe","description":"GET /ip-probe","tags":["communication"],"parameters":[{"name":"ip","in":"query","required":true,"description":"IPv4 or IPv6 address","schema":{"type":"string","description":"IPv4 or IPv6 address"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/phone-playback":{"post":{"operationId":"communication_neutrinoapi_phone_playback","summary":"Phone Playback","description":"POST /phone-playback","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/phone-validate":{"get":{"operationId":"communication_neutrinoapi_phone_validate","summary":"Phone Validate","description":"GET /phone-validate","tags":["communication"],"parameters":[{"name":"number","in":"query","required":true,"description":"A phone number. This can be in international format (E.164) or local format. If passing local format you must also set either the…","schema":{"type":"string","description":"A phone number. This can be in international format (E.164) or local format. If passing local format you must also set either the…"}},{"name":"country-code","in":"query","required":false,"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…","schema":{"type":"string","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…"}},{"name":"ip","in":"query","required":false,"description":"Pass in a users IP address and we will assume numbers are based in the country of the IP address","schema":{"type":"string","description":"Pass in a users IP address and we will assume numbers are based in the country of the IP address"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/phone-verify":{"post":{"operationId":"communication_neutrinoapi_phone_verify","summary":"Phone Verify","description":"POST /phone-verify","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/qrcode":{"post":{"operationId":"communication_neutrinoapi_qrcode","summary":"QR Code","description":"POST /qr-code","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/smsverify":{"post":{"operationId":"communication_neutrinoapi_smsverify","summary":"SMS Verify","description":"POST /sms-verify","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/ualookup":{"get":{"operationId":"communication_neutrinoapi_ualookup","summary":"UA Lookup","description":"GET /ua-lookup","tags":["communication"],"parameters":[{"name":"ua","in":"query","required":true,"description":"The user-agent string to lookup. For client hints use the 'UA' header or the JSON data directly from 'navigator.userAgentData.brands' or…","schema":{"type":"string","description":"The user-agent string to lookup. For client hints use the 'UA' header or the JSON data directly from 'navigator.userAgentData.brands' or…"}},{"name":"ua-version","in":"query","required":false,"description":"For client hints this corresponds to the 'UA-Full-Version' header or 'uaFullVersion' from NavigatorUAData","schema":{"type":"string","description":"For client hints this corresponds to the 'UA-Full-Version' header or 'uaFullVersion' from NavigatorUAData"}},{"name":"ua-platform","in":"query","required":false,"description":"For client hints this corresponds to the 'UA-Platform' header or 'platform' from NavigatorUAData","schema":{"type":"string","description":"For client hints this corresponds to the 'UA-Platform' header or 'platform' from NavigatorUAData"}},{"name":"ua-platform-version","in":"query","required":false,"description":"For client hints this corresponds to the 'UA-Platform-Version' header or 'platformVersion' from NavigatorUAData","schema":{"type":"string","description":"For client hints this corresponds to the 'UA-Platform-Version' header or 'platformVersion' from NavigatorUAData"}},{"name":"ua-mobile","in":"query","required":false,"description":"For client hints this corresponds to the 'UA-Mobile' header or 'mobile' from NavigatorUAData","schema":{"type":"string","description":"For client hints this corresponds to the 'UA-Mobile' header or 'mobile' from NavigatorUAData"}},{"name":"device-model","in":"query","required":false,"description":"For client hints this corresponds to the 'UA-Model' header or 'model' from NavigatorUAData. You can also use this parameter to lookup a…","schema":{"type":"string","description":"For client hints this corresponds to the 'UA-Model' header or 'model' from NavigatorUAData. You can also use this parameter to lookup a…"}},{"name":"device-brand","in":"query","required":false,"description":"This parameter is only used in combination with 'device-model' when doing direct device lookups without any user-agent data. Set this to…","schema":{"type":"string","description":"This parameter is only used in combination with 'device-model' when doing direct device lookups without any user-agent data. Set this to…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/urlinfo":{"get":{"operationId":"communication_neutrinoapi_urlinfo","summary":"URL Info","description":"GET /url-info","tags":["communication"],"parameters":[{"name":"url","in":"query","required":true,"description":"The URL to probe","schema":{"type":"string","description":"The URL to probe"}},{"name":"fetch-content","in":"query","required":false,"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…","schema":{"type":"boolean","default":false,"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…"}},{"name":"ignore-certificate-errors","in":"query","required":false,"description":"Ignore any TLS/SSL certificate errors and load the URL anyway","schema":{"type":"boolean","default":false,"description":"Ignore any TLS/SSL certificate errors and load the URL anyway"}},{"name":"timeout","in":"query","required":false,"description":"Timeout in seconds. Give up if still trying to load the URL after this number of seconds","schema":{"type":"integer","default":60,"description":"Timeout in seconds. Give up if still trying to load the URL after this number of seconds"}},{"name":"retry","in":"query","required":false,"description":"If the request fails for any reason try again this many times","schema":{"type":"integer","default":0,"description":"If the request fails for any reason try again this many times"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:neutrinoapi/verify-security-code":{"get":{"operationId":"communication_neutrinoapi_verify_security_code","summary":"Verify Security Code","description":"GET /verify-security-code","tags":["communication"],"parameters":[{"name":"security-code","in":"query","required":true,"description":"The security code to verify","schema":{"type":"string","description":"The security code to verify"}},{"name":"limit-by","in":"query","required":false,"description":"If set then enable additional brute-force protection by limiting the number of attempts by the supplied value. This can be set to any…","schema":{"type":"string","description":"If set then enable additional brute-force protection by limiting the number of attempts by the supplied value. This can be set to any…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}