Pular para o conteúdo principal
Documentation Powered by Redocly

Assine Online Suite (1.0)

Download OpenAPI specification:Download

Soluti Produtos: contato@assine.online URL: https://ajuda.assine.online/pt-br/knowledge

Assine Online Application Suite

Perfil

Perfil de conta

Exibe o perfil

Exibe informações do perfil

Authorizations:
OAuth

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "avatar": "string",
  • "is_verified": true,
  • "created_at": "string",
  • "updated_at": "string"
}

Contatos

Contato do usuário

Lista contatos

Lista contatos da conta, quando alguma interação é completada, o contato é adicionado de forma automática.

Authorizations:
OAuth
query Parameters
q
string

Faz uma pesquisa informando um termo de busca

sort
string
Enum: "name" "email" "-name" "-email"

Ordena resultados de forma crescente, ou com sinal de menos (-) para descrescente.

page
number

Define o número da página a ser exibida

limit
number

Define a quantidade de itens na página a serem exibidos

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Exibe o contato

Exibe dados de contato

Authorizations:
OAuth
path Parameters
contact
required
string <uuid>

ID de contato

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string"
}

Edita o contato

Edita os dados de contato

Authorizations:
OAuth
path Parameters
contact
required
string <uuid>

ID de contato

Request Body schema: application/json
One of
name
string or null

Nome de contato

email
required
string <email>

Email de contato

phone
string or null

Telefone de contato

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string"
}

Arquivos e diretórios

Arquivos e diretórios

Lista itens

Lista diretórios, subdiretórios e arquivos

Authorizations:
OAuth
query Parameters
q
string

Termo de busca por itens (id do usuário, id da pasta pai, id de compartilhamento, nome, mimetype, sha1)

parent
string <uuid>

ID de diretório pai

shared
boolean

Exibe somente itens compartilhados

filter[mimetype]
string

Filtra os itens pelo mimetype

filter[is_directory]
boolean

Filtra somente diretórios (true) ou somente arquivos (false)

sort
string
Enum: "name" "is_directory" "created_at" "updated_at"

Ordena resultados de forma crescente, ou com sinal de menos (-) para descrescente.

page
number

Define o número da página a ser exibida

limit
number

Define a quantidade de itens na página a serem exibidos

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Cria diretório

Cria diretórios e subdiretórios

Authorizations:
OAuth
header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: application/json
parent
string <uuid>

ID do diretório pai

name
required
string

Nome do diretório

Responses

Request samples

Content type
application/json
{
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parent": { },
  • "name": "string",
  • "mimetype": "string",
  • "size": 0,
  • "depth": 0,
  • "is_directory": true,
  • "is_user_created": true,
  • "is_signed": true,
  • "is_shared": true,
  • "user_type": "owner",
  • "sha1": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "publish_token": "string",
  • "links": {
    }
}

Upload de arquivo

Faz upload de arquivo no diretório definido

Authorizations:
OAuth
header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: multipart/form-data
parent
string <uuid>

ID do diretório pai

file
string <binary>

O arquivo

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parent": { },
  • "name": "string",
  • "mimetype": "string",
  • "size": 0,
  • "depth": 0,
  • "is_directory": true,
  • "is_user_created": true,
  • "is_signed": true,
  • "is_shared": true,
  • "user_type": "owner",
  • "sha1": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "publish_token": "string",
  • "links": {
    }
}

Exibe metadados do item

Exibe metadados do item

Authorizations:
OAuth
path Parameters
item
required
string <uuid>

ID do item

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parent": { },
  • "name": "string",
  • "mimetype": "string",
  • "size": 0,
  • "depth": 0,
  • "is_directory": true,
  • "is_user_created": true,
  • "is_signed": true,
  • "is_shared": true,
  • "user_type": "owner",
  • "sha1": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "publish_token": "string",
  • "links": {
    }
}

Renomeia o item

Renomeia o item, não podendo duplicar o nome

Authorizations:
OAuth
path Parameters
item
required
string <uuid>

ID do item

header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: application/json
name
required
string

