Documentação API

Sumário


Requisitar documento

Passo a passo de como requisitar um documento

Clique aqui

Consultas

Visualizar todos os endpoints de Consulta.

Clique aqui

Downloads

Visualizar todos os endpoints de Download.

Clique aqui

Endpoints

Descrição:

Este método retorna um identificador único (UUID) que deverá ser passado para solicitar o upload de um documento.

URL:

GET

Parâmetros de entrada:

Nenhum parâmetro é preciso, o sistema faz a autenticação pelo seu Token enviado pelo HEADER e gera um identificador randomicamente.

Retorno:

JSON:
 

                            {"identifier": "UUID"}

                            


Descrição:

Este método permite realizar o upload de um documento (arquivo) para assinatura, juntamente com as partes envolvidas.

** Obrigatório enviar o parâmetro URL_ARQUIVO ou ARQUIVO conforme descritos abaixo na tabela de parâmetros de entrada.

URL:

POST

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_identifier UUID Identificador do documento, gerado por get_identifier_to_upload
lista_partes Array<ParteEnvio> Lista das partes envolvidas na assinatura separados por vírgula, vide estrutura <ParteEnvio>.
url_arquivo String URL com documento PDF
arquivo Base64 Arquivo encodado em base64
identificacao_arquivo String Nome do arquivo, sem espaços ou caracteres especiais
sufixo_arquivo String Extensão do arquivo
quadro_assinaturas int Indica se terá um quadro de assinatura no comprovante da Assine Bem
id_centro_custo int ID único de centro de custo que deve ser vinculado ao documento

Retorno:

JSON:
 

                            {"status_api": 999, "mensagem": "descricao da resposta", "documento": {"id_documento_status": "null", "descricao_documento_status": "null", "identificacao_arquivo": "null", "dt_criacao": "null", "id_externo": "null", "identificador_documento": "null", "hash_arquivo": "null", "quadro_assinaturas": "null", "quantidade_paginas": "null", "dt_limite_assinatura": "null", "lista_partes": "Array<ParteRetorno></ParteRetorno>"}}

                            


Descrição:

Este método permite adicionar uma nova parte em um documento existente.

** Obrigatório enviar o parâmetro URL_ARQUIVO ou ARQUIVO conforme descritos abaixo na tabela de parâmetros de entrada.

URL:

POST

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo_documento String ID único do documento na plataforma, utilizado para consultas e alterações
parte Array<ParteEnvio> Dados da parte que deseja inserir.

Retorno:

JSON:
 

                            {"status_api": 999, "mensagem": "descricao da resposta", "documento": {"id_documento_status": "null", "descricao_documento_status": "null", "identificacao_arquivo": "null", "dt_criacao": "null", "id_externo": "null", "identificador_documento": "null", "hash_arquivo": "null", "quadro_assinaturas": "null", "quantidade_paginas": "null", "dt_limite_assinatura": "null", "lista_partes": "Array<ParteRetorno></ParteRetorno>"}}

                            


Descrição:

Este método busca os dados do documento e retorna no formato JSON.

URL:

GET

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo String ID único do documento na plataforma, utilizado para consultas e alterações

Retorno:

JSON:
 

                            {"status_api": 999, "mensagem": "descricao da resposta", "documento": {"id_documento_status": "null", "descricao_documento_status": "null", "identificacao_arquivo": "null", "dt_criacao": "null", "id_externo": "null", "identificador_documento": "null", "hash_arquivo": "null", "quadro_assinaturas": "null", "quantidade_paginas": "null", "dt_limite_assinatura": "null", "lista_partes": "Array<ParteRetorno></ParteRetorno>"}}

                            


Descrição:

Este método retorna o binario do documento e informações do arquivo.

URL:

GET

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo String ID único do documento na plataforma, utilizado para consultas e alterações
assinado String (valor:1) Se parâmetro enviado, a API retornará a última versão do arquivo disponível com as assinaturas das partes e o comprovante da Assine Bem. Senão será retornado o arquivo original enviado para assinatura.

Retorno:

JSON:
 

                            {"arquivo": "hash do arquivo", "file_length": "tamanho do arquivo", "file_name": "nome do arquivo", "file_type": "tipo do arquivo", "identificacao_arquivo": "identifica\u00e7\u00e3o do arquivo", "mensagem": "descri\u00e7\u00e3o da resposta"}

                            


Descrição:

Este método retorna o binário do documento.

URL:

GET

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo String ID único do documento na plataforma, utilizado para consultas e alterações

Retorno:

JSON:
 

                            {"arquivo": "hash do arquivo", "file_length": "tamanho do arquivo", "file_name": "nome do arquivo", "file_type": "tipo do arquivo", "identificacao_arquivo": "identifica\u00e7\u00e3o do arquivo", "mensagem": "descri\u00e7\u00e3o da resposta"}

                            


Descrição:

Este método invalida o documento na plataforma e não permite futuras assinaturas.

URL:

POST

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo String ID único do documento na plataforma, utilizado para consultas e alterações

Retorno:

JSON:
 

                            {"status_api":999,"mensagem":"descrição da resposta"}

                            


Descrição:

Este método busca os dados da parte e retorna no formato JSON.

URL:

GET

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo String ID único do documento na plataforma, utilizado para consultas e alterações

Retorno:

JSON:
 

                            {"status_api": 999, "mensagem": "descri\u00e7\u00e3o da resposta", "parte": {"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": "null", "rg": "null", "cpf": "null", "id_tipo_documento": "null", "descricao_documento": "null", "documento": "null", "pessoa_preenche_dados": "null", "lista_emails": "Array <PessoaEmail></PessoaEmail>", "lista_telefones": "Array <PessoaTelefone></PessoaTelefone>"}, "parte_url": "<ParteUrlRetorno></ParteUrlRetorno> //(Opcional)"}}

                            


Descrição:

Este método permite adicionar uma nova parte sem vinculo com um documento.

** Obrigatório enviar o parâmetro NOME conforme descritos abaixo na tabela de parâmetros de entrada.

URL:

POST

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
nome String Representando NOME da parte. Parâmetro obrigatório.
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.
rg String Representando RG da parte. Se não for passado, não será atualizado.
cpf String Representando CPF (sem pontuação) da parte. Se não for passado, não será atualizado.
email String Representando o e-mail da parte. Se não for passado, não será atualizado.
id_tipo_telefone int Int representando o tipo de telefone.
ddd int Int representando os dois dígitos do DDD. Se não for passado, não será atualizado.
telefone int Int representando o número de celular da parte. (8 ou 9 dígitos) Se não for passado, não será atualizado.
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... Só é obrigatório caso o id_tipo_documento seja 2.
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.
id_referencia String Identificação da parte no sistema de origem dos dados.
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.

Retorno:

JSON:
 

                            {"status_api": 999, "mensagem": "descricao da resposta", "documento": {"id_documento_status": "null", "descricao_documento_status": "null", "identificacao_arquivo": "null", "dt_criacao": "null", "id_externo": "null", "identificador_documento": "null", "hash_arquivo": "null", "quadro_assinaturas": "null", "quantidade_paginas": "null", "dt_limite_assinatura": "null", "lista_partes": "Array<ParteRetorno></ParteRetorno>"}}

                            


Descrição:

Este método busca o status da parte e retorna no formato JSON.

URL:

GET

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo String ID único do documento na plataforma, utilizado para consultas e alterações

Retorno:

JSON:
 

                            {"status_api": 999, "mensagem": "descri\u00e7\u00e3o da resposta", "id_externo": "ID", "id_status": "ID", "descricao": "descri\u00e7\u00e3o do status em texto"}

                            


Descrição:

Este método atualiza os dados básicos da parte dependendo das restrições.

** Somente será permitido atualizar se status da parte for 'Não validado' ou 'Dados inválidos'.

** Somente será atualizado se os valores passados forem diferentes dos atuais.

** O ddd/telefone só será atualizado se passar os dois valores em conjunto.

URL:

POST

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo String ID único do documento na plataforma, utilizado para consultas e alterações
rg String Representando RG da parte. Se não for passado, não será atualizado.
cpf String Representando CPF (sem pontuação) da parte. Se não for passado, não será atualizado.
ddd int Int representando os dois dígitos do DDD. Se não for passado, não será atualizado.
telefone int Int representando o número de celular da parte. (8 ou 9 dígitos) Se não for passado, não será atualizado.
id_tipo_telefone int Int representando o tipo de telefone.

Retorno:

JSON:
 

                            {"status_api": 999, "mensagem": "descricao da resposta", "documento": {"id_documento_status": "null", "descricao_documento_status": "null", "identificacao_arquivo": "null", "dt_criacao": "null", "id_externo": "null", "identificador_documento": "null", "hash_arquivo": "null", "quadro_assinaturas": "null", "quantidade_paginas": "null", "dt_limite_assinatura": "null", "lista_partes": "Array<ParteRetorno></ParteRetorno>"}}

                            


Descrição:

Esse método notifica a parte via E-mail e SMS com novo acesso para assinar documentos pendentes.

URL:

POST

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo String ID único do documento na plataforma, utilizado para consultas e alterações

Retorno:

JSON:
 

                            {"sucesso": 1}

                            

Descrição Retorno:

ID Descrição
1 Se parte foi notificada com sucesso.
0 Se parte não foi notificada.


Descrição:

Este método busca o status da parte e retorna em forma de JSON.

URL:

GET

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo_parte String ID único da parte na plataforma, utilizado para consultas e alterações
id_externo_documento String ID único do documento na plataforma, utilizado para consultas e alterações

Retorno:

JSON:
 

                            {"id_externo_parte": "ID", "id_externo_documento": "ID", "identificador_assinatura": ""}

                            

Descrição Retorno:

ID Descrição
identificador_assinatura UUID único da assinatura, se vier preenchido significa que a parte assinou.


Descrição:

Este método busca todas as partes com assinatura pendente de documentos ainda não assinados.

URL:

POST

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
offset int Offset da busca de assinaturas pendentes, pois é retornado 50 registros por vez.

Retorno:

JSON:
 

                            {"offset_ini": "\u00cdndice inicial do offset", "offset_fim": "\u00cdndice final do offset", "total": "Total de assinaturas pendentes.", "total_retornado": "Total de registros retornados", "assinaturas_pendentes": [{"id_externo_parte": "ID \u00fanico", "id_externo_documento": "ID \u00fanico", "documento": {"id_documento_status": "null", "descricao_documento_status": "null", "identificacao_arquivo": "null", "dt_criacao": "null", "id_externo": "null", "identificador_documento": "null", "hash_arquivo": "null", "quadro_assinaturas": "null", "quantidade_paginas": "null", "dt_limite_assinatura": "null", "lista_partes": "Array<ParteRetorno></ParteRetorno>"}, "parte": {"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": "null", "rg": "null", "cpf": "null", "id_tipo_documento": "null", "descricao_documento": "null", "documento": "null", "pessoa_preenche_dados": "null", "lista_emails": "Array <PessoaEmail></PessoaEmail>", "lista_telefones": "Array <PessoaTelefone></PessoaTelefone>"}, "parte_url": "<ParteUrlRetorno></ParteUrlRetorno> //(Opcional)"}}]}

                            


Descrição:

Este método busca todos os modelos configurados para cliente e retorna lista em JSON.

URL:

GET

Parâmetros de entrada:

Nenhum parâmetro é preciso, o sistema faz a autenticação pelo seu Token enviado pelo HEADER e retorna lista de modelos configurados para sua conta.

Retorno:

JSON:
 

                            {"status_api": 999, "mensagem": "descricao da resposta", "modelos": [{"dt_alteracao": "DD/MM/AAAA HH:MI:SS", "nome": "STRING", "id_externo": "ID_INTEIRO", "dt_criacao": "DD/MM/AAAA HH:MI:SS"}]}

                            


Descrição:

Este método busca os dados do modelo e retorna no formato JSON.

URL:

GET

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo int ID único do modelo na plataforma, utilizado para consultas.

Retorno:

JSON:
 

                            {"status_api": 999, "mensagem": "descricao da resposta", "modelos": [{"dt_alteracao": "DD/MM/AAAA HH:MI:SS", "nome": "STRING", "id_externo": "ID_INTEIRO", "dt_criacao": "DD/MM/AAAA HH:MI:SS"}]}

                            


Descrição:

Este método permite solicitar assinatura de modelo, juntamente com as partes envolvidas.

URL:

POST

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo int ID único do modelo na plataforma, utilizado para consultas.
lista_partes Array Lista das partes envolvidas na assinatura separados por vírgula, vide estrutura < ParteEnvio >.
lista_campos Array Lista com campos do modelo que devem ser preenchidos separados por vírgula, vide formato abaixo. Se modelo não tiver campos configurados para preenchimento, não é preciso enviar esse parâmetro.
identificacao_arquivo String Nome do arquivo, sem espaços ou caracteres especiais.
quadro_assinaturas String Indica se terá um quadro de assinatura no comprovante da Assine Bem.
id_centro_custo int ID único de centro de custo que deve ser vinculado ao documento.

Retorno:

JSON:
 

                            {"status_api": 999, "mensagem": "descricao da resposta", "documento": {"id_documento_status": "null", "descricao_documento_status": "null", "identificacao_arquivo": "null", "dt_criacao": "null", "id_externo": "null", "identificador_documento": "null", "hash_arquivo": "null", "quadro_assinaturas": "null", "quantidade_paginas": "null", "dt_limite_assinatura": "null", "lista_partes": "Array<ParteRetorno></ParteRetorno>"}}

                            


