Transactions

Cancel Transaction

Changed on
post/v1/transactions/{id}/cancel

Request

Path parameters

idstring required

ID of the transaction

Query parameters

document_url_version'v1' | 'v2'

Control documents and signer photo identifications download URLs. v1 for AWS S3 pre-signed URLs. v2 for Proof secure URLs.

Response

successful

idstring
activation_timestring nullable

An ISO-8601 formatted DateTime String.

allowed_notary_statesstring[] nullable

The 2-letter US state abbreviations the transaction restricts notary routing to; absent when unrestricted.

audit_trail_urlstring nullable
cc_recipient_emailsCcRecipientEmail[]
charge_statement_urlstring nullable
config_idstring nullable
cost_center_idstring nullable

The cost center attributed to this transaction, if any.

costnumber float

Cost of the transaction.

date_createdstring date-time

Date Transaction was created/uploaded.

date_updatedstring date-time

Date Transaction was updated.

default_text_tag_syntaxstring nullable
detailed_status'draft' | 'recalled' | 'order_placed' | 'sent_to_title_agent' | 'sent_to_signer' | 'active' | 'viewed' | 'started' | 'partially_complete' | 'attempted' | 'awaiting_payment' | 'open_order' | 'review_now' | 'sign_now' | 'payment_required' | 'meeting_in_progress' | 'complete' | 'complete_with_rejections' | 'expired' | 'esign_complete' | 'wet_sign_complete' | 'on_hold' | 'converted_to_wet_sign' | 'identify_complete_idv_passed' | 'identify_complete_idv_failed' | 'ready_for_review' | 'add_document' | 'processing' | 'held_for_review' | 'declined' | 'screened' | 'canceled'
expirystring nullable
external_idstring nullable
idv_use_case'STANDARD' | 'ACCOUNT_RECOVERY' nullable
message_signaturestring nullable
message_subjectstring nullable
message_to_signerstring nullable
notary_idstring nullable
notary_meeting_timestring date-time nullable
organization_idstring
payer'signer' | 'sender'
recall_reasonstring nullable

Reason for recalling the transaction.

referral_campaign_idstring nullable

The ID of the referral campaign that the transaction is associated with.

referral_codestring nullable

The referral code that the transaction is associated with.

require_secondary_photo_idboolean
sender_logostring nullable
sender_namestring

Name of the sending organization.

statusstring
transaction_namestring
transaction_typestring nullable

Changes