Retrieve Alert Hits | Flagright

{
  "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",
            "summary": "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",
            "summary": "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",
            "summary": "string"
          }
        ],
        "mediaSources": [
          {
            "evidenceId": "string",
            "url": "string",
            "name": "string",
            "category": "string",
            "summary": "string",
            "publicationDate": "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

hasNextboolean

hasPrevboolean

nextstring

prevstring

countinteger

pageSizeinteger

laststring

Errors

400

Bad Request Error

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	"summary": "string"
91	}
92	],
93	"pepSources": [
94	{
95	"evidenceId": "string",
96	"countryCodes": [
97	"AF"
98	],
99	"createdAt": 1.1,
100	"endedAt": 1.1,
101	"name": "string",
102	"sourceName": "string",
103	"url": "string",
104	"description": "string",
105	"internalId": "string",
106	"fields": [
107	{
108	"name": "string",
109	"values": [
110	"string"
111	]
112	}
113	],
114	"media": [
115	{
116	"snippet": "string",
117	"title": "string",
118	"url": "string"
119	}
120	],
121	"category": "string",
122	"summary": "string"
123	}
124	],
125	"relSources": [
126	{
127	"evidenceId": "string",
128	"countryCodes": [
129	"AF"
130	],
131	"createdAt": 1.1,
132	"endedAt": 1.1,
133	"name": "string",
134	"sourceName": "string",
135	"url": "string",
136	"description": "string",
137	"internalId": "string",
138	"fields": [
139	{
140	"name": "string",
141	"values": [
142	"string"
143	]
144	}
145	],
146	"media": [
147	{
148	"snippet": "string",
149	"title": "string",
150	"url": "string"
151	}
152	],
153	"category": "string",
154	"summary": "string"
155	}
156	],
157	"mediaSources": [
158	{
159	"evidenceId": "string",
160	"url": "string",
161	"name": "string",
162	"category": "string",
163	"summary": "string",
164	"publicationDate": "string"
165	}
166	],
167	"images": [
168	"string"
169	]
170	}
171	}
172	],
173	"hasNext": true,
174	"hasPrev": true,
175	"next": "string",
176	"prev": "string",
177	"count": 1,
178	"pageSize": 1,
179	"last": "string"
180	}

$	curl https://sandbox.api.flagright.com/management/alerts/alertId/hits \
>	-H "x-api-key: <apiKey>"