Referencia de la API

Riesgo de proveedores

Lo que conviene revisar de cada proveedor: datos bancarios, verificación de sanciones y documentos que faltan.

Más sobre este recurso

Pleaxy mantiene tres comprobaciones sobre cada proveedor de un comprador y las resume en un nivel: ok, attention o blocked. Datos bancarios: la cuenta a la que cada factura pide que se pague se guarda por canal de cobro, y una factura que indica una cuenta nueva o distinta espera la aprobación de una persona antes de poder exportarse para el pago. Verificación de sanciones: cuando está activada, los nombres del proveedor se comparan con las listas de OFAC, la UE, el Reino Unido y la ONU, y los pagos esperan mientras se revisa una posible coincidencia. Cuestionarios: respuestas marcadas y documentos que faltan. Estos endpoints solo leen. Aprobar una cuenta bancaria y decidir sobre una coincidencia de la verificación lo hace una persona con sesión iniciada en Pleaxy.

Listar riesgo de proveedores

Lista el nivel de riesgo de cada proveedor y las comprobaciones en que se basa.

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

Devuelve

200 OK con el objeto que se muestra en la respuesta.

Más detalles

Devuelve el nivel de cada proveedor con sus filas: bank, screening, flaggedAnswers y missingDocuments, cada una con un estado ok, attention, blocked o none. En esta lista, una verificación sin nada marcado aparece como none; consulta un proveedor con GetSupplierRisk para ver su estado bancario y de verificación completo.

Necesita acceso 'view' a los proveedores.

Campos de la respuesta

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

    El estado más grave entre las filas que el espacio de trabajo tiene en cuenta para el nivel. blocked significa una coincidencia de sanciones confirmada. Es un nivel, nunca una puntuación.

  • bankobject

    Las cuentas bancarias registradas del proveedor: waiting cuenta las cuentas que esperan aprobación.

  • screeningobject

    La verificación de sanciones del proveedor: su estado y cuándo se comprobó por última vez. status es off mientras la verificación no está activada.

  • flaggedAnswersobject

    Cuántas respuestas del cuestionario del proveedor están marcadas para revisión.

  • missingDocumentsobject

    Las etiquetas de los documentos obligatorios del cuestionario que el proveedor no ha aportado.

Errores

  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
  • 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
GET /v1/workspaces/{regionId}/supplier-risk
Solicitud
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/supplier-risk" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Respuesta · 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" ] }
   }
]

Obtener riesgo de proveedor

Obtiene el nivel de riesgo de un proveedor y las comprobaciones en que se basa.

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

Parámetros

  • connectionIdstringObligatorio

    El id de conexión del proveedor en este espacio de trabajo.

Devuelve

200 OK con el objeto que se muestra en la respuesta.

Más detalles

Devuelve el riesgo de un proveedor como lo hace ListSupplierRisk, con bank.status y el estado y checkedAt de la verificación completados.

Necesita acceso 'view' a los proveedores.

Campos de la respuesta

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

    El estado más grave entre las filas que el espacio de trabajo tiene en cuenta para el nivel. blocked significa una coincidencia de sanciones confirmada. Es un nivel, nunca una puntuación.

  • bankobject

    Las cuentas bancarias registradas del proveedor: waiting cuenta las cuentas que esperan aprobación.

  • screeningobject

    La verificación de sanciones del proveedor: su estado y cuándo se comprobó por última vez. status es off mientras la verificación no está activada.

  • flaggedAnswersobject

    Cuántas respuestas del cuestionario del proveedor están marcadas para revisión.

  • missingDocumentsobject

    Las etiquetas de los documentos obligatorios del cuestionario que el proveedor no ha aportado.

Errores

  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
  • 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
GET /v1/workspaces/{regionId}/supplier-risk/{connectionId}
Solicitud
GET /v1/workspaces/reg_01k5x8p9j3q7vn2mhb4tzc6rde.buyer/supplier-risk/SC-1A2B3C4D
Respuesta · 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": [] }
}

Listar cuentas bancarias por aprobar

Lista las cuentas bancarias de proveedores que esperan la aprobación de una persona.

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

Devuelve

200 OK con el objeto que se muestra en la respuesta.