Nome do item

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parent": { },
  • "name": "string",
  • "mimetype": "string",
  • "size": 0,
  • "depth": 0,
  • "is_directory": true,
  • "is_user_created": true,
  • "is_signed": true,
  • "is_shared": true,
  • "user_type": "owner",
  • "sha1": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "publish_token": "string",
  • "links": {
    }
}

Remove item

Remove o item

Authorizations:
OAuth
path Parameters
item
required
string <uuid>

ID do item

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Move o item

Move o item para outro diretório ou raiz

Authorizations:
OAuth
path Parameters
item
required
string <uuid>

ID do item

header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: application/json
parent
string or null <uuid>

ID do diretório para mover

Responses

Request samples

Content type
application/json
{
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Faz download do item

Faz download do arquivo ou um zip de uma pasta

Authorizations:
OAuth
path Parameters
item
required
string <uuid>

ID do item

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Exibe binário do item

Exibe o arquivo ou faz download de um zip de uma pasta

Authorizations:
OAuth
path Parameters
item
required
string <uuid>

ID do item

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Organizações

Empresa, organização ou companhia

Lista organizações

Lista as organizações criadas pelo usuário

Authorizations:
OAuth
query Parameters
page
number

Define o número da página a ser exibida

limit
number

Define a quantidade de itens na página a serem exibidos

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Envelopes

Envelopes de documentos para assinar

Lista envelopes enviados

Lista todos envelopes enviados. Para exibir os envelopes em rascunho, é necessário aplicar filtro de pesquisa

Authorizations:
OAuth
query Parameters
q
string

Termo de busca (nome do documento, valor do addressee, id do envelope, hashid do envelope, id da organização, id do dono do envelope, assunto do envelope, mensagem do envelope, data de expiração do envelope, título do envelope)

filter[state]
string
Enum: "draft" "in-transit" "completed" "cancelled" "expired" "halted" "stand-by" "template"

Estado do envelope

sort
string
Enum: "state" "-state" "created_at" "-created_at" "expire_at" "-expire_at"

Ordenação dos dados, podendo informar com sinal de menos (-) para ordem decrescente.

include
string
Enum: "sender" "triggers" "recipients_stats"

Relacionamentos inclusos quando listar os envelopes

page
number

Define o número da página a ser exibida

limit
number

Define a quantidade de itens na página a serem exibidos

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Cria um envelope

Cria um novo envelope em modo rascunho, do qual poderá ser enviado após a configuração.

Authorizations:
OAuth
header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: application/json
subject
string or null

Assunto do envelope. Max: 255 caractéres

message
string or null

Mensagem do envelope

expire_at
string or null <date-time>

Data de vencimento para assinar

action_reminder_frequency
integer or null
Enum: 24 72 120

Frequencia, em horas, de notificações ao destinatário para realizar a ação, caso ainda não tenham.

title
string or null

Título do envelope. Max: 255 caractéres

Array of objects or null

Gatilhos a serem executado de acordo com os eventos do envelope

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "message": "string",
  • "expire_at": "2019-08-24T14:15:22Z",
  • "action_reminder_frequency": 24,
  • "title": "string",
  • "triggers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hashid": "string",
  • "state": "draft",
  • "subject": "string",
  • "message": "string",
  • "expire_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "action_reminder_frequency": 0,
  • "next_action_reminder_at": "2019-08-24T14:15:22Z",
  • "sender": {
    },
  • "recipients_stats": {
    },
  • "title": "string",
  • "triggers": [
    ]
}

Lista envelopes recebidos

Lista os envelopes recebidos

Authorizations:
OAuth
query Parameters
q
string

Termo de busca (nome do documento, valor do addressee, id do envelope, hashid do envelope, id da organização, id do dono do envelope, assunto do envelope, mensagem do envelope, data de expiração do envelope, título do envelope)

filter[state]
string
Enum: "waiting" "signing" "rejected" "failed" "suspended" "done"

Status como destinatário

filter[envelope.state]
string
Enum: "draft" "in-transit" "completed" "cancelled" "expired" "halted" "stand-by"

Status do envelope

include
string
Value: "envelope.recipients_stats"

Relacionamentos inclusos quando listar os envelopes recebidos

