v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
Electronic Signature check

Review an Electronic Signature check

Approve or reject an Electronic Signature check. The Reviewer type will be set to api.

patch/v1/checks/electronic_signature/{id}/review

Path parameters

idstring uuid required

Id of the Electronic Signature check

Request body

action'approve' | 'reject' required
commentstring nullable

Optional comment for the review.

overrideboolean

Set to true to change the status of an already reviewed check (in status approved or rejected).

Response

Electronic Signature check has been reviewed

ℹ️ Click to see full payload

idstring uuid required
individual_idstring uuid required
is_internalboolean required
status'in_progress' | 'need_review' | 'processing' | 'approved' | 'rejected' | 'expired' required

ℹ️ Check status expired is deprecated and will be removed Q1'25. It will be replaced with an expired flag.

type'electronic_signature' required
subtypestring required

Contains "document_template:{settings.document_template_key}"

last_activity_atstring date-time required

Latest activity date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)