Firma Virtual México - Clientes API
  1. Files
Firma Virtual México - Clientes API
  • API
    • Authentication
      • authenticateLogin
      • registerUser
      • resetPassword
      • authMe
    • Documents
      • createDocument
      • getAllDocumentsByMe
      • getDocumentById
      • getDocumentStatisticsByMe
    • Files
      • uploadBiometryFiles
        POST
      • downloadByFileName
        GET
      • downloadBiometryMedia
        GET
    • Signatures
      • signDocument
    • PackagePurchase
      • getAllPurchasesByMe
    • SignatureCredit
      • getSignatureCreditByUserId
    • SignaturePackages
      • getAllPackages
    • Mails
      • forwardBiometricValidation
  1. Files

uploadBiometryFiles

POST
https://demo-apimex.firmavirtual.mx/api/files/uploadBiometryFiles

uploadBiometryFiles#

Este endpoint permite cargar archivos relacionados con la validación biométrica, como videos y documentos de identidad escaneados. También se registra la dirección IP del dispositivo utilizado para la validación.
URL: /api/files/uploadBiometryFiles
METHOD: POST
BODY:
CampoTipoRequeridoDescripción
filesobjectSíContenedor para los archivos y datos biométricos.
files.videostringNoArchivo de video en base64 que contiene la declaración biométrica. Puede ser opcional.
files.dataobjectNoObjeto que contiene los datos de la identificación obtenida desde la validación biométrica. Puede ser opcional.
files.biometryobjectSíContiene los datos relacionados con la validación biométrica.
files.biometry.statusBooleanSíIndica si el escaneo fue exitoso.
files.biometry.session_idstringSíIdentificador único de la sesión de escaneo.
files.biometry.is_donebooleanSíIndica si el escaneo está completamente terminado.
files.biometry.scan_idstringNoCódigo del escaneo del documento (si está disponible).
files.biometry.back_imagestringSíImagen escaneada en base64 del reverso del documento de identidad.
files.biometry.front_imagestringSíImagen escaneada en base64 del frente del documento de identidad.
document_idintegerSíIdentificador único del documento asociado a los archivos.
signer_idintegerSíIdentificador único del firmante asociado a los archivos biométricos.
ip_addressstringSíDirección IP del dispositivo que realiza la validación biométrica.

Solicitud

Parámetros de Header

Parámetros del Body application/json

Ejemplos

Respuestas

🟢200
application/json
Body

Solicitud Ejemplo de Solicitud
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://demo-apimex.firmavirtual.mx/api/files/uploadBiometryFiles' \
--header 'Content-Type: application/json' \
--data-raw '{
    "files": {
        "video": "",
        "biometry": {
            "status": true,
            "session_id": "",
            "is_done": true,
            "scan_id": "",
            "back_image": "",
            "front_image": ""
        }
    },
    "document_id": 0,
    "signer_id": 0,
    "ip_address": ""
}'
Respuesta Ejemplo de Respuesta
{}
Modificado en 2026-03-12 17:04:05
Anterior
Files
Siguiente
downloadByFileName
Built with