{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"aa5f7600-4247-453c-9179-a107f231864b","name":"API Notary - FirmaVirtual","description":"## Introducción\n\nEsta API permite el envío de documentos firmados a notaría para su legalización. El flujo principal consiste en crear un trámite con el documento firmado, enviarlo al notario asignado y recibir notificaciones (callbacks) sobre cada acción que realice el notario, ya sea una observación o la entrega del documento notariado.\n\nCada interacción del notario con el trámite genera un callback hacia la URL configurada por el cliente, incluyendo el `status` actualizado y el `id` del trámite.\n\n---\n\n## Ambientes\n\nLa API cuenta con dos ambientes disponibles:\n\n| Ambiente | URL Base |\n| --- | --- |\n| **Producción** | `https://notary.firmavirtual.legal` |\n| **Demo (Sandbox)** | `https://demo-notary.firmavirtual.legal` |\n\n> **Nota:** Se recomienda probar primero la integración en el ambiente Demo antes de pasar a Producción. \n  \n\n---\n\n## Autenticación\n\nTodos los endpoints requieren autenticación mediante un API Key que debe enviarse en el header de cada petición:\n\n```\nX-API-KEY: {tu_api_key}\n\n ```\n\n### ¿Cómo obtener un API Key?\n\nAntes de usar la API debes solicitar la habilitación de tu API Key escribiendo a:\n\n- **Solicitud de API Key:** [karianny@firmavirtual.legal](https://mailto:karianny@firmavirtual.legal)\n    \n- **Información general:** [info@firmavirtual.legal](https://mailto:info@firmavirtual.legal)\n    \n\n---\n\n## Variables de entorno recomendadas en Postman\n\nPara facilitar el uso de la colección, se recomienda configurar las siguientes variables:\n\n| Variable | Descripción | Ejemplo |\n| --- | --- | --- |\n| `URL` | URL base del ambiente | `https://demo-notary.firmavirtual.legal` |\n| `TOKEN` | Tu API Key | `xxxxxxxxxxxxxxxxxxxx` |\n\n---\n\n## Tipos de legalización disponibles\n\n| Valor | Descripción |\n| --- | --- |\n| `CERTIFICACION_NOTARIAL` | Certificación notarial del documento |\n| `PROTOCOLIZACION_NOTARIAL` | Protocolización notarial del documento |\n| `ANF` | Autorización Notarial de Firma |\n\n---\n\n## Estados de un trámite\n\n| Status | Descripción |\n| --- | --- |\n| `PENDING` | El trámite está en proceso e ingresado al sistema |\n| `IN_REVIEW` | El trámite se encuentra en proceso de revisión por parte de la notaría |\n| `OBSERVED` | El notario dejó una observación. Puedes ver el detalle en el callback o consultando el trámite |\n| `NOTARIZED` / `COMPLETED` | El documento ha sido notariado exitosamente |\n\n\\- **Importante:** Para descargar el documento notariado debes consultar el trámite usando el endpoint **\"Visualizar un trámite\"** y obtener la `download_url` actualizada.\n\n> En el ambiente Sandbox, los documentos notariados son de prueba y contienen la leyenda `DOCUMENTO DEMO - NO VALIDO LEGALMENTE`. \n  \n\n---\n\n# Sandbox / Ambiente Demo\n\nEl ambiente Demo te permite probar la integración completa sin realizar trámites reales en notaría. Para activar las simulaciones, agrega el campo `demo_case` al crear el trámite:\n\n| Valor de `demo_case` | Comportamiento |\n| --- | --- |\n| `OBSERVE` | El sistema simula que el notario deja una observación. Recibirás el callback `procedure.observed` |\n| `NOTARIZE` | El sistema simula que el notario completa la notarización y sube un documento notariado de prueba. Recibirás el callback `procedure.notarized` |\n\n> **Recomendación:** Usa [webhook.site](https://webhook.site) para inspeccionar los callbacks durante el desarrollo. \n  \n\n---\n\n# Flujo recomendado de integración\n\n1. **Solicitar API Key** escribiendo a [karianny@firmavirtual.legal](https://mailto:karianny@firmavirtual.legal)\n    \n2. **Validar credenciales** consultando `GET /api/me`\n    \n3. **Configurar callback_url** en una URL pública accesible (en desarrollo puedes usar webhook.site)\n    \n4. **Crear trámite** con `POST /api/procedures` enviando el documento firmado\n    \n5. **Escuchar callbacks** en tu URL configurada\n    \n6. Si recibes `procedure.observed`: **subir corrección** con `POST /api/procedures/{ID_PROCEDURE}`\n    \n7. Si recibes `procedure.notarized`: **descargar documento notariado** consultando `GET /api/procedures/{ID_PROCEDURE}`","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"51572693","team":12846427,"collectionId":"aa5f7600-4247-453c-9179-a107f231864b","publishedId":"2sBXqJKLKQ","public":true,"publicUrl":"https://documenter-api.postman.tech/view/51572693/2sBXqJKLKQ","privateUrl":"https://go.postman.co/documentation/51572693-aa5f7600-4247-453c-9179-a107f231864b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/b0e4c9b3-7196-4f2f-8ab3-ece3ce9501ed/Ykc5bmIxOUdTVkpOUVY5V1NWSlVWVUZNWHpFeU1UQXVjRzVuLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/b0e4c9b3-7196-4f2f-8ab3-ece3ce9501ed/Ykc5bmIxOUdTVkpOUVY5V1NWSlVWVUZNWHpFeU1UQXVjRzVuLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.10","publishDate":"2026-04-28T15:09:27.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/b0e4c9b3-7196-4f2f-8ab3-ece3ce9501ed/Ykc5bmIxOUdTVkpOUVY5V1NWSlVWVUZNWHpFeU1UQXVjRzVuLnBuZw==","logoDark":"https://content.pstmn.io/b0e4c9b3-7196-4f2f-8ab3-ece3ce9501ed/Ykc5bmIxOUdTVkpOUVY5V1NWSlVWVUZNWHpFeU1UQXVjRzVuLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/901b35767dfb343f890047d4538919121daf44de49ef79b93b64fe50f251ed47","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBXqJKLKQ"}