Resultado de un lote ya finalizado

Actualizado: 08-sep-2023

Método que devuelve el detalle de un lote ya finalizado a partir de un operationId y sessionId.

Request

• Método: GET
• Seguridad: Basic Auth
• Servicio: /api/rest/services/signatureResult/{operationId}?sessionId={sessionId}

Response

Response Code 200 OK

{
    "signatures": [
        {
            "documentId": "string",
            "signatureId": "string",
            "sourceId" : "string",
            "errorCode": null,
            "errorMessage": null
        }
    ],
    "certificateValidationData": {
        "operationId": "string",
        "numberUserId": "string",
        "name": "string",
        "surname1": "string",
        "surname2": "string",
        "email": "string",
        "ca": "string",
        "shortCa": "string",
        "jobTitle": "string",
        "type": "string",
        "cn": "string",
        "certificateProperties": {
            "C": "string",
            "SERIALNUMBER": "string"
        },
        "isValidated": true,
        "isExpired": false,
        "isRevoked": false
    }
}

Donde:

• signatures: lista de elementos procesados en el lote
  • documentId: (string) identificador individual por cada documento. Coincide con el documentId obtenido en la response del método /preparesignature/addOperationFile usado para añadir elementos al lote.
  • signatureId: (string) identificador individual de firma asociado a cada documento, necesario para obtener información o descargar el documento firmado.
  • sourceId: (string) identificador facilitado por el integrador durante la solicitud del servicio usado normalmente para identificar internamente el documento que ha sido firmado.
  • errorCode: (string) código de error generado durante el proceso de firma para este documento.
  • errorMessage: (string) descripción del error generado durante el proceso de firma para este documento.
• certificateValidationData: objeto con toda la información de validación extraida del certificado utilizado para la firma. Este objeto podrá contener mayor o menor número de propiedades en función del tipo de certificado y CA elegido. A continuación algunas de las propiedades normalmente encontradas en un certificado.
  • isValidated: (boolean) certificado validado en las fuentes informadas en sus propiedades (CRL y/o OCSP)
  • isExpired: (boolean) certificado caducado
  • isRevoked: (boolean) certificado revocado
  • operationId: operationIid asocidado al lote en el que este documento fue firmado.
  • numberUserId: identificación del titular del certificado, por ejemplo su DNI.
  • name: nombre del titular del certificado
  • surname1: primer apellido del titular del certificado
  • surname2: segundo apellido del titular del certificado
    • certificateProperties: otras propiedades encontradas en el certificado utilizado para la firma
      • C: (string) código de país
      • SERIALNUMBER: (string) identificación del titular del certificado, por ejemplo su DNI.

IMPORTANTE: el objeto certificateValidationDatacontiene toda la información de validación extraída del certificado utilizado para la firma. Este objeto podrá contener mayor o menor número de propiedades en función del tipo de certificado y CA elegido. A continuación algunas de las propiedades normalmente encontradas en un certificado.

Respuestas Error

Los errores controlados durante la finalización de un lote podrán ser los siguientes:

Lote no encontrado

Response Code 400 Bad Request

{
    "signatures": [
        {
            "documentId": null,
            "signatureId": null,
            "errorCode": "400",
            "errorMessage": "No operation data found with operationId: <operationId>"
        }
    ],
    "certificateValidationData": null
}

Para cualquier otro no controlado se devolverá una Response Code 500 Server Error.