Crear un nuevo documento a partir de una plantilla existente

POST

/api/v1/templates/{templateId}/generate-document

curl --request POST \
  --url https://app.legaldoc.io/api/v1/templates/example/generate-document \
  --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" } }'

Crear un nuevo documento a partir de una plantilla existente. Al pasar valores para título y meta, se anularán los valores originales definidos en la plantilla. Si no pasas valores para los destinatarios, se utilizarán los valores definidos en la plantilla.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

templateId

required

string

Request Body

Body

Media typeapplication/json

object

title

string

>= 1 characters

externalId

string

nullable

recipients

Array<object>

object

name

required

string

>= 1 characters

email

required

string format: email

>= 1 characters

role

string

default: SIGNER

Allowed values: CC SIGNER VIEWER APPROVER ASSISTANT

signingOrder

number

nullable

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

default: Etc/UTC

Allowed values: Etc/UTC

dateFormat

El formato de la fecha. Debe ser una de las opciones enumeradas en la lista a continuación.

string

default: yyyy-MM-dd hh:mm a

redirectUrl

string

signingOrder

string

Allowed values: PARALLEL SEQUENTIAL

allowDictateNextSigner

boolean

language

string

Allowed values: es en

typedSignatureEnabled

boolean

default: true

uploadSignatureEnabled

boolean

default: true

drawSignatureEnabled

boolean

default: true

distributionMethod

string

Allowed values: EMAIL NONE

emailSettings

object

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

Allowed values: ACCOUNT

globalActionAuth

El tipo de autenticación requerida para que el destinatario firme el documento.

string

Allowed values: ACCOUNT PASSKEY TWO_FACTOR_AUTH CLAVE_UNICA

formValues

object

key

additional properties

One of:

string

string

boolean

boolean

number

number

Responses

200

200

Media typeapplication/json

object

documentId

required

number

externalId

string

nullable

recipients

required

Array<object>

object

id

required

number

name

required

string

email

required

string

Example^generated

{
  "documentId": 1,
  "externalId": "example",
  "recipients": [
    {
      "id": 1,
      "name": "example",
      "email": "example"
    }
  ]
}

401

401

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

404

404

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}