Retrieve Alert Hits | Flagright

import requests
url = "https://sandbox.api.flagright.com/management/alerts/alertId/hits"
headers = {"x-api-key": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "items": [
    {
      "hitId": "string",
      "hitMetaData": {
        "searchTerm": "string",
        "entityType": "CONSUMER_NAME",
        "paymentMethodId": "string",
        "ruleInstanceId": "string",
        "ruleId": "string",
        "userId": "string",
        "entity": "USER",
        "transactionId": "string"
      },
      "status": "OPEN",
      "hitDetails": {
        "name": "string",
        "aliases": [
          "string"
        ],
        "dateOfBirths": [
          "string"
        ],
        "gender": "string",
        "countries": [
          "string"
        ],
        "documents": [
          {
            "id": "string",
            "name": "string",
            "formattedId": "string"
          }
        ],
        "profileNotes": "string",
        "yearOfIncorporation": [
          "string"
        ],
        "addresses": [
          {
            "addressType": "string",
            "addressLine": "string",
            "city": "string",
            "country": "AF",
            "postalCode": "string"
          }
        ],
        "associates": [
          {
            "id": "string",
            "name": "string",
            "association": "string",
            "sanctionsSearchTypes": [
              "SANCTIONS"
            ],
            "ranks": [
              "LEVEL_1"
            ]
          }
        ],
        "sanctionsSources": [
          {
            "evidenceId": "string",
            "countryCodes": [
              "AF"
            ],
            "createdAt": 1.1,
            "endedAt": 1.1,
            "name": "string",
            "sourceName": "string",
            "url": "string",
            "description": "string",
            "internalId": "string",
            "fields": [
              {
                "name": "string",
                "values": [
                  "string"
                ]
              }
            ],
            "media": [
              {
                "snippet": "string",
                "title": "string",
                "url": "string"
              }
            ],
            "category": "string"
          }
        ],
        "pepSources": [
          {
            "evidenceId": "string",
            "countryCodes": [
              "AF"
            ],
            "createdAt": 1.1,
            "endedAt": 1.1,
            "name": "string",
            "sourceName": "string",
            "url": "string",
            "description": "string",
            "internalId": "string",
            "fields": [
              {
                "name": "string",
                "values": [
                  "string"
                ]
              }
            ],
            "media": [
              {
                "snippet": "string",
                "title": "string",
                "url": "string"
              }
            ],
            "category": "string"
          }
        ],
        "relSources": [
          {
            "evidenceId": "string",
            "countryCodes": [
              "AF"
            ],
            "createdAt": 1.1,
            "endedAt": 1.1,
            "name": "string",
            "sourceName": "string",
            "url": "string",
            "description": "string",
            "internalId": "string",
            "fields": [
              {
                "name": "string",
                "values": [
                  "string"
                ]
              }
            ],
            "media": [
              {
                "snippet": "string",
                "title": "string",
                "url": "string"
              }
            ],
            "category": "string"
          }
        ],
        "mediaSources": [
          "string"
        ],
        "images": [
          "string"
        ]
      }
    }
  ],
  "hasNext": true,
  "hasPrev": true,
  "next": "string",
  "prev": "string",
  "count": 1,
  "pageSize": 1,
  "last": "string"
}

Authentication

x-api-keystring

API keys are used to authenticate the requests.

Path parameters

alertIdstringRequired

Unique Alert Identifier

Query parameters

pageSizedoubleOptional1-1000

pagedoubleOptional>=1

Response

itemslist of objects or null

hasNextboolean or null

hasPrevboolean or null

nextstring or null

prevstring or null

countinteger or null

pageSizeinteger or null

laststring or null

1	{
2	"items": [
3	{
4	"hitId": "string",
5	"hitMetaData": {
6	"searchTerm": "string",
7	"entityType": "CONSUMER_NAME",
8	"paymentMethodId": "string",
9	"ruleInstanceId": "string",
10	"ruleId": "string",
11	"userId": "string",
12	"entity": "USER",
13	"transactionId": "string"
14	},
15	"status": "OPEN",
16	"hitDetails": {
17	"name": "string",
18	"aliases": [
19	"string"
20	],
21	"dateOfBirths": [
22	"string"
23	],
24	"gender": "string",
25	"countries": [
26	"string"
27	],
28	"documents": [
29	{
30	"id": "string",
31	"name": "string",
32	"formattedId": "string"
33	}
34	],
35	"profileNotes": "string",
36	"yearOfIncorporation": [
37	"string"
38	],
39	"addresses": [
40	{
41	"addressType": "string",
42	"addressLine": "string",
43	"city": "string",
44	"country": "AF",
45	"postalCode": "string"
46	}
47	],
48	"associates": [
49	{
50	"id": "string",
51	"name": "string",
52	"association": "string",
53	"sanctionsSearchTypes": [
54	"SANCTIONS"
55	],
56	"ranks": [
57	"LEVEL_1"
58	]
59	}
60	],
61	"sanctionsSources": [
62	{
63	"evidenceId": "string",
64	"countryCodes": [
65	"AF"
66	],
67	"createdAt": 1.1,
68	"endedAt": 1.1,
69	"name": "string",
70	"sourceName": "string",
71	"url": "string",
72	"description": "string",
73	"internalId": "string",
74	"fields": [
75	{
76	"name": "string",
77	"values": [
78	"string"
79	]
80	}
81	],
82	"media": [
83	{
84	"snippet": "string",
85	"title": "string",
86	"url": "string"
87	}
88	],
89	"category": "string"
90	}
91	],
92	"pepSources": [
93	{
94	"evidenceId": "string",
95	"countryCodes": [
96	"AF"
97	],
98	"createdAt": 1.1,
99	"endedAt": 1.1,
100	"name": "string",
101	"sourceName": "string",
102	"url": "string",
103	"description": "string",
104	"internalId": "string",
105	"fields": [
106	{
107	"name": "string",
108	"values": [
109	"string"
110	]
111	}
112	],
113	"media": [
114	{
115	"snippet": "string",
116	"title": "string",
117	"url": "string"
118	}
119	],
120	"category": "string"
121	}
122	],
123	"relSources": [
124	{
125	"evidenceId": "string",
126	"countryCodes": [
127	"AF"
128	],
129	"createdAt": 1.1,
130	"endedAt": 1.1,
131	"name": "string",
132	"sourceName": "string",
133	"url": "string",
134	"description": "string",
135	"internalId": "string",
136	"fields": [
137	{
138	"name": "string",
139	"values": [
140	"string"
141	]
142	}
143	],
144	"media": [
145	{
146	"snippet": "string",
147	"title": "string",
148	"url": "string"
149	}
150	],
151	"category": "string"
152	}
153	],
154	"mediaSources": [
155	"string"
156	],
157	"images": [
158	"string"
159	]
160	}
161	}
162	],
163	"hasNext": true,
164	"hasPrev": true,
165	"next": "string",
166	"prev": "string",
167	"count": 1,
168	"pageSize": 1,
169	"last": "string"
170	}

Authentication

Path parameters

Query parameters

Response

Errors