sort
string
Enum: "state" "notified_at" "envelope.state" "envelope.created_at" "envelope.expire_at"

Ordenação dos dados, podendo informar com sinal de menos (-) para ordem decrescente. Exemplo: "-state".

page
number

Define o número da página a ser exibida

limit
number

Define a quantidade de itens na página a serem exibidos

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Exibe o envelope

Exibe informações do envelope

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

query Parameters
extended
boolean

Este parâmetro faz com que o envelope seja exibido de forma extendida, ou seja, será adicionado dados de documentos e destinatários na resposta.

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hashid": "string",
  • "state": "draft",
  • "subject": "string",
  • "message": "string",
  • "expire_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "action_reminder_frequency": 0,
  • "next_action_reminder_at": "2019-08-24T14:15:22Z",
  • "sender": {
    },
  • "recipients_stats": {
    },
  • "title": "string",
  • "triggers": [
    ]
}

Edita o envelope

Edita o envelope em rascunho, template ou que não possua assinaturas

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: application/json
subject
string or null

Assunto do envelope. Max: 255 caractéres

message
string or null

Mensagem do envelope

expire_at
string or null <date-time>

Data de vencimento para assinar

action_reminder_frequency
integer or null
Enum: 24 72 120

Frequencia, em horas, de notificações ao destinatário para realizar a ação, caso ainda não tenham.

title
string or null

Título do envelope. Max: 255 caractéres

Array of objects or null

Gatilhos a serem executado de acordo com os eventos do envelope

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "message": "string",
  • "expire_at": "2019-08-24T14:15:22Z",
  • "action_reminder_frequency": 24,
  • "title": "string",
  • "triggers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hashid": "string",
  • "state": "draft",
  • "subject": "string",
  • "message": "string",
  • "expire_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "action_reminder_frequency": 0,
  • "next_action_reminder_at": "2019-08-24T14:15:22Z",
  • "sender": {
    },
  • "recipients_stats": {
    },
  • "title": "string",
  • "triggers": [
    ]
}

Apaga o envelope

Apaga o envelope que está como draft ou template

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Envia o envelope

Envia o envelope que está em rascunho

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "action_token": "string"
}

Cancela o envelope

Cancela o envelope que esteja pendente

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Copia o envelope

Copia o envelope que está em rascunho para template ou vice-versa

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: application/json
into
string
Enum: "draft" "template"

Estado final do envelope a ser copiado

Responses

Request samples

Content type
application/json
{
  • "into": "draft"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "hashid": "string",
  • "state": "draft",
  • "subject": "string",
  • "message": "string",
  • "expire_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "action_reminder_frequency": 0,
  • "next_action_reminder_at": "2019-08-24T14:15:22Z",
  • "sender": {
    },
  • "recipients_stats": {
    },
  • "title": "string",
  • "triggers": [
    ]
}

Reenvia notificações

Reenvia notificações para destinatários waiting caso o envelope esteja pendente.

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Faz download do envelope

Faz download dos documentos de um envelope em formato zip

Authorizations:
OAuth
path Parameters
item
required
string <uuid>

ID do envelope

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Destinatários

Destinatários de envelope

Lista os destinatários

Lista os destinatários do envelope passado como parâmetro

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Adiciona um destinatário

Adiciona um destinatário ao envelope que está como rascunho

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: application/json

Cria um novo destinatário

type
required
string
Enum: "signer" "approver" "carbon-copy"

Tipo do destinatário

signature_type
string or null
Enum: "simple" "qualified"

Tipo de assinatura a ser usada quando destinatário assinante:
- simple: Assinatura simples.
- qualified: Assinatura qualificada com certificado A1, A3 ou BirdId.

routing_order
integer or null

Ordem de envio ao destinatário após cada ação

Array of objects

Endereçados relativos a este destinatário. Caso vá assinar/aprovar sí mesmo, basta não definir esse valor. Para assinantes presenciais, este campo é ignorado.

Responses

Request samples

Content type
application/json
{
  • "type": "signer",
  • "signature_type": "simple",
  • "routing_order": 0,
  • "addressees": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "state": "queued",
  • "type": "signer",
  • "signature_type": "simple",
  • "routing_order": 0,
  • "notified_at": "2019-08-24T14:15:22Z",
  • "addressees": [
    ]
}

