API-Referenz

Lieferantenrisiko

Was bei jedem Lieferanten einen Blick verdient: Bankdaten, Sanktionsprüfung und fehlende Dokumente.

Mehr zu dieser Ressource

Pleaxy führt zu jedem Lieferanten eines Käufers drei Prüfungen und fasst sie in einer Stufe zusammen: ok, attention oder blocked. Bankdaten: Das Konto, auf das jede Rechnung bezahlt werden möchte, wird je Abrechnungsweg hinterlegt, und eine Rechnung, die ein neues oder anderes Konto nennt, wartet auf die Freigabe durch eine Person, bevor sie zur Zahlung exportiert werden kann. Sanktionsprüfung: Ist sie aktiviert, werden die Namen des Lieferanten mit den Listen von OFAC, EU, Vereinigtem Königreich und UN abgeglichen, und Zahlungen warten, solange ein möglicher Treffer geprüft wird. Fragebögen: markierte Antworten und fehlende Dokumente. Diese Endpunkte lesen nur. Ein Bankkonto freigeben und über einen Treffer der Sanktionsprüfung entscheiden kann nur eine angemeldete Person in Pleaxy.

Lieferantenrisiko auflisten

Listet die Risikostufe jedes Lieferanten und die Prüfungen dahinter auf.

GET/v1/workspaces/{regionId}/supplier-risk

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Gibt die Stufe jedes Lieferanten mit ihren Zeilen zurück: bank, screening, flaggedAnswers und missingDocuments, jeweils mit einem Zustand ok, attention, blocked oder none. In dieser Liste erscheint eine Sanktionsprüfung ohne Auffälligkeit als none; lesen Sie einen Lieferanten mit GetSupplierRisk, um seinen vollständigen Bank- und Prüfstatus zu sehen.

Braucht 'view'-Zugriff auf Lieferanten.

Antwortfelder

  • level"ok" | "attention" | "blocked"

    Der schwerwiegendste Zustand unter den Zeilen, die der Workspace für die Stufe berücksichtigt. blocked bedeutet einen bestätigten Sanktionstreffer. Es ist eine Stufe, nie eine Punktzahl.

  • bankobject

    Die hinterlegten Bankkonten des Lieferanten: waiting zählt die Konten, die auf Freigabe warten.

  • screeningobject

    Die Sanktionsprüfung des Lieferanten: ihr Status und wann zuletzt geprüft wurde. status ist off, solange die Sanktionsprüfung nicht aktiviert ist.

  • flaggedAnswersobject

    Wie viele Fragebogenantworten des Lieferanten zur Prüfung markiert sind.

  • missingDocumentsobject

    Die Bezeichnungen der Pflichtdokumente des Fragebogens, die der Lieferant nicht eingereicht hat.

Fehler

  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
GET /v1/workspaces/{regionId}/supplier-risk
Anfrage
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/supplier-risk" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 200 OK
[
   {
      "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" ] }
   }
]

Lieferantenrisiko abrufen

Ruft die Risikostufe eines Lieferanten und die Prüfungen dahinter ab.

GET/v1/workspaces/{regionId}/supplier-risk/{connectionId}

Parameter

  • connectionIdstringPflicht

    Die Verbindungs-id des Lieferanten in diesem Workspace.

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Gibt das Risiko eines Lieferanten wie ListSupplierRisk zurück, mit ausgefülltem bank.status sowie Status und checkedAt der Sanktionsprüfung.

Braucht 'view'-Zugriff auf Lieferanten.

Antwortfelder

  • level"ok" | "attention" | "blocked"

    Der schwerwiegendste Zustand unter den Zeilen, die der Workspace für die Stufe berücksichtigt. blocked bedeutet einen bestätigten Sanktionstreffer. Es ist eine Stufe, nie eine Punktzahl.

  • bankobject

    Die hinterlegten Bankkonten des Lieferanten: waiting zählt die Konten, die auf Freigabe warten.

  • screeningobject

    Die Sanktionsprüfung des Lieferanten: ihr Status und wann zuletzt geprüft wurde. status ist off, solange die Sanktionsprüfung nicht aktiviert ist.

  • flaggedAnswersobject

    Wie viele Fragebogenantworten des Lieferanten zur Prüfung markiert sind.

  • missingDocumentsobject

    Die Bezeichnungen der Pflichtdokumente des Fragebogens, die der Lieferant nicht eingereicht hat.

Fehler

  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