Más detalles

Devuelve las cuentas bancarias que esperan aprobación: la primera cuenta de un canal de cobro (estado unverified) o un cambio en una ya aprobada (estado changing, con pendingChange). Las facturas que se pagarían a esas cuentas esperan hasta que una persona las aprueba.

Necesita acceso 'view' a las facturas. Aprobar una cuenta, rechazar un cambio y mostrar los números completos lo hace una persona con sesión iniciada en Pleaxy.

Campos de la respuesta

  • laneKeystring

    El canal de cobro al que pertenece la cuenta: un beneficiario y una moneda de este proveedor.

  • detailsobject

    Los datos de pago registrados, con los números de cuenta enmascarados salvo los últimos cuatro caracteres.

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

    unverified: la primera cuenta del canal, en espera de aprobación. verified: aprobada. changing: una factura indicó otros datos, que se guardan en pendingChange hasta que una persona los aprueba o los rechaza.

  • approvalobject

    Cómo se aprobó la cuenta. verification es supplier_confirmed, buyer_approved o paid_before, y check.method es cómo la comprobó el comprador.

  • historyArray<object>

    Los eventos más recientes de la cuenta, con el número de cuenta enmascarado.

Errores

  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
  • 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
GET /v1/workspaces/{regionId}/bank-accounts/review
Solicitud
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/bank-accounts/review" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Respuesta · 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"
   }
]

Listar cuentas bancarias de proveedor

Lista las cuentas bancarias registradas de un proveedor, con cómo se aprobó cada una.

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

Parámetros

  • connectionIdstringObligatorio

    El id de conexión del proveedor en este espacio de trabajo.

Devuelve

200 OK con el objeto que se muestra en la respuesta.

Más detalles

Devuelve las cuentas bancarias registradas de un proveedor, una por canal de cobro (un beneficiario y una moneda), con el estado de cada cuenta, cómo se aprobó y sus últimos 10 eventos.

Necesita acceso 'view' a las facturas. Aprobar una cuenta, rechazar un cambio y mostrar los números completos lo hace una persona con sesión iniciada en Pleaxy.

Campos de la respuesta

  • laneKeystring

    El canal de cobro al que pertenece la cuenta: un beneficiario y una moneda de este proveedor.

  • detailsobject

    Los datos de pago registrados, con los números de cuenta enmascarados salvo los últimos cuatro caracteres.

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

    unverified: la primera cuenta del canal, en espera de aprobación. verified: aprobada. changing: una factura indicó otros datos, que se guardan en pendingChange hasta que una persona los aprueba o los rechaza.

  • approvalobject

    Cómo se aprobó la cuenta. verification es supplier_confirmed, buyer_approved o paid_before, y check.method es cómo la comprobó el comprador.

  • historyArray<object>

    Los eventos más recientes de la cuenta, con el número de cuenta enmascarado.

Errores

  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
  • 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
GET /v1/workspaces/{regionId}/bank-accounts/suppliers/{connectionId}
Solicitud
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/bank-accounts/suppliers/{connectionId}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Respuesta · 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"
   }
]

Obtener cuenta bancaria de factura

Indica si el pago de una factura espera por la cuenta bancaria de su proveedor.

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

Parámetros

  • invoiceIdstringObligatorio

    El id de la factura, p. ej. INV-7F3A9C21.

  • buyerstring

    Para un llamador proveedor, el comprador al que pertenece la factura, como en GetInvoice.

Devuelve

200 OK con el objeto que se muestra en la respuesta.

Más detalles

Indica si esta factura espera por la cuenta bancaria de su proveedor. hold es first_payment cuando la cuenta del canal de cobro aún no está aprobada, differs_from_file cuando la factura indica datos distintos de los de la cuenta aprobada, y no aparece cuando la factura se puede pagar. Mientras espera, la factura no se puede exportar para el pago; registrar un pago hecho por otra vía y pagar a través de Pleaxy no quedan retenidos.

Necesita acceso 'view' a las facturas. Un llamador proveedor solo recibe hold.

Campos de la respuesta

  • hold"first_payment" | "differs_from_file"

    Por qué espera el pago. No aparece cuando no espera.

  • accountobject

    La cuenta registrada del canal de cobro, con los números enmascarados salvo los últimos cuatro caracteres.

