CodeConstant (Not sure if needed)DescriptionSolution
1API_MAX_REDIRECT_CODECode when api get max number of redirects for checking url. Every company contain value of maximum number or redirects in settings. In case when checked url contain number of redirects bigger that value from company settings, PhishProtection will return error message with this code.You must avoid urls with too many redirects. <sub>Or raise number of redirect value in company's settings</sub>
100MSG_CODE_COMPANY_LOAD_ERRORCode when company id is invalid or cannot load company from database. This message is triggered when we have some error on load company from database. On every request to PhishProtection API, you must send query param id with company public id value. This id is used to identify your company. <br><sub>Example: https://urlf.phishprotection.local/?url=example.com&id=95ee&rcpt=user@mexample.com&tss=1559976239&msgid=7584611b-8e55-4b06-a6f8-48d52d3a5e1b&h=015346ba.</sub>Check company's public id from your request query params. In other case contact administrator or developer to resolve this problem
101MSG_CODE_NOT_CONFIG_COMPANYCode when company is not FULL configured. Every company contain required settings. In some cases, company do not contain all needed values.You must update your company's settings on portal side
200MSG_CODE_INVALID_IDCode when company id is invalid. On every request to PhishProtection api, you must send query param id with company public id value. This id is used to identify your company. <br><sub>Example: https://urlf.phishprotection.local/?url=example.com&id=95ee&rcpt=user@mexample.com&tss=1559976239&msgid=7584611b-8e55-4b06-a6f8-48d52d3a5e1b&h=015346ba.</sub>Check company's public id from your request to API.
201MSG_CODE_MISSING_URLCode when missing url value in your request. On every request to PhishProtection API, you must send query param url, with url value what you need to check. <br><sub>Example: https://urlf.phishprotection.local/?url=example.com&id=95ee&rcpt=user@mexample.com&tss=1559976239&msgid=7584611b-8e55-4b06-a6f8-48d52d3a5e1b&h=015346ba.</sub>Check if required url value is not missing in your request and value is right.
202MSG_CODE_MISSING_IDCode when company id is missing in request url. On every request to PhishProtection API, you must send query param id with company public id value. This id is used to identify your company. <br><sub>Example: https://urlf.phishprotection.local/?url=example.com&id=95ee&rcpt=user@mexample.com&tss=1559976239&msgid=7584611b-8e55-4b06-a6f8-48d52d3a5e1b&h=015346ba.</sub>Add you company's public id in you request to PhishProtection API.
203MSG_CODE_MISSING_HASHCode when missing hash in query request. On every request to PhishProtection API, you must send query param h with hash value of you request. This hash is used to validate your request. <br><sub>Example: https://urlf.phishprotection.local/?url=example.com&id=95ee&rcpt=user@mexample.com&tss=1559976239&msgid=7584611b-8e55-4b06-a6f8-48d52d3a5e1b&h=015346ba.</sub>Add hash to your request query params values
204MSG_CODE_INVALID_HASHCode when hash is invalid. On every request to PhishProtection API, you must send query param h with hash value of you request. This hash is used to validate your request. <br><sub>Example: https://urlf.phishprotection.local/?url=example.com&id=95ee&rcpt=user@mexample.com&tss=1559976239&msgid=7584611b-8e55-4b06-a6f8-48d52d3a5e1b&js=1&multi=1&h=015346ba.</sub>Check if full url is hashed and hash has right value
205MSG_CODE_INVALID_QUERYCode when query is invalid or missing. On every request to PhishProtection API, you must send required query params. <br><sub>Example: https://urlf.phishprotection.local/?url=example.com&id=95ee&rcpt=user@mexample.com&tss=1559976239&msgid=7584611b-8e55-4b06-a6f8-48d52d3a5e1b&h=015346ba.</sub>Check if your request contain all needed query params.