Edita o destinatário

Edita o destinatário que ainda não realizou a ação.

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

recipient
required
string <uuid>

ID do destinatário

header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: application/json

Cria um novo destinatário

type
required
string
Enum: "signer" "approver" "carbon-copy"

Tipo do destinatário

signature_type
string or null
Enum: "simple" "qualified"

Tipo de assinatura a ser usada quando destinatário assinante:
- simple: Assinatura simples.
- qualified: Assinatura qualificada com certificado A1, A3 ou BirdId.

routing_order
integer or null

Ordem de envio ao destinatário após cada ação

Array of objects

Endereçados relativos a este destinatário. Caso vá assinar/aprovar sí mesmo, basta não definir esse valor. Para assinantes presenciais, este campo é ignorado.

Responses

Request samples

Content type
application/json
{
  • "type": "signer",
  • "signature_type": "simple",
  • "routing_order": 0,
  • "addressees": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "state": "queued",
  • "type": "signer",
  • "signature_type": "simple",
  • "routing_order": 0,
  • "notified_at": "2019-08-24T14:15:22Z",
  • "addressees": [
    ]
}

Remove o destinatário

Remove o destinatário que ainda não realizou a ação.

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

recipient
required
string <uuid>

ID do destinatário

header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: application/json

Cria um novo destinatário

type
required
string
Enum: "signer" "approver" "carbon-copy"

Tipo do destinatário

signature_type
string or null
Enum: "simple" "qualified"

Tipo de assinatura a ser usada quando destinatário assinante:
- simple: Assinatura simples.
- qualified: Assinatura qualificada com certificado A1, A3 ou BirdId.

routing_order
integer or null

Ordem de envio ao destinatário após cada ação

Array of objects

Endereçados relativos a este destinatário. Caso vá assinar/aprovar sí mesmo, basta não definir esse valor. Para assinantes presenciais, este campo é ignorado.

Responses

Request samples

Content type
application/json
{
  • "type": "signer",
  • "signature_type": "simple",
  • "routing_order": 0,
  • "addressees": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Notifica os destinatários

Envia a notificação do pedido para realizar a ação caso esteja como waiting.

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

recipient
required
string <uuid>

ID do destinatário

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Documentos

Documentos de envelope

Adiciona um documento

Adiciona um documento ao envelope que está como rascunho

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema:

Cria um novo documento

file
required
string <uuid>

ID do item de documento do armazenamento pessoal, devendo este ID estar relacionado à um item que seja do tipo PDF.

Responses

Request samples

Content type
{
  • "file": "00bd29cf-1ab3-4825-b15f-d80a4a0e1cbb"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "stage": "original",
  • "sha1": "string",
  • "fields": [
    ],
  • "contents": [
    ],
  • "updated_at": "string",
  • "links": {
    }
}

Remove o documento

Remove o documento de um envelope em draft ou sent

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

document
required
string <uuid>

ID do document

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Adiciona campo ao documento

Adiciona campos de preenchimento ao documento PDF

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

document
required
string <uuid>

ID do documento

header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: application/json

Cria um campo no documento PDF

recipient
required
string <uuid>

ID do assinante que deverá preencher este campo

is_required
required
boolean
type
required
string
Enum: "text" "checkbox" "dropdown" "radio-group" "option-list" "signature" "initial"
name
required
string

Nome identificador do campo. Ex: text_1

options
Array of strings or null

Opções para campos do tipo dropdown e option-list

description
string or null

Descrição do campo

placeholder
string or null

Placeholder para o campo

title
string or null

Título descritivo do campo

value
string or null

Valor inicial para o campo, ou deixe nulo para vazio

required
Array of Widget (object) or WidgetTypeInitial (object) or WidgetTypeSignature (object)

Widgets de representação visual do campo

Responses

Request samples

Content type
application/json
{
  • "recipient": "31d78262-cbd4-4f35-8070-a83c4bfe5327",
  • "is_required": true,
  • "type": "text",
  • "name": "string",
  • "options": [
    ],
  • "description": "string",
  • "placeholder": "string",
  • "title": "string",
  • "value": "string",
  • "widgets": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "recipient": "31d78262-cbd4-4f35-8070-a83c4bfe5327",
  • "is_required": true,
  • "type": "text",
  • "name": "string",
  • "options": [
    ],
  • "description": "string",
  • "placeholder": "string",
  • "title": "string",
  • "value": "string",
  • "filled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "widgets": [
    ]
}