GET /v1/workspaces/{regionId}/supplier-risk/{connectionId}
Anfrage
GET /v1/workspaces/reg_01k5x8p9j3q7vn2mhb4tzc6rde.buyer/supplier-risk/SC-1A2B3C4D
Antwort · 200 OK
{
   "connectionId": "SC-1A2B3C4D",
   "supplierName": "Northwind Hosting",
   "level": "attention",
   "bank": { "state": "attention", "waiting": 1, "status": "changing" },
   "screening": { "state": "ok", "status": "clear", "checkedAt": "2026-11-10T06:00:00.000Z" },
   "flaggedAnswers": { "state": "ok", "count": 0 },
   "missingDocuments": { "state": "ok", "fields": [] }
}

Freizugebende Bankkonten auflisten

Listet die Bankkonten von Lieferanten auf, die auf die Freigabe durch eine Person warten.

GET/v1/workspaces/{regionId}/bank-accounts/review

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Gibt die Bankkonten zurück, die auf Freigabe warten: das erste Konto eines Abrechnungswegs (Status unverified) oder eine Änderung an einem freigegebenen Konto (Status changing, mit pendingChange). Rechnungen, die auf diese Konten bezahlt werden sollen, warten, bis eine Person sie freigibt.

Braucht 'view'-Zugriff auf Rechnungen. Ein Konto freigeben, eine Änderung ablehnen und die vollständigen Nummern anzeigen kann nur eine angemeldete Person in Pleaxy.

Antwortfelder

  • laneKeystring

    Der Abrechnungsweg, zu dem das Konto gehört: ein Zahlungsempfänger und eine Währung dieses Lieferanten.

  • detailsobject

    Die hinterlegten Zahlungsdaten, wobei die Kontonummern bis auf die letzten vier Zeichen maskiert sind.

  • status"unverified" | "verified" | "changing"

    unverified: das erste Konto des Abrechnungswegs, wartet auf Freigabe. verified: freigegeben. changing: Eine Rechnung nannte andere Daten; sie stehen in pendingChange, bis eine Person sie freigibt oder ablehnt.

  • approvalobject

    Wie das Konto freigegeben wurde. verification ist supplier_confirmed, buyer_approved oder paid_before, und check.method gibt an, wie der Käufer es geprüft hat.

  • historyArray<object>

    Die jüngsten Ereignisse des Kontos, mit maskierter Kontonummer.

Fehler

  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
GET /v1/workspaces/{regionId}/bank-accounts/review
Anfrage
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/bank-accounts/review" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 200 OK
[
   {
      "id": "string",
      "connectionId": "string",
      "supplierName": "string",
      "supplierKey": "string",
      "laneKey": "string",
      "payeeName": "string",
      "currency": "string",
      "details": { "method": "bank_transfer" | "wire" | "ach" | "check" | "other", "payeeName": "string", "bankName": "string", "iban": "string", "accountNumber": "string", "bic": "string", "routingNumber": "string", "mailingAddress": "string", "paymentReference": "string", "notes": "string" },
      "status": "unverified" | "verified" | "changing",
      "learnedFrom": { "invoiceId": "string", "side": "buyer" | "supplier" },
      "approval": {
         "verification": "supplier_confirmed" | "buyer_approved" | "paid_before",
         "at": "string",
         "by": { "sub": "string", "name": "string", "side": "buyer" | "supplier" },
         "check": { "method": "call" | "email" | "bank_letter" | "supplier_portal" | "other" | "none", "detail": "string", "note": "string" },
         "invoiceId": "string"
      },
      "pendingChange": { "details": { ... }, "invoiceId": "string", "side": "buyer" | "supplier", "at": "string" },
      "history": [
         { "at": "string", "event": "learned" | "seeded" | "approved" | "change_proposed" | "change_rejected", "masked": "string", "invoiceId": "string", "by": "string" }
      ],
      "version": number,
      "createdAt": "string",
      "updatedAt": "string"
   }
]

Bankkonten eines Lieferanten auflisten

Listet die hinterlegten Bankkonten eines Lieferanten auf, jeweils mit der Art ihrer Freigabe.

GET/v1/workspaces/{regionId}/bank-accounts/suppliers/{connectionId}

Parameter

  • connectionIdstringPflicht

    Die Verbindungs-id des Lieferanten in diesem Workspace.

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Gibt die hinterlegten Bankkonten eines Lieferanten zurück, eines je Abrechnungsweg (ein Zahlungsempfänger und eine Währung), mit dem Status jedes Kontos, der Art seiner Freigabe und seinen letzten 10 Ereignissen.

