List supplier risk
Lists each supplier's risk level and the checks behind it.
GET/v1/workspaces/{regionId}/supplier-risk
Returns
200 OK with the object shown in the response.
More details
Returns every supplier's level with its rows: bank, screening, flaggedAnswers and missingDocuments, each with a state of ok, attention, blocked or none. In this list a screening that isn't flagged shows as none; read one supplier with GetSupplierRisk for its full bank and screening status.
Needs 'view' access to suppliers.
Response fields
level"ok" | "attention" | "blocked"The most serious state among the rows the workspace counts toward it. blocked means a confirmed sanctions match. It is a level, never a score.
bankobjectThe supplier's bank accounts on file: waiting counts the accounts waiting for approval.
screeningobjectThe supplier's sanctions screening: its status and when it was last checked. status is off while screening isn't switched on.
flaggedAnswersobjectHow many of the supplier's questionnaire answers are flagged for review.
missingDocumentsobjectThe labels of the required questionnaire documents the supplier hasn't provided.
Errors
- 401 Unauthorized - No credential was presented, or the Bearer token / X-Api-Key value is missing, invalid, expired, or revoked.
- 403 Forbidden - The caller's Bearer token or API key doesn't grant access to this workspace (regionId), or lacks the required role.
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/supplier-risk" \
-H "X-Api-Key: $PLEAXY_API_KEY"[
{
"connectionId": "string",
"supplierName": "string",
"level": "ok" | "attention" | "blocked",
"bank": { "state": "ok" | "attention" | "blocked" | "none", "waiting": number, "status": "none" | "approved" | "waiting" | "changing" },
"screening": { "state": "ok" | "attention" | "blocked" | "none", "status": "off" | "not_screened" | "clear" | "possible_match" | "confirmed_match", "checkedAt": "string" },
"flaggedAnswers": { "state": "ok" | "attention" | "blocked" | "none", "count": number },
"missingDocuments": { "state": "ok" | "attention" | "blocked" | "none", "fields": [ "string" ] }
}
]