eSign.AIeSign.AI
Central do desenvolvedor

Adicionar arquivo de assinatura

POST /esignglobal/v1/envelope/files/addSignFiles

Descrição da interface

Enquanto o envelope estiver fechado, é possível adicionar arquivos a serem assinados ao envelope. Envelopes já abertos não suportam a adição de arquivos para assinatura.

Parâmetros de solicitação

Nome do parâmetro

Tipo

Obrigatório

Descrição

envelopeId

string

true

ID do envelope

signFiles

array

true

Conjunto de informações dos arquivos a serem assinados; a ordem de exibição corresponde à ordem em que os arquivos foram adicionados.

 

fileKey

string

true

fileKey do arquivo a ser assinado; apenas o formato PDF é suportado

 documentFieldsarrayfalseLista de controles na dimensão do arquivo. Utilizada para adicionar controles na dimensão do arquivo que não estão vinculados a signatários em um arquivo específico.
  

fieldType

string

false

Tipo de controle. Use eMeterai para indicar o controle de imposto de carimbos da Indonésia.

  

pageNo

string

false

Número da página onde o controle está localizado. O controle de imposto de carimbos da Indonésia suporta apenas uma única página específica; deve ser informado um único número de página, não sendo suportados formatos de múltiplas páginas contínuas ou não contínuas como 1-3 ou 1,3.

  posXfloatfalseDeslocamento no eixo x, com a origem das coordenadas no canto inferior esquerdo da página. A faixa de coordenadas é consistente com a faixa de coordenadas de outros controles.
  posYfloatfalseDeslocamento no eixo y, com a origem das coordenadas no canto inferior esquerdo da página. A faixa de coordenadas é consistente com a faixa de coordenadas de outros controles.

Exemplo de solicitação

{   
  "envelopeId": "9fbe6c8190824227bde29136b0145c81",
  "signFiles": [
  {
    "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
  }
]
}

Parâmetros de resposta

Nome do parâmetro

Tipo

Descrição

code

int

Código de negócio: 0 indica sucesso; valores diferentes de 0 indicam erro.

message

string

Informação de negócio

[Atenção] Avalie o status de erro com base no código, não na mensagem, pois a mensagem pode ser alterada.

data

object

Dados de negócio

Exemplo de resposta

{
    "code": "0",
    "message": "success",
    "data": null
}