Skip to main content
POST
Criar lote de assinaturas

Authorizations

x-juridiq-api-key
string
header
required

Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a documentação de integradores).

Body

multipart/form-data
files
any[]
required

Arquivos PDF do lote (mínimo 2, campo files)

Minimum array length: 2

Arquivo enviado no multipart/form-data

name
string
required

Nome do lote

signatories
string

E-mails ou telefones dos signatários, separados por vírgula

people
string

JSON com contatos vinculados. Ex: [{ "id": "uuid", "value": "email@...", "type": "email", "request_selfie": true, "request_document": false }]

signatory_options
string

JSON com overrides por signatário (livre ou cadastrado). Ex: [{ "value": "email@...", "request_selfie": true, "request_document": false }]

subject
string

Assunto do envio

message
string

Mensagem enviada aos signatários

has_chain
string

true para assinatura em cadeia

request_selfie
string

true para solicitar selfie do signatário (padrão global)

request_document
string

true para solicitar documento com foto (padrão global)

request_rubric
string

false para desabilitar rubrica desenhada

isPrivate
string

true para lote privado no escritório

due_months
string

Meses de validade dos documentos assinados

expire_date
string

Data de expiração do pedido de assinatura

width_page
string

Largura da página em pixels. Padrão: 596

false para não enviar o link de assinatura automaticamente. Padrão: true

Response

Default Response

id
string<uuid>
required

ID do lote

name
string
required

Nome do lote

plugsignLoteId
string
required

ID do lote no PlugSign

status
string
required

Status do lote

officeId
string<uuid>
required

ID do escritório

createdAt
required

Criado em

updatedAt
required

Atualizado em

signatories
any

Signatários do lote

responsibleId
string | null

ID do responsável

isPrivate
boolean | null

Lote privado

Envio automático do link de assinatura aos signatários

expireDate

Data de expiração

responsible
object | null
personOnBatches
any

Pessoas vinculadas ao lote

signatures
object[]

Documentos do lote