Objetivo
Esse Endpoint tem como objetivo fornecer ao usuário a possibilidade de inserir/anexar mais de um documento no envelope, gerando ID’s de documentos para serem inseridos nos Endpoints.
URL
POST /rest/signer/IntegrationEnvelopeDocument
Parâmetros
Para realizar a requisição via API é necessário fazer a autenticação da chave de acesso do usuário, você pode encontrar o passo a passo para realizar essa etapa, clicando aqui
Name: Nesse campo o usuário deve preencher com o nome ou título do documento que deseja receber a “ID” no seguinte formato “TituloDocumento + Extensão” esse campo é do tipo “String” e obrigatório na requisição, segue exemplo:
- “testecopia.pdf”
File: Esse campo o usuário deverá preenche-lo com um “BASE64” do documento que deseja receber a “ID” , o usuário deve acessar um site que transforme o seu documento em “BASE64” esse campo é do tipo “String” e obrigatório na requisição.
Esse Endpoint retornará “ID” para utilizar no seguinte Endpoint “POST /rest/signer/IntegrationEnvelope” para mais informações, clique aqui para acessar a documentação do mesmo.
Retornos
O retorno do endpoint será de acordo com o resultado final da requisição, se for um erro devido a um parâmetro preenchido de forma incorreta, não seguindo as instruções acima, o retorno deverá informar qual o parâmetro que está invalido.
Quando a execução for feita com sucesso, o retorno será o código 200 indicando que a requisição foi executada corretamente, e no “response body” será retornado as informações e o “ID” do documento.
