Webhooks

Qualified Electronic Signature Webhooks

Webhook notifications for <a href="https://docs.fourthline.com/docs/qes-overview">Qualified Electronic Signature</a>. For setup and authentication, see <a href="https://docs.fourthline.com/docs/webhooks">Webhooks</a>.

post/qes/{signatureId}

Request

  • Base URL
    https://mysite.com/api/fourthline
  • URL
    https://mysite.com/api/fourthline/qes/{signatureId}
  • 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

Headers

Authorizationstring required

Your Basic or Bearer access token. <br />The examples we’ve provided show Bearer. <br /><br /><img src="https://files.readme.io/ad2486a-Inline_Note.svg" align="left"/>More information: Webhooks – Specify authentication method

Request body

signatureIdstring required

Our unique identifier for the signature. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0 <br />Validations: uuid format, signatureId exists <br />Errors: Format is incorrect or doesn’t exist

status'new' | 'pending' | 'selfie_required' | 'kyc_required' | 'user_consent_required' | 'confirmation_required' | 'pending_verification' | 'invalid_signature' | 'signed' | 'error' required

The signature status. <br />Validation: Valid enum value <br />Errors: Invalid enum value.

statusCodeinteger

The status code. <br />Validation: Integer between 0 and 6010 <br />Errors: Value must be an integer between 0 and 6010

Response

Return HTTP 2xx to acknowledge receipt. See Handle webhook deliveries.

object required

A successful response is empty.

Changes

No recorded changes to this operation across all 1 revision of this API.