Criar documento via Modelo

Criar documento via Modelo

POST https://api.zapsign.com.br/api/v1/models/create-doc/

Esse endpoint permite que você crie um documento a partir de um Modelo dinâmico (isto é, um .docx com variáveis que você sobe na ZapSign, que terá suas variáveis automaticamente substituídas e convertido para .pdf). Você deverá enviar os dados em JSON, bem como receberá eles nesse mesmo formato.

Headers

Request Body

{
    "open_id": 5,
    "token": "eb9c367a-e62f-4992-8360-b0219deaeecc",
    "status": "pending",
    "name": "Contrato de Admissão",
    "original_file": "https://zapsign.s3.amazonaws.com/pdf/62xxxxx-d8fc-4392-8575-f3c46c3cfc7a/df6bac91-2766-4182-8c8b-ded5287e4c0f.pdf",
    "signed_file": null,
    "created_at": "2020-04-16T03:33:46.241747Z",
    "last_update_at": "2020-04-16T03:33:46.241775Z",
    "signers": [
        {
            "token": "921c115d-4a6e-445d-bdca-03fadedbbc0b",
            "sign_url": "https://app.zapsign.com.br/verificar/921c115d-4a6e-445d-bdca-03fadedbbc0b",
            "status": "new",
            "name": "João da Silva",
            "email": "",
            "phone_country": "",
            "phone_number": "",
            "times_viewed": 0,
            "last_view_at": null,
            "signed_at": null
        }
    ],
    "answers": [ // lista de variaveis e respostas no modelo dinamico (caso o documento tenha sido criado através de um modelo dinamico)
        {
            "variable": "NOME COMPLETO",
            "value": "Nome Teste"
        },
        {
            "variable": "NÚMERO DO CPF",
            "value": "99999999999"
        },
        {
            "variable": "ENDEREÇO COMPLETO",
            "value": "Endereço teste"
        }
    ]
}

Exemplo de requisição

O que fazer com a resposta

Após uma requisição bem sucedida, você deverá receber uma resposta como essa:

Atenção: os links retornados em original_file e signed_file são temporários e duram 60 minutos. Caso seu sistema necessite salvar estes links é recomendado que sejam baixados em uma CDN própria ou que o endpoint de Detalhar documento seja consultado sempre para garantir que seu usuário sempre receberá um link válido.

{
    "open_id": 5,
    "token": "eb9c367a-e62f-4992-8360-b0219deaeecc",
    "status": "pending",
    "name": "Contrato de Admissão",
    "original_file": "https://zapsign.s3.amazonaws.com/pdf/62xxxxx-d8fc-4392-8575-f3c46c3cfc7a/df6bac91-2766-4182-8c8b-ded5287e4c0f.pdf",
    "signed_file": null,
    "created_at": "2020-04-16T03:33:46.241747Z",
    "last_update_at": "2020-04-16T03:33:46.241775Z",
    "signers": [
        {
            "token": "921c115d-4a6e-445d-bdca-03fadedbbc0b",
            "sign_url": "https://app.zapsign.com.br/verificar/921c115d-4a6e-445d-bdca-03fadedbbc0b",
            "status": "new",
            "name": "João da Silva",
            "email": "",
            "phone_country": "",
            "phone_number": "",
            "times_viewed": 0,
            "last_view_at": null,
            "signed_at": null,
            "resend_attempts": null
        }
    ],
    "answers": [ // lista de variaveis e respostas no modelo dinamico (caso o documento tenha sido criado através de um modelo dinamico)
        {
            "variable": "NOME COMPLETO",
            "value": "Nome Teste"
        },
        {
            "variable": "NÚMERO DO CPF",
            "value": "99999999999"
        },
        {
            "variable": "ENDEREÇO COMPLETO",
            "value": "Endereço teste"
        }
    ]
}

O que você deverá fazer com essa resposta é enviar o link de assinatura para o signatário através da sua aplicação.

O link de assinatura consiste na rota: https://app.zapsign.com.br/verificar/{signer_token}

Ou seja, no exemplo acima, você deve enviar o seguinte link de assinatura ao signatário: - https://app.zapsign.com.br/verificar/921c115d-4a6e-445d-bdca-03fadedbbc0b E agora é só aguardar que o signatário assine!

Mais de um signatário

Mais de um signatário? Se você quiser adicionar mais signatários, utilize os endpoints "Atualizar signatário" e "Adicionar signatário", receba o token do novo signatário e envie o link de assinatura como explicado acima.

Como criar um Modelo dinâmico na ZapSign

Acesse nossa central de ajuda e veja o passo a passo completo:

Last updated