Qualified Electronic Signature

Approve documents to sign

When the signature status changes to user_consent_required and after making the Get signature details request, use this endpoint to confirm that the client has approved the documents to sign and accepted the QTSP legal conditions. <br /><br /><img src="https://files.readme.io/310d4d3-Inline_Caution.svg" align="left" alt="Important" /> Important: <br />• Before using this endpoint, see the <a href="https://docs.fourthline.com/docs/qes-integration">integration guide</a>. <br />• <code>signatureId</code> and <code>workflowId</code> are string identifiers that can be used interchangeably.<br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/> Tip: When testing this endpoint, you must use a real ID document with an <Glossary>MRZ</Glossary> or <Glossary>VIZ</Glossary>.

post/v1/signatures/{signatureId}/authorize

Request

  • Base URL
    https://api.ext-sandbox.fourthline.com
  • URL
    https://api.ext-sandbox.fourthline.com/v1/signatures/{signatureId}/authorize
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://example.com/token

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'cs' | 'de' | 'en' | 'es' | 'fi' | 'fr' | 'it' | 'nl' | 'pl' | 'sk'

The language of the SMS message containing the one-time passcode to confirm the signature. <br /><br />Format: ISO 639-1 alpha-2 <br />Enum: <br />• cs: Czech <br />• de: German <br />• en: English (default) <br />• es: Spanish <br />• fi: Finnish <br />• fr: French <br />• it: Italian <br />• nl: Dutch <br />• pl: Polish <br />• sk: Slovak

Headers

Authorizationstring required

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

Request body

Response

Document approval accepted

attemptIdstring

The unique identifier for this document approval attempt.

Changes

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