Crear

Descripción general

Puede enviar documentos a Legaliza utilizando esta solicitud API.

Detalle de la API

Pedido

• URL: /documents/
• Método: POST
• Content-Type: application/json
• Cuerpo:

{
  "id": "112297d3-1d5f-4ec5-bc8e-450e36ab2323",
  "document_type": 1,
  "document_id": 1234,
  "file": "JVBERi0xLjQNJeLjz9MNCjE1IDAgb2J...",
  "file_name": "contract.pdf",
  "description": "Contract for notary",
  "attached_files": [
    {
      "type": 1,
      "file": "JVBERi0xLjQNJeLjz9MNCjE1IDAgb2J...",
      "file_name": "id_card.jpg",
    }
  ],
  "signers": [
    {
      "email": "signer1.email@example.com",
      "firstname": "Signer",
      "lastname1": "1",
      "lastname2": "Name",
      "phone": "+56911112222",
      "rut": null
    },
    {
      "email": "signer2.email@example.com",
      "firstname": "Signer",
      "lastname1": "2",
      "lastname2": null,
      "phone": null,
      "rut": null
    }
  ],
  "geolocations": [
    {
      "latitude": 56.2235,
      "longitude": 100.345446
    },
    {
      "latitude": -23.43467,
      "longitude": -142.34534645
    }
  ],
  "assign_callback": {
    "callback_url": "https://your.callback.com/assign/",
    "callback_header": {
      "Api-Key": "your service api key"
    }
  },
  "sign_callback": {
    "callback_url": "https://your.callback.com/sign/",
    "callback_header": {
      "Api-Key": "your service api key"
    }
  }
}

Pedido body details

Valor	Tipo	Se requiere	Descripción
document_id	int	Sí	ID único del documento.
document_type	int	Sí	El ID del tipo de documento de uno de los tipos de documento que obtuvo de aquí.
file	str	Sí	Cadena Base64 del archivo PDF que va a cargar en Legaliza.
file_name	str	Sí	Nombre del archivo del PDF, el nombre del archivo debe estar en un formato de nombre de archivo válido, por ejemplo contract.pdf, de lo contrario, Legaliza generará un error de validación.
description	str	No	Descripción del archivo PDF.

• attached_files

Valor	Tipo	Se requiere	Descripción
type	int	Sí	El ID del tipo de archivo adjunto del tipo de documento que seleccionó anteriormente.
file	str	Sí	Cadena Base64 del archivo adjunto
file_name	str	Sí	Nombre del archivo adjunto, el nombre del archivo debe estar en un formato de nombre de archivo válido para PDF, por ejemplo contract.pdf, de lo contrario, Legaliza generará un error de validación.

• signers

Valor	Tipo	Se requiere	Descripción
email	str	Sí	Email del firmante, debe tener un formato de email válido.
firstname	str	Sí	Primer nombre del firmante
lastname1	str	Sí	Primer apellido del firmante
lastname2	str	No	Segundo apellido del firmante
phone	str	No	Número de teléfono del firmante
rut	str	No	RUT del firmante

• geolocations

Valor	Tipo	Se requiere	Descripción
latitude	float	Sí	Latitud de la información de geolocalización del firmante (debe tener un formato válido: float con un valor entre -90 y 90, ej: 23.456789, -12.3456787)
longitude	float	Sí	Longitud de la información de geolocalización del firmante (debe tener un formato válido: float con un valor entre -180 y 180, ej: 97.34656777, -132.2354564)

• assign_callback

Valor	Tipo	Se requiere	Descripción
callback_url	str	Sí	URL de callback para recibir un evento cuando el documento es asignado a un usuario notario. Puede ver más detalles sobre la solicitud de callback aquí.
callback_header	json	No	Encabezado de solicitud API adicional que necesita obtener de la solicitud de callback, por ejemplo, clave API para autenticación.

• sign_callback

Valor	Tipo	Se requiere	Descripción
callback_url	str	Sí	URL de callback para recibir un evento cuando el documento es firmado o rechazado. Puede ver más detalles sobre la solicitud de callback aquí.
callback_header	json	No	Encabezado de solicitud API adicional que necesita obtener de la solicitud de callback, por ejemplo, clave API para autenticación.

Respuesta

Éxito

• Código de estado: 201
• Cuerpo:

{
  "id": "bae92562-effb-4db7-a8f8-aabb37674597",
  "attached_files": [
    {
      "id": 1,
      "file": "http://api.legaliza.io/media/documents/bae92562-effb-4db7-a8f8-aabb37674597/attached_files/attached1.jpg",
      "file_name": "id_card.jpg",
      "description": null,
      "extra_data": null,
      "type": 1
    },
  ],
  "file": "http://api.legaliza.io/media/documents/bae92562-effb-4db7-a8f8-aabb37674597/documents/test.pdf",
  "file_name": "contract.pdf",
  "description": "Contract for notary",
  "status": "not_signed",
  "customer": "6a579a31-0d99-4ab6-bd4e-eb5436b587a6",
  "document_type": 1
}

• status

Valor	Tipo	Descripción
not_signed	str	El documento no está firmado
signed	str	El documento está firmado

Error

Todos los errores están en español y siguen el formato de error de respuesta general de la API Rest.

• Código de estado: 400
• Cuerpo:

{
  "document_type": [
    "Este campo es requerido."
  ]
}