Braucht 'view'-Zugriff auf Rechnungen. Ein Konto freigeben, eine Änderung ablehnen und die vollständigen Nummern anzeigen kann nur eine angemeldete Person in Pleaxy.

Antwortfelder

  • laneKeystring

    Der Abrechnungsweg, zu dem das Konto gehört: ein Zahlungsempfänger und eine Währung dieses Lieferanten.

  • detailsobject

    Die hinterlegten Zahlungsdaten, wobei die Kontonummern bis auf die letzten vier Zeichen maskiert sind.

  • status"unverified" | "verified" | "changing"

    unverified: das erste Konto des Abrechnungswegs, wartet auf Freigabe. verified: freigegeben. changing: Eine Rechnung nannte andere Daten; sie stehen in pendingChange, bis eine Person sie freigibt oder ablehnt.

  • approvalobject

    Wie das Konto freigegeben wurde. verification ist supplier_confirmed, buyer_approved oder paid_before, und check.method gibt an, wie der Käufer es geprüft hat.

  • historyArray<object>

    Die jüngsten Ereignisse des Kontos, mit maskierter Kontonummer.

Fehler

  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
GET /v1/workspaces/{regionId}/bank-accounts/suppliers/{connectionId}
Anfrage
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/bank-accounts/suppliers/{connectionId}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 200 OK
[
   {
      "id": "string",
      "connectionId": "string",
      "supplierName": "string",
      "supplierKey": "string",
      "laneKey": "string",
      "payeeName": "string",
      "currency": "string",
      "details": { "method": "bank_transfer" | "wire" | "ach" | "check" | "other", "payeeName": "string", "bankName": "string", "iban": "string", "accountNumber": "string", "bic": "string", "routingNumber": "string", "mailingAddress": "string", "paymentReference": "string", "notes": "string" },
      "status": "unverified" | "verified" | "changing",
      "learnedFrom": { "invoiceId": "string", "side": "buyer" | "supplier" },
      "approval": {
         "verification": "supplier_confirmed" | "buyer_approved" | "paid_before",
         "at": "string",
         "by": { "sub": "string", "name": "string", "side": "buyer" | "supplier" },
         "check": { "method": "call" | "email" | "bank_letter" | "supplier_portal" | "other" | "none", "detail": "string", "note": "string" },
         "invoiceId": "string"
      },
      "pendingChange": { "details": { ... }, "invoiceId": "string", "side": "buyer" | "supplier", "at": "string" },
      "history": [
         { "at": "string", "event": "learned" | "seeded" | "approved" | "change_proposed" | "change_rejected", "masked": "string", "invoiceId": "string", "by": "string" }
      ],
      "version": number,
      "createdAt": "string",
      "updatedAt": "string"
   }
]

Bankkonto einer Rechnung abrufen

Sagt, ob die Zahlung einer Rechnung auf das Bankkonto ihres Lieferanten wartet.

GET/v1/workspaces/{regionId}/invoices/{invoiceId}/bank-account

Parameter

  • invoiceIdstringPflicht

    Die id der Rechnung, z. B. INV-7F3A9C21.

  • buyerstring

    Für einen Aufrufer mit Lieferantenrolle der Käufer, zu dem die Rechnung gehört, wie bei GetInvoice.

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Sagt, ob diese Rechnung auf das Bankkonto ihres Lieferanten wartet. hold ist first_payment, wenn das Konto des Abrechnungswegs noch nicht freigegeben ist, differs_from_file, wenn die Rechnung andere Daten nennt als das freigegebene Konto, und fehlt, wenn die Rechnung bezahlt werden kann. Solange sie wartet, kann die Rechnung nicht zur Zahlung exportiert werden; das Erfassen einer anderswo geleisteten Zahlung und das Bezahlen über Pleaxy werden nicht angehalten.

Braucht 'view'-Zugriff auf Rechnungen. Ein Aufrufer mit Lieferantenrolle erhält nur hold.

Antwortfelder

  • hold"first_payment" | "differs_from_file"

    Warum die Zahlung wartet. Fehlt, wenn sie nicht wartet.

  • accountobject

    Das hinterlegte Konto des Abrechnungswegs, wobei die Nummern bis auf die letzten vier Zeichen maskiert sind.

