folder
|
Não |
As pastas têm o objetivo de organizar os pacotes de documentos. Nelas, você pode cadastrar informações complementares.
Para anexar um pacote de documentos à uma pasta já existente, o número da mesma deve ser informado através do atributo key.
Caso não seja informado o atributo key da pasta, o pacote de documentos será vinculado à uma nova pasta automaticamente criada.
|
{
"folder": {
"key": "0087/2022",
"type": "1",
"stakeholder": {
"type": "PF/PJ/Outros",
"name": "José da Silva",
"documentation": "123.456.789-10"
},
"area": "4",
"business_unit": "7",
"validity_date_start": "2022-02-06",
"validity_date_end": "2023-02-08"
}
}
|
folder > type
|
Não |
Este atributo define o tipo da sua pasta, de acordo com os tipos cadastrados e configurados em sua base no RRSign | Portal de Assinaturas.
Exemplo: Documentos de Funcionários, Contratos de Serviço e etc.
Para ter acesso à lista de Tipos de Pastas disponíveis para utilização, vá até a sessão Requisição de Parâmetros > Tipos de Pastas nesta documentação e siga as instruções.
Como parâmetro deste atributo, utilize o id do Tipo de pasta desejado.
|
folder > stakeholder
|
Não |
Este atributo é responsável por adicionar uma parte interessada à pasta.
Para isso, os atributos devem ser preenchidos como exemplificado abaixo:
- type: Identifica se é uma Pessoa Física, Jurídica ou Outros (com as opções de parâmetros: PF/PJ/OUTROS)
- name: Nome do Parte Interessada da Pasta
- documentation: Número do documento da Parte Interessada da Pasta
|
folder > area
|
Não |
Este atributo define a área da sua pasta, de acordo com as áreas cadastradas e configuradas em sua base no RRSign | Portal de Assinaturas.
Exemplo: Contratual, Jurídica e etc.
Caso a Área selecionada tenha signatários vinculados, os mesmos serão anexados automaticamente ao pacote de documentos.
Para ter acesso à lista de Áreas disponíveis para utilização, vá até a sessão Requisição de Parâmetros > Áreas nesta documentação e siga as instruções.
Como parâmetro deste atributo, utilize o id da Área desejada.
|
folder > business_unit
|
Não |
Este atributo define a unidade de negócio da sua pasta, de acordo com as unidades de negócios cadastradas e configuradas em sua base no RRSign | Portal de Assinaturas.
Exemplo: Filial de São Paulo, Sede de Porto Alegre e etc.
Caso a Unidade de Negócio selecionada tenha signatários vinculados, os mesmos serão anexados automaticamente ao pacote de documentos.
Para ter acesso à lista de Unidades de Negócios disponíveis para utilização, vá até a sessão Requisição de Parâmetros > Unidades de Negócio nesta documentação e siga as instruções.
Como parâmetro deste atributo, utilize o id da Unidade de Negócio desejada.
|
folder > validity_date_start
|
Não |
Este atributo define a data de início de vigência da pasta.
Esta é uma informação complementar que auxilia no controle e gestão das pastas.
Como parâmetro deste atributo, envie uma data no seguinte formato: 2022-01-25.
|
folder > validity_date_end
|
Não |
Este atributo define a data de fim de vigência da pasta.
Esta é uma informação complementar que auxilia no controle e gestão das pastas.
Como parâmetro deste atributo, envie uma data no seguinte formato: 2022-02-25.
|
draft
|
Não |
Este atributo define se o pacote de documentos será enviado diretamente para assinatura dos signatários ou ficará apenas cadastrado em seu portal de assinaturas, neste caso, aguardando o envio manualmente por um usuário.
O parâmetro deve ser enviado no formato boolean: true ou false.
|
{
"draft": "true"
}
|
sender
|
Não |
Este parâmetro é responsável por mostrar o retemente na notificação por e-mail ou whatsapp.
Nele, você deve enviar os dados do remetente informando os atributos conforme as instruções abaixo:
- name
- email
- telephone
|
{
"sender": {
"name": "Eduardo Oliveira",
"email": "eduardo@email.com.br",
"telephone": "(11) 12345-6789"
}
}
|
system_code
|
Sim |
A API permite que múltiplos sistemas sejam integrados ao Portal. Este atributo define qual o Sistema Integrado que está enviando uma requisição para o Portal. Este valor, ou seja, o Código de cada Sistema Integrado está disponível nas Configurações do Portal.
|
{
"system_code": "SI1",
}
|
sequence
|
Não* |
Este atributo tem a função de definir se haverá ordenção no processo de assinatura dos signatários, fazendo com que os mesmos sigam uma fila para assinatura do pacote de documentos.
Este parâmetro deve ser enviado no formato boolean: true ou false.
|
{
"sequence": "true"
}
|
stakeholder
|
Não |
Este atributo é responsável por adicionar um interessado exclusivamente ao pacote. Desta forma, dando suporte aos casos em que é necessário vincular um interessado diretamente ao pacote, e não à pasta.
Para isso, os parâmetros devem ser preenchidos como exemplificado abaixo:
- type: Identifica se é uma Pessoa Física, Jurídica ou Outros (com as opções de parâmetros: PF/PJ/OUTROS)
- name: Nome do Interessado do Pacote
- documentation: Número do documento do Interessado do Pacote
|
{
"stakeholder": {
"type": "PF",
"name": "Felipe Pereira Oliveira",
"documentation": "123.456.789-10"
}
}
|
business_unit
|
Não |
Este atributo define a unidade de negócio do seu pacote, de acordo com as unidades de negócios cadastradas e configuradas em sua base no RRSign | Portal de Assinaturas.
Exemplo: Filial de São Paulo, Sede de Porto Alegre e etc.
Para ter acesso à lista de Unidades de Negócios disponíveis para utilização, vá até a sessão Requisição de Parâmetros > Unidades de Negócio nesta documentação e siga as instruções.
Como parâmetro deste atributo, utilize o id da Unidade de Negócio desejada.
|
documents
|
Sim |
Este parâmetro é responsável por enviar a lista de documentos que serão anexados ao pacote.
Nele, você deve enviar a lista de documentos PDF no formato base64, obrigatoriamente.
Para isso, os atributos devem ser preenchidos, formando um array de objetos, conforme as seguintes instruções:
- title: Título do Documento
- content: Documento (em base64)
|
{
"documents": [
{
"title": "Contrato de Serviços",
"content": "DQolUERGLTEuNwoxIDAgb2J[...]"
},
{
"title": "Contrato de Renovação",
"content": "MyAwIFIgPj4KZW5kb2JqCja[...]"
}
]
}
|
signers
|
Sim |
Este parâmetro é responsável por enviar a lista de signatários que deverão assinar o pacote de documentos.
Nele, você deve enviar a lista de signatários, formando um array de objetos, informando os atributos conforme as instruções abaixo:
- name
- documentType: Tipo de documento do signatário. Possíveis valores:
- 1: CPF.
- 2: CNPJ.
- 3: Documento Estrangeiro.
- 4: RG.
- 5: RNM.
- 6: RNE.
- 7: CTPS.
- 8: CNH.
- 9: OAB.
- 10: Passaporte.
- documentation: Número do documento do signatário.
- foreign: Caso o signatário não possua um CPF ou CNPJ, este atributo deve ser preenchido com o parâmetro true. Seu valor padrão é false
- email
- phone: Obrigatório caso whatsapp = true ou tipo_assinatura = eletronica_avancada.
- whatsapp: Para enviar a notificação de assinatura através do WhatsApp, atribua o parâmetro true. Seu valor padrão é false.
- facial_biometrics: Para exigir autenticação biométrica facial pelo signatário, atribua o parâmetro true. Seu valor padrão é false.
- position: Para ter acesso à lista de Posições disponíveis para utilização, vá até a sessão Requisição de Parâmetros > Posição do Signatário nesta documentação e siga as instruções. Como parâmetro deste atributo, utilize o id da Posição desejada.
- sign_type: Possíveis valores:
- eletronica_simples: Assinatura Eletrônica.
- eletronica_avancada: Assinatura Eletrônica com autenticação via SMS.
- digital: Assinatura Digital utilizando o certificado ICP-Brasil.
Para saber mais sobre os tipos de assinatura existentes em nosso Portal de Assinaturas, clique aqui.
|
{
"signers": [
{
"name": "Rogério da Silva",
"documentType": "1",
"documentation": "123.456.789-10",
"email": "rogerio@email.com.br",
"phone": "(11) 12345-6789",
"position": "1",
"sign_type": "digital",
"whatsapp": true,
"facial_biometrics": true
},
{
"name": "Paul Walker",
"documentType": "3",
"documentation": "132546",
"foreign": true,
"email": "paul@email.com",
"position": "2",
"sign_type": "eletronica_simples"
}
]
}
|
followers
|
Não |
Este parâmetro é responsável por enviar a lista de acompanhantes que receberão alertas dos andamentos dos documentos.
Nele, você deve enviar a lista de acompanhantes, formando um array de objetos, informando os atributos conforme as instruções abaixo:
- name
- email
- sign_alert: Define se o acompanhante receberá alerta de assinaturas de cada signatário. Parâmetros possíveis: true ou false.
- finish_alert: Define se o acompanhante receberá alerta de finalização do processo de assinaturas do pacote de documentos. Parâmetros possíveis: true ou false.
|
{
"followers": [
{
"name": "Carlos Magno",
"email": "carlos@email.com.br",
"sign_alert": false,
"finish_alert": true
},
{
"name": "Enzo Marlon",
"email": "enzo@email.com.br",
"sign_alert": true,
"finish_alert": true
}
]
}
|
