Documentação API

ParteEnvio

Quando deseja criar nova parte:

Estrutura Json:


{
    'id_validacao_bloco': 999,
    'nome': 'Joao da Silva',
    'rg': '21000112-2',
    'cpf': '11122233344455',
    'id_tipo_documento': 0,
    'descricao_documento': 'aaaa1111',
    'documento': 'aaaa1111',
    'email': 'usuario@dominio.com.br',
    'ddd': 99,
    'telefone': 11112222,
    'id_tipo_telefone': 2,
    'identificacao_parte': '',
    'id_referencia': 'aaa111',
    'ordem_assinatura': 99,
    'notificar': 0, // opcional
    'pessoa_preenche_dados': '0', // opcional
    'validar_campos': '0', // opcional
    'validar_anexos': '0',  // opcional
    'redirecionamentos': Array // opcional
}
    

Parametro Tipo Obrigatório Descrição
id_validacao_bloco int Vide tabela validacoes_blocos
id_tipo_telefone int Vide tabela telefones_tipos
identificacao_parte string Identificar a função da parte no documento
Ex.: Locador, Locatário, Estagiário, Empresa concedente, etc.
id_referencia string Identificação da parte no sistema de origem dos dados.
ordem_assinatura int Indicar ordem de assinaturas, assinam do menor para o maior, o padrão é sempre 0, ou seja, assinam primeiro.
notificar int Indica se a parte deve ser notificada. O parâmetro não é obrigatório e o default é 1, ou seja, sempre é notificado. Caso não queira que seja notificado, é necessário enviar como 0.
pessoa_preenche_dados int Define que a parte deve preencher os dados pela Assine Bem antes de realizar Assinatura, portanto não é necessário enviar os dados obrigatórios como CPF, RG. Para utilizar esta opção, o valor deste parâmetro deve ser 1 e o produto estar configurado e disponível para a sua conta.
validar_campos int Se a parte assina um modelo e o solicitante deseja validar os campos preenchidos antes de efetivar a assinatura, o valor deve ser 1.
validar_anexos int Se a parte assina um modelo e possui anexos no processo de assinatura, e o solicitante deseja validar os anexos enviados, o valor deve ser 1.
redirecionamentos ParteRedirecionamento Estrutura ParteRedirecionamento para configurar redirecionamentos da parte durante processo de assinatura digital.

Essa estrutura depende de um produto extra que necessita liberação da equipe da Assine Bem para utilização.

A identificação padrão da parte no processo de assinatura é o CPF, porém é possível solicitar outro tipo de identificação, como por exemplo, passaporte, código interno ou qualquer um que desejar. Para isso, é preciso enviar os três parâmetros abaixo para cada estrutura de parte. Para manter o CPF, basta ignorar os parâmetros abaixo.

Parametro Tipo Obrigatório Descrição
id_tipo_documento int Inteiro para identificar que deseja identificar a parte por outro processo que não seja o CPF, para isso, o valor desse parâmetro deve ser 2.
descricao_documento string String com a descrição para a parte sobre qual documento está sendo utilizado para identificação. Exemplo: Passaporte, código interno e etc...
documento string String com o valor do documento para cada parte. Exemplo: número do passaporte da pessoa ou código interno pré-combinado com a parte.

Adicionar parte que já existe ao documento, a partir do id_externo:

Estrutura Json:


{
    'id_validacao_bloco': 999,
    'id_externo': 'ID',
    'identificacao_parte': '',
    'id_referencia': 'aaa111',
    'ordem_assinatura': 99
}
    

Parametro Tipo Obrigatório Descricao
id_externo int ID que foi retornado ao criar a parte
id_referencia string Identificação da parte no sistema de origem dos dados
ordem_assinatura int Indicar ordem de assinaturas, assinam do menor para o maior, o padrão é sempre 0, ou seja, assina primeiro.

ParteRetorno

Retorno da função que cria a parte:

Estrutura Json:


{
    'id_referencia': '',
    'id_externo': 'ID',
    'id_status_pessoa_parte': '',
    'descricao_parte_status': '',
    'identificacao_parte': '',
    'dt_ult_notificado': 'DD/MM/YYYY HH:MI:SS',
    'dt_criacao': 'DD/MM/YYYY HH:MI:SS',
    'pessoa': {
        'nome': None,
        'rg': None,
        'cpf': None,
        'id_tipo_documento': None,
        'descricao_documento': None,
        'documento': None,
        'emails': Array,
        'telefones': Array
    },
    'parte_url':  (Opcional)
}
    

Parametro Tipo Obrigatório Descricao
id_referencia int Só retorna se tiver valor
id_status_pessoa_parte string Vide tabela pessoas_partes_status

PessoaEmail

E-mails de uma parte:

Estrutura Json:


{
    'email': None,
    'descricao_status_email': None,
    'data_criacao': 'DD/MM/YYYY HH:MI:SS'
}
    

PessoaTelefone

Telefones de uma parte:

Estrutura Json:


{
    'ddd': None,
    'telefone': None,
    'id_pessoa_tipo_telefone': None,
    'descricao_status_telefone': None,
    'descricao_tipo_telefone': None,
    'data_criacao': 'DD/MM/YYYY HH:MI:SS'
}
    

Parametro Tipo Obrigatório Descricao
id_pessao_tipo_telefone int Vide tabela telefones_tipos

ParteUrl

Url para acesso de uma parte:
Estrutura de retorno somente para clientes que possuam este produto ativo na conta. Caso tenha dúvidas, contate a equipe Assine Bem.

Estrutura Json:


{
    'url': None,
    'token': None,
    'assinatura': None,
    'validacao': None, 
    'dt_expiracao_token': 'DD/MM/YYYY HH:MI:SS'
}
    