Fehler

  • 404 Not Found - Keine Rechnung mit dieser id, die der Aufrufer sehen kann.
  • 409 Conflict - Nur für Aufrufer mit Lieferantenrolle. Code INVOICE_ID_AMBIGUOUS: Mehr als einer Ihrer Käufer hat eine Rechnung von Ihnen mit dieser ID (IDs sind nur innerhalb eines Käufers eindeutig), daher rät Pleaxy nicht, welche gemeint ist. Es wird nichts gelesen oder geändert. Das Feld buyers im Body listet Workspace-ID und Namen jedes Käufers auf: Wiederholen Sie den Aufruf mit ?buyer=<diese Workspace-ID>.
  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
GET /v1/workspaces/{regionId}/invoices/{invoiceId}/bank-account
Anfrage
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/invoices/{invoiceId}/bank-account" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 200 OK
{
   "hold": "first_payment" | "differs_from_file",
   "account": {
      "id": "string",
      "connectionId": "string",
      "supplierName": "string",
      "supplierKey": "string",
      "laneKey": "string",
      "payeeName": "string",
      "currency": "string",
      "details": { "method": "bank_transfer" | "wire" | "ach" | "check" | "other", "payeeName": "string", "bankName": "string", "iban": "string", "accountNumber": "string", "bic": "string", "routingNumber": "string", "mailingAddress": "string", "paymentReference": "string", "notes": "string" },
      "status": "unverified" | "verified" | "changing",
      "learnedFrom": { "invoiceId": "string", "side": "buyer" | "supplier" },
      "approval": {
         "verification": "supplier_confirmed" | "buyer_approved" | "paid_before",
         "at": "string",
         "by": { "sub": "string", "name": "string", "side": "buyer" | "supplier" },
         "check": { "method": "call" | "email" | "bank_letter" | "supplier_portal" | "other" | "none", "detail": "string", "note": "string" },
         "invoiceId": "string"
      },
      "pendingChange": { "details": { ... }, "invoiceId": "string", "side": "buyer" | "supplier", "at": "string" },
      "history": [
         { "at": "string", "event": "learned" | "seeded" | "approved" | "change_proposed" | "change_rejected", "masked": "string", "invoiceId": "string", "by": "string" }
      ],
      "version": number,
      "createdAt": "string",
      "updatedAt": "string"
   },
   "supplierKey": "string"
}

Treffer der Sanktionsprüfung auflisten

Listet die Lieferanten auf, deren Sanktionsprüfung einen zu prüfenden oder einen bestätigten Treffer hat.

GET/v1/workspaces/{regionId}/screening/review

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Gibt die Lieferanten zurück, deren Prüfstatus possible_match oder confirmed_match ist. Zahlungen an sie warten, und ein Lieferant mit einem bestätigten Treffer erhält keine neuen Bestellungen und keine vom Käufer erfassten Rechnungen. Die Liste ist leer, solange die Sanktionsprüfung deaktiviert ist. Ein Treffer ist eine Namensähnlichkeit, die eine Person prüfen soll, keine Feststellung, dass der Lieferant sanktioniert ist.

Braucht 'view'-Zugriff auf Lieferanten. Einen Treffer verwerfen oder bestätigen kann nur eine angemeldete Person in Pleaxy.

Antwortfelder

  • status"not_screened" | "clear" | "possible_match" | "confirmed_match"

    possible_match: Mindestens ein Treffer wartet auf die Prüfung durch eine Person. confirmed_match: Eine Person hat bestätigt, dass der Lieferant die gelistete Partei ist.

  • subjectsArray<object>

    Die geprüften Namen: der Name des Lieferanten, ein früherer Name und die Zahlungsempfänger seiner Bankkonten.

  • listVersionsobject

    Die Version jeder Sanktionsliste, gegen die der Lieferant zuletzt geprüft wurde.

  • matchesArray<object>

    Jeder Listeneintrag, dem ein geprüfter Name ähnelt: die Liste, die Namen, Länder und Programme des Eintrags sowie die Punktzahl. state ist open, bis eine Person ihn verwirft oder bestätigt, mit Angabe, wer entschieden hat und warum. closed bedeutet, dass der Eintrag die Liste verlassen hat oder nicht mehr passt.

Fehler

  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
