Light API

Light API

Here you’ll find all the documentation you need in order to get started with the Checkjelinkje Light API.

The Safe URL response object

ParameterDescription
urlThe given URL.
effective_urlWith the regular check, this is the final URL after following redirects. For the Light API this is always the same as the url parameter.
properties.is_bank_urlWhether the URL is part of an official Dutch banking website.
properties.is_su_safefalse if we (or our partners) have determined that the URL contains phishing.
properties.is_tlsWhether the URL uses TLS/HTTPS.
properties.is_no_bank_site_warningtrue when the URL might imitate a banking site, when in fact it’s not.

Performing a check

  • Endpoint: https://api.checkyourlink.net/v2/consumer-apis/light-check
  • Method: POST
  • Authentication: none

When you start using this API, you agree to our API License, Privacy Policy and brand guidelines.

Example body

{
  "safe_url_request": {
    "url": "https://www.checkjelinkje.nl/"
  }
}

Example response

{
    "data": {
        "url": "https:\/\/www.checkjelinkje.nl\/",
        "effective_url": "https:\/\/www.checkjelinkje.nl\/",
        "properties": {
            "is_bank_url": false,
            "is_su_safe": true,
            "is_tls": true,
            "is_no_bank_site_warning": false
        },
        "remarks": []
    },
    "error": [],
    "success": true
}

Example request

POST /v2/consumer-apis/light-check HTTP/1.1
Host: api.checkyourlink.net
Content-Type: application/json
User-Agent: YourApplication/1.1
Accept: application/json
Cache-Control: no-cache
Content-Length: 70
Connection: keep-alive
cache-control: no-cache

{
	"safe_url_request": {
		"url": "https://www.checkjelinkje.nl/"
	}
}