Solución de problemas

En está sección encontraras solución a errores comunes, adémas de una lista con las diferentes rutas y los errores de validación que puede devolver.

Access Denied

Ejemplo

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized"
}

Solución: Verifica que el apiKey o el JWT sean correctos, para usar el JWT, agrega el header: "Authorization: bearer JWT", como en el siguiente ejemplo:

Ejemplo

    fetch(url, {
        method: 'GET'
        body,
        headers:{
            'Authorization': 'bearer iOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2'
        }
    })

o si usas el apikey:

Ejemplo

   fetch(url, {
        method: 'GET'
        body,
        headers:{
            'apikey': 'apikey aqui'
        }
    })

Si usas una herramienta para crear peticiones sobre APIs (como Postman), agrega los encabezados en la sección de Headers

Ejemplo

    key: Authorization
    value: bearer iOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2

Ejemplo

    key: apikey
    value: apikey aqui

En caso de tener habilitada dicha protección en el TENANT, lo que cambia es como se obtiene el contenido de los archivos, por lo que con esto es necesario tener una sesión válida, por lo que nadie que no este autorizado podrá obtener el archivo.

Ejemplo

{
  "success": false,
  "statusCode": 400,
  "error": "Account email is required in order to process this request."
}

Solución: Para hacer la llamada para generar el jwt, verifica que las llaves del objeto esten escritas de forma correcta, como en el siguiente ejemplo:

Ejemplo

{
  "email": "myuser@mydomain.com",
  "password": "mypassword"
}

Bad Request

[POST] /create/contract

Error	Descripción
Source parameter is required to create a new contract.	La propiedad "source" no fue recibida
Template ID is required to create a new contract when the source is a template or document.	"source" es igual a "template" pero el id de la plantilla no fue recibido, este debe ser enviado dentro del parámetro "templateid"
Document Type is required when the contract's source is a document.	La propiedad "type" dentro de "document", no fue recibida, esta debe ser igual a "word" o "pdf" dependiendo del caso
Document Data -Base64 String- is required when the contract's source is a document.	La propiedad "data" dentro de "document" no fue recibida, esta debe ser una cadena en Base64, omitiendo los headers que indican el MIME Type del archivo

[GET] /contract/status/{:contractID}

Error	Descripción
Contract ID is required in order to process this request.	El párametro `{:contractID}` no fue recibido o es inválido
The contract `{:contractID}` does not exist on the database or is not associated to your account	El contrato con el id recibido no existe

[POST] /contract/configuration/{:contractID}

Error	Descripción
Contract ID is required in order to process this request.	El párametro `{:contractID}` no fue recibido o es inválido
The contract `{:contractID}` does not exist on the database or is not associated to your account	El contrato con el id recibido no existe
'The specified value for the parameter `{parameter}` is not supported.'	El Valor del parámetro no es valido, si esté debe ser de tipo fecha, debes usar el formato: "mm/dd/aaaa", si el valor debe ser de tipo "boolean" y otro tipo es recibido, también recibiras este error, otra causa es que envias una opción que no está disponible."

[GET] /contract/variables/{:contractID}

Error	Descripción
Contract ID is required in order to process this request.	El párametro `{:contractID}` no fue recibido o es inválido
The contract `{:contractID}` does not exist on the database or is not associated to your account	El contrato con el id recibido no existe

[POST] /contract/variables/{:contractID}/{:participantID}

Error	Descripción
Contract ID is required in order to process this request.	El párametro `{:contractID}` no fue recibido o es inválido
The contract `{:contractID}` does not exist on the database or is not associated to your account	El contrato con el id recibido no existe
The contract `{:contractID}` must have a DRAFT status in order to proceed.	La propiedad "status" del contrato no es borrador (status == "")
An object of variables must be provided in order to update the contract.	Ninguna Variable fue enviada a la llamada
The participant `{:participantID}` does not exist on the given contract.	El ID del participante recibido no se encuentra en este contrato
The variable `{variable}` is not associated to the given participant.	La variable no existe en el contrato, el nombre de esta debe ser igual a la propiedad "apiName" de la variable que quieres actualizar
The variable `{variable}` must be a String, Number or Boolean value in order to be processed.	El valor de la variable no es de tipo String
The variable `{variable}` is a DynamicTable, object value must be defined as `{headers: [string], rows:[ {cols:[string] }, {cols:[string] }, ... ]}` in order to be processed.	La variable es de tipo Tabla Dinámica pero su valor no es tipo objeto o tiene la estructura incorrecta

[GET] /contract/participant/{:contractID}/{:participantID}

Error	Descripción
Contract ID is required in order to process this request.	El párametro `{:contractID}` no fue recibido o es inválido
The contract `{:contractID}` does not exist on the database or is not associated to your account	El contrato con el id recibido no existe
The participant `{:participantID}` does not exist on the given contract.	El ID del participante recibido no se encuentra en este contrato

[POST] /contract/attachments/{:contractID}/{:participantID}

