Before we start, we’d like to emphasize that we’re so happy to have you aboard. We hope that by integrating our services into your app we can make it safer than ever before. But, we’ll also need to agree on how you’ll integrate us in your app, and what you’ll tell your users about it.
How to inform your users
You must not:
- ❌ Act as if you have a partnership, collaboration or otherwise special status with Checkjelinkje and/or Freave.
- ❌ Give users a false sense of security by indicating a link is guaranteed to be safe, if not flagged by us.
- ❌ Cache API responses for more than one hour.
- ✅ Display one of our badges where the processing of links takes place.
- ✅ Always use HTTPS to perform checks with our API.
You’re advised to:
- Subscribe to API updates, so that you’re aware of any changes.
We’d like it to be clear to your end users that the links they share/add/use in your app, are checked by us. Therefore we require you to display the underneath badges near the element of your app where the processing of the links takes place. If you’re unable to use these badges, you must not use our API.
You’re free to download the SVG’s above and host them yourself. For ease of use we also provide CDN-hosted assets. You’ll find their embed codes below.
Displaying warnings to users
Depending on what our API returns you may or must display some form of warning. For examples of how you could phrase these warnings, see checkjelinkje.nl.
Display a warning for phishing sites
When our API indicates that a URL definitely contains phishing (
is_su_safe === false), you must indicate to your users that this is the case.
We, or one of our partners, have then determined that the site is guaranteed to contain phishing. You may also prevent a user from clicking the link, optionally with an option to skip the warning.
Display a warning for
When our API returns
true for the “no bank site warning”-property you may display a warning to your users, that indicates that the URL doesn’t designate to an official banking website. You’re best
suited to determine if this warning is relevant to your users. If they’d expect a banking site, this warning is very relevant. If you only check non-banking related URL’s, it might not.