Introducing the HackCheck API, offering individuals and companies a way to seamlessly integrate our search engine into your systems.
\nHow you can get started
\nTo get started you have to purchase a HackCheck plan that has API access. You can purchase a plan here.
\nTo authorize a search request you must have the following:
\nIn the case of any error response you can expect the following:
\nIn the case of a successful query request you can expect the following:
\nA 'X-HackCheck-Limit' header
\nThis header is an integer that represents the total requests you can make to the API in one second.
\nA 'X-HackCheck-Remaining' header
\nThis header is an integer that represents the remaining requests you can send in the next second before getting rate limited.
\nIn the case you have any questions, you can visit our FAQ page hackcheck.io/frequently-asked-questions. If this isn't helpful you can contact us at support@hackcheck.io.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"26427470","collectionId":"119afde2-ad57-4aee-99a9-0164a9eec6cd","publishedId":"2s9Xy5MWUd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-08-14T05:06:11.000Z"},"item":[{"name":"Searching","item":[{"name":"Normal Search","id":"3e4eaaea-d84f-4684-b2b7-0c67dc86d8b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hackcheck.io/search/:api_key/email/my-email@domain.com","description":"This endpoint allows users to perform searches on the HackCheck database.
\n","urlObject":{"path":["search",":api_key","email","my-email@domain.com"],"host":["https://api.hackcheck.io"],"query":[],"variable":[]}},"response":[{"id":"b0a3fb6f-732e-4cd1-ad66-522837f8fdc1","name":"OK","originalRequest":{"method":"GET","header":[],"url":"https://api.hackcheck.io/search/your-API-key/email/my-email@domain.com"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-HackCheck-Limit","value":"5","description":"","type":"text"},{"key":"X-HackCheck-Remaining","value":"4","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"found\": 1,\n \"databases\": 1,\n \"first_seen\": \"2020-02\",\n \"last_seen\": \"2020-02\",\n \"elapsed\": \"5ms\",\n \"results\": [\n {\n \"email\": \"my-email@domain.com\",\n \"password\": \"Password123\",\n \"full_name\": \"John Smith\",\n \"username\": \"john_smith\",\n \"ip_address\": \"1.1.1.1\",\n \"phone_number\": \"1112223333\",\n \"hash\": \"5d41402abc4b2a76b9719d911017c592\",\n \"source\": {\n \"name\": \"website.com\",\n \"date\": \"2020-02\"\n }\n }\n ]\n}"}],"_postman_id":"3e4eaaea-d84f-4684-b2b7-0c67dc86d8b4"},{"name":"How to Pagination","id":"148d1365-bf53-40ba-8e71-d3cbc97b311a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hackcheck.io/search/:api_key/email/my-email@domain.com?offset=0&limit=5","description":"The parameters shown here will allow you to paginate the results.
\nuse the offset and limit parameter to paginate results.
\nWhen both of these parameters are present another JSON object called 'pagination' will be in the response.
\nThe pagination object will include three values
\nnext: the offset and limit value to receive the next page of results ~ null if no page
\nprev: the offset and limit value to receive the previous page of results ~ null if no page
\ndocument_count: the total number of unique results found for the search term
\nIn some cases 'found' may be different from 'pagination.document_count', this is because 'found' does not account for dupelicate results while 'pagination.document_count' does.
\n","urlObject":{"path":["search",":api_key","email","my-email@domain.com"],"host":["https://api.hackcheck.io"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"5"}],"variable":[]}},"response":[{"id":"4e4d7e80-5037-4801-93fd-6bf88f5ddbe8","name":"Pagination","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.hackcheck.io/search/your-API-key/email/my-email@domain.com?offset=0&limit=5","protocol":"https","host":["api","hackcheck","io"],"path":["search","your-API-key","email","my-email@domain.com"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-HackCheck-Limit","value":"5","description":"","type":"text"},{"key":"X-HackCheck-Remaining","value":"4","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"found\": 500,\n \"databases\": 10,\n \"first_seen\": \"2010-05\",\n \"last_seen\": \"2020-10\",\n \"elapsed\": \"5ms\",\n \"pagination\": {\n \"next\": {\n \"offset\": 5,\n \"limit\": 5\n },\n \"prev\": null,\n \"document_count\": 400\n },\n \"results\": [\n {\n \"email\": \"my-email@domain.com\",\n \"password\": \"pass-word\",\n \"full_name\": \"\",\n \"username\": \"\",\n \"ip_address\": \"1.2.3.4\",\n \"phone_number\": \"\",\n \"hash\": \"\",\n \"source\": {\n \"name\": \"a-website.com\",\n \"date\": \"2017-03\"\n }\n },\n {\n \"email\": \"my-email@domain.com\",\n \"password\": \"\",\n \"full_name\": \"email user\",\n \"username\": \"\",\n \"ip_address\": \"\",\n \"phone_number\": \"\",\n \"hash\": \"\",\n \"source\": {\n \"name\": \"www.website.com\",\n \"date\": \"2020-10\"\n }\n },\n {\n \"email\": \"my-email@domain.com\",\n \"password\": \"\",\n \"full_name\": \"\",\n \"username\": \"\",\n \"ip_address\": \"\",\n \"phone_number\": \"1112223333\",\n \"hash\": \"\",\n \"source\": {\n \"name\": \"url.com\",\n \"date\": \"2015-01\"\n }\n },\n {\n \"email\": \"my-email@domain.com\",\n \"password\": \"superPassword123\",\n \"full_name\": \"\",\n \"username\": \"kingUsername\",\n \"ip_address\": \"\",\n \"phone_number\": \"\",\n \"hash\": \"\",\n \"source\": {\n \"name\": \"internet.org\",\n \"date\": \"2010-05\"\n }\n },\n {\n \"email\": \"my-email@domain.com\",\n \"password\": \"\",\n \"full_name\": \"internet user\",\n \"username\": \"\",\n \"ip_address\": \"\",\n \"phone_number\": \"\",\n \"hash\": \"\",\n \"source\": {\n \"name\": \"example.com\",\n \"date\": \"2014-08\"\n }\n }\n ]\n}"}],"_postman_id":"148d1365-bf53-40ba-8e71-d3cbc97b311a"},{"name":"How to Filter Results","id":"00f7d4ea-cd0d-4c39-9d71-e672af19550c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hackcheck.io/search/:api_key/email/my-email@domain.com?filter=use&databases=website.com,website.org","description":"Use the filter and databases parameters to filter the data sources the results can or cannot come from.
\nThese parameters do not change the response body object, they only change what documents are returned.
\nfilter has two values
\nuse: if filter is assigned the use value it will only return documents from the provided databases list
\nignore: if filter is assigned the ignore value it will not return documenst from the provided databases list
\nThe databases parameter tells the API which data sources you want to use or ignore, you can specify one or more data sources, an example can be seen below:
\ndatabases=website.org
\ndatabases=website.org,website.com,website.net
\n","urlObject":{"path":["search",":api_key","email","my-email@domain.com"],"host":["https://api.hackcheck.io"],"query":[{"key":"filter","value":"use"},{"key":"databases","value":"website.com,website.org"}],"variable":[]}},"response":[{"id":"e270b585-07cd-435d-ae24-47da063877d4","name":"Filtering Data Sources","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.hackcheck.io/search/:api_key/email/my-email@domain.com?filter=use&databases=website.com,website.org","host":["https://api.hackcheck.io"],"path":["search",":api_key","email","my-email@domain.com"],"query":[{"key":"filter","value":"use"},{"key":"databases","value":"website.com,website.org"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-HackCheck-Limit","value":"5","description":"","type":"text"},{"key":"X-HackCheck-Remaining","value":"4","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"found\": 0,\n \"databases\": 0,\n \"first_seen\": \"\",\n \"last_seen\": \"\",\n \"elapsed\": \"5ms\",\n \"results\": []\n}"}],"_postman_id":"00f7d4ea-cd0d-4c39-9d71-e672af19550c"},{"name":"Formatting","id":"10b66687-ea17-4c4c-a729-4417c04ef57f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hackcheck.io/search/:api_key/email/my-email@domain.com?format=json","description":"The parameters shown here will allow you to specify the format of the results.
We currently offer two formats
When exporting as TSV the header is as follows:
\nemail, password, full_name, username, ip_address, phone_number, hash, source_name, source_date
\n","urlObject":{"path":["search",":api_key","email","my-email@domain.com"],"host":["https://api.hackcheck.io"],"query":[{"key":"format","value":"json"}],"variable":[]}},"response":[{"id":"69281f70-ade6-4423-a9d0-bbb961a6a97c","name":"JSON","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.hackcheck.io/search/:api_key/email/my-email@domain.com?format=json","host":["https://api.hackcheck.io"],"path":["search",":api_key","email","my-email@domain.com"],"query":[{"key":"format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"found\": 2,\n \"databases\": 1,\n \"first_seen\": \"2020-01\",\n \"last_seen\": \"2020-01\",\n \"elapsed\": \"19ms\",\n \"upgrade\": false,\n \"results\": [\n {\n \"email\": \"email@email.com\",\n \"password\": \"Password1\",\n \"full_name\": \"bob jones\",\n \"username\": \"bob_jones21\",\n \"ip_address\": \"1.1.1.1\",\n \"phone_number\": \"123456789\",\n \"hash\": \"5d41402abc4b2a76b9719d911017c59\",\n \"source\": {\n \"name\": \"website.com\",\n \"date\": \"2020-01\"\n }\n },\n {\n \"email\": \"email@email.com\",\n \"password\": \"SecurePassword123\",\n \"full_name\": \"josh smith\",\n \"username\": \"jsmith87\",\n \"ip_address\": \"2.2.2.2\",\n \"phone_number\": \"987654321\",\n \"hash\": \"49f68a5c8493ec2c0bf489821c21fc3b\",\n \"source\": {\n \"name\": \"website.com\",\n \"date\": \"2020-01\"\n }\n }\n ]\n}"},{"id":"a7edf183-66b0-47a0-b36f-3d1b29a0b019","name":"TSV","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.hackcheck.io/search/:api_key/email/my-email@domain.com?format=tsv","host":["https://api.hackcheck.io"],"path":["search",":api_key","email","my-email@domain.com"],"query":[{"key":"format","value":"tsv"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":"email\tpassword\tfull_name\tusername\tip_address\tphone_number\thash\tsource_name\tsource_date\nemail@email.com\tPassword1 bob jones bob_jones21 1.1.1.1 123456789 5d41402abc4b2a76b9719d911017c59 website.com 2020-01\nemail@email.com\tSecurePassword123 josh smith jsmith87 2.2.2.2 987654321 49f68a5c8493ec2c0bf489821c21fc3b website.com 2020-01"}],"_postman_id":"10b66687-ea17-4c4c-a729-4417c04ef57f"}],"id":"a7302d69-e776-4705-b997-dd6fdd0b04d4","description":"These requests go over how to use HackCheck's API to perform queries, as well as the different features you can take advantage.
\napi.hackcheck.io/search/:api_key/:type/:term
\nBelow are the type values HackCheck supports:
\nThis endpoint allows users to quickly check if what they're searching is in the the HackCheck database.
\n","urlObject":{"path":["search","check",":api_key","email","my-email@domain.com"],"host":["https://api.hackcheck.io"],"query":[],"variable":[]}},"response":[{"id":"44080fbf-d4a9-4c6b-86f9-962734cac89b","name":"OK","originalRequest":{"method":"GET","header":[],"url":"https://api.hackcheck.io/search/check/:api_key/email/my-email@domain.com"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-HackCheck-Limit","value":"5","description":"","type":"text"},{"key":"X-HackCheck-Remaining","value":"4","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"found\": true\n}"}],"_postman_id":"2a22bf91-2404-4649-a8e3-290d1e1a024c"}],"id":"7ab3bad2-162b-4024-b396-396905ae9f8c","description":"These requests go over how to use HackCheck's API to perform checks.
\napi.hackcheck.io/search/check/:api_key/:type/:term
\napi_key ~ your accounts API key
\ntype ~ the data type you're searching for
\nterm ~ the term you're searching for
\nBelow are the type values HackCheck supports:
\npassword
\nusername
\nfull_name
\nip_address
\nphone_number
\nhash
\ndomain
\nGet a list of all breach monitors on your account.
\n","urlObject":{"path":["monitors",":api_key","list"],"host":["https://api.hackcheck.io"],"query":[],"variable":[]}},"response":[{"id":"076d5ffb-3413-4916-bc24-03b192a9ae9f","name":"Response","originalRequest":{"method":"GET","header":[],"url":"https://api.hackcheck.io/monitors/:api_key/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"asset_monitors\": [\n {\n \"id\": \"monitor_id\",\n \"status\": 0,\n \"type\": \"username\",\n \"asset\": \"my_username\",\n \"notification_email\": \"email@mail.com\",\n \"expires_soon\": false,\n \"created_at\": \"2024-01-01T00:00:00.00Z\",\n \"ends_at\": \"2025-01-01T00:00:00.00Z\"\n },\n {\n \"id\": \"monitor_id\",\n \"status\": 1,\n \"type\": \"email\",\n \"asset\": \"personal@gmail.com\",\n \"notification_email\": \"randomtest@gmail.com\",\n \"expires_soon\": true,\n \"created_at\": \"2024-01-20T00:00:00.00Z\",\n \"ends_at\": \"2024-01-22T00:00:00.00Z\"\n }\n ],\n \"domain_monitors\": [\n {\n \"id\": \"monitor_id\",\n \"status\": 0,\n \"domain\": \"hackcheck.io\",\n \"notification_email\": \"admin@hackcheck.io\",\n \"expires_soon\": false,\n \"created_at\": \"2023-10-00T00:00:00.00Z\",\n \"ends_at\": \"2025-01-01T00:00:00.00Z\"\n }\n ]\n}"}],"_postman_id":"fc5f541a-aff1-4e73-b694-225be4ba7611"},{"name":"List One Asset Monitor","id":"4b1d5477-56a0-42d8-88be-83c9c0ec49b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.hackcheck.io/monitors/:api_key/list/asset/:monitor_id","description":"Get a specific asset monitor.
\n","urlObject":{"path":["monitors",":api_key","list","asset",":monitor_id"],"host":["https://api.hackcheck.io"],"query":[],"variable":[{"type":"any","value":"","key":"monitor_id"}]}},"response":[{"id":"1f6433cb-0c96-4058-9f61-3d055d087061","name":"Response","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.hackcheck.io/monitors/:api_key/list/asset/:monitor_id","host":["https://api.hackcheck.io"],"path":["monitors",":api_key","list","asset",":monitor_id"],"variable":[{"key":"monitor_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 25 Feb 2024 15:51:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=BDOp7ko%2B3zvW3B1ngNas0j1D6vu6tGVmnDbuBg7glfqCyNFJ7L9nBzeUXJ0t8hOqiiD3Q3h0qk6F4hsVmqtf7e1cr%2BsJh%2FjzyFRRoP1n%2FaIHCWTHf5n50I%2FKg1ZLtm9tOO8%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"85b11baf6d1fc34d-EWR"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"65cba605e6378e9241ce3694\",\n \"status\": 0,\n \"type\": \"username\",\n \"asset\": \"my_username\",\n \"notification_email\": \"email@mail.com\",\n \"expires_soon\": false,\n \"created_at\": \"2024-01-01T00:00:00.00Z\",\n \"ends_at\": \"2025-01-01T00:00:00.00Z\"\n}"}],"_postman_id":"4b1d5477-56a0-42d8-88be-83c9c0ec49b6"},{"name":"List One Domain Monitor","id":"ef6317a4-6371-4253-b04f-e4346066fde3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.hackcheck.io/monitors/:api_key/list/domain/:monitor_id","description":"Get a specific domain monitor.
\n","urlObject":{"path":["monitors",":api_key","list","domain",":monitor_id"],"host":["https://api.hackcheck.io"],"query":[],"variable":[{"id":"c07a3356-2ab3-44db-ba86-c486406d0f04","description":{"content":"your breach monitor ID
\n","type":"text/plain"},"type":"any","value":"","key":"monitor_id"}]}},"response":[{"id":"4b9d168b-077f-48c4-be34-ed70f298959f","name":"Response","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.hackcheck.io/monitors/:api_key/list/:monitor_id","host":["https://api.hackcheck.io"],"path":["monitors",":api_key","list",":monitor_id"],"variable":[{"key":"monitor_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6521da37ed2d44abde597a83\",\n \"status\": 0,\n \"domain\": \"domain.org\",\n \"notification_email\": \"notify@domain.org\",\n \"expires_soon\": false,\n \"created_at\": \"2023-10-00T00:00:00.00Z\",\n \"ends_at\": \"2025-01-01T00:00:00.00Z\"\n}"}],"_postman_id":"ef6317a4-6371-4253-b04f-e4346066fde3"},{"name":"View Asset Monitor Sources","id":"8c2ff77b-f082-4421-a842-d8944fa050ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.hackcheck.io/monitors/:api_key/sources/asset/:monitor_id","description":"This request will return a list of sources your information/domain is found in.
\n","urlObject":{"path":["monitors",":api_key","sources","asset",":monitor_id"],"host":["https://api.hackcheck.io"],"query":[],"variable":[{"id":"adfdbc14-d755-47cf-ab95-b8e4fa666147","description":{"content":"your breach monitor ID
\n","type":"text/plain"},"type":"any","value":"","key":"monitor_id"}]}},"response":[{"id":"372bf6ca-ea2b-46e2-9f96-b4cfd4bd1162","name":"Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.hackcheck.io/monitors/:api_key/sources/asset/:monitor_id","host":["https://api.hackcheck.io"],"path":["monitors",":api_key","sources","asset",":monitor_id"],"variable":[{"key":"monitor_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"Example.com\",\n \"date\": \"2022-10\"\n },\n {\n \"name\": \"Website.org\",\n \"date\": \"2013-05\"\n }\n]"}],"_postman_id":"8c2ff77b-f082-4421-a842-d8944fa050ae"},{"name":"View Domain Monitor Sources","id":"064c87d4-a6a9-4824-bc63-9a56df3be235","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.hackcheck.io/monitors/:api_key/sources/domain/:monitor_id","description":"This request will return a list of sources your information/domain is found in.
\n","urlObject":{"path":["monitors",":api_key","sources","domain",":monitor_id"],"host":["https://api.hackcheck.io"],"query":[],"variable":[{"description":{"content":"your breach monitor ID
\n","type":"text/plain"},"type":"any","value":"","key":"monitor_id"}]}},"response":[{"id":"eea53ceb-e33f-4b47-a998-917228abf0c9","name":"Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.hackcheck.io/monitors/:api_key/sources/domain/:monitor_id","host":["https://api.hackcheck.io"],"path":["monitors",":api_key","sources","domain",":monitor_id"],"variable":[{"key":"monitor_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"Example.com\",\n \"date\": \"2022-10\"\n },\n {\n \"name\": \"Website.org\",\n \"date\": \"2013-05\"\n }\n]"}],"_postman_id":"064c87d4-a6a9-4824-bc63-9a56df3be235"},{"name":"Update Asset Monitor","id":"43efdb88-4f89-4ad5-b748-884f20254e90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"asset_type\": \"username\",\n \"asset\": \"my_username\",\n \"notification_email\": \"notify@mail.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hackcheck.io/monitors/:api_key/update/asset/:monitor_id","description":"This request will update the content of an asset monitor.
\n","urlObject":{"path":["monitors",":api_key","update","asset",":monitor_id"],"host":["https://api.hackcheck.io"],"query":[],"variable":[{"description":{"content":"your breach monitor ID
\n","type":"text/plain"},"type":"any","value":"","key":"monitor_id"}]}},"response":[{"id":"e5bd4914-e451-4aa6-b20b-74ac1481d5db","name":"Response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"asset_type\": \"username\",\n \"asset\": \"my_username\",\n \"notification_email\": \"notify@mail.com\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.hackcheck.io/monitors/:api_key/update/asset/:monitor_id","protocol":"https","host":["api","hackcheck","io"],"path":["monitors",":api_key","update","asset",":monitor_id"],"variable":[{"key":"api_key","value":""},{"key":"monitor_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"monitor_id\",\n \"status\": 0,\n \"type\": \"username\",\n \"asset\": \"my_username\",\n \"notification_email\": \"notify@mail.com\",\n \"expires_soon\": false,\n \"created_at\": \"2024-01-01T00:00:00.00Z\",\n \"ends_at\": \"2025-01-01T00:00:00.00Z\"\n}"}],"_postman_id":"43efdb88-4f89-4ad5-b748-884f20254e90"},{"name":"Update Domain Monitor","id":"aab585b7-41f5-4d73-87f8-227e1057c899","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"domain\": \"domain.org\",\n \"notification_email\": \"notify@domain.org\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hackcheck.io/monitors/:api_key/update/domain/:monitor_id","description":"This request will update the content of a domain monitor.
\n","urlObject":{"path":["monitors",":api_key","update","domain",":monitor_id"],"host":["https://api.hackcheck.io"],"query":[],"variable":[{"description":{"content":"your breach monitor ID
\n","type":"text/plain"},"type":"any","value":"","key":"monitor_id"}]}},"response":[{"id":"1fcbb053-ed60-4d0f-8ae0-a919eda610a7","name":"Response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"domain\": \"domain.org\",\n \"notification_email\": \"notify@domain.org\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.hackcheck.io/monitors/:api_key/update/domain/:monitor_id","protocol":"https","host":["api","hackcheck","io"],"path":["monitors",":api_key","update","domain",":monitor_id"],"variable":[{"key":"api_key","value":""},{"key":"monitor_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6521da37ed2d44abde597a83\",\n \"status\": 0,\n \"domain\": \"domain.org\",\n \"notification_email\": \"notify@domain.org\",\n \"expires_soon\": false,\n \"created_at\": \"2023-10-00T00:00:00.00Z\",\n \"ends_at\": \"2025-01-01T00:00:00.00Z\"\n}"}],"_postman_id":"aab585b7-41f5-4d73-87f8-227e1057c899"},{"name":"Toggle Pause Asset Monitor","id":"a3ebd1c1-bfbc-4fae-bab8-a2d0fc12c8ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.hackcheck.io/monitors/:api_key/pause/asset/:monitor_id","description":"This request will toggle the pause status of an asset monitor.
\nIf the monitor is paused it will become unpaused.
\nIf the monitor is unpaused it will become paused.
\n","urlObject":{"path":["monitors",":api_key","pause","asset",":monitor_id"],"host":["https://api.hackcheck.io"],"query":[],"variable":[{"description":{"content":"your breach monitor ID
\n","type":"text/plain"},"type":"any","value":"","key":"monitor_id"}]}},"response":[{"id":"80c3d8c7-aad9-41d7-959f-80a9bebf8161","name":"Pause Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.hackcheck.io/monitors/:api_key/pause/asset/:monitor_id","protocol":"https","host":["api","hackcheck","io"],"path":["monitors",":api_key","pause","asset",":monitor_id"],"variable":[{"key":"api_key","value":""},{"key":"monitor_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"monitor_id\",\n \"status\": 1,\n \"type\": \"email\",\n \"asset\": \"personal@email.com\",\n \"notification_email\": \"notify@email.com\",\n \"expires_soon\": false,\n \"created_at\": \"2024-01-01T00:00:00.00Z\",\n \"ends_at\": \"2025-01-01T00:00:00.00Z\"\n}"},{"id":"129d5e14-8f99-4194-9203-04fa98833212","name":"Unpause Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.hackcheck.io/monitors/:api_key/pause/asset/:monitor_id","host":["https://api.hackcheck.io"],"path":["monitors",":api_key","pause","asset",":monitor_id"],"variable":[{"key":"monitor_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"monitor_id\",\n \"status\": 0,\n \"type\": \"email\",\n \"asset\": \"personal@email.com\",\n \"notification_email\": \"notify@email.com\",\n \"expires_soon\": false,\n \"created_at\": \"2024-01-01T00:00:00.00Z\",\n \"ends_at\": \"2025-01-01T00:00:00.00Z\"\n}"}],"_postman_id":"a3ebd1c1-bfbc-4fae-bab8-a2d0fc12c8ce"},{"name":"Toggle Pause Domain Monitor","id":"97922918-3f47-416f-b0be-df3f3b75e36e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.hackcheck.io/monitors/:api_key/pause/domain/:monitor_id","description":"This request will toggle the pause status of a domain monitor.
\nIf the monitor is paused it will become unpaused.
\nIf the monitor is unpaused it will become paused.
\n","urlObject":{"path":["monitors",":api_key","pause","domain",":monitor_id"],"host":["https://api.hackcheck.io"],"query":[],"variable":[{"description":{"content":"your breach monitor ID
\n","type":"text/plain"},"type":"any","value":"","key":"monitor_id"}]}},"response":[{"id":"a062bbbe-20e2-42d4-9392-96b0b75ed5c2","name":"Pause Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.hackcheck.io/monitors/:api_key/pause/domain/:monitor_id","protocol":"https","host":["api","hackcheck","io"],"path":["monitors",":api_key","pause","domain",":monitor_id"],"variable":[{"key":"api_key","value":""},{"key":"monitor_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"monitor_id\",\n \"status\": 1,\n \"domain\": \"hackcheck.io\",\n \"notification_email\": \"admin@hackcheck.io\",\n \"expires_soon\": false,\n \"created_at\": \"2023-10-01T00:00:00.00Z\",\n \"ends_at\": \"2024-10-01T00:00:00.00Z\"\n}"},{"id":"fdeeb96b-df9f-42b8-8755-6b36e8e16892","name":"Unpause Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.hackcheck.io/monitors/:api_key/pause/domain/:monitor_id","host":["https://api.hackcheck.io"],"path":["monitors",":api_key","pause","domain",":monitor_id"],"variable":[{"key":"monitor_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"monitor_id\",\n \"status\": 0,\n \"domain\": \"hackcheck.io\",\n \"notification_email\": \"admin@hackcheck.io\",\n \"expires_soon\": false,\n \"created_at\": \"2023-10-01T00:00:00.00Z\",\n \"ends_at\": \"2024-10-01T00:00:00.00Z\"\n}"}],"_postman_id":"97922918-3f47-416f-b0be-df3f3b75e36e"}],"id":"be33a396-e62d-4ed7-a166-b22a13c7fe85","description":"Introducing an API for HackCheck's Breach Monitoring service, making for a simple way to integrate breach monitors into your applications.
\nBelow is a list of different data types you can monitor using an asset monitor:
\nThese values should be used in the 'type' field.
\nUniversal values
\nThese fields are in both asset and domain monitors.
\nAsset Monitor Keys
\nThese fields are only in asset monitors.
\nDomain Monitor Keys
\nThese fields are only in domain monitors.
\n","_postman_id":"be33a396-e62d-4ed7-a166-b22a13c7fe85"},{"name":"Get IP","id":"15cada97-acb9-4ffd-8acf-d88b8dbce1ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hackcheck.io/auth/ip","description":"If you're having trouble getting your IP address you can use this endpoint to fetch your IP, this is also available on your profile page.
\n","urlObject":{"path":["auth","ip"],"host":["https://api.hackcheck.io"],"query":[],"variable":[]}},"response":[{"id":"af85e58c-1852-40bd-855e-a708e0d54700","name":"Get IP","originalRequest":{"method":"GET","header":[],"url":"https://api.hackcheck.io/auth/ip"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"IP\": \"1.1.1.1\"\n}"}],"_postman_id":"15cada97-acb9-4ffd-8acf-d88b8dbce1ce"}],"event":[{"listen":"prerequest","script":{"id":"c2de2f31-2845-450c-b3bf-12cad9d08eaa","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cbd0f75d-ba4e-41cf-bc94-d4dc9d9c9ba0","type":"text/javascript","exec":[""]}}],"variable":[{"key":"APIKey","value":":api_key","type":"string"},{"key":"Type","value":"email","type":"string"},{"key":"Term","value":"my-email@domain.com","type":"string"},{"key":"BaseURL","value":"https://api.hackcheck.io","type":"string"}]}