apacuana-sdk-core 1.22.0 → 1.25.0

package/README.md

@@ -78,8 +78,7 @@ El SDK puede inicializarse sin el parámetro `customerId`, lo que permite el acc
 - `uploadSignatureVariant(params)`
 - `getSignatureVariant()`
 - `deleteSignatureVariant()`
-- `createFaceLivenessSession()`
-- `validateFaceLiveness({ sessionId })`
+-
 - `requestRevocation(params)`
 - `getRevocationReasons()`
 
@@ -501,7 +500,7 @@ const imageFile = new File(
     /* datos */
   ],
   "firma.png",
-  { type: "image/png" }
+  { type: "image/png" },
 );
 const result = await apacuana.uploadSignatureVariant({ file: imageFile });
 // result.data contendrá la información de la variante subida
@@ -518,48 +517,61 @@ const result = await apacuana.getSignatureVariant();
 // result.data contendrá la imagen en Base64
 ```
 
-### `deleteSignatureVariant()`
+### `sendFaceLiveness(params)`
 
-Elimina la variante de firma almacenada para el usuario autenticado. Este método solo está disponible si el SDK fue inicializado con un customerId. No requiere parámetros de entrada. Si la operación es exitosa, el resultado vendrá en el objeto `data` del response. Si no existe una variante de firma registrada, la operación no tendrá efecto y el resultado indicará el estado actual.
+Envía la captura de biometría facial (Prueba de Vida) para ser procesada y vinculada a un trámite específico.
 
-**Ejemplo:**
+Ejemplo de estructura de parámetros:
 
-```javascript
-try {
-  const response = await apacuana.deleteSignatureVariant();
-  console.log(response.data);
-} catch (error) {
-  console.error("Error al eliminar la firma:", error.message);
+```js
+{
+  faceLiveness: base64,
+  documentprefid: 'id-pref-faceliveness'
 }
 ```
 
-### `createFaceLivenessSession()`
+#### Comportamiento:
 
-Crea una nueva sesión de prueba de vida (face liveness) para el usuario autenticado. Este método solo está disponible si el SDK fue inicializado con customerId. No requiere parámetros de entrada. El resultado vendrá en el objeto `data` del response, incluyendo el identificador único de la sesión creada.
+- Solo disponible para `integrationType: ONBOARDING`. Si se usa con `ONPREMISE`, lanzará un error `NOT_IMPLEMENTED`.
+- El SDK convierte automáticamente el Base64 en un archivo binario y lo sube al endpoint de validación de Apacuana. Devuelve una instancia de `ApacuanaSuccess` con un mensaje de confirmación.
 
-Ejemplo de uso:
+#### Respuesta:
 
-```js
-const result = await apacuana.createFaceLivenessSession();
-// result.data contendrá el ID de la sesión de prueba de vida
-```
+`````js
+{
+  success: true,
+  data: {
+    ...
+  }
+}
+
+#### Ejemplo:
+
+````javascript
+try {
+  const result = await apacuana.sendFaceLiveness({
+    faceLiveness: "data:image/png;base64,iVBOR...",
+    documentprefid: "DOC-12345",
+  });
+  console.log("Estado de envío:", result.data.status);
+} catch (error) {
+  console.error("Error:", error.message);
+}
 
-### `validateFaceLiveness({ sessionId })`
+`````
 
-Valida el resultado de una sesión de prueba de vida.
+### `deleteSignatureVariant()`
 
-- `sessionId` (String, **obligatorio**): El ID de la sesión de prueba de vida que se va a validar.
+Elimina la variante de firma almacenada para el usuario autenticado. Este método solo está disponible si el SDK fue inicializado con un customerId. No requiere parámetros de entrada. Si la operación es exitosa, el resultado vendrá en el objeto `data` del response. Si no existe una variante de firma registrada, la operación no tendrá efecto y el resultado indicará el estado actual.
 
 **Ejemplo:**
 
 ```javascript
 try {
-  const response = await apacuana.validateFaceLiveness({
-    sessionId: "your-session-id",
-  });
-  console.log("Resultado de la validación:", response.data);
+  const response = await apacuana.deleteSignatureVariant();
+  console.log(response.data);
 } catch (error) {
-  console.error("Error al validar la sesión de prueba de vida:", error.message);
+  console.error("Error al eliminar la firma:", error.message);
 }
 ```