API Reference
System statusHome

Document Authentication Webhooks

post
https://mysite.com/api/fourthline/docauth/

Webhook notifications for Document Authentication. For setup and authentication, see Webhooks.

Path Params
string
required

Our unique identifier for the Document Authentication case.

Format: uuid string

Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

Body Params
string
required

Our unique identifier for the case.

Format: uuid string

Example: 790f325a-48c9-4b82-bb53-c0ea128236f0
Validations: uuid format, verificationId exists
Errors: Format is incorrect or doesn’t exist

string

The MD5 hash of the ZIP report, as a lowercase hexadecimal string. Sent when verification is completed and a report exists. Sent as an empty string when that notification has no report. Omitted on other notifications.

Format: MD5, lowercase hex
Errors: Invalid MD5 hash

string
enum
required

The case status.
Validation: Valid enum value
Errors: Invalid enum value.

Allowed:
string
required
Defaults to NaturalPersons

The type of workflow.
Expected value: Always ClientDocumentRenewal
Validation: Expected value
Errors: Must be set to ClientDocumentRenewal

sla
object

Information about the SLA for case processing. Properties with a null value are omitted.

messages
array of objects

Information about the case status.

messages
boolean
required

The marker for whether the notification was triggered by a post-completion QA data correction. This field is included in every webhook notification.

• true: A Fourthline QA analyst has corrected case data after the verification was completed.
• false: Standard notification. No post-completion QA correction has been applied.

This feature is only active if Fourthline has enabled QA corrections for your account. Contact your delivery manager for more information.
Validation: true or false value
Errors: Invalid boolean value.

string
required

The timestamp for this notification.

Format: ISO 8601 UTC date and time

Example: 2020-07-10 15:00:00.000
Validation: Valid datetime
Errors: Invalid datetime

Responses

Updated 6 months ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 months ago