Edición de evidencias OTP

Última revisión: 19 Oct 2022

Tenemos la opción de editar el teléfono o el email de las evidencias OTP mientras la solicitud no haya completado

PUT /api/v3/evidences/edit

Este método recibe un JSON con los parámetros:

{
  "messageCode ": "ZL581654693486017R29 ",
  "evidenceCode": "ZL581654693486017R296P001E001",
  "phone": "Teléfono que queremos utilizar si la evidencia es OTP SMS",
  "email": "Email que queremos utilizar si la evidencia es OTP MAIL"
}

Respuesta correcta:

200 devolviendo el JSON del message completo. Un ejemplo Sería:

 {
  "groupCode" : "<here_your_groupCode>",
  "workflow" : {
    "type" : "APP"
  },
  "notification" : {
    "text" : "Nuevo contrato pendiente de firma.",
    "detail" : "Núm. Contrato AA9988",
    "devices": [
      {
        "appCode": "com.viafirma.documents",
        "code": "<here_your_registered_app",
        "userCode": "<here_your_registered_userCode"
      }
    ]
  },
  "document" : {
    "templateCode" : "<here_your_templateCode>",
    "readRequired" : false,
    "watermarkText" : "Preview",
    "formRequired" : false
  },
  "callbackMails" : "<here_your_email>",
  "callbackURL" : "<here_your_system_callback>"
}

Respuesta para mensaje que no exista:

{
    "code": 236,
    "type": "Error",
    "message": "No es posible recuperar la información del mensaje solicitado",
    "trace": "b54dc0f7-1862-40a9-882d-70dd6554ecc2"
}

Respuesta si no encuentra una evidencia editable en el mensaje (Evidencia que exista de tipo OTP_SMS/OTP_MAIL con teléfono o email informado) :

{
    "code": 271,
    "type": "Error",
    "message": "No se ha encontrado una evidencia editable para ese código de evidencia",
    "trace": "b54dc0f7-1862-40a9-882d-70dd6554ecc2"
}

Respuesta si intentamos editar una evidencia de tipo OTP_SMS con un teléfono incorrecto

{
    "code": 712,
    "type": "Error",
    "message": "El número de teléfono informado para el envío de sms no es válido",
    "trace": "b54dc0f7-1862-40a9-882d-70dd6554ecc2"
}

Respuesta si intentamos editar una evidencia de tipo OTP_MAIL con un email incorrecto

{
    "code": 716,
    "type": "Error",
    "message": "El correo electrónico informado para el envío de la evidencia OTP es incorrecto o no viene informado",
    "trace": "b54dc0f7-1862-40a9-882d-70dd6554ecc2"
}

Respuesta si el mensaje ya está finalizado

{
    "code": 243,
    "type": "Error",
    "message": "El estado de la solicitud no es válido",
    "trace": "b54dc0f7-1862-40a9-882d-70dd6554ecc2"
}

Respuesta para credenciales del API incorrectas:

{
    "code": 401,
    "type": "ERROR",
    "message": "Invalid credentials",
    "trace": "30ec3b02-dd0a-4768-8c92-b7660057f5ff"
}

Respuesta si el API que hace la consulta no esta autorizada:

{
    "code": 91,
    "type": "Error",
    "message": "Sorry, the application does not have access rights to the requested resource",
    "trace": "0714703a-c35e-4852-884c-3bf9163fa887"
}