Skip to main content
GET
/
api
/
v1
/
customers
/
{customerId}
/
beneficiaries
/
{id}
/
screening
Get beneficiary screening
curl --request GET \
  --url http://localhost:45000/api/v1/customers/{customerId}/beneficiaries/{id}/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

x-api-key
string
header
required

Nuvera API application secret key

Authorization
string
header
required

RS256 per-request signed JWT

Path Parameters

customerId
string
required
id
string
required

Response

default - application/json
subject
object
required
query
object
required
openMatches
object[]
required
previouslyCleared
object[]
required
historyCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
readOnlyReason
string | null
required