Skip to content
rigid.fi

Retrieve a screening

GET/v1/screenings/{screeningId}

Requires an API client bearer token.

Fetch a screening by id (tenant-scoped), including the candidates it surfaced.

Parameters

Path parameters

NameRequiredDescription
screeningIdrequired

Example

curl https://api.rigid.fi/v1/screenings/{screeningId} \
  -H "Authorization: Bearer $RIGID_API_TOKEN"

Responses

200

The screening and its candidates.

idstringrequired
subject_idstringrequired
trigger"check" | "monitor"required
result"clear" | "candidates" | "confirmed_match"required
matcher_versionstringrequired
requested_atstringrequired
candidatesarray of objectrequired
+ show properties
idstringrequired
subject_idstringrequired
screening_idstringrequired
entry_hashstringrequired
sourcestringrequired
source_refstringrequired
primary_namestringrequired
scorenumberrequired
status"pending" | "suppressed" | "confirmed"required
awaiting_confirmationobject
+ show properties
reviewer_namestringrequired
recorded_atstringrequired
created_atstringrequired
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

Screening not found

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring