Pular para o conteúdo principal
Documentation Powered by Redocly

Sign Core API (1.0)

Download OpenAPI specification:Download

Contact

Consulta dos contatos para filtro de autocomplete

Authorizations:
Bearer
Request Body schema:
Array of objects or null (ContactFilterRequest)
Array
key
string or null
value
string or null

Responses

Request samples

Content type
{
  • "filters": [
    ]
}

Documents

/api/v1/documents

Authorizations:
Bearer
Request Body schema:
Order
string or null

Ordem de busca dos Documentos pela data de criação

Status
Array of integers or null <int32>

Status dos Documentos

Page
integer <int32>

Página específica que pretende buscar

Search
string or null

Busca aberta, podendo ter dados de qualquer campo do documento, inclusive conteúdo interno

StartDate
string or null

Data inicial do intervalo de criação dos documentos

EndDate
string or null

Data final do intervalo de criação dos documentos

Units
Array of strings or null

Unidades específicas para a busca

Categories
Array of strings or null

Categorias específicas para a busca

SubCategories
Array of strings or null

Tipos de documentos específicos para a busca

IsSubscriber
boolean

Informa se a busca é por subscriber ou não

SubscriberRoles
Array of integers or null <int32>

Tipos de assinaturas específicos

Array of objects or null (SubscriberSearchJson)

Assinantes específicos para a busca

DocumentsUUIDS
Array of strings or null

Documentos epecíficos para a busca

EmitterId
string or null

Emissor específicss para a buca

TenantId
string or null

Empresa específica para a buca

PageSize
integer <int32>

Quantidade de documentos por página

EnvelopeTags
Array of strings or null

Tags específicas para busca

Responses

Request samples

Content type
Example
{
  • "Order": "ASC",
  • "Page": 1,
  • "Search": "",
  • "StartDate": "04/10/2024",
  • "EndDate": "03/10/2024",
  • "IsSubscriber": false,
  • "EmitterId": "",
  • "TenantId": "",
  • "PageSize": 1,
  • "notifications": [ ],
  • "isValid": true
}

Envelope

/api/v1/envelopes

Authorizations:
Bearer
Request Body schema: application/json
Order
string or null
Status
Array of integers or null <int32>
Page
integer <int32>
Search
string or null
StartDate
string or null
EndDate
string or null
Units
Array of strings or null
Categories
Array of strings or null
SubCategories
Array of strings or null
IsSubscriber
boolean
SubscriberRoles
Array of integers or null <int32>
Array of objects or null (SubscriberSearchJson)
DocumentsUUIDS
Array of strings or null
EmitterId
string or null
TenantId
string or null
PageSize
integer <int32>
EnvelopeTags
Array of strings or null

Responses

Request samples

Content type
application/json
Example
{
  • "Order": "ASC",
  • "Page": 1,
  • "Search": "",
  • "StartDate": "04/10/2024",
  • "EndDate": "03/10/2024",
  • "IsSubscriber": false,
  • "EmitterId": "",
  • "TenantId": "",
  • "PageSize": 1,
  • "notifications": [ ],
  • "isValid": true
}

Gerenciar Contatos

Cria ou Atualiza um contato

Para utilizar esta rota é necessário que o usuário tenha permissão de Administrar Contatos

Authorizations:
Bearer
Request Body schema: application/json
ContactName
string

Nome do assinante

ContactCPF
string

Número de cadastro de pessoa física do assinante

  • sem formatação, apenas os 11 números

Não é possível atualizar CPF de algum assinante existente. Sendo assim, caso seja fornecido um novo CPF haverá o registro de um novo assinante

ContactEmail
string or null <email>

E-mail da assinante

ContactPhone
string or null <tel>

Telefone do assinante com DDD

  • Sem formatação e contendo apenas 10 ou 11 números
ContactIdentifier
string or null

Campo livre, não único, para identificação do contato do lado do cliente

TenantID
string or null <uuid>

Identificador único da empresa

Units
Array of strings or null <uuid>

Identificador único da unidade/filial

Responses

Request samples

Content type
application/json
{
  • "ContactName": "Margaria Clara",
  • "ContactCPF": "10000000019",
  • "ContactEmail": "test@test.com",
  • "ContactPhone": "1192345678",
  • "ContactIdentifier": "test-123-test",
  • "Units": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "Success": true,
  • "Message": "Contato inserido com sucesso"
}

Gerenciar Documentos

Obtém arquivo de documento

Authorizations:
Bearer
path Parameters
uuidDocument
required
string <uuid>

Identificador único do documento

Responses

Response samples

Content type
No sample

Obtém arquivo de conjunto de evidências

Authorizations:
Bearer
path Parameters
uuidDocument
required
string <uuid>

Identificador único do documento

Responses

Response samples

Content type
No sample

Obtém dados fornecidos pelo usuário na assinatura do documento baseado em modelo

Authorizations:
Bearer
path Parameters
documentUuid
required
string <uuid>

Identificador único do documento

Responses

Response samples

Content type
application/json
{
  • "Success": true,
  • "Message": "",
  • "Data": {
    }
}

Obtém os dados de categoria e subcategoria de documento por cliente

Authorizations:
Bearer
query Parameters
page
integer <int32>

Número da página

Responses

Response samples

Content type
application/json
{
  • "Success": true,
  • "Message": "",
  • "Data": {
    }
}

Detalhes do documento

Authorizations:
Bearer
path Parameters
uuidDocument
required
string <uuid>

Identificador único do documento

Responses

Response samples

Content type
application/json
{
  • "Url": "https://",
  • "UrlVoucher": "https://",
  • "DocumentType": "Nome",
  • "CreatedDate": "10/04/2024 13:10",
  • "EmitterUserName": "Name",
  • "EmitterUserEmail": "email@gmail.com",
  • "CompanySocialName": "Unico",
  • "UUID": "37110655-18ad-405f-8c78-c86e74a5a683",
  • "HasFile": false,
  • "Subscribers": [
    ],
  • "IsTemplate": false,
  • "DocumentSubcategoryUUID": "f83d3de5-bd4f-43b7-9593-87cb7c296e8d",
  • "DocumentSubcategoryName": "Abertura de conta bancária",
  • "DocumentCategoryUUID": "bfb5fd9a-e390-4eab-8b46-b7a816809bca",
  • "DocumentCategoryName": "Admissão"
}

Gerenciar Envelopes

Obtém envelopes

Para utilizar esta rota é necessário que o usuário tenha permissão de Visualizar Documentos
Serão obtidos os dados dos envelopes atrelados ao usuário do token utilizado.
Nenhum dos filtros é obrigatório. Caso nenhum seja informado, o retorno padrão será a primeira página contendo 30 envelopes.

Authorizations:
Bearer
Request Body schema: application/json
CPF
string or null = 11 characters ^[0-9]{11}$
Default: null

Número de cadastro de pessoa física do assinante

Se fornecido valor para EnvelopeUUID o valor de CPF será ignorado

  • sem formatação, apenas os 11 números
EnvelopeUUID
string or null <uuid>
Default: null

Identificador único do envelope

Status
integer <int32> (EnvelopeStatusEnum)
Enum: 0 1 2 3 4 5 6

Estado do envelope, que pode ser:

  • 0 - Expirado
  • 1 - Pendente
  • 2 - Concluído
  • 3 - Cancelado
  • 4 - Processando
  • 5 - Recusado
  • 6 - Agendado
Page
integer or null <int32>
Default: 1

Número da página da busca Ops, estamos corrigindo! Paginação não suportada da página 334 em diante. Por favor utilizar mais filtros para fazer uma busca mais precisa de acordo com seu objetivo

StartDate
string or null <date>

Data inicial para busca sob a data de criação do envelope

  • Se esta data for definida, também deve ser definida a data em EndDate
  • A data deve ser após 01/01/2018
  • A data deve ser anterior a data definida em EndDate
EndDate
string or null <date>

Data final para busca sob a data de criação do envelope

  • Se esta data for definida, também deve ser definida a data em StartDate
  • A data deve ser após 01/01/2018
Order
string (Orders)
Enum: "ASC" "DESC"

Ordenação dos elementos da lista, que pode ser:

  • ASC - Crescente
  • DESC - Decrescente
EnvelopeTags
Array of strings or null

Lista de tags do envelope Ao passar mais de uma tag, a busca retornará apenas envelope que contenha todas as tags informadas

Responses

Request samples

Content type
application/json
Example
{
  • "EnvelopeTags": [ ]
}

Response samples

Content type
application/json
Example
{
  • "Success": true,
  • "Message": "",
  • "Data": {
    }
}

Cancela um envelope

Para utilizar esta rota é necessário que o usuário tenha permissão de Enviar Documentos

Authorizations:
Bearer
Request Body schema: application/json
EnvelopeUUID
string <uuid>

Identificador único do envelope

Reason
string

Motivo de cancelamento do envelope

UserName
string or null
Default: "Integração"

Nome do usuário que está cancelando

Se não fornecido será extraído o nome de usuário do token utilizado, e se não encontrado o nome será Integração

Responses

Request samples

Content type
application/json
Example
{
  • "EnvelopeUUID": "00000000-0000-0000-0000-000000000000",
  • "Reason": "Solicitação de correção"
}

