LOloket
Sign document

Initiate signature - Conceptemployee

Activity name : <a href="https://developer.loket.nl/Activities/PostInitiateSignatureByConceptEmployeeIdAndDocumentId" target="_blank">PostInitiateSignatureByConceptEmployeeIdAndDocumentId</a>

Metadata: No metadata available. Defaults are available by adding /defaults to the path.

Initiate the proces to sign a document for an employment by one or more signers.

post/v2/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/signature/initiate

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/conceptemployees/{conceptEmployeeId}/documents/{documentId}/signature/initiate
  • Auth
    none required

Path parameters

conceptEmployeeIdstring uuid required

The unique identifier of the concept employee

documentIdstring required

The unique identifier of the template

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Request body

emailAddressstring

The email address of the signer.

namestring

The name of the signer

mobilePhoneNumberstring

The mobile phone number of the signer. In E.164 format

signingOrderinteger nullable

When filled, this integer is used to set the order in which the signers have to sign the document. An email will be sent to all signers with the first SigningOrder number. When signed an email will be sent to all signers with the second SingingOrder. Etcetera.

Example request

[
  {
    "emailAddress": "test@test.com",
    "name": "Ben Hur",
    "mobilePhoneNumber": "+31612345678"
  }
]

Response

Initiated

Example response

{
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "signDocumentStatus": {
      "Key": "Ne",
      "Value": "Nieuw onderteken-verzoek"
    }
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.