Edita o campo

Edita o campo caso o destinatário não o tenha preenchido ainda, e o envelope esteja como draft, sent, in-transit ou stand-by.

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

document
required
string <uuid>

ID do documento

field
required
string <uuid>

ID do campo

header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: application/json

Atualiza um campo no documento PDF

recipient
required
string <uuid>

ID do assinante que deverá preencher este campo

is_required
boolean
name
string

Nome identificador do campo. Ex: text_1

options
Array of strings or null

Opções para campos do tipo dropdown e option-list

description
string or null

Descrição do campo

placeholder
string or null

Placeholder para o campo

title
string or null

Título descritivo do campo

value
string or null

Valor inicial para o campo, ou deixe nulo para vazio

Array of objects

Widgets de representação visual do campo

Responses

Request samples

Content type
application/json
{
  • "recipient": "31d78262-cbd4-4f35-8070-a83c4bfe5327",
  • "is_required": true,
  • "name": "string",
  • "options": [
    ],
  • "description": "string",
  • "placeholder": "string",
  • "title": "string",
  • "value": "string",
  • "widgets": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "recipient": "31d78262-cbd4-4f35-8070-a83c4bfe5327",
  • "is_required": true,
  • "type": "text",
  • "name": "string",
  • "options": [
    ],
  • "description": "string",
  • "placeholder": "string",
  • "title": "string",
  • "value": "string",
  • "filled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "widgets": [
    ]
}

Remove o campo

Remove o campo caso o destinatário não o tenha preenchido ainda, e o envelope esteja como draft, sent, in-transit ou stand-by.

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

document
required
string <uuid>

ID do documento

field
required
string <uuid>

ID do campo

header Parameters
X-Organization
string <uuid>

ID da organização

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Adiciona conteúdo ao documento

Adiciona conteúdo ao documento PDF

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

document
required
string <uuid>

ID do documento

header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: application/json

Cria conteúdo no documento PDF

type
required
string
Enum: "text" "link" "image"

Tipo do conteúdo

value
required
string

Valor do conteúdo. No caso de imagem, deve-se passar um arquivo binário de imagem jpg ou png.

page
required
integer

Página do campo

x_axis
required
integer

Posição do eixo X em pixels (72 dpi)

y_axis
required
integer

Posição do eixo Y em pixels (72 dpi)

width
integer

Largura em pixels (72 dpi)

height
integer

Altura em pixels (72 dpi)

rotation
integer

Rotação ou angulatura do campo

line_height
integer

Espaçamento de linhas para textos com multilinhas.

text_color
string

Valor hexidecimal da cor do texto

opacity
number

Valor entre 0 e 1 para opacidade

font_size
integer

Tamanho da fonte do texto em pt

font_family
string
Enum: "Courier" "Courier-Bold" "Courier-Oblique" "Courier-BoldOblique" "Helvetica" "Helvetica-Bold" "Helvetica-Oblique" "Helvetica-BoldOblique" "Times-Roman" "Times-Bold" "Times-Italic" "Times-BoldItalic"

Fonte a ser usada no texto

Responses

Request samples