GET /v1/workspaces/{regionId}/screening/review
Anfrage
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/screening/review" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 200 OK
[
   {
      "connectionId": "string",
      "supplierKey": "string",
      "supplierName": "string",
      "status": "not_screened" | "clear" | "possible_match" | "confirmed_match",
      "checkedAt": "string",
      "listVersions": { "ofac": "string", "eu": "string", "uk": "string", "un": "string" },
      "subjects": [ { "role": "name" | "former_name" | "payee", "name": "string" } ],
      "countries": [ "string" ],
      "matches": [
         {
            "id": "string",
            "entryId": "string",
            "list": "ofac" | "eu" | "uk" | "un" | "jurisdiction",
            "entryName": "string",
            "matchedName": "string",
            "subject": { "role": "name" | "former_name" | "payee", "name": "string" },
            "score": number,
            "countryMismatch": boolean,
            "entry": { "kind": "entity" | "individual" | "other", "names": [ "string" ], "countries": [ "string" ], "programmes": [ "string" ], "listedOn": "string" },
            "state": "open" | "dismissed" | "confirmed" | "closed",
            "foundAt": "string",
            "decidedAt": "string",
            "decidedBy": { "sub": "string", "name": "string" },
            "reason": "string",
            "closedReason": "entry_removed" | "no_longer_matches"
         }
      ],
      "history": [ { "at": "string", "event": "screened" | "dismissed" | "confirmed" | "reopened" | "closed", "matchId": "string", "by": "string" } ],
      "version": number
   }
]

Sanktionsprüfung eines Lieferanten abrufen

Ruft die Sanktionsprüfung eines Lieferanten und ihre Treffer ab.

GET/v1/workspaces/{regionId}/screening/suppliers/{connectionId}

Parameter

  • connectionIdstringPflicht

    Die Verbindungs-id des Lieferanten in diesem Workspace.

Rückgabe

200 OK mit dem in der Antwort gezeigten Objekt.

Weitere Details

Gibt zurück, ob die Sanktionsprüfung aktiviert ist, und, wenn der Lieferant geprüft wurde, seine Prüfung: die geprüften Namen, die Listenversionen und jeden Treffer mit seinem Zustand.

Braucht 'view'-Zugriff auf Lieferanten. Einen Treffer verwerfen oder bestätigen kann nur eine angemeldete Person in Pleaxy.

Antwortfelder

  • enabledboolean

    Ob die Sanktionsprüfung aktiviert ist.

  • status"not_screened" | "clear" | "possible_match" | "confirmed_match"

    possible_match: Mindestens ein Treffer wartet auf die Prüfung durch eine Person. confirmed_match: Eine Person hat bestätigt, dass der Lieferant die gelistete Partei ist.

  • subjectsArray<object>

    Die geprüften Namen: der Name des Lieferanten, ein früherer Name und die Zahlungsempfänger seiner Bankkonten.

  • listVersionsobject

    Die Version jeder Sanktionsliste, gegen die der Lieferant zuletzt geprüft wurde.

  • matchesArray<object>

    Jeder Listeneintrag, dem ein geprüfter Name ähnelt: die Liste, die Namen, Länder und Programme des Eintrags sowie die Punktzahl. state ist open, bis eine Person ihn verwirft oder bestätigt, mit Angabe, wer entschieden hat und warum. closed bedeutet, dass der Eintrag die Liste verlassen hat oder nicht mehr passt.

Fehler

  • 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
  • 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
GET /v1/workspaces/{regionId}/screening/suppliers/{connectionId}
Anfrage
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/screening/suppliers/{connectionId}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Antwort · 200 OK
{
   "enabled": boolean,
   "screening": {
      "connectionId": "string",
      "supplierKey": "string",
      "supplierName": "string",
      "status": "not_screened" | "clear" | "possible_match" | "confirmed_match",
      "checkedAt": "string",
      "listVersions": { "ofac": "string", "eu": "string", "uk": "string", "un": "string" },
      "subjects": [ { "role": "name" | "former_name" | "payee", "name": "string" } ],
      "countries": [ "string" ],
      "matches": [
         {
            "id": "string",
            "entryId": "string",
            "list": "ofac" | "eu" | "uk" | "un" | "jurisdiction",
            "entryName": "string",
            "matchedName": "string",
            "subject": { "role": "name" | "former_name" | "payee", "name": "string" },
            "score": number,
            "countryMismatch": boolean,
            "entry": { "kind": "entity" | "individual" | "other", "names": [ "string" ], "countries": [ "string" ], "programmes": [ "string" ], "listedOn": "string" },
            "state": "open" | "dismissed" | "confirmed" | "closed",
            "foundAt": "string",
            "decidedAt": "string",
            "decidedBy": { "sub": "string", "name": "string" },
            "reason": "string",
            "closedReason": "entry_removed" | "no_longer_matches"
         }
      ],
      "history": [ { "at": "string", "event": "screened" | "dismissed" | "confirmed" | "reopened" | "closed", "matchId": "string", "by": "string" } ],
      "version": number
   }
}
Kontakt aufnehmen