Subir un nuevo documento y obtener una URL prefirmada
POST
/api/v1/documents
const url = 'https://app.legaldoc.io/api/v1/documents';const options = { method: 'POST', headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'}, body: '{"title":"example","externalId":"example","recipients":[{"name":"example","email":"[email protected]","role":"CC","signingOrder":1}],"meta":{},"authOptions":{"globalAccessAuth":"ACCOUNT","globalActionAuth":"ACCOUNT"},"formValues":{"additionalProperty":"example"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://app.legaldoc.io/api/v1/documents \ --header 'Authorization: <Authorization>' \ --header 'Content-Type: application/json' \ --data '{ "title": "example", "externalId": "example", "recipients": [ { "name": "example", "email": "[email protected]", "role": "CC", "signingOrder": 1 } ], "meta": {}, "authOptions": { "globalAccessAuth": "ACCOUNT", "globalActionAuth": "ACCOUNT" }, "formValues": { "additionalProperty": "example" } }'Authorizations
Sección titulada «Authorizations»Request Body
Sección titulada «Request Body»Body
Media typeapplication/json
object
title
required
string
externalId
string
recipients
required
Array<object>
object
name
required
string
email
required
string format: email
role
string
signingOrder
number
meta
object
subject
string
message
string
timezone
La zona horaria de la fecha. Debe ser una de las opciones enumeradas en la lista a continuación.
string
dateFormat
El formato de la fecha. Debe ser una de las opciones enumeradas en la lista a continuación.
string
redirectUrl
string
signingOrder
string
allowDictateNextSigner
boolean
language
string
typedSignatureEnabled
boolean
uploadSignatureEnabled
boolean
drawSignatureEnabled
boolean
distributionMethod
string
emailSettings
authOptions
Propiedades de autenticación global que se aplican a todos los destinatarios del documento. Si no se especifica, se utilizarán las configuraciones predeterminadas de la cuenta.
object
globalAccessAuth
El tipo de autenticación requerida para que el destinatario acceda al documento.
string
globalActionAuth
El tipo de autenticación requerida para que el destinatario firme el documento.
string
Responses
Sección titulada «Responses»200
Media typeapplication/json
object
uploadUrl
required
string
documentId
required
number
externalId
string
recipients
required
Array<object>
object
id
required
number
name
required
string
email
required
string
Examplegenerated
{ "uploadUrl": "example", "documentId": 1, "externalId": "example", "recipients": [ { "id": 1, "name": "example", "email": "example" } ]}401
Media typeapplication/json
object
message
required
string
Examplegenerated
{ "message": "example"}404
Media typeapplication/json
object
message
required
string
Examplegenerated
{ "message": "example"}