Response samples

Content type
application/json
{
  • "Success": true,
  • "Message": "Envelope cancelado com sucesso"
}

Reenvia um envelope pendente e notifica os assinantes Recebe dados em JSON Body

Authorizations:
Bearer
Request Body schema: application/json

Contém a estrutura para o Reenvio

UUID
string <uuid>

Identificador do envelope que será reenviado

  • O envelope deve estar no status pendente
Array of objects or null (ResendEnvelopeRequest_Subscriber)

Lista de Subscribers do envelope

Responses

Request samples

Content type
application/json
{
  • "UUID": "00000000-0000-0000-0000-000000000000",
  • "Subscribers": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "errors": [
    ]
}

Notification

Reenvia o link de assinatura para 1 ou mais envelopes em status Pendente ou Expirado

Authorizations:
Bearer
Request Body schema: application/json
Envelopes
Array of strings or null <uuid>

Lista de Envelopes para que a notificação seja reenviada

Responses

Request samples

Content type
application/json
{
  • "Envelopes": [
    ]
}

Response samples

Content type
application/json
{
  • "Success": true,
  • "Message": "Envelopes reenviados com sucesso"
}

Solicitar Assinatura

Cria um envelope, documento e arquivos Recebe dados em JSON Body

Para utilizar esta rota é necessário que o usuário tenha permissão de Enviar Documentos

Authorizations:
Bearer
Request Body schema: application/json

Contém a estrutura para criação do envelope

ScheduleDate
string or null <date-time>

Data de agendamento do envelope

  • Data deve ser maior que o período atual + 20 minutos.
  • Data não pode ser maior que o período atual + 30 dias..
TenantID
string or null <uuid>

Identificador da empresa dentro da Unico

IsFrame
boolean or null

Deve ser passado true ou false

  • Quando passado true, nenhuma notificação será enviada para os assinantes.
  • Desta forma é necessário direcionar o assinante para o fluxo de assinatura web usando a URL (parâmetro UrlFrameFull).
EnvelopeTitle
string or null

Título do envelope

  • O título será utilizado como assunto do e-mail de notificação enviado ao assinante.
  • Limite máximo de 150 caracteres.
EmailMessage
string or null

Mensagem do e-mail enviado para os assinantes

  • Limite máximo de 500 caracteres.
ExpirationDate
string or null <date-time>

Data de expiração do envelope

  • Data deve ser maior que D+1.
  • Data não pode ser maior que D+180.
UrlCallback
string or null <uri>

Deve ser passado uma Url para receber o nosso callback do envelope caso seja necessário.

  • O callback será enviado quando o envelope for finalizado, ou seja, quando o status for 2-Concluído, 3-Cancelado ou 5-Recusado.
RequireGeolocation
boolean or null

Indica se o fluxo de geolocatização é obrigatório na assinatura do envelope

Array of objects or null (PostEnvelopeRequest_EnvelopeFlowList)

Lista de fluxos de autenticação dos assinantes no envelope

Array of objects or null (PostEnvelopeRequest_Document)

Lista de documentos no envelope.

EnvelopeTags
Array of strings or null

Lista de tags do envelope.

Responses

Request samples

Content type
application/json
Example
{
  • "TenantID": "00000000-0000-0000-0000-000000000000",
  • "IsFrame": false,
  • "RequireGeolocation": false,
  • "EnvelopeFlow": [
    ],
  • "Documents": [
    ],
  • "EnvelopeTags": [ ]
}

Response samples

Content type
application/json
{
  • "Success": true,
  • "Message": "",
  • "Data": {
    }
}

Template

Retorna uma lista de templates com dados do template e unidade a qual pertence

Authorizations:
Bearer
query Parameters
withTemplateFields
boolean
withCategoryId
boolean
withUnits
boolean
Request Body schema: application/json
ExternalCategorizationUUIDS
Array of strings or null <uuid>

Lista de ExternalCategorization para filtrar os templates obtidos

Units
Array of strings or null <uuid>

Lista de Unidades para filtrar os templates obtidos

TenantId
string <uuid>

TenantID do cliente no sign para filtrar os templates obtidos

Responses

Request samples

Content type
application/json
{
  • "ExternalCategorizationUUIDS": [
    ],
  • "Units": [
    ],
  • "TenantId": "00000000-0000-0000-0000-000000000000"
}

Response samples

Content type
application/json
{
  • "Success": true,
  • "Message": "",
  • "Data": [
    ]
}

Retorna os detalhes de um Template específico

Authorizations:
Bearer
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "Success": true,
  • "Message": "",
  • "Data": {
    }
}