Get customer screening
curl --request GET \
--url http://localhost:45000/api/v1/customers/{customerId}/screening \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>'{
"subject": {
"subjectId": "<string>",
"entityId": "<string>",
"displayName": "<string>",
"customerId": "<string>",
"customerName": "<string>",
"beneficiaryId": "<string>",
"paymentHold": true,
"onboardingBlocked": true,
"openMatchCount": 0,
"lastScreenedAt": "<string>",
"nextDueAt": "<string>"
},
"query": {
"properties": [
{
"label": "<string>",
"key": "<string>",
"values": [
"<string>"
]
}
],
"algorithm": "<string>",
"threshold": "<string>",
"topicsScope": [
"<string>"
],
"datasetScope": "<string>",
"dataVersion": "<string>"
},
"openMatches": [
{
"matchId": "<string>",
"osEntityId": "<string>",
"caption": "<string>",
"schema": "<string>",
"score": "<string>",
"isMatch": true,
"topics": [
"<string>"
],
"datasets": [
"<string>"
],
"features": [
{
"key": "<string>",
"label": "<string>",
"score": "<string>",
"matchedValue": "<string>",
"candidateValue": "<string>",
"note": "<string>"
}
],
"evidence": [
{
"label": "<string>",
"values": [
"<string>"
],
"fullWidth": true
}
],
"aliases": [
"<string>"
],
"disposition": {
"id": "<string>",
"osEntityId": "<string>",
"reason": "<string>",
"topicsAtDecision": [
"<string>"
],
"reviewedByUserId": "<string>",
"reviewedByDisplayName": "<string>",
"reviewedAt": "<string>"
},
"createdAt": "<string>"
}
],
"previouslyCleared": [
{
"id": "<string>",
"osEntityId": "<string>",
"reason": "<string>",
"topicsAtDecision": [
"<string>"
],
"reviewedByUserId": "<string>",
"reviewedByDisplayName": "<string>",
"reviewedAt": "<string>"
}
],
"historyCount": 0,
"readOnlyReason": "<string>"
}Screening
Get customer screening
Get read-only sanctions screening detail for a customer.
GET
/
api
/
v1
/
customers
/
{customerId}
/
screening
Get customer screening
curl --request GET \
--url http://localhost:45000/api/v1/customers/{customerId}/screening \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>'{
"subject": {
"subjectId": "<string>",
"entityId": "<string>",
"displayName": "<string>",
"customerId": "<string>",
"customerName": "<string>",
"beneficiaryId": "<string>",
"paymentHold": true,
"onboardingBlocked": true,
"openMatchCount": 0,
"lastScreenedAt": "<string>",
"nextDueAt": "<string>"
},
"query": {
"properties": [
{
"label": "<string>",
"key": "<string>",
"values": [
"<string>"
]
}
],
"algorithm": "<string>",
"threshold": "<string>",
"topicsScope": [
"<string>"
],
"datasetScope": "<string>",
"dataVersion": "<string>"
},
"openMatches": [
{
"matchId": "<string>",
"osEntityId": "<string>",
"caption": "<string>",
"schema": "<string>",
"score": "<string>",
"isMatch": true,
"topics": [
"<string>"
],
"datasets": [
"<string>"
],
"features": [
{
"key": "<string>",
"label": "<string>",
"score": "<string>",
"matchedValue": "<string>",
"candidateValue": "<string>",
"note": "<string>"
}
],
"evidence": [
{
"label": "<string>",
"values": [
"<string>"
],
"fullWidth": true
}
],
"aliases": [
"<string>"
],
"disposition": {
"id": "<string>",
"osEntityId": "<string>",
"reason": "<string>",
"topicsAtDecision": [
"<string>"
],
"reviewedByUserId": "<string>",
"reviewedByDisplayName": "<string>",
"reviewedAt": "<string>"
},
"createdAt": "<string>"
}
],
"previouslyCleared": [
{
"id": "<string>",
"osEntityId": "<string>",
"reason": "<string>",
"topicsAtDecision": [
"<string>"
],
"reviewedByUserId": "<string>",
"reviewedByDisplayName": "<string>",
"reviewedAt": "<string>"
}
],
"historyCount": 0,
"readOnlyReason": "<string>"
}Authorizations
Nuvera API application secret key
RS256 per-request signed JWT
Path Parameters
Response
default - application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
-9007199254740991 <= x <= 9007199254740991⌘I