Descrição:

Este método busca os anexos configurados para os assinantes do documento.

É possível buscar os anexos configurados para o documento ou somente de uma parte no documento ao passar o parâmetro não obrigatório "id_externo_parte".

URL:

GET

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo String ID único do documento na plataforma, utilizado para consultas.
id_externo_parte String ID único da parte na plataforma, utilizado para consultas.

Retorno:

JSON:
 

                            {"status_api": 999, "mensagem": "descricao da resposta", "documento": {"id_externo": "None", "identificador_documento": "None", "identificacao_arquivo": "None"}, "anexos": "<AnexoRetorno>"}

                            


Descrição:

Este método retorna o binário do arquivo anexo.

Binário do arquivo com RESPONSE type: "application/png | jpg | jpeg | pdf".

URL:

GET

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo String ID único do documento na plataforma, utilizado para consultas.
id_download Int ID único do para fazer download do anexo, retornado ao consultar os anexos no documento vide (< AnexoRetorno >)

Retorno:

JSON:
 

                            {"arquivo": "hash do arquivo", "file_length": "tamanho do arquivo", "file_name": "nome do arquivo", "file_type": "tipo do arquivo", "identificacao_arquivo": "identifica\u00e7\u00e3o do arquivo", "mensagem": "descri\u00e7\u00e3o da resposta"}

                            


Descrição:

Este método aprova o anexo enviado pelo assinante que muda o status de pendente para aprovado.

Com isso, o anexo fica disponível para download e é anexado a versão final do arquivo assinado.

URL:

POST

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo String ID único do documento na plataforma, utilizado para consultas.
id_externo_parte String ID único da parte na plataforma, utilizado para consultas.
id_download Int ID único do anexo, retornado ao consultar os anexos no documento vide (< AnexoRetorno >)

Retorno:

JSON:
 

                            {"status_api": 200, "mensagem": "descricao da resposta"}

                            


Descrição:

Este método invalida o anexo enviado pelo assinante que muda o status de pendente para inválido.

Com isso, se o parâmetro "reenviar" for passado, a plataforma enviará uma notificação para assinante refazer o envio do anexo invalidado.

Se anexo reenviado para o assinante, o parâmetro de retorno "reenviado" é igual a 1 senão é 0.

URL:

POST

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo String ID único do documento na plataforma, utilizado para consultas.
id_externo_parte String ID único da parte na plataforma, utilizado para consultas.
id_download Int ID único do anexo, retornado ao consultar os anexos no documento vide (< AnexoRetorno >)
reenviar Int Inteiro para definir se o assinante deverá ou não reenviar o anexo invalidado. Valores: 1 (para reenviar) ou 2 (para não reenviar).

Retorno:

JSON:
 

                            {"status_api": 200, "mensagem": "descricao da resposta", "reenviado": "INTEIRO"}

                            


Descrição:

Busca centros de custo configurados da empresa.

URL:

GET

Parâmetros de entrada:

Nenhum parâmetro é preciso, o sistema faz a autenticação pelo seu Token enviado pelo HEADER.

Retorno:

JSON:
 

                            {"status_api": 200, "mensagem": "descricao da resposta", "centros_custo": [{"id_centro_custo": "INTEIRO", "descricao": "STRING"}]}

                            


Descrição:

Busca URL do assinante para assinatura ou validação dependendo do Assinante X Documento.

** Podem ser retornadas duas URLs, uma para assinatura ou para validação.

** Para assinatura, é retornada somente se o assinante tiver com assinatura pendente do documento passado como parâmetro ou algum outro. Ou se o status do assinante for "válido".

** Para validação, é retornada se não tiver documento pendente ou estiver com status diferente de "válido".

URL:

GET

Parâmetros de entrada:

Parâmetro Obrigatório Tipo Descrição
id_externo String ID único do documento na plataforma, utilizado para consultas.
id_externo_parte String ID único da parte na plataforma, utilizado para consultas.

Retorno:

JSON:
 

                            {"status_api": 200, "mensagem": "descricao da resposta", "url": "STRING (URL ABSOLUTA)", "assinatura": "INTEIRO", "validacao": "INTEIRO", "token": "STRING (UUID)", "dt_expiracao_token": "STRING (dd/mm/yyyy hh:mi:ss)", "id_externo_documento": "ID \u00fanico", "id_externo_parte": "ID \u00fanico"}