Sign in

v1

latestOpenAPI 3.0.02026-07-2667172347.6 KB
Qualified Electronic Signature

Start a signature process

Use this endpoint to trigger processing of a Qualified Electronic Signature case <br /><br /><img src="https://files.readme.io/310d4d3-Inline_Caution.svg" align="left" alt="Important" /> Important: <code>signatureId</code> and <code>workflowId</code> are string identifiers that can be used interchangeably.

post/v1/signatures/{signatureId}

Path parameters

signatureIdstring required

Our unique identifier for the signature. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0 <br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/>Tip: This is the same value as the workflowId returned in the Create workflow response.

Query parameters

lang'de' | 'en' | 'es' | 'fr' | 'it' | 'pl' | 'pt' | 'ro'

The client's device or browser language. This value also determines the language of legal documents, such as terms and conditions and the privacy statement.<br /><br />Format: ISO 639-1 alpha-2 <br /> If omitted or unsupported, defaults to en. <br /> Supported values when Namirial is the QTSP: <br />• de: German <br />• en: English (default) <br />• es: Spanish <br />• fr: French <br />• it: Italian <br />• pl: Polish <br />• pt: Portuguese <br /> • ro: Romanian

Headers

Authorizationstring required

The access_token returned in your most recent Create access token response.

Request body

mobilePhoneNumberstring

The client’s mobile phone number, which you have ensured is valid. <br /><br />Format: +{prefixNumber} {phoneNumber} <br /><img src="https://files.readme.io/ad2486a-Inline_Note.svg" align="left"/> Notes: <br />• Always include a space between the prefix and phone number. <br />• The prefix can contain a maximum of 4 digits. <br /><br />Example: +31 612345678

Response

Signature process started

object required

A successful response is empty.