In dit artikel leiden wij u stap voor stap door het versturen van een document ter ondertekening met de Sign.Plus eSignature API.
Met deze stappen maakt u een envelop aan, voegt u een document toe, stelt u een ontvanger in, plaatst u een handtekeningannotatie en verstuurt u ten slotte de envelop ter ondertekening.
Vereisten
- Een Sign.Plus-account met een API-abonnement
- Uw
Personal Access Token
Stap 1: Een envelop aanmaken
Een envelop is een container voor documenten die door ontvangers moeten worden ondertekend.
- Stuur een verzoek naar het endpoint POST /v2/envelope om een nieuwe envelop aan te maken.
{
"name": "My wonderful envelope",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
} - Neem uw API-sleutel op in de header
Authorization. -
Bij succes ontvangt u een
Envelope-object.{ "id": "<string>" ... } -
Sla de
idop als deenvelope_id
Stap 2: Een document aan uw envelop toevoegen
-
Gebruik het endpoint POST /v2/envelope/{envelope_id}/document om een document toe te voegen.
-
Vervang
{envelope_id}door de ID die u in stap 1 hebt ontvangen. - Verstuur een POST-verzoek met het documentbestand in de verzoekbody als
multipart/form-data. -
Bij succes ontvangt u een
Document-object als antwoord.{ "id": "<string>" ... } -
Sla de
idop alsdocument_idvoor later gebruik.
Stap 3: Een ontvanger instellen voor uw envelop
-
Gebruik het POST /v2/envelope/{envelope_id}/signing_steps-endpoint om een ontvanger toe te voegen.
-
Vervang
{envelope_id}door uw envelop-ID. -
Verstuur een
POST-verzoek met de volgende JSON-body:{
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john.doe@example.com", "role": "SIGNER"
} ] } ] } -
Bij succes ontvangt u een array van
SigninStep. -
Doorloop de array en neem de
id-naam over van de ontvanger voor wie u het handtekeningkader (handtekeningannotatie) wilt toevoegen. Sla dezeidop alsrecipient_id.
Stap 4: Een handtekeningannotatie aan uw document toevoegen
Zorg ervoor dat u, voordat u een handtekeningannotatie toevoegt, uw handtekening hebt gedefinieerd op het Sign.Plus-platform.
- Gebruik het POST /v2/envelope/{envelope_id}/annotation-endpoint om een handtekeningannotatie toe te voegen.
- Vervang
{envelope_id}door uw envelop-ID. - Stuur een
POST-verzoek met de volgende JSON-body:{
"recipient_id": "<recipient_id>",
"document_id": "<document_id>",
"page": 1,
"x": 50,
"y": 20,
"width": 20,
"height": 60,
"required": true,
"type": "SIGNATURE",
}Vervang
<recipient_id>en<document_id>door de juiste waarden.
Stap 5: Uw envelop ter ondertekening verzenden
- Gebruik het POST /v2/envelope/{envelope_id}/send-endpoint om de envelop te verzenden.
- Vervang
{envelope_id}door uw envelop-ID. - Stuur een
POST-verzoek naar dit endpoint. - Bij succes wordt de envelop ter ondertekening naar de ontvanger verzonden.
Conclusie
U hebt nu met succes een document ter ondertekening verzonden via de Sign.Plus eSignature API. De ontvanger ontvangt een e-mailmelding met een link om het document te ondertekenen.
Voor meer gedetailleerde informatie over elk API-endpoint dat in dit proces wordt gebruikt, verwijzen wij u naar onze API-documentatie.