Content type
application/json
{
  • "type": "text",
  • "value": "string",
  • "page": 0,
  • "x_axis": 0,
  • "y_axis": 0,
  • "width": 0,
  • "height": 0,
  • "rotation": 0,
  • "line_height": 0,
  • "text_color": "string",
  • "opacity": 0,
  • "font_size": 0,
  • "font_family": "Courier"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "text",
  • "value": "string",
  • "page": 0,
  • "x_axis": 0,
  • "y_axis": 0,
  • "width": 0,
  • "height": 0,
  • "rotation": 0,
  • "line_height": 0,
  • "text_color": "string",
  • "opacity": 0,
  • "font_size": 0,
  • "font_family": "Courier",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Edita o conteúdo

Edita o conteúdo caso não tenha assinaturas e o envelope esteja como draft, sent ou 'stand-by'. Lembrando que o envelope pode estar como stand-by e ter assinaturas, não sendo possível editar.

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

document
required
string <uuid>

ID do documento

content
required
string <uuid>

ID do conteúdo

header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: application/json

Atualiza conteúdo no documento PDF

value
required
string

Valor do conteúdo. No caso de imagem, deve-se passar um arquivo binário de imagem jpg ou png.

page
required
integer

Página do campo

x_axis
required
integer

Posição do eixo X em pixels (72 dpi)

y_axis
required
integer

Posição do eixo Y em pixels (72 dpi)

width
integer

Largura em pixels (72 dpi)

height
integer

Altura em pixels (72 dpi)

rotation
integer

Rotação ou angulatura do campo

line_height
integer

Espaçamento de linhas para textos com multilinhas.

text_color
string

Valor hexidecimal da cor do texto

opacity
number

Valor entre 0 e 1 para opacidade

font_size
integer

Tamanho da fonte do texto em pt

font_family
string
Enum: "Courier" "Courier-Bold" "Courier-Oblique" "Courier-BoldOblique" "Helvetica" "Helvetica-Bold" "Helvetica-Oblique" "Helvetica-BoldOblique" "Times-Roman" "Times-Bold" "Times-Italic" "Times-BoldItalic"

Fonte a ser usada no texto

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "page": 0,
  • "x_axis": 0,
  • "y_axis": 0,
  • "width": 0,
  • "height": 0,
  • "rotation": 0,
  • "line_height": 0,
  • "text_color": "string",
  • "opacity": 0,
  • "font_size": 0,
  • "font_family": "Courier"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "text",
  • "value": "string",
  • "page": 0,
  • "x_axis": 0,
  • "y_axis": 0,
  • "width": 0,
  • "height": 0,
  • "rotation": 0,
  • "line_height": 0,
  • "text_color": "string",
  • "opacity": 0,
  • "font_size": 0,
  • "font_family": "Courier",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Remove o conteúdo

Remove o conteúdo caso não tenha assinaturas e o envelope esteja como draft, sent ou 'stand-by'. Lembrando que o envelope pode estar como stand-by e ter assinaturas, não sendo possível remover.

Authorizations:
OAuth
path Parameters
envelope
required
string <uuid>

ID do envelope

document
required
string <uuid>

ID do documento

content
required
string <uuid>

ID do conteúdo

header Parameters
X-Organization
string <uuid>

ID da organização

Request Body schema: application/json

Atualiza conteúdo no documento PDF

value
required
string

Valor do conteúdo. No caso de imagem, deve-se passar um arquivo binário de imagem jpg ou png.

page
required
integer

Página do campo

x_axis
required
integer

Posição do eixo X em pixels (72 dpi)

y_axis
required
integer

Posição do eixo Y em pixels (72 dpi)

width
integer

Largura em pixels (72 dpi)

height
integer

Altura em pixels (72 dpi)

rotation
integer

Rotação ou angulatura do campo

line_height
integer

Espaçamento de linhas para textos com multilinhas.

text_color
string

Valor hexidecimal da cor do texto

opacity
number

Valor entre 0 e 1 para opacidade

font_size
integer

Tamanho da fonte do texto em pt

font_family
string
Enum: "Courier" "Courier-Bold" "Courier-Oblique" "Courier-BoldOblique" "Helvetica" "Helvetica-Bold" "Helvetica-Oblique" "Helvetica-BoldOblique" "Times-Roman" "Times-Bold" "Times-Italic" "Times-BoldItalic"

Fonte a ser usada no texto

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "page": 0,
  • "x_axis": 0,
  • "y_axis": 0,
  • "width": 0,
  • "height": 0,
  • "rotation": 0,
  • "line_height": 0,
  • "text_color": "string",
  • "opacity": 0,
  • "font_size": 0,
  • "font_family": "Courier"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "text",
  • "value": "string",
  • "page": 0,
  • "x_axis": 0,
  • "y_axis": 0,
  • "width": 0,
  • "height": 0,
  • "rotation": 0,
  • "line_height": 0,
  • "text_color": "string",
  • "opacity": 0,
  • "font_size": 0,
  • "font_family": "Courier",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Exibe folha de logs

Exibe a folha de logs do documento em formato PDF

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Ações de destinatários

Ações de destinatários

Exibe a ação

Exibe dados do destinatário e o envelope

path Parameters
token
required
string <uuid>

Token de autorização do destinatário

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "approver",
  • "signature_type": "simple",
  • "state": "waiting",
  • "via": "email",
  • "value": "string",
  • "name": "string",
  • "routing_order": 0,
  • "notified_at": "2019-08-24T14:15:22Z",
  • "identifiers": [
    ],
  • "fields": [
    ],
  • "envelope": {
    },
  • "action_token": "string"
}

