Skip to content
HalvorAI mark HalvorAI mark HalvorAI

List screenings

GET
/v1/screenings

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
result
string
Allowed values: clear potential_match match
reviewed
string
Allowed values: true false
limit
integer
default: 50 >= 1 <= 200

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Screenings

object
data
required
Array<object>
object
id
required
string
payee_key
required
string
result
required
string
Allowed values: clear potential_match match
matches
required
Array<object>
object
list
required
string
entry_id
required
string
name
required
string
score
required
number
matched_on
required
string
list_versions
required
object
key
additional properties
string
at
required
string

401

Section titled “401 ”

Not signed in

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W

403

Section titled “403 ”

Forbidden

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W