Bienvenido a la documentación de la API de weetrust, diseñada específicamente para desarrolladores de empresas que buscan integrar la firma electrónica de manera eficiente y sin complicaciones en sus aplicaciones. Nuestro objetivo es proporcionarte todos los recursos necesarios para facilitar la integración de este proceso en tu flujo de trabajo.
\nCon la API de weetrust, podrás cargar documentos para ser enviados a firma, agregar firmantes, usar verificaciones de identidad, todo ello utilizando una API Restful para una experiencia fluida. Además, podrás compartir documentos firmados y verificar su autenticidad de manera sencilla usando blockchain.
\nLa documentación de weetrust está diseñada para guiarte a través de cada paso del proceso de integración, proporcionándote ejemplos claros y detallados para que puedas comenzar rápidamente a aprovechar todas las capacidades de la API de weetrust en tus aplicaciones.
\nPara mejorar su experiencia en el proceso de integración, contamos con dos entornos: uno de pruebas (sandbox), y otro de producción. Para hacer uso de ellos será necesario que previamente se registre para poder obtener un access token.
\nPaginas de registro:
\nEntorno de sandbox: https://sandbox.weetrust.com.mx/home/register
\nEntorno de producción: https://app.weetrust.mx/home/register
\nPaginas principales:
\nEntorno de sandbox: https://sandbox.weetrust.com.mx/
\nEntorno de producción: https://app.weetrust.mx/
\nNuestro ambiente de sandbox está pensado para que puedas realizar las pruebas de código necesarias previo a su integración con tu ambiente de producción. Es importante señalar que este ambiente está contemplado únicamente para que se realicen pruebas y no para documentos reales.
\nPara realizar peticiones a este ambiente deberás usar la ruta:
\nhttps://api-sandbox.weetrust.com.mx
Una vez que finalices con el proceso de pruebas podrás proceder a realizar la integración con el ambiente de producción.
\nPara realizar peticiones a este ambiente deberás usar la ruta:
\nhttps://api.weetrust.mx/
StartFragmentEndpoint que permite obtener un access token válido. Los access token tienen una vigencia de 5 minutos; si uno vence, es necesario generar uno nuevo.EndFragment
\n","urlObject":{"path":["token"],"host":["{{baseUrl}}access"],"query":[],"variable":[]}},"response":[],"_postman_id":"60e0de92-f9bf-4eb0-9f7e-c01dfd0388ba"}],"id":"f246e67a-ae47-4189-a7c3-c3b51bc97946","description":"Para acceder a nuestro servicio de API Restful, se necesita generar un access token .
\nPara generarlo se ocupa de un ID de usuario (user-id) y una clave de API (api-key). Estos elementos son cruciales para autorizar y autenticar la solicitud de acceso a nuestro servicio.
\nEl user-id identifica de manera única la cuenta de usuario, mientras que el api-key es una clave secreta que actúa como una especie de contraseña para garantizar que solo los desarrolladores autorizados puedan consumir la API.
\n\n\n📘
\n
\n\nEl api-key puede ser generado las veces que se necesite, por seguridad.
\n
Para obtener el user-id y el api-key deberá tener una cuenta en weetrust en el ambiente deseado, ya sea sandbox o productivo, despues ir a la sección de Perfil que se encuentra dentro del menú configuración y obtenerlos.
\n![\"Vista](\"https://files.readme.io/d016226-CleanShot_2024-02-21_at_12_.02.16.png\")
\n\nVista de perfil para credenciales de API
\nCuando se obtenga el access-token válido, se podrá realizar solicitudes a nuestra API, accediendo así a los recursos y funcionalidades que proporcionamos.
\n\n\n🚧
\n
\n\n","_postman_id":"f246e67a-ae47-4189-a7c3-c3b51bc97946"},{"name":"DOCUMENTO","item":[{"name":"Acciones del documento","item":[{"name":"Obtener documentos","id":"ceee2010-b915-4808-8ace-ce372aa83e1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{token}}","type":"text"},{"key":"user-id","value":"{{user-id}}","type":"text"}],"url":"{{baseUrl}}documents?status=COMPLETED","urlObject":{"host":["{{baseUrl}}documents"],"query":[{"key":"status","value":"COMPLETED"}],"variable":[]}},"response":[],"_postman_id":"ceee2010-b915-4808-8ace-ce372aa83e1f"},{"name":"Obtener un documento","id":"8fedc5a8-e2d1-4e77-943c-9dbf532d48c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","type":"text","value":"{{token}}"},{"key":"user-id","type":"text","value":"{{user-id}}"}],"url":"{{baseUrl}}documents/{{documentID}}","urlObject":{"path":["{{documentID}}"],"host":["{{baseUrl}}documents"],"query":[],"variable":[]}},"response":[],"_postman_id":"8fedc5a8-e2d1-4e77-943c-9dbf532d48c3"},{"name":"Editar documento","id":"db1e1898-c3ee-4938-a198-b93d4b7bb56d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"documentID","value":"{{documentID}}","type":"text"},{"key":"documentSignType","value":"","type":"text"},{"key":"country","value":"Mexico","type":"text"},{"key":"position","value":"","type":"text"}]},"url":"{{baseUrl}}documents","urlObject":{"host":["{{baseUrl}}documents"],"query":[],"variable":[]}},"response":[],"_postman_id":"db1e1898-c3ee-4938-a198-b93d4b7bb56d"},{"name":"Eliminar documento","id":"e504015c-666c-45c9-b295-170db2e31dd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"token","type":"text","value":"{{token}}"},{"key":"user-id","type":"text","value":"{{user-id}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}documents/?documentID={{documentID}}","urlObject":{"path":[""],"host":["{{baseUrl}}documents"],"query":[{"key":"documentID","value":"{{documentID}}"}],"variable":[]}},"response":[],"_postman_id":"e504015c-666c-45c9-b295-170db2e31dd5"}],"id":"1ec42113-20a8-4e66-83ab-c867a1778a5d","_postman_id":"1ec42113-20a8-4e66-83ab-c867a1778a5d","description":""},{"name":"Otras funcionalidades","item":[{"name":"Validar integridad de documento","id":"dd133b73-50fd-4863-a32e-97dff1dfacfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"user-id","type":"text","value":"{{user-id}}"},{"key":"token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"document","type":"file","value":null}]},"url":"{{baseUrl}}documents/validate","urlObject":{"path":["validate"],"host":["{{baseUrl}}documents"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd133b73-50fd-4863-a32e-97dff1dfacfa"},{"name":"Reenviar correo a firmantes de un documento","id":"31cd534e-267a-40d3-a652-77fe5f20ae9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"user-id","type":"text","value":"{{user-id}}"},{"key":"token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{baseUrl}}documents/resend-email?documentID={{documentID}}","urlObject":{"path":["resend-email"],"host":["{{baseUrl}}documents"],"query":[{"key":"documentID","value":"{{documentID}}"}],"variable":[]}},"response":[],"_postman_id":"31cd534e-267a-40d3-a652-77fe5f20ae9b"},{"name":"Compartir documento","id":"743a74ff-c3bd-4615-a46c-714ac5487d8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"user-id","type":"text","value":"{{user-id}}"},{"key":"token","type":"text","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"documentID","value":"{{documentID}}","type":"text"},{"key":"postedTo","value":"email@domain.com","type":"text"}]},"url":"{{baseUrl}}documents/share","urlObject":{"path":["share"],"host":["{{baseUrl}}documents"],"query":[],"variable":[]}},"response":[],"_postman_id":"743a74ff-c3bd-4615-a46c-714ac5487d8c"},{"name":"Regenerar enlaces de firma de un documento","id":"f5efaeb0-f156-4710-82fd-6831d95cec82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"token","type":"text","value":"{{token}}"},{"key":"user-id","type":"text","value":"{{user-id}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"documentID\": \"{{documentID}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}documents/update-signatures","urlObject":{"path":["update-signatures"],"host":["{{baseUrl}}documents"],"query":[],"variable":[]}},"response":[],"_postman_id":"f5efaeb0-f156-4710-82fd-6831d95cec82"},{"name":"Repetir solicitud de firma en documento","id":"6f3b7fa8-1f59-4e30-8f81-bfd6a511836b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"token","type":"text","value":"{{token}}"},{"key":"user-id","type":"text","value":"{{user-id}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"documentID\": \"618c2f82413ebb18cb71aa8e\",\n \"biometricLogID\": \"618c3051413ebb18cb71aa96\",\n \"action\": \"biometricRetry\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}documents/retry-biometric","urlObject":{"path":["retry-biometric"],"host":["{{baseUrl}}documents"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f3b7fa8-1f59-4e30-8f81-bfd6a511836b"},{"name":"Actualizar URL de documento","id":"9c981720-9d42-4247-9658-06a6223bfb7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"token","type":"text","value":"{{token}}"},{"key":"user-id","type":"text","value":"{{user-id}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"documentID\": \"602ec9ccaef6711edeeb8f44\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}documents/update-url","urlObject":{"path":["update-url"],"host":["{{baseUrl}}documents"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c981720-9d42-4247-9658-06a6223bfb7e"}],"id":"5240acc4-69ac-47fb-b33e-0626e39d50de","_postman_id":"5240acc4-69ac-47fb-b33e-0626e39d50de","description":""},{"name":"Agregar documento","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"documentID\", jsonData.responseData.documentID);"],"type":"text/javascript","id":"c2d3074f-46cd-45f1-b6f5-12357c198dbc"}}],"id":"678511d2-92b4-46fb-99f2-82c631f71317","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{token}}","type":"text"},{"key":"user-id","value":"{{user-id}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"document","type":"file","src":"/Users/ricardoisaacosunacastillo/Documents/Documentos/Firma.pdf"}]},"url":"{{baseUrl}}documents","urlObject":{"host":["{{baseUrl}}documents"],"query":[],"variable":[]}},"response":[],"_postman_id":"678511d2-92b4-46fb-99f2-82c631f71317"},{"name":"Fijar la firma en base a coordenadas en un documento","id":"272634b3-3b87-464a-af08-1a8a8bbd7a82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"token","value":"{{token}}","type":"text"},{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"documentID\":\"66a2c1f680a4e70035717732\",\"staticSignPositions\":[{\"user\":{\"email\":\"malena@neoleasing.mx\"},\"coordinates\":{\"x\":\" 130\",\"y\":\" 131\"},\"page\":\" 11\",\"pageY\":\" 131\",\"pageYv2\":\" 131\",\"color\":\"#FFD247\",\"imageSize\":{\"width\":80,\"height\":51},\"parentImageSize\":{\"width\":590,\"height\":792},\"viewport\":{\"width\":590,\"height\":792}},{\"user\":{\"email\":\"malena@neoleasing.mx\"},\"coordinates\":{\"x\":\" 130\",\"y\":\" 180\"},\"page\":\" 16\",\"pageY\":\" 180\",\"pageYv2\":\" 180\",\"color\":\"#FFD247\",\"imageSize\":{\"width\":80,\"height\":51},\"parentImageSize\":{\"width\":590,\"height\":792},\"viewport\":{\"width\":590,\"height\":792}},{\"user\":{\"email\":\"mgme76@yahoo.com\"},\"coordinates\":{\"x\":\" 362\",\"y\":\" 131\"},\"page\":\" 11\",\"pageY\":\" 131\",\"pageYv2\":\" 131\",\"color\":\"#FFD247\",\"imageSize\":{\"width\":80,\"height\":51},\"parentImageSize\":{\"width\":590,\"height\":792},\"viewport\":{\"width\":590,\"height\":792}},{\"user\":{\"email\":\"mgme76@yahoo.com\"},\"coordinates\":{\"x\":\" 39\",\"y\":\" 599\"},\"page\":\" 13\",\"pageY\":\" 599\",\"pageYv2\":\" 599\",\"color\":\"#FFD247\",\"imageSize\":{\"width\":80,\"height\":51},\"parentImageSize\":{\"width\":590,\"height\":792},\"viewport\":{\"width\":590,\"height\":792}},{\"user\":{\"email\":\"mgme76@yahoo.com\"},\"coordinates\":{\"x\":\" 365\",\"y\":\" 180\"},\"page\":\" 16\",\"pageY\":\" 180\",\"pageYv2\":\" 180\",\"color\":\"#FFD247\",\"imageSize\":{\"width\":80,\"height\":51},\"parentImageSize\":{\"width\":590,\"height\":792},\"viewport\":{\"width\":590,\"height\":792}},{\"user\":{\"email\":\"jlmo1968@gmail.com\"},\"coordinates\":{\"x\":\" 337\",\"y\":\" 276\"},\"page\":\" 11\",\"pageY\":\" 276\",\"pageYv2\":\" 276\",\"color\":\"#FFD247\",\"imageSize\":{\"width\":80,\"height\":51},\"parentImageSize\":{\"width\":590,\"height\":792},\"viewport\":{\"width\":590,\"height\":792}},{\"user\":{\"email\":\"jlmo1968@gmail.com\"},\"coordinates\":{\"x\":\" 50\",\"y\":\" 355\"},\"page\":\" 16\",\"pageY\":\" 355\",\"pageYv2\":\" 355\",\"color\":\"#FFD247\",\"imageSize\":{\"width\":80,\"height\":51},\"parentImageSize\":{\"width\":590,\"height\":792},\"viewport\":{\"width\":590,\"height\":792}}]}"},"url":"{{baseUrl}}documents/fixed-signatory","urlObject":{"path":["fixed-signatory"],"host":["{{baseUrl}}documents"],"query":[],"variable":[]}},"response":[],"_postman_id":"272634b3-3b87-464a-af08-1a8a8bbd7a82"},{"name":"Enviar documento a firma","id":"e3907628-2b80-4a3f-abcf-0b12cb5f75a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"token","type":"text","value":"{{token}}"},{"key":"user-id","type":"text","value":"{{user-id}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"documentID\": \"{{documentID}}\",\n \"message\": \"Nuevo\",\n \"title\": \"Documento Prueba Nuevo\",\n \"hasOrder\": true,\n \"disableMailing\": false,\n \"signatory\": [{\n \"emailID\": \"email@domain.com\",\n \"name\": \"Juanito Perez\",\n \"identification\": \"face\",\n \"check\": true,\n \"order\": 105\n }, {\n \"emailID\": \"email2@domain.com\",\n \"name\": \"Juanito López\",\n \"identification\": \"face\",\n \"check\": false,\n \"order\": 4\n }, {\n \"emailID\": \"email3@domain.com\",\n \"name\": \"Juanito García\",\n \"identification\": \"face\",\n \"check\": false,\n \"order\": 78\n }]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}documents/signatory","urlObject":{"path":["signatory"],"host":["{{baseUrl}}documents"],"query":[],"variable":[]}},"response":[],"_postman_id":"e3907628-2b80-4a3f-abcf-0b12cb5f75a4"}],"id":"580c407a-5966-4154-a050-24c497aa3171","description":"Recuerda mantener tu user-id y api-key de manera segura y confidencial, ya que son fundamentales para garantizar la seguridad de tus interacciones con nuestra plataforma.
\n
weetrust permite un flujo de firma digital muy sencillo y fácil de integrar a cualquier tipo de operación de negocio.
\nEl primer paso en el flujo de firma de un documento es obtener un Token de Acceso con las credenciales.
\nPetición:
\nShell
\ncurl --location --request POST 'https://api-sandbox.weetrust.com.mx/access/token' \\\n--header 'user-id: [USER_ID]' \\\n--header 'api-key: [API_KEY]'\n\nRespuesta:
\nJSON
\n{\n \"responseData\": {\n \"accessToken\": \"[ACCESS_TOKEN]\"\n },\n \"message\": \"Token generated Successfully\",\n \"success\": true,\n \"responseCode\": 200\n}\n\n\n\n<h2 ><p >📘</p><p >El token solo es válido durante 5 min.</p></h2>
\n
Para el segundo paso, se deberá de Agregar el documento que se desea firmar en formato PDF o DOCX.
\n\n\n<h2 ><p >📘</p><p >Para esta petición se requiere enviar el token previamente obtenido.</p></h2>
\n
Petición:
\nJSON
\ncurl --location 'https://api-sandbox.weetrust.com.mx/documents' \\\n--header 'token: [ACCESS_TOKEN]' \\\n--header 'user-id: [USER_ID]' \\\n--form 'document=@\"sample.pdf\"'\n\nRespuesta:
\nJSON
\n{\n \"responseData\": {\n \"documentID\": \"65d7d2a3867234003591c367\",\n \"documentType\": \"OTHERS\",\n \"status\": \"DRAFT\",\n \"country\": \"Mexico\",\n \"documentSignType\": \"ELECTRONIC_SIGNATURE\",\n \"addedOn\": 1708642980323,\n \"documentFileObj\": {\n \"url\": \"[SIGNED_URL_DOCUMENT_UPLOADED]\",\n \"size\": \"71.5 KB\"\n },\n \"signatory\": [],\n \"sharedWith\": [],\n \"pscCertificate\": \"\",\n \"blockchainCertificate\": \"\"\n },\n \"message\": \"Saved Successfully\",\n \"success\": true,\n \"responseCode\": 200\n}\n\nComo tercer paso, de forma opcional, si se requiere posicionar la firma del usuario(s) en una coordenada especifica sobre el documento, por ejemplo en una linea al pie de pagina o en los laterales, se debe utilizar el endpoint de fixed-signatory.
\nPara obtener las coordenadas que se envian en el parametro de staticSignPositions usaremos la herramienta de PDF Coordinates
\n\n\n<h2 ><p >📘</p><p >Si se omite este paso, el firmante podrá posicionar la firma en cualquier parte del documento.</p></h2>
\n
\n\n<h2 ><p >📘</p><p >Si se requiere posicionar mas de una firma, se debe enviar un arreglo de objetos en el parametro staticSignPositions</p></h2>
\n
Petición:
\nShell
\ncurl --location --request PUT 'https://api-sandbox.weetrust.com.mx/documents/fixed-signatory' \\\n--header 'accept: application/json' \\\n--header 'content-type: application/json' \\\n--header 'token: [ACCESS_TOKEN]' \\\n--header 'user-id: [USER_ID]' \\\n--data-raw '{\n \"documentID\": \"65d7d2a3867234003591c367\",\n \"staticSignPositions\": [\n {\n \"user\": {\n \"email\": \"email@example.com\"\n },\n \"coordinates\": {\n \"x\": 324,\n \"y\": 314\n },\n \"page\": 1,\n \"pageY\": 314,\n \"pageYv2\": 314,\n \"color\": \"#FFD247\",\n \"imageSize\": {\n \"width\": 101,\n \"height\": 51\n },\n \"parentImageSize\": {\n \"width\": 612,\n \"height\": 792\n },\n \"viewport\": {\n \"width\": 612,\n \"height\": 792\n }\n }\n ]\n}'\n\nRespuesta:
\nJSON
\n{\n \"responseData\": {\n \"documentID\": \"65d7d2a3867234003591c367\",\n \"documentType\": \"OTHERS\",\n \"status\": \"DRAFT\",\n \"country\": \"Mexico\",\n \"documentSignType\": \"ELECTRONIC_SIGNATURE\",\n \"addedOn\": 1708959160376,\n \"documentFileObj\": {\n \"url\": \"[URL_DOCUMENT]\",\n \"size\": \"71.5 KB\"\n },\n \"signatory\": [],\n \"sharedWith\": [],\n \"pscCertificate\": \"\",\n \"blockchainCertificate\": \"\"\n },\n \"message\": \"Updated Successfully\",\n \"success\": true,\n \"responseCode\": 200\n}\n\nUna vez configurado el documento, se deberá de enviar la solicitud a los firmantes que usted requiera en dicho documento. Puede ser ser uno o más, en este caso enviaremos un solo firmante.
\nPeticion
\nJSON
\n{\n \"documentID\": \"65d7d2a3867234003591c367\",\n \"message\": \"Se le solicita la firma del siguiente contrato\",\n \"title\": \"Firma de contrato\",\n \"signatory\": [\n {\n \"emailID\": \"jose.perez@example.com\",\n \"name\": \"José Pérez\"\n }\n ]\n}\n\nRespuesta
\nJSON
\n{\n \"responseData\": {\n \"documentID\": \"65d7d2a3867234003591c367\",\n \"documentType\": \"OTHERS\",\n \"status\": \"PENDING\",\n \"country\": \"Mexico\",\n \"documentSignType\": \"ELECTRONIC_SIGNATURE\",\n \"addedOn\": 1708959097626,\n \"documentFileObj\": {\n \"url\": \"[DOCUMENT_FILE_URL]\",\n \"size\": \"71.5 KB\"\n },\n \"signatory\": [\n {\n \"emailID\": \"jose.perez@example.com\",\n \"name\": \"José Pérez\",\n \"isSigned\": 0,\n \"signatoryID\": \"65dca59c8f034d002a289ea2\",\n \"signing\": {\n \"url\": \"https://test.weetrust.com.mx/signatory/65dc45788f034d002a289e9bx/65dca59c8f034d002a289ea8/1708959132938/8b0015\",\n \"expiry\": 1709823132958\n },\n \"imageURL\": \"\",\n \"emailTracking\": []\n }\n ],\n \"sharedWith\": [],\n \"pscCertificate\": \"\",\n \"blockchainCertificate\": \"\"\n },\n \"message\": \"Updated Successfully\",\n \"success\": true,\n \"responseCode\": 200\n}\n\nSe remienda el uso de webhooks para recibir notificaciones de los eventos relacionados a la trazabilidad de la firma del documento.
\nPara ello puede revisar la guia rapida de webooks en Guia Rapida de Webhooks
\n\n\n","_postman_id":"580c407a-5966-4154-a050-24c497aa3171"},{"name":"IDENTIDAD","item":[{"name":"Extracción de recibos de México","item":[{"name":"Verificar OCR","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"uuid\", jsonData.responseData.uuid);"],"type":"text/javascript","id":"650f8cbf-ff38-4f76-aa1f-26e31905955e"}}],"id":"c0603d84-6512-4060-9f35-bc25e315bd42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fileImage\": \"{{cfeImage}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}ocr/verify","urlObject":{"path":["verify"],"host":["{{baseUrl}}ocr"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0603d84-6512-4060-9f35-bc25e315bd42"},{"name":"Obtener resultados de OCR","id":"34e06779-3e2c-4241-a418-71f5c42d7924","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"uuid\": \"{{uuid}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}ocr/get-results","urlObject":{"path":["get-results"],"host":["{{baseUrl}}ocr"],"query":[],"variable":[]}},"response":[],"_postman_id":"34e06779-3e2c-4241-a418-71f5c42d7924"}],"id":"b1cfa4d3-adef-4f3f-9b2b-1a0266b33812","_postman_id":"b1cfa4d3-adef-4f3f-9b2b-1a0266b33812","description":""},{"name":"Verificación","item":[{"name":"Verificar ID","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"uuid\", jsonData.responseData.uuid);"],"type":"text/javascript","id":"3744815d-686f-4ccc-b093-5b7d681030f5"}}],"id":"66f86420-d617-4c2b-8035-b495734c0184","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"frontImage\": \"{{frontImage}}\",\n \"backImage\": \"{{backImage}}\",\n \"faceImage\": \"{{faceImage}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}biometric/verify-document","urlObject":{"path":["verify-document"],"host":["{{baseUrl}}biometric"],"query":[],"variable":[]}},"response":[],"_postman_id":"66f86420-d617-4c2b-8035-b495734c0184"},{"name":"Obtener estado de la biometria","id":"4f7f7084-4c53-47fa-8336-bd5349c05cab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"uuid\": \"{{uuid}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}biometric/get-status","urlObject":{"path":["get-status"],"host":["{{baseUrl}}biometric"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f7f7084-4c53-47fa-8336-bd5349c05cab"},{"name":"Obtener resultados de la verificación","id":"67b47e54-8b76-44da-a77a-ec82a22e8e8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"uuid\": \"{{uuid}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}biometric/get-results","urlObject":{"path":["get-results"],"host":["{{baseUrl}}biometric"],"query":[],"variable":[]}},"response":[],"_postman_id":"67b47e54-8b76-44da-a77a-ec82a22e8e8d"},{"name":"Validar CURP","id":"9431e366-db9d-4082-be84-2a318a70410d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"curp\": \"{{curp}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}biometric/validate-curp","urlObject":{"path":["validate-curp"],"host":["{{baseUrl}}biometric"],"query":[],"variable":[]}},"response":[],"_postman_id":"9431e366-db9d-4082-be84-2a318a70410d"},{"name":"Validar INE/IFE","id":"b2ca285e-10b0-4f8a-905d-b991b3be4ba9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ocr\": \"{{ocr}}\",\n \"claveElector\": \"{{claveElector}}\",\n \"numeroEmision\": \"{{numeroEmision}}\",\n \"cic\": \"{{cic}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}biometric/validate-ine","urlObject":{"path":["validate-ine"],"host":["{{baseUrl}}biometric"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2ca285e-10b0-4f8a-905d-b991b3be4ba9"}],"id":"5b33e240-187f-4149-97b4-f9d282cd2a51","_postman_id":"5b33e240-187f-4149-97b4-f9d282cd2a51","description":""}],"id":"c880acb3-39a3-4ae1-a945-d1498af433c8","description":"<h2 ><p >🚧</p><p >No se recomienda el uso de long polling.</p></h2>
\n
Verificación de los rasgos biométricos faciales de una selfie vs la fotografía del documento de identidad de forma independiente al flujo normal de documentos.
\n","_postman_id":"c880acb3-39a3-4ae1-a945-d1498af433c8"},{"name":"WEBHOOKS","item":[{"name":"Documentos","item":[{"name":"Agregar webhook de documento","id":"3b8b5ed2-9e78-4ab1-a5ba-e354961cbb9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"options\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}webhooks?url=https://webhook.site/84879336-a343-4edb-bcf6-ca5c85be0f75&type=completedDocument","urlObject":{"host":["{{baseUrl}}webhooks"],"query":[{"key":"url","value":"https://webhook.site/84879336-a343-4edb-bcf6-ca5c85be0f75"},{"key":"type","value":"completedDocument"}],"variable":[]}},"response":[],"_postman_id":"3b8b5ed2-9e78-4ab1-a5ba-e354961cbb9e"},{"name":"Obtener webhook en documento","id":"f7f5b919-8f69-4cb3-9959-f673cf78f5cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}webhooks","urlObject":{"host":["{{baseUrl}}webhooks"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7f5b919-8f69-4cb3-9959-f673cf78f5cb"},{"name":"Actualizar webhook de documento","id":"afbba67b-da88-4ddb-a3b8-5ee9981ab04e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"user-id","type":"text","value":"{{user-id}}"},{"key":"token","type":"text","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n \"options\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}webhooks?url=https://webhook.site/b8c5d380-5ba5-487b-876d-08ccbdf6abe4&type=failedBiometric&webHookID=e80a8661129c19a642f5623306af76df9c181bfb","urlObject":{"host":["{{baseUrl}}webhooks"],"query":[{"key":"url","value":"https://webhook.site/b8c5d380-5ba5-487b-876d-08ccbdf6abe4"},{"key":"type","value":"failedBiometric"},{"key":"webHookID","value":"e80a8661129c19a642f5623306af76df9c181bfb"}],"variable":[]}},"response":[],"_postman_id":"afbba67b-da88-4ddb-a3b8-5ee9981ab04e"},{"name":"Eliminar webhook de documento","id":"0db75074-481c-4c10-a42b-d13ed46a29cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user-id","type":"text","value":"{{user-id}}"},{"key":"token","type":"text","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n\t\"options\": [{\n\t\t\"key\": \"llave\",\n\t\t\"value\": \"valor\"\n\t}, {\n\t\t\"key\": \"token\",\n\t\t\"value\": \"12345\"\n\t}, {\n\t\t\"key\": \"valor2\",\n\t\t\"value\": \"llave2\"\n\t}]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}webhooks?webHookID=4ea00c429fe7c937682ddb15e0e29f836541103d","urlObject":{"host":["{{baseUrl}}webhooks"],"query":[{"key":"webHookID","value":"4ea00c429fe7c937682ddb15e0e29f836541103d"}],"variable":[]}},"response":[],"_postman_id":"0db75074-481c-4c10-a42b-d13ed46a29cd"}],"id":"5913e62e-18d0-448c-9822-7a34fbb0c744","_postman_id":"5913e62e-18d0-448c-9822-7a34fbb0c744","description":""},{"name":"Verificaciones","item":[{"name":"Agregar webhook de verificación","id":"80b6ca4f-5cae-4b5c-a1df-c92525706564","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Webhooksite Identity\",\n \"type\": \"IDENTITY_FINISHED\",\n \"url\": \"https://webhook.site/b2346f1e-c5ce-49ef-bfc2-0f144b4f22ed\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}webhooks/verify","urlObject":{"path":["verify"],"host":["{{baseUrl}}webhooks"],"query":[],"variable":[]}},"response":[],"_postman_id":"80b6ca4f-5cae-4b5c-a1df-c92525706564"},{"name":"Obtener webhook de verificación","id":"15e1813f-ede9-4256-a003-67b1cfb0b4d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}webhooks/verify","urlObject":{"path":["verify"],"host":["{{baseUrl}}webhooks"],"query":[],"variable":[]}},"response":[],"_postman_id":"15e1813f-ede9-4256-a003-67b1cfb0b4d5"},{"name":"Actualizar webhook de verificación","id":"e12c225c-bd00-4b8e-918a-462b01d9a2af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://webhook.site/f8570106-3f90-438e-bc79-f82c3ddfbdf5\",\n \"webHookID\": \"a62c96152cd7c546cf2455995858b44aa7e10569\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}webhooks/verify","urlObject":{"path":["verify"],"host":["{{baseUrl}}webhooks"],"query":[],"variable":[]}},"response":[],"_postman_id":"e12c225c-bd00-4b8e-918a-462b01d9a2af"},{"name":"Eliminar webhook de verificación","id":"d63d60a4-a875-40b8-8b4f-b400c73c41c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"user-id","value":"{{user-id}}","type":"text"},{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}webhooks/verify?webHookID=","urlObject":{"path":["verify"],"host":["{{baseUrl}}webhooks"],"query":[{"key":"webHookID","value":""}],"variable":[]}},"response":[],"_postman_id":"d63d60a4-a875-40b8-8b4f-b400c73c41c7"}],"id":"c1aba041-e88f-4cdb-b4e9-234601036e99","_postman_id":"c1aba041-e88f-4cdb-b4e9-234601036e99","description":""}],"id":"d983263a-ea2a-4c74-b541-0e9024991dc5","description":"Los webhooks permiten conocer el estado de diferentes eventos relacionados con los procesos de los documentos, los cuales no tienen un tiempo determinado para dar una respuesta. De esta manera, se pueden programar eventos que permitan conocer cuando estos procesos finalicen, a través de la configuración que el usuario provea.
\nA continuación, se enlista los eventos relacionados al documentos desde que se envía a firma hasta cuando se completa.
\nAquí mostraremos como hacer el registro de un webhook usando los tipos de webhook de documentos, para los ejemplos usaremos https://webhook.site/ que permite poder escuchar eventos usando webhook's.
\nPetición
\nShell
\ncurl --location --request POST 'https://api-sandbox.weetrust.com.mx/webhooks?url=https://webhook.site/2424c940-1a2b-49bc-b2c8-b07ca0196c8c&type=completedDocument' \\\n--header 'user-id: [USER_ID]' \\\n--header 'token: [ACCESS_TOKEN]'\n\nRespuesta
\nJSON
\n{\n \"responseData\": {\n \"webHookID\": \"83d3731d2fc20204e1b9cefb411561cfdc5b57d3\",\n \"type\": \"completedDocument\",\n \"addedOn\": 1709050181018,\n \"webHookUrl\": \"https://webhook.site/2424c940-1a2b-49bc-b2c8-b07ca0196c8c\",\n \"options\": []\n },\n \"message\": \"WebHook Added Successfully\",\n \"success\": true,\n \"responseCode\": 200\n}\n\nPuedes enlistar todos los webhook's que hallas registrado por tipo de evento, para ello puedes usar el siguiente endpoint
\nPetición
\nShell
\ncurl --location 'https://api-sandbox.weetrust.com.mx/webhooks' \\\n--header 'user-id: [USER_ID]' \\\n--header 'token: [ACCESS_TOKEN]'\n\nRespuesta
\nJSON
\n{\n \"responseData\": [\n {\n \"webHookID\": \"83d3731d9fc24204e1b9c8fb011561cfdc5b57d3\",\n \"type\": \"completedDocument\",\n \"addedOn\": 1709050181018,\n \"webHookUrl\": \"https://webhook.site/ca85fe6c-f53b-456-bf37-cdc85dce46eb\",\n \"options\": []\n }\n ],\n \"message\": \"Get Successfully\",\n \"success\": true,\n \"responseCode\": 200\n}\n\nPara eliminar un webhook, solo será necesario conocer el webHookID que se puede conseguir al momento de crear o de listar el webhook.
\nPetición
\nShell
\ncurl --location --request DELETE 'https://api-sandbox.weetrust.com.mx/webhooks?webHookID=83d3731d9fc20204e1b9cefb011561cfdc5b57d3' \\\n--header 'user-id: [USER_ID]' \\\n--header 'token: [ACCESS_TOKEN]' \\\n--header 'Content-Type: application/json'\n\nRespuesta
\n{\n \"responseData\": {},\n \"message\": \"Deleted Successfully\",\n \"success\": true,\n \"responseCode\": 200\n}\n\n{\n \"type\": \"completedDocument\",\n \"Document\": {\n \"_id\": \"65df4ceed7c349002a067f03\",\n \"documentFileObj\": {\n \"url\": \"[DOCUMENT_URL]\",\n \"key\": \"[FILENAME].pdf\",\n \"pendingForBlockChain\": \"\",\n \"originalKey\": \"[FILENAME].pdf\",\n \"version\": \"\",\n \"size\": \"71.5 KB\"\n },\n \"createdBy\": {\n \"userID\": \"[USER_ID]\",\n \"adminID\": \"\",\n \"fullName\": \"Firma digital\",\n \"emailID\": \"admin@email.com\",\n \"isSigned\": \"false\"\n },\n \"savedDocument\": {},\n \"computedFields\": {\n \"signatoryCount\": 1,\n \"pendingSignatoryCount\": 0,\n \"biometricCount\": 0,\n \"validBiometricCount\": 0,\n \"pendingBiometricCount\": 0,\n \"isAllSignatoryPending\": false,\n \"signatoryCountLessOne\": 0,\n \"isAllValidBiometric\": true,\n \"search\": [\n ]\n },\n \"documentID\": \"65df4ceed7c499002a067f03\",\n \"documentHash\": \"6f1de3e2f844b5346c960295761d7cbdb51e9f75adb5fee48ef9bbe35f456c7880839f2ca5176d68ef28c9e0ecad52328d1f126137c69334927054e08163\",\n \"nomHash\": \"\",\n \"apiNomFileName\": \"\",\n \"pdfNomFileName\": \"\",\n \"title\": \"[FILENAME].pdf\",\n \"signatoryMessage\": \"Por favor firma el documento\",\n \"signatoryTitle\": \"Fija firma por api\",\n \"documentType\": \"OTHERS\",\n \"verificationType\": \"\",\n \"status\": \"COMPLETED\",\n \"country\": \"Mexico\",\n \"documentSignType\": \"ELECTRONIC_SIGNATURE\",\n \"isForceID\": false,\n \"hasOrder\": false,\n \"disableMailing\": false,\n \"documentFiles\": [],\n \"signatory\": [\n {\n \"signing\": {\n \"url\": \"[SIGNATURE_URL]\",\n \"expiry\": 1709997046234\n },\n \"forceBiometric\": {\n \"forcedPhotoID\": false,\n \"forcedID\": false,\n \"forcedFaceID\": false,\n \"forcedBackgroundCheck\": false,\n \"forcedFaceLogin\": false,\n \"forcedOcr\": false\n },\n \"signatoryID\": \"65d45cf6d7c299002a067f0a\",\n \"name\": \"Firma digital\",\n \"emailID\": \"admin@email.com\",\n \"phone\": \"\",\n \"verificationCode\": \"\",\n \"password\": \"\",\n \"order\": 0,\n \"photo\": [],\n \"isSigned\": 1,\n \"signatureType\": \"\",\n \"title\": \"Fija firma por api\",\n \"message\": \"Por favor firma el documento\",\n \"signature\": [],\n \"signatureArray\": [\n {\n \"url\": null,\n \"imageName\": \"[SIGN].png\",\n \"svgCoordinates\": null\n }\n ],\n \"fieldArray\": [\n {\n \"left\": 396,\n \"top\": 475.99999999999994,\n \"pageY\": 476,\n \"pageYv2\": 475.99999999999994,\n \"width\": 127.75735294117646,\n \"height\": 68.13725490196079,\n \"type\": \"SIGNATURE\",\n \"fontSize\": 0,\n \"page\": 1,\n \"viewport\": {\n \"width\": 695,\n \"height\": 899\n },\n \"extraData\": {},\n \"value\": \"[SIGN].png\"\n }\n ],\n \"isInvalidSignature\": false,\n \"invalidSignatureReason\": \"\",\n \"biometricApprovedByUser\": false,\n \"hasBiometricDocument\": false,\n \"identitySessionId\": \"\",\n \"biometric\": null,\n \"_id\": \"65df4cf6d7c299002a067f0a\",\n \"attachment\": [],\n \"attachmentUrl\": null\n },\n {\n \"userID\": \"[USER_ID]\",\n \"adminID\": \"\",\n \"fullName\": \"Firma digital\",\n \"emailID\": \"admin@example.com\",\n \"isSigned\": \"false\"\n }\n ],\n \"processingStatus\": \"IMAGE_PROCESSING_COMPLETED\",\n \"voBoStatus\": \"INITIAL\",\n \"isVoBo\": false,\n \"signatureArray\": [],\n \"language\": \"es\",\n \"addedOn\": 1709133039470,\n \"modifiedOn\": 1709133066759,\n \"isDeleted\": 0,\n \"isInactive\": 0,\n \"isCanceled\": false,\n \"isActiveGeolocation\": false,\n \"isBiometricIDEnabled\": false,\n \"isBiometricFaceIDEnabled\": false,\n \"isBiometricBackgroundCheckEnabled\": false,\n \"version\": 2,\n \"templateHistoryID\": \"\",\n \"templateID\": \"\",\n \"isTemplateV2\": false,\n \"splitOriginDocumentId\": \"\",\n \"splitChildDocumentId\": \"\",\n \"splitPage\": \"\",\n \"splitNumber\": null,\n \"nickname\": \"\",\n \"identityProvider\": \"[PROVIDER]\",\n \"isSignatureText\": false,\n \"source\": \"DOCUMENT\",\n \"formSignatory\": [],\n \"formStatus\": \"\",\n \"formAnswer\": null,\n \"hasLegalPrivacyPolicy\": false,\n \"isEndorsement\": false,\n \"endorsementsCount\": 0,\n \"endorsementId\": \"\",\n \"isHiddenCreated\": false,\n \"autocaptureSDKEnabled\": false,\n \"isRatification\": false,\n \"documentImage\": [],\n \"logsStatus\": [\n {\n \"operationData\": {\n \"documentID\": \"\",\n \"signatoryID\": \"\",\n \"biometricID\": \"\",\n \"endorsementID\": \"\"\n },\n \"operationBy\": {\n \"name\": \"Firma digital\",\n \"emailID\": \"admin@email.com\"\n },\n \"operationType\": \"CREATED\",\n \"sourceIP\": \"127.172.0.55\",\n \"addedOn\": 1709133039470,\n \"_id\": \"65df4cf6d7c299002a067f0b\"\n },\n {\n \"operationData\": {\n \"documentID\": \"\",\n \"signatoryID\": \"\",\n \"biometricID\": \"\",\n \"endorsementID\": \"\"\n },\n \"operationBy\": {\n \"name\": \"Test\",\n \"emailID\": \"email@email.com\"\n },\n \"operationType\": \"SENT_FOR_SIGNATURE\",\n \"sourceIP\": \"\",\n \"addedOn\": 1709133046234,\n \"_id\": \"65df4cf3d7c299002a067f0c\"\n },\n {\n \"operationData\": {\n \"documentID\": \"\",\n \"signatoryID\": \"\",\n \"biometricID\": \"\",\n \"endorsementID\": \"\"\n },\n \"operationBy\": {\n \"name\": \"Test\",\n \"emailID\": \"email@email.com\"\n },\n \"operationType\": \"SIGNED\",\n \"sourceIP\": \"127.172.0.34\",\n \"addedOn\": 1709133066759,\n \"_id\": \"65df4d0ad74299002a067f12\"\n },\n {\n \"operationData\": {\n \"documentID\": \"\",\n \"signatoryID\": \"\",\n \"biometricID\": \"\",\n \"endorsementID\": \"\"\n },\n \"operationBy\": {\n \"name\": \"\",\n \"emailID\": \"\"\n },\n \"operationType\": \"STORED_IN_PSC_WORLD\",\n \"sourceIP\": \"\",\n \"addedOn\": 1709133070090,\n \"_id\": \"65df4d0ed7c299002a067f19\"\n },\n {\n \"operationData\": {\n \"documentID\": \"\",\n \"signatoryID\": \"\",\n \"biometricID\": \"\",\n \"endorsementID\": \"\"\n },\n \"operationBy\": {\n \"name\": \"\",\n \"emailID\": \"\"\n },\n \"operationType\": \"STORED_BLOCKCHAIN\",\n \"sourceIP\": \"\",\n \"addedOn\": 1709133070090,\n \"_id\": \"65df4d0ed7c299002a067f1a\"\n }\n ],\n \"voBo\": [],\n \"forwardings\": [],\n \"__v\": 0,\n \"computedAt\": \"2022-02-28T15:11:10.211Z\",\n \"lastUpdatedAt\": 1709133066759,\n \"documentURL\": \"[DOCUMENT_URL]\",\n \"certificateURL\": \"[CERTIFICATE_URL]\",\n \"pscCertificateURL\": \"[PSC_URL]\"\n },\n \"addedOn\": 1709133077879\n}\n\n{\n \"type\": \"signDocument\",\n \"Document\": {\n \"_id\": \"65df50c0d7c299002a067f28\",\n \"documentFileObj\": {\n \"url\": \"[DOCUMENT_URL]\",\n \"key\": \"[FILENAME].pdf\",\n \"pendingForBlockChain\": \"\",\n \"originalKey\": \"[FILENAME].pdf\",\n \"version\": \"\",\n \"size\": \"71.5 KB\"\n },\n \"createdBy\": {\n \"userID\": \"[USER_ID]\",\n \"adminID\": \"\",\n \"fullName\": \"Firma digital\",\n \"emailID\": \"admin@example.com\",\n \"isSigned\": \"false\"\n },\n \"savedDocument\": {},\n \"computedFields\": {\n \"signatoryCount\": 1,\n \"pendingSignatoryCount\": 1,\n \"biometricCount\": 0,\n \"validBiometricCount\": 0,\n \"pendingBiometricCount\": 0,\n \"isAllSignatoryPending\": true,\n \"signatoryCountLessOne\": -1,\n \"isAllValidBiometric\": false,\n \"search\": [\n ]\n },\n \"documentID\": \"65df50cc299002a067f28\",\n \"documentHash\": \"\",\n \"nomHash\": \"\",\n \"apiNomFileName\": \"\",\n \"pdfNomFileName\": \"\",\n \"title\": \"[FILENAME].pdf\",\n \"signatoryMessage\": \"Por favor firma el documento\",\n \"signatoryTitle\": \"Fija firma por api\",\n \"documentType\": \"OTHERS\",\n \"verificationType\": \"\",\n \"status\": \"PENDING\",\n \"country\": \"Mexico\",\n \"documentSignType\": \"ELECTRONIC_SIGNATURE\",\n \"isForceID\": false,\n \"hasOrder\": false,\n \"disableMailing\": false,\n \"documentFiles\": [],\n \"signatory\": [\n {\n \"signing\": {\n \"url\": \"[SIGNATURE_URL]\",\n \"expiry\": 1709998044386\n },\n \"forceBiometric\": {\n \"forcedPhotoID\": false,\n \"forcedID\": false,\n \"forcedFaceID\": false,\n \"forcedBackgroundCheck\": false,\n \"forcedFaceLogin\": false,\n \"forcedOcr\": false\n },\n \"signatoryID\": \"65dfdcd7c299002a067f2f\",\n \"name\": \"Test\",\n \"emailID\": \"example@example.com\",\n \"phone\": \"\",\n \"verificationCode\": \"\",\n \"password\": \"\",\n \"order\": 0,\n \"photo\": [],\n \"isSigned\": 1,\n \"signatureType\": \"\",\n \"title\": \"Fija firma por api\",\n \"message\": \"Por favor firma el documento\",\n \"signature\": [],\n \"signatureArray\": [\n {\n \"url\": null,\n \"imageName\": \"[SIGN_DRAW].png\",\n \"svgCoordinates\": null\n }\n ],\n \"fieldArray\": [\n {\n \"left\": 396,\n \"top\": 475.99999999999994,\n \"pageY\": 476,\n \"pageYv2\": 475.99999999999994,\n \"width\": 127.75735294117646,\n \"height\": 68.13725490196079,\n \"type\": \"SIGNATURE\",\n \"fontSize\": 0,\n \"page\": 1,\n \"viewport\": {\n \"width\": 695,\n \"height\": 899\n },\n \"extraData\": {},\n \"value\": \"[SIGN_DRAW].png\"\n }\n ],\n \"isInvalidSignature\": false,\n \"invalidSignatureReason\": \"\",\n \"biometricApprovedByUser\": false,\n \"hasBiometricDocument\": false,\n \"identitySessionId\": \"\",\n \"biometric\": null,\n \"_id\": \"65df50dcd799002a067f2f\",\n \"attachment\": [],\n \"attachmentUrl\": null\n }\n ],\n \"processingStatus\": \"IMAGE_PROCESSING_COMPLETED\",\n \"voBoStatus\": \"INITIAL\",\n \"isVoBo\": false,\n \"signatureArray\": [],\n \"language\": \"es\",\n \"addedOn\": 1709134018198,\n \"modifiedOn\": 1709134526413,\n \"isDeleted\": 0,\n \"isInactive\": 0,\n \"isCanceled\": false,\n \"isActiveGeolocation\": false,\n \"isBiometricIDEnabled\": false,\n \"isBiometricFaceIDEnabled\": false,\n \"isBiometricBackgroundCheckEnabled\": false,\n \"version\": 2,\n \"templateHistoryID\": \"\",\n \"templateID\": \"\",\n \"isTemplateV2\": false,\n \"splitOriginDocumentId\": \"\",\n \"splitChildDocumentId\": \"\",\n \"splitPage\": \"\",\n \"splitNumber\": null,\n \"nickname\": \"\",\n \"identityProvider\": \"[PROVIDER]\",\n \"isSignatureText\": false,\n \"source\": \"DOCUMENT\",\n \"formSignatory\": [],\n \"formStatus\": \"\",\n \"formAnswer\": null,\n \"hasLegalPrivacyPolicy\": false,\n \"isEndorsement\": false,\n \"endorsementsCount\": 0,\n \"endorsementId\": \"\",\n \"isHiddenCreated\": false,\n \"autocaptureSDKEnabled\": false,\n \"isRatification\": false,\n \"veridasSdkDocumentType\": \"\",\n \"veridasSdkDefaultCountry\": \"\",\n \"veridasSdkResidentPermit\": false,\n \"documentImage\": [],\n \"logsStatus\": [\n {\n \"operationData\": {\n \"documentID\": \"\",\n \"signatoryID\": \"\",\n \"biometricID\": \"\",\n \"endorsementID\": \"\"\n },\n \"operationBy\": {\n \"name\": \"firma digital\",\n \"emailID\": \"admin@example.com\"\n },\n \"operationType\": \"CREATED\",\n \"sourceIP\": \"[IP]\",\n \"addedOn\": 1709134018198,\n \"_id\": \"65df50dcd299002a067f30\"\n },\n {\n \"operationData\": {\n \"documentID\": \"\",\n \"signatoryID\": \"\",\n \"biometricID\": \"\",\n \"endorsementID\": \"\"\n },\n \"operationBy\": {\n \"name\": \"Test\",\n \"emailID\": \"example@example.com\"\n },\n \"operationType\": \"SENT_FOR_SIGNATURE\",\n \"sourceIP\": \"\",\n \"addedOn\": 1709134044386,\n \"_id\": \"65df50dcd7c299002a067f31\"\n },\n {\n \"operationData\": {\n \"documentID\": \"\",\n \"signatoryID\": \"\",\n \"biometricID\": \"\",\n \"endorsementID\": \"\"\n },\n \"operationBy\": {\n \"name\": \"Test\",\n \"emailID\": \"example@example.com\"\n },\n \"operationType\": \"SIGNED\",\n \"sourceIP\": \"[IP]\",\n \"addedOn\": 1709134526412,\n \"_id\": \"65df52bed799002a067f3a\"\n }\n ],\n \"voBo\": [],\n \"forwardings\": [],\n \"__v\": 0,\n \"computedAt\": \"2022-02-28T15:27:24.580Z\",\n \"lastUpdatedAt\": 1709134044386,\n \"webhookData\": {\n \"signatory\": {\n \"signing\": {\n \"url\": \"[SIGNATURE_URL]\",\n \"expiry\": 1709998044386\n },\n \"forceBiometric\": {\n \"forcedPhotoID\": false,\n \"forcedID\": false,\n \"forcedFaceID\": false,\n \"forcedBackgroundCheck\": false,\n \"forcedFaceLogin\": false,\n \"forcedOcr\": false\n },\n \"signatoryID\": \"65df50dcd7c9002a067f2f\",\n \"name\": \"Test\",\n \"emailID\": \"example@example.com\",\n \"phone\": \"\",\n \"verificationCode\": \"\",\n \"password\": \"\",\n \"order\": 0,\n \"photo\": [],\n \"isSigned\": 1,\n \"signatureType\": \"\",\n \"title\": \"Fija firma por api\",\n \"message\": \"Por favor firma el documento\",\n \"signature\": [],\n \"signatureArray\": [\n {\n \"url\": null,\n \"imageName\": \"[SIGN_DRAW].png\",\n \"svgCoordinates\": null\n }\n ],\n \"fieldArray\": [\n {\n \"left\": 396,\n \"top\": 475.99999999999994,\n \"pageY\": 476,\n \"pageYv2\": 475.99999999999994,\n \"width\": 127.75735294117646,\n \"height\": 68.13725490196079,\n \"type\": \"SIGNATURE\",\n \"fontSize\": 0,\n \"page\": 1,\n \"viewport\": {\n \"width\": 695,\n \"height\": 899\n },\n \"extraData\": {},\n \"value\": \"[SIGN_DRAW].png\"\n }\n ],\n \"isInvalidSignature\": false,\n \"invalidSignatureReason\": \"\",\n \"biometricApprovedByUser\": false,\n \"hasBiometricDocument\": false,\n \"identitySessionId\": \"\",\n \"biometric\": null,\n \"_id\": \"65df507c299002a067f2f\",\n \"attachment\": [],\n \"attachmentUrl\": null\n }\n }\n },\n \"addedOn\": 1709134526652\n}\n\n{\n \"type\": \"sendDocument\",\n \"Document\": {\n \"_id\": \"65df50c0d7c299002a067f28\",\n \"documentFileObj\": {\n \"url\": \"[DOCUMENT_URL]\",\n \"key\": \"[FILENAME].pdf\",\n \"pendingForBlockChain\": \"\",\n \"originalKey\": \"[FILENAME].pdf\",\n \"version\": \"\",\n \"size\": \"71.5 KB\"\n },\n \"createdBy\": {\n \"userID\": \"[USER_ID]\",\n \"adminID\": \"\",\n \"fullName\": \"FIRMA DIGITAL\",\n \"emailID\": \"admin@example.com\",\n \"isSigned\": \"false\"\n },\n \"savedDocument\": {},\n \"computedFields\": {\n \"signatoryCount\": 1,\n \"pendingSignatoryCount\": 0,\n \"biometricCount\": 0,\n \"validBiometricCount\": 0,\n \"pendingBiometricCount\": 0,\n \"isAllSignatoryPending\": false,\n \"signatoryCountLessOne\": 0,\n \"isAllValidBiometric\": true,\n \"search\": [\n ]\n },\n \"documentID\": \"65df50c0d7c002a067f28\",\n \"documentHash\": \"cfef0036be2dd04ca2c19908b694df570a9fda529d0bcf9e0fdc017e398efa68665f58bd89e99dc380bb36d97a1d4095d56469d81f0404bf746ee386b\",\n \"nomHash\": \"688fb0d6790e2355e5b7b99127146e044bfc5b544189b4af27e1b73fb3e90f85da861a1f31d46e6b5086251f237f0f578311112ac1a8fba74c47fc9807cfa445\",\n \"apiNomFileName\": \"[FILENAME].asn\",\n \"pdfNomFileName\": \"\",\n \"title\": \"[FILENAME].pdf\",\n \"signatoryMessage\": \"Por favor firma el documento\",\n \"signatoryTitle\": \"Fija firma por api\",\n \"documentType\": \"OTHERS\",\n \"verificationType\": \"\",\n \"status\": \"COMPLETED\",\n \"country\": \"Mexico\",\n \"documentSignType\": \"ELECTRONIC_SIGNATURE\",\n \"isForceID\": false,\n \"hasOrder\": false,\n \"disableMailing\": false,\n \"documentFiles\": [],\n \"signatory\": [\n {\n \"signing\": {\n \"url\": \"[SIGNATURE_URL]\",\n \"expiry\": 1709998044386\n },\n \"forceBiometric\": {\n \"forcedPhotoID\": false,\n \"forcedID\": false,\n \"forcedFaceID\": false,\n \"forcedBackgroundCheck\": false,\n \"forcedFaceLogin\": false,\n \"forcedOcr\": false\n },\n \"signatoryID\": \"65df5cd7c299002a067f2f\",\n \"name\": \"Test\",\n \"emailID\": \"example@example.com\",\n \"phone\": \"\",\n \"verificationCode\": \"\",\n \"password\": \"\",\n \"order\": 0,\n \"photo\": [],\n \"isSigned\": 1,\n \"signatureType\": \"\",\n \"title\": \"Fija firma por api\",\n \"message\": \"Por favor firma el documento\",\n \"signature\": [],\n \"signatureArray\": [\n {\n \"url\": null,\n \"imageName\": \"[SIGN_DRAW].png\",\n \"svgCoordinates\": null\n }\n ],\n \"fieldArray\": [\n {\n \"left\": 396,\n \"top\": 475.99999999999994,\n \"pageY\": 476,\n \"pageYv2\": 475.99999999999994,\n \"width\": 127.75735294117646,\n \"height\": 68.13725490196079,\n \"type\": \"SIGNATURE\",\n \"fontSize\": 0,\n \"page\": 1,\n \"viewport\": {\n \"width\": 695,\n \"height\": 899\n },\n \"extraData\": {},\n \"value\": \"[SIGN_DRAW].png\"\n }\n ],\n \"isInvalidSignature\": false,\n \"invalidSignatureReason\": \"\",\n \"biometricApprovedByUser\": false,\n \"hasBiometricDocument\": false,\n \"identitySessionId\": \"\",\n \"biometric\": null,\n \"_id\": \"65df50d7c299002a067f2f\",\n \"attachment\": [],\n \"attachmentUrl\": null\n }\n ],\n \"processingStatus\": \"COMPLETED\",\n \"voBoStatus\": \"INITIAL\",\n \"isVoBo\": false,\n \"signatureArray\": [],\n \"language\": \"es\",\n \"addedOn\": 1709134018198,\n \"modifiedOn\": 1709134526413,\n \"isDeleted\": 0,\n \"isInactive\": 0,\n \"isCanceled\": false,\n \"isActiveGeolocation\": false,\n \"isBiometricIDEnabled\": false,\n \"isBiometricFaceIDEnabled\": false,\n \"isBiometricBackgroundCheckEnabled\": false,\n \"version\": 2,\n \"templateHistoryID\": \"\",\n \"templateID\": \"\",\n \"isTemplateV2\": false,\n \"splitOriginDocumentId\": \"\",\n \"splitChildDocumentId\": \"\",\n \"splitPage\": \"\",\n \"splitNumber\": null,\n \"nickname\": \"\",\n \"identityProvider\": \"[PROVIDER]\",\n \"isSignatureText\": false,\n \"source\": \"DOCUMENT\",\n \"formSignatory\": [],\n \"formStatus\": \"\",\n \"formAnswer\": null,\n \"hasLegalPrivacyPolicy\": false,\n \"isEndorsement\": false,\n \"endorsementsCount\": 0,\n \"endorsementId\": \"\",\n \"isHiddenCreated\": false,\n \"autocaptureSDKEnabled\": false,\n \"isRatification\": false,\n \"veridasSdkDocumentType\": \"\",\n \"veridasSdkDefaultCountry\": \"\",\n \"veridasSdkResidentPermit\": false,\n \"documentImage\": [],\n \"logsStatus\": [\n {\n \"operationData\": {\n \"documentID\": \"\",\n \"signatoryID\": \"\",\n \"biometricID\": \"\",\n \"endorsementID\": \"\"\n },\n \"operationBy\": {\n \"name\": \"Firma digital\",\n \"emailID\": \"admin@example.com\"\n },\n \"operationType\": \"CREATED\",\n \"sourceIP\": \"[IP]\",\n \"addedOn\": 1709134018198,\n \"_id\": \"65df50dcd7c299002a067f30\"\n },\n {\n \"operationData\": {\n \"documentID\": \"\",\n \"signatoryID\": \"\",\n \"biometricID\": \"\",\n \"endorsementID\": \"\"\n },\n \"operationBy\": {\n \"name\": \"Test\",\n \"emailID\": \"example@example.com\"\n },\n \"operationType\": \"SENT_FOR_SIGNATURE\",\n \"sourceIP\": \"\",\n \"addedOn\": 1709134044386,\n \"_id\": \"65df50dcd7c299002a067f31\"\n },\n {\n \"operationData\": {\n \"documentID\": \"\",\n \"signatoryID\": \"\",\n \"biometricID\": \"\",\n \"endorsementID\": \"\"\n },\n \"operationBy\": {\n \"name\": \"Test\",\n \"emailID\": \"example@example.com\"\n },\n \"operationType\": \"SIGNED\",\n \"sourceIP\": \"187.172.0.50:52429\",\n \"addedOn\": 1709134526412,\n \"_id\": \"65df52bed7c299002a067f3a\"\n },\n {\n \"operationData\": {\n \"documentID\": \"\",\n \"signatoryID\": \"\",\n \"biometricID\": \"\",\n \"endorsementID\": \"\"\n },\n \"operationBy\": {\n \"name\": \"\",\n \"emailID\": \"\"\n },\n \"operationType\": \"STORED_IN_PSC_WORLD\",\n \"sourceIP\": \"\",\n \"addedOn\": 1709134529687,\n \"_id\": \"65df52c1d7c299002a067f41\"\n },\n {\n \"operationData\": {\n \"documentID\": \"\",\n \"signatoryID\": \"\",\n \"biometricID\": \"\",\n \"endorsementID\": \"\"\n },\n \"operationBy\": {\n \"name\": \"\",\n \"emailID\": \"\"\n },\n \"operationType\": \"STORED_BLOCKCHAIN\",\n \"sourceIP\": \"\",\n \"addedOn\": 1709134529687,\n \"_id\": \"65df52c1d7c299002a067f42\"\n }\n ],\n \"voBo\": [],\n \"forwardings\": [],\n \"__v\": 0,\n \"computedAt\": \"2024-02-28T15:35:34.512Z\",\n \"lastUpdatedAt\": 1709134526413,\n \"webhookData\": {\n \"signatory\": {\n \"emailID\": \"example@example.com\"\n },\n \"pscUrl\": \"[PSC_URL]\",\n \"documentURL\": \"[DOCUMENT_URL]\",\n \"certificateURL\": \"[CERTIFICATE_URL]\"\n }\n },\n \"addedOn\": 1709135576037\n}\n\n