Errores

  • 404 Not Found - No hay ninguna factura con este id que el llamador pueda ver.
  • 409 Conflict - Solo para llamadores proveedores. Código INVOICE_ID_AMBIGUOUS: más de uno de tus compradores tiene una factura tuya con este id (los ids solo son únicos dentro de un comprador), así que Pleaxy no adivina a cuál te refieres. No se lee ni se cambia nada. El campo buyers del cuerpo lista el ID del espacio de trabajo y el nombre de cada comprador: repite la llamada con ?buyer=<ese ID del espacio de trabajo>.
  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
  • 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
GET /v1/workspaces/{regionId}/invoices/{invoiceId}/bank-account
Solicitud
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/invoices/{invoiceId}/bank-account" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Respuesta · 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"
}

Listar coincidencias de verificación

Lista los proveedores cuya verificación de sanciones tiene una coincidencia por revisar o una confirmada.

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

Devuelve

200 OK con el objeto que se muestra en la respuesta.

Más detalles

Devuelve los proveedores cuyo estado de verificación es possible_match o confirmed_match. Los pagos a esos proveedores esperan, y un proveedor con una coincidencia confirmada no recibe órdenes nuevas ni facturas ingresadas por el comprador. La lista está vacía mientras la verificación está desactivada. Una coincidencia es un parecido entre nombres que una persona debe revisar, no una conclusión de que el proveedor esté sancionado.

Necesita acceso 'view' a los proveedores. Descartar o confirmar una coincidencia lo hace una persona con sesión iniciada en Pleaxy.

Campos de la respuesta

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

    possible_match: al menos una coincidencia espera la revisión de una persona. confirmed_match: una persona confirmó que el proveedor es la parte que figura en la lista.

  • subjectsArray<object>

    Los nombres que se verificaron: el nombre del proveedor, un nombre anterior y los beneficiarios de sus cuentas bancarias.

  • listVersionsobject

    La versión de cada lista de sanciones con la que se verificó al proveedor por última vez.

  • matchesArray<object>

    Cada entrada de una lista a la que se parece un nombre verificado: la lista, los nombres, países y programas de la entrada, y la puntuación. state es open hasta que una persona la descarta o la confirma, con quién decidió y por qué. closed significa que la entrada salió de la lista o ya no coincide.

Errores

  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
  • 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
GET /v1/workspaces/{regionId}/screening/review
Solicitud
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/screening/review" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Respuesta · 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
   }
]

Obtener verificación de proveedor

Obtiene la verificación de sanciones de un proveedor y sus coincidencias.

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

Parámetros

  • connectionIdstringObligatorio

    El id de conexión del proveedor en este espacio de trabajo.

Devuelve

200 OK con el objeto que se muestra en la respuesta.

Más detalles

Devuelve si la verificación está activada y, cuando el proveedor ya fue verificado, su verificación: los nombres verificados, las versiones de las listas y cada coincidencia con su estado.

Necesita acceso 'view' a los proveedores. Descartar o confirmar una coincidencia lo hace una persona con sesión iniciada en Pleaxy.

Campos de la respuesta

  • enabledboolean

    Si la verificación de sanciones está activada.

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

    possible_match: al menos una coincidencia espera la revisión de una persona. confirmed_match: una persona confirmó que el proveedor es la parte que figura en la lista.

  • subjectsArray<object>

    Los nombres que se verificaron: el nombre del proveedor, un nombre anterior y los beneficiarios de sus cuentas bancarias.

  • listVersionsobject

    La versión de cada lista de sanciones con la que se verificó al proveedor por última vez.

  • matchesArray<object>

    Cada entrada de una lista a la que se parece un nombre verificado: la lista, los nombres, países y programas de la entrada, y la puntuación. state es open hasta que una persona la descarta o la confirma, con quién decidió y por qué. closed significa que la entrada salió de la lista o ya no coincide.

Errores

  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
  • 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
GET /v1/workspaces/{regionId}/screening/suppliers/{connectionId}
Solicitud
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/screening/suppliers/{connectionId}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Respuesta · 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
   }
}
Habla con nosotros