diff --git a/docs/api-reference/v4/endpoints/get-event.mdx b/docs/api-reference/v4/endpoints/get-event.mdx index eefa074..2b3ebdf 100644 --- a/docs/api-reference/v4/endpoints/get-event.mdx +++ b/docs/api-reference/v4/endpoints/get-event.mdx @@ -3,136 +3,26 @@ title: "Get Event" api: "GET https://api.flare.io/firework/v4/events/" authMethod: "bearer" --- +import BlogPostFieldData from '/snippets/event-data/blog-post-fields.mdx' +import BlogPostModelData from '/snippets/event-data/blog-post-model.mdx' +import CreditCardFieldData from '/snippets/event-data/credit-card-fields.mdx' +import CreditCardModelData from '/snippets/event-data/credit-card-model.mdx' +import LookAlikeFieldData from '/snippets/event-data/lookalike-domain-fields.mdx' +import LookAlikeModelData from '/snippets/event-data/lookalike-domain-model.mdx' +import RansomLeakFieldData from '/snippets/event-data/ransomleak-fields.mdx' +import RansomLeakModelData from '/snippets/event-data/ransomleak-model.mdx' +import StealerLogFieldData from '/snippets/event-data/stealer-log-fields.mdx' +import StealerLogModelData from '/snippets/event-data/stealer-log-model.mdx' Returns data for a specific event. - ```json Blog Post - { - "data": { - "url": "", - "content": "", - "description": "", - "posted_at": "2025-01-01T00:00:00.000000+00:00" - }, - "metadata": { - "estimated_created_at": "2023-11-07T05:31:56Z", - "flare_url": "", - "matched_at": "2023-11-07T05:31:56Z", - "severity": "info", - "uid": "" - }, - "event_type": "blog_post", - } - ``` - ```json Financial - { - "data": { - "bank": "", - "bin": "", - "brand": "", - "country": "", - "expiration": "2030-05-01T00:00:00+00:00", - "owner": "", - "state_code": "", - "zip": "", - "has_cvv": "", - "has_date_of_birth": "", - "has_mother_maiden_name": "", - "has_phone": "", - "has_pin": "", - "has_ssn": "", - "has_track_1": "", - "has_vbv": "" - }, - "metadata": { - "estimated_created_at": "2023-11-07T05:31:56Z", - "flare_url": "", - "matched_at": "2023-11-07T05:31:56Z", - "severity": "info", - "uid": "" - }, - "event_type": "cc", - } - ``` - ```json Ransom Leak - { - "data": { - "victim_information": { - "name": "", - "display_name": "", - "domain": "", - "alternative_domains": "[]", - "industry": "", - "employee_count": "", - "city": "", - "state": "", - "country": "", - "latitude": "", - "longitude": "" - } - "url": "", - "response_url": "", - "title": "", - "content": "", - }, - "metadata": { - "estimated_created_at": "2023-11-07T05:31:56Z", - "flare_url": "", - "matched_at": "2023-11-07T05:31:56Z", - "severity": "info", - "uid": "" - }, - "event_type": "listing", - } - ``` - ```json Stealer Log - { - "data": { - "victim_information": { - "ip_address": "", - "ip_network": "", - "username": "", - "country_code": "", - "zip_code": "", - "location": "", - "hwid": "", - "current_language": "", - "screensize_width": 123, - "screensize_height": 123, - "timezone": "", - "os": "", - "uac": "", - "process_elevation": "", - "available_keyboards": [ - "" - ], - "hardware": [ - "" - ], - "anti_viruses": [ - "" - ] - }, - "malware_information": { - "malware_family": "", - "build_id": "", - "file_location": "", - "infected_at": "2023-11-07T05:31:56Z" - } - }, - "metadata": { - "estimated_created_at": "2023-11-07T05:31:56Z", - "flare_url": "", - "matched_at": "2023-11-07T05:31:56Z", - "severity": "info", - "uid": "" - }, - "event_type": "stealer_log" - } - ``` + + + + + @@ -147,74 +37,19 @@ Returns data for a specific event. Response fields differ based on event type as follows: - - Blog Post Event Data - - - Url of the specific blog post. - - - Content of the Blog Post. - - - Blog Post description, if provided. - - - The date the blog post was posted on the web. - - - + - - - Financial Event Data - - - Name of the bank related to the card/information leak. - - - Associated BIN to a leaked credit card. - - - Major brand of the leaked credit card. - Ex: VISA - - - The country of origin of the leaked card/information. - - - Expiration of the leaked card. - - - Name of the owner found on the card. - - - Initials of the state tied to the card. This is included for American leaked cards. - - - Zip code of the address attached to the leaked card. This is included for American leaked cards. - - - When true, this means that the leaked data includes the CVV of the leaked card. - - - + + + + + - - RansomLeak Event Data - - - - + - - Stealer Log Event Data - - - - + diff --git a/docs/snippets/event-data/blog-post-fields.mdx b/docs/snippets/event-data/blog-post-fields.mdx new file mode 100644 index 0000000..c60f649 --- /dev/null +++ b/docs/snippets/event-data/blog-post-fields.mdx @@ -0,0 +1,17 @@ + + Blog Post Event Data + + + Url of the specific blog post. + + + Content of the Blog Post. + + + Blog Post description, if provided. + + + The date the blog post was posted on the web. + + + diff --git a/docs/snippets/event-data/blog-post-model.mdx b/docs/snippets/event-data/blog-post-model.mdx new file mode 100644 index 0000000..10bbc76 --- /dev/null +++ b/docs/snippets/event-data/blog-post-model.mdx @@ -0,0 +1,18 @@ +```json Blog Post + { + "data": { + "url": "", + "content": "", + "description": "", + "posted_at": "2025-01-01T00:00:00.000000+00:00" + }, + "metadata": { + "estimated_created_at": "2023-11-07T05:31:56Z", + "flare_url": "", + "matched_at": "2023-11-07T05:31:56Z", + "severity": "info", + "uid": "" + }, + "event_type": "blog_post", + } +``` diff --git a/docs/snippets/event-data/credit-card-fields.mdx b/docs/snippets/event-data/credit-card-fields.mdx new file mode 100644 index 0000000..5b4d60e --- /dev/null +++ b/docs/snippets/event-data/credit-card-fields.mdx @@ -0,0 +1,33 @@ + + Credit Card Event Data + + + Name of the bank related to the card/information leak. + + + Associated BIN to a leaked credit card. + + + Major brand of the leaked credit card. + Ex: VISA + + + The country of origin of the leaked card/information. + + + Expiration of the leaked card. + + + Name of the owner found on the card. + + + Initials of the state tied to the card. This is included for American leaked cards. + + + Zip code of the address attached to the leaked card. This is included for American leaked cards. + + + When true, this means that the leaked data includes the CVV of the leaked card. + + + diff --git a/docs/snippets/event-data/credit-card-model.mdx b/docs/snippets/event-data/credit-card-model.mdx new file mode 100644 index 0000000..7de7b2e --- /dev/null +++ b/docs/snippets/event-data/credit-card-model.mdx @@ -0,0 +1,30 @@ +```json Credit Card + { + "data": { + "bank": "", + "bin": "", + "brand": "", + "country": "", + "expiration": "2030-05-01T00:00:00+00:00", + "owner": "", + "state_code": "", + "zip": "", + "has_cvv": "", + "has_date_of_birth": "", + "has_mother_maiden_name": "", + "has_phone": "", + "has_pin": "", + "has_ssn": "", + "has_track_1": "", + "has_vbv": "" + }, + "metadata": { + "estimated_created_at": "2023-11-07T05:31:56Z", + "flare_url": "", + "matched_at": "2023-11-07T05:31:56Z", + "severity": "info", + "uid": "" + }, + "event_type": "cc", + } +``` diff --git a/docs/snippets/event-data/lookalike-domain-fields.mdx b/docs/snippets/event-data/lookalike-domain-fields.mdx new file mode 100644 index 0000000..370ddae --- /dev/null +++ b/docs/snippets/event-data/lookalike-domain-fields.mdx @@ -0,0 +1,22 @@ + + LookAlike Domain Event Data + + + Domain of the detected lookalike domain. + + + Associated BIN to a leaked credit card. + + + Flare feed id where the event can be found. + + + List of domains contained in your identifiers that match on this lookalike domain. + + + Date the certificate was issued for the lookalike domain. + + + + + diff --git a/docs/snippets/event-data/lookalike-domain-model.mdx b/docs/snippets/event-data/lookalike-domain-model.mdx new file mode 100644 index 0000000..b41ad74 --- /dev/null +++ b/docs/snippets/event-data/lookalike-domain-model.mdx @@ -0,0 +1,25 @@ +```json LookAlike Domain + { + "data": { + "domain": <"string">, + "registered_at": "2023-11-07T05:31:56Z", + "feed": <"integer">, + "identifier_domain": [ + <"string"> + ], + "cert_data": "2023-11-07T05:31:56Z", + "subject": <"string">, + "issuers": [ + <"string"> + ] + }, + "metadata": { + "estimated_created_at": "2023-11-07T05:31:56Z", + "flare_url": "", + "matched_at": "2023-11-07T05:31:56Z", + "severity": "info", + "uid": "" + }, + "event_type": "domain" + } +``` diff --git a/docs/snippets/event-data/ransomleak-fields.mdx b/docs/snippets/event-data/ransomleak-fields.mdx new file mode 100644 index 0000000..b272b3a --- /dev/null +++ b/docs/snippets/event-data/ransomleak-fields.mdx @@ -0,0 +1,33 @@ + + RansomLeak Event Data + + + + + Name of the affected entity, this could be a company or a person. + + + + + + Industry of operation of the victim. Ex: Healthcare + + + Enployee count of the ransomed entity. + + + City of operations of the entity's Headquarters. + + + + + + + + + + + + + + diff --git a/docs/snippets/event-data/ransomleak-model.mdx b/docs/snippets/event-data/ransomleak-model.mdx new file mode 100644 index 0000000..d6b41ae --- /dev/null +++ b/docs/snippets/event-data/ransomleak-model.mdx @@ -0,0 +1,32 @@ +```json Ransom Leak + { + "data": { + "victim_information": { + "name": "", + "display_name": "", + "domain": "", + "alternative_domains": "[]", + "industry": "", + "employee_count": "", + "city": "", + "state": "", + "country": "", + "latitude": "", + "longitude": "" + }, + "url": "", + "response_url": "", + "title": "", + "content": "", + }, + "metadata": { + "estimated_created_at": "2023-11-07T05:31:56Z", + "flare_url": "", + "matched_at": "2023-11-07T05:31:56Z", + "severity": "info", + "uid": "" + }, + "event_type": "ransomleak", + } +``` diff --git a/docs/snippets/event-data/stealer-log-fields.mdx b/docs/snippets/event-data/stealer-log-fields.mdx new file mode 100644 index 0000000..ed062f3 --- /dev/null +++ b/docs/snippets/event-data/stealer-log-fields.mdx @@ -0,0 +1,66 @@ + + Stealer Log Event Data + + + Collection of data that relates to the victim's and their infected device. + + + + + Username of the device's account that was accessed. + + + + + Location set on the device. + + + The hardware id of the device. + + + Language set on the device. + + + Screen width in pixels. + + + Screen height in pixels. + + + + Operating System of the device. + + + The device's User Account Control setting. + + + Indicator that the malware was ran as administrator/super user. + + + Available keyboard configurations/languages. + + + List of hardware detected on the device. + + + List of anti-virus software detected on the device. + + + + + Data pertaining to the malware used to infect the device. + + + Classification of the malware family used for infection. + + + The build id of the malware. + + + + Date of infection of the device. + + + + + diff --git a/docs/snippets/event-data/stealer-log-model.mdx b/docs/snippets/event-data/stealer-log-model.mdx new file mode 100644 index 0000000..c261a6d --- /dev/null +++ b/docs/snippets/event-data/stealer-log-model.mdx @@ -0,0 +1,45 @@ +```json Stealer Log + { + "data": { + "victim_information": { + "ip_address": "", + "ip_network": "", + "username": "", + "country_code": "", + "zip_code": "", + "location": "", + "hwid": "", + "current_language": "", + "screensize_width": 123, + "screensize_height": 123, + "timezone": "", + "os": "", + "uac": "", + "process_elevation": "", + "available_keyboards": [ + "" + ], + "hardware": [ + "" + ], + "anti_viruses": [ + "" + ] + }, + "malware_information": { + "malware_family": "", + "build_id": "", + "file_location": "", + "infected_at": "2023-11-07T05:31:56Z" + } + }, + "metadata": { + "estimated_created_at": "2023-11-07T05:31:56Z", + "flare_url": "", + "matched_at": "2023-11-07T05:31:56Z", + "severity": "info", + "uid": "" + }, + "event_type": "stealer_log" + } +```