Hoe verstuurt u een document ter ondertekening?

Wie kan deze functie gebruiken?

Beschikbaar voor alle Ontwikkelaars-API abonnementen.

Alle leden

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

Stap 1: Een envelop aanmaken

Een envelop is een container voor documenten die door ontvangers moeten worden ondertekend.

  1. 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
    }
  2. Neem uw API-sleutel op in de header Authorization .
  3. Bij succes ontvangt u een Envelope-object.

    { "id": "<string>" ... }
  4. Sla de id op als de envelope_id

Stap 2: Een document aan uw envelop toevoegen

  1. Gebruik het endpoint POST /v2/envelope/{envelope_id}/document om een document toe te voegen.

  2. Vervang {envelope_id} door de ID die u in stap 1 hebt ontvangen.

  3. Verstuur een POST-verzoek met het documentbestand in de verzoekbody als multipart/form-data.
  4. Bij succes ontvangt u een Document-object als antwoord.
    { "id": "<string>" ... }

  5. Sla de id op als document_id voor later gebruik.

Stap 3: Een ontvanger instellen voor uw envelop

  1. Gebruik het POST /v2/envelope/{envelope_id}/signing_steps-endpoint om een ontvanger toe te voegen.

  2. Vervang {envelope_id} door uw envelop-ID.

  3. Verstuur een POST-verzoek met de volgende JSON-body:

    {
    "signing_steps": [
    {
    "recipients": [
    {
    "name": "John Doe", "email": "john.doe@example.com", "role": "SIGNER"
    } ] } ] }
  4. Bij succes ontvangt u een array van SigninStep.

  5. Doorloop de array en neem de id-naam over van de ontvanger voor wie u het handtekeningkader (handtekeningannotatie) wilt toevoegen. Sla deze id op als recipient_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.

  1. Gebruik het POST /v2/envelope/{envelope_id}/annotation-endpoint om een handtekeningannotatie toe te voegen.
  2. Vervang {envelope_id} door uw envelop-ID. 
  3. 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

  1. Gebruik het POST /v2/envelope/{envelope_id}/send-endpoint om de envelop te verzenden.
  2. Vervang {envelope_id} door uw envelop-ID.
  3. Stuur een POST-verzoek naar dit endpoint.
  4. 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.

Was dit artikel nuttig?
Aantal gebruikers dat dit nuttig vond: 0 van 0
More Articles in this section