query · Module: Trade · Requires trade:read
Arguments
| Argument | Type | Description |
|---|---|---|
createdGte | Int | Filter by created gte. |
createdLte | Int | Filter by created lte. |
limit | Int | Page size, 1–100 (default 10). |
startingAfter | ID | Cursor: return objects after this ID. |
endingBefore | ID | Cursor: return objects before this ID. |
Returns
ComplianceScreeningList!
| Field | Type |
|---|---|
data | [ComplianceScreening!]! |
has_more | Boolean |
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query ComplianceScreenings($limit: Int) {
complianceScreenings(limit: $limit) {
data {
id
object
livemode
created
updated
decision
parties {
role
decision
matches {
name
list
score
entry_id
}
}
items {
index
decision
restrictions {
code
country
level
agency
}
}
embargo {
country
program
}
lists_version
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"complianceScreenings": {
"data": [
{
"id": "scr_1a2B3c",
"object": "compliance_screening",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"decision": "clear",
"parties": [
{
"role": "example",
"decision": "clear",
"matches": [
{
"name": "Example",
"list": "example",
"score": 1.5,
"entry_id": "example"
}
]
}
],
"items": [
{
"index": 2,
"decision": "clear",
"restrictions": [
{
"code": "dhl_express_worldwide",
"country": "GB",
"level": "prohibited",
"agency": "example"
}
]
}
],
"embargo": {
"country": "GB",
"program": "example"
},
"lists_version": "example"
}
],
"has_more": true
}
}
}