Error	Descripción
Document Object must be declared.	La propiedad "document" es igual a undefined o es inválida
Only PDF and Docx formats are accepted.	La propiedad "type" dentro de "document" es igual a undefined o es inválida o no es de tipo "docx" o "pdf"
Filename is required.	La propiedad "filename" es igual a undefined o es inválida
Name is required.	La propiedad "name" es igual a undefined o es inválida
The contract `{:contractID}` does not exist on the database or is not associated to your account	El contrato con el id recibido no existe
The contract `{:contractID}` must have a DRAFT status in order to proceed.	La propiedad "status" del contrato no es borrador (status == "")
The participant `{:participantID}` does not exist on the given contract.	El ID del participante recibido no se encuentra en este contrato
Error in parsing the file	Ocurrió un error con el archivo, verifica que sea de tipo docx/pdf
Error uploading the file to the server	Ocurrió un error subiendo el archivo al servidor, vuelve a intentarlo

[POST] /contract/participant/{:contractID}/{:participantID}

Error	Descripción
Contract ID is required in order to process this request.	El párametro `{:contractID}` no fue recibido o es inválido
The contract `{:contractID}` does not exist on the database or is not associated to your account	El contrato con el id recibido no existe
The contract `{:contractID}` must have a DRAFT status in order to proceed.	La propiedad "status" del contrato no es borrador (status == "")
The participant `{:participantID}` does not exist on the given contract.	El ID del participante recibido no se encuentra en este contrato
An object of parameters must be provided in order to update the participant details.	La solicitud al API no recibio ningún parámetro
Insufficient permissions to set 'requestLocation' on the participant, Insufficient permissions to set 'customMessage' on the participant, Insufficient permissions to set 'requestOneTimePassword' on the participant	El usuario no cuenta con los privilegios correspondientes
The date `{date}` is not in a valid format to update the participant.	La fecha es inválida, debes usar el formato: "mm/dd/aaaa"
The key `{key}` must be a String, Number, Boolean or Array value in order to be processed.	La variable no puede ser de tipo "object"
The key `{key}` is not a valid property to update the participant details.	La variable no se encuentra entre los parámetros disponibles

[POST] /contract/send/{:contractID}

Error	Descripción
CantSendContract	El contrato no puede ser enviado a firma debido al estatus actual del contrato

[GET] /api/contract/documents/{:contractID}

Error	Descripción
Contract ID is required in order to process this request.	El párametro `{:contractID}` no fue recibido o es inválido
The contract `{:contractID}` does not exist on the database or is not associated to your account	El contrato con el id recibido no existe
The contract `{:contractID}` must have a RECEIVED_SIGNED status in order to retrieve the signed documents.	La propiedad "RECEIVED_SIGNED" del contrato no es borrador (status == "RECEIVED_SIGNED")

[GET] /list/contracts

Error	Descripción
participantVariables parameter has a incorrect construction	El parámetro &participantVariables tiene la estuctura incorrecta, debe ser como el siguiente ejemplo:

&participantVariables=key1|value1;key2|value2;key3|value3

[GET] /contract/pending/{:contractID}

Error	Descripción
Contract ID is required in order to process this request.	El párametro `{:contractID}` no fue recibido o es inválido
The contract `{:contractID}` does not exist on the database or is not associated to your account	El contrato con el id recibido no existe

[POST] /contract/archive/{:contractID}

Error	Descripción
OnlyOwnerAction	Esta acción solo puede ser realizada con el dueño del contrato
ContractNotFound	El contrato con el id recibido no existe

[DELETE] /contract/cancel/{:contractID}

Error	Descripción
Contract ID is required in order to process this request.	El párametro `{:contractID}` no fue recibido o es inválido
ContractNotFound	El contrato con el id recibido no existe
Can not cancel the contract `{:contractID}` due to previous cancellation.	Esté contrato ya estaba previamente cancelado

[POST] /contract/finalize/{:contractID}

Error	Descripción
ContractNotFound	El contrato con el id recibido no existe

[POST] /contracts/{:contractID}/validate/nom151

Error	Descripción
MutableDocument	La acción no puede ser realizada debido a que el documento se no encuentra en alguna de los siguientes status: Firmado, Finalizado, Enviado a Participantes, Firma Física
UnsupportedDocument	El Contrato no tiene la propiedad "nom151Bin"
FileRequired	El archivo con la NOM 151 no fue recibido
InvalidNom151	El resultado de la llamada es que la NOM 151 es inválida

[POST] /contracts/{:contractID}/customproperties

Error	Descripción
contractNotFound	El contrato con el id recibido no existe
UndefinedProperties	El Array debe estar dentro de la propiedad "properties", verifica que esté escrito de forma correcta
PropertyArrayIsEmpty	Se recibió un Array vacío
PropertyNameIsNotOfTypeString	El valor de "name" debe ser de tipo String
PropertyValueIsNotOfTypeString	El valor de "value" debe ser de tipo String
PropertyNameIsRequired	"name" no fue definido
PropertyValueIsRequired	"value" no fue definido
PropertyNamesCannotBeRepeated	Los nombres de las propiedades deben ser únicos

Solución de problemas

Errores de Blindaje

Ejemplo

Access Denied

Ejemplo

Ejemplo

Ejemplo

Ejemplo

Ejemplo

Credenciales Incorrectas

Ejemplo

Ejemplo

Bad Request