Realiza a ação

Realiza a ação requerida como destinatário, ou seja, caso aprovador, a ação aprovará o envelope. Caso assinante, assinará o envelope.

path Parameters
token
required
string <uuid>

Token de autorização do destinatário

Request Body schema: application/json

Realiza a ação de destinatário. Somente assinantes precisam informar os dados do corpo da requisição

latitude
string or null

Latitude em que se encontra

longitude
string or null

Longitude em que se encontra

access_token
string or null

Token de acesso Bird ID

certificate_alias
string or null

Alias de certificado Bird ID a se usar

Responses

Request samples

Content type
application/json
{
  • "latitude": "string",
  • "longitude": "string",
  • "access_token": "string",
  • "certificate_alias": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "approver",
  • "signature_type": "simple",
  • "state": "waiting",
  • "via": "email",
  • "value": "string",
  • "name": "string",
  • "routing_order": 0,
  • "notified_at": "2019-08-24T14:15:22Z",
  • "identifiers": [
    ],
  • "fields": [
    ],
  • "envelope": {
    },
  • "action_token": "string"
}

Rejeita a ação/Cancela o envelope

Rejeita o envelope, não realizando a ação requisitada. Caso o remetente tenha enviado para sí mesmo, esta ação cancela o envelope.

path Parameters
token
required
string <uuid>

Token de autorização do destinatário

Request Body schema: application/json

Rejeita a ação requerida.

reason
required
string

Motivo da recusa. Este campo não é obrigatório se o destinatário é o mesmo remetente.

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "approver",
  • "signature_type": "simple",
  • "state": "waiting",
  • "via": "email",
  • "value": "string",
  • "name": "string",
  • "routing_order": 0,
  • "notified_at": "2019-08-24T14:15:22Z",
  • "identifiers": [
    ],
  • "fields": [
    ],
  • "envelope": {
    },
  • "action_token": "string"
}

Preenche identificador

Preenche o identificador requisitado, sendo cada código tendo sua própria validação. Exemplo: CPF será válidado se o CPF é valido, BIRTH_DATE validará se é uma data válida e etc.

path Parameters
token
required
string <uuid>

Token de autorização do destinatário

code
required
string
Enum: "CPF" "BIRTH_DATE" "PHOTO"

Código do identificador a preencher

Request Body schema:

Preenche o identificador do destinatário

value
required
string

Valor para o identificador

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "code": "CPF",
  • "title": "string",
  • "type": "text",
  • "is_required": true,
  • "value": "string",
  • "filled_at": "2019-08-24T14:15:22Z"
}

Download do envelope

Faz download de todos os documentos do envelope no formato zip

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Download de folha de assinaturas

Faz download de todas as folhas de assinaturas de cada documento do envelope no formato zip. O envelope precisa estar finalizado.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Validação

Validação de documentos

Valida o código de um documento

Valida um código de documento do qual, caso exista, exibe os dados do documento referente ao código e os dados de assinantes.

Request Body schema: application/json

Valida o código vindo de um documento

code
required
string

Código impresso no documento, ou informado no link de QRCode.

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "stage": "original",
  • "item": "5953ca74-944e-4941-87b8-f4f42ef3ae12",
  • "sha1": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "envelope": {
    }
}