Parametro Tipo Obrigatório Descricao
url string URL completa para acesso ao sistema pelo assinante.
assinatura int Opcional com valor 0 ou 1. Se a URL for de assinatura, este parâmetro retorna 1.
validacao int Opcional com valor 0 ou 1. Se a URL for de validação, este parâmetro retorna 1.
token string UUID Token UUID para acesso ao sistema com expiração.
dt_expiracao_token string formato data BR Data de expiração do Token quando for URL de acesso para assinatura.

ParteRedirecionamento

Configuração de redirecionamento da parte durante processo de assinatura:
Estrutura de envio somente para clientes que possuam este produto ativo na conta. Caso tenha dúvidas, contate a equipe Assine Bem.

Estrutura Json:


    {
    'tipo': 'STRING',
    'url': 'STRING',
    'parametros': 'JSON KEY-VALUE PAIR'
    }
    

Parâmetro Tipo Obrigatório Descrição
tipo string Vide tabela tipos_redirecionamentos .
url string URL para onde a parte será redirecionada.
A URL deve ser com protocolo https e estar liberada na whitelist da Assine Bem.
Para isso, é preciso enviar a solicitação de adicionar a URL para a equipe comercial.
parametros JSON String JSON key-value pair com os parâmetros que devem ser enviados juntos com a URL durante o redirecionamento.

Exemplo:

{'PARAM1': 'VAL_PARAM1'}

AssinaturaParte

Assinatura de uma parte:

Estrutura Json:


{
    'dt_criado': 'DD/MM/YYYY HH:MI:SS',
    'dt_visualizado': 'DD/MM/YYYY HH:MI:SS',
    'dt_assinado': 'DD/MM/YYYY HH:MI:SS',
    'id_externo': 'ID da parte',
    'identificador_assinatura': 'Identificador único da assinatura da parte no documento'
}
    

ModeloParte

Parte de um modelo:

Estrutura Json:


{
    'id_modelo_parte': 'ID_INTEIRO',
    'identificacao_parte': 'STRING',
    'anexos': 'INTEIRO' // opcional (quantidade de anexos que devem ser enviados pela parte no modelo)
}
    

ModeloParteEnvio

Quando se deseja adicionar uma parte no documento:

Estrutura Json:


{
    'id_modelo_parte': 'ID_INTEIRO',
    // < ParteEnvio >
}
    

id_modelo_parte: ID da parte configurada no modelo, usa-se esse ID como referência para vincular a parte a ser cadastrada (vide ) na parte referência do modelo


ModeloCampo

Campo de um modelo:

Estrutura Json:


{
    "id_campo": 'ID_INTEIRO',
    "nome_campo": "STRING",
    "label_campo": "STRING",
    "preenchimento_obrigatorio": 'INT',
    "id_tipo_campo": 'INT',
    "descricao_tipo_campo": "STRING",
    'opcoes': Array // (opcional)
}
    

Parametro Tipo Obrigatório Descricao
label_campo String Formatada sem acento, caractere especial ou espaço e etc. Os espaços são substituídos como '-'
id_tipo_campo int Vide tabela modelo_tipos_campos

ModeloCampoEnvio

Preenche campo de modelo:

Estrutura Json:


{
    "$id_campo": '$VALOR_CAMPO'
}
    

$ID_CAMPO: retornado pela consulta do campo (vide )

$VALOR_CAMPO: Valor preenchido do campo para gerar documento a partir do modelo. (pode ser nulo se o campo não for obrigatório e não desejar preencher nada)


ModeloCampoOpcoes

Opções de um campo do modelo:

Estrutura Json:


{
    "id_opcao": 'ID_INTEIRO',
    "opcao": 'STRING'
}
    

ModeloRetorno

Dados do modelo:

Estrutura Json:


{
    "modelo": {
        'dt_criacao': 'DD/MM/AAAA HH:MI:SS',
        'dt_alteracao': 'DD/MM/AAAA HH:MI:SS',
        'nome': 'STRING',
        'id_externo': 'ID_INTEIRO',
        "partes": Array<ModeloParte></modeloparte>, // (opcional)
        "campos_avulsos": Array // (opcional)
    }
}
    

Parametro Tipo Obrigatório Descricao
partes Array Lista de partes do modelo que devem ser preenchidas para solicitar a assinatura digital.
campos_avulsos Array Campos que o modelo espera que sejam preenchidos para gerar o documento a partir do modelo e solicitar a assinatura.

AnexoRetorno

Dados do anexo por parte:

Estrutura Json:


{
    "$id_externo_parte": Array<{
        'identificacao_anexo': 'STRING',
        'envio_obrigatorio': 'INTEIRO',
        'enviado': 'INTEIRO',
        'status': 'INTEIRO',
        'descricao_status': 'STRING'
        'dt_enviado': 'DD/MM/AAAA HH:MI:SS',
        'id_download' 'INTEIRO' // opcional
    }>
}
    

$id_externo_parte: id string único de identificação da parte.


Parametro Tipo Descricao
envio_obrigatorio int Este parâmetro identifica se o envio do anexo é ou não obrigatório. Retorno 1 se obrigatório, 0 se não obrigatório.
enviado int Este parâmetro identifica se o anexo foi enviado. Retorno 1 se foi enviado, 0 se não foi enviado.
status int Este parâmetro identifica o status do anexo enviado. Pode ser 1 (Pendente) ou 2 (Aprovado) ou 3 (Inválido) ou 4 (Não enviado)
id_download int Este parâmetro só é retornado se (enviado = 1) e utiliza-o para fazer download do anexo no Endpoint "documento/anexos/download"