--- title: "Create Transaction" method: POST path: "/mortgage/v2/transactions" tags: ["Transactions"] --- # Create Transaction `POST /mortgage/v2/transactions` ## Query parameters - `document_url_version` 'v1' | 'v2' ## Request body - TransactionCreateParams - `activation_time` string — An ISO-8601 formatted DateTime String, optionally including a timezone offset. If timezone offset is not provided, the Proof account’s default timezone settings will be applied. This param sets the time after which the signer is permitted to connect with a notary to complete the transaction. If a signer attempts to connect with a notary before this time is reached, the signer will be only permitted to review documents. - `file_number` string — Unique value used to map transactions to a title agency’s records and systems. Including this value helps streamline communications with the title company who is supporting the transaction. - `loan_number` string — Unique value used to map transactions to your own records and systems. Providing loan_number as part of a create transaction request ensures it is visible to all users to manage the transaction. - `paper_note_consent` boolean — Allows a lender to create a hybrid transaction and bypass the eNote requirement. - `signer` Signer - `signer_id` string — Signer ID - `email` string, required — Email is required unless you provide a recipient_group object. - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `phone_number` string — Signer phone number. A country code can be defined by using the `+` symbol. For example, `+11234567890` will set the country code to `+1` for the number `1234567890`. If no country code is specified the default will be the United States country code of `+1`. - `phone` object, nullable - `country_code` string — The country code for the phone number, e.g. 1 - `number` string — The phone number without the country code, e.g. 5551234567 - `address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `dob` string — The signer's date of birth. - `capacity` string, nullable — The signers capacity when signing on behalf of an entity, required when entity is present - `entity` string, nullable — Entity the signer is signing on behalf of, required when capacity is present - `external_id` string, nullable — A string representing an ID external to Proof's systems. Use this to associate a signer to an ID that your systems understand, such as a User ID. - `link_expired` boolean — Indicates if the signer's passwordless link has expired. - `personally_known_to_notary` boolean — If the signer is personally known to the notary. This can currently only be used on single signer transactions, or when the notary_id is specified on the signer. - `proof_requirement` ProofRequirement - `id_verification` ProofRequirementIdVerification - `selfie` boolean, required — Signer identity is verified through credential analysis and selfie comparison. SMS multi_factor_authentication is required with this for IAL2 compliant identity verification. - `knowledge_based_authentication` boolean, required — (KBA) Signer answers a series of personal identity questions. - `multi_factor_authentication` ProofRequirementMultiFactorAuthentication - `type` 'sms', required — Signer enters authentication code sent to their mobile phone. - `recipient_group` RecipientGroup - `shared_inbox_email` string — The email address that is shared by a group. Whomever has access to this email address can claim the transaction for themself. - `sdk_token` string, nullable — Equivalent to transaction_access_link; prefer using that instead. - `signatory_capacities` object[] — An array of signatory capacities for the signer when signing on behalf of multiple entities. - `capacity` string - `type` 'attorney_in_fact' | 'corporate_officer' | 'guardian_or_conservator' | 'general_partner' | 'limited_partner' | 'trustee' | 'other' - `representative_of` string - `primary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `secondary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `signing_requirement` 'esign' | 'identify' | 'verify', nullable — Override the document signing requirement for an individual signer. - `signing_status` 'incomplete' | 'in_progress' | 'complete', nullable - `transaction_access_link` string — A link to the transaction for this signer. - `vesting_type` 'borrower' | 'non_borrower' — Can be either `borrower` or `non_borrower`. Defaults to `borrower`. - `credential_assets` CredentialAssetObject[], nullable - `credential_type` 'primary' | 'secondary' | 'selfie' - `credential_images` CredentialImage[] - `url` string — URL of the image - `descriptor` 'back' | 'front' - `esign_authentication_records` PhotoValidationAttempt[], nullable - `validation_source` 'lexis-flex' | 'identity-verification-service' | 'lexis' | 'noop' | 'persona' | 'firebase' | 'null' | 'none' | 'notakred', nullable - `verified_at` string — An ISO-8601 formatted DateTime String. - `verification_method` string, nullable - `images` object - `front` string - `back` string, nullable - `selfie` string, nullable - `status` 'success' | 'failure' | 'unknown' | 'skipped' | 'pending' | 'action_required' | 'deleted', nullable - `document_address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `document_claimed_type` 'bank_account_statement' | 'bank_investment_loan_statement' | 'birth_certificate' | 'certificate_of_citizenship' | 'citizen_id' | 'credit_or_debit_card_statement' | 'deed_of_trust' | 'driver_license' | 'foreigner_id' | 'healthcare_insurance' | 'i_94' | 'id_card' | 'internal_passport' | 'keypass_id' | 'lease' | 'long_term_pass_card' | 'matricula_consular' | 'mortgage' | 'municipal_id' | 'my_number_card' | 'nbi' | 'nexus_card' | 'ofw' | 'organizational_membership_card' | 'pan' | 'passport' | 'passport_card' | 'paycheck_stub' | 'permanent_resident_card' | 'postal_id' | 'property_insurance' | 'property_tax_bill' | 'residency_permit' | 'school_id_card' | 'social_security_card' | 'sss' | 'travel_document' | 'tribal_id' | 'umid' | 'us_visa' | 'utility_bill' | 'vehicle_registration' | 'voter_registration_card' | 'work_permit' | 'other' | 'unknown' - `document_classification` string, nullable - `document_date_of_birth` string, nullable - `document_expiration_date` string, nullable - `document_first_name` string, nullable - `document_middle_name` string, nullable - `document_last_name` string, nullable - `document_issue_date` string, nullable - `document_issuer` string, nullable - `document_number` string, nullable - `verified` boolean - `failure_reasons` object[] - `check` string - `category` 'aamva_failure' | 'fraud' | 'image_quality' | 'ineligible_id' | 'kba_mismatch' | 'not_classified' | 'user_action_required' - `reasons` string[] - `required` boolean - `verification_type` 'id' | 'selfie' - `notary_id` string, nullable — User ID ("us_xxxxxxx") of the assigned Notary or "notarize". Eligible notaries must be a notary who is a member of your organization. Order must be utilized with this field, all notarization signers with the same order must have the same notary_id. - `order` integer, nullable — Order the signers will sign in. Should be positive numbers starting with 1. Setting to the same order as another signer indicates they will sign at the same time. - `suppress_communications` boolean, nullable - `verify_tool_configuration` VerifyToolConfiguration - `requirement` 'run' | 'pass' | 'none', required — Setting indicating whether or not the verify tool will be required to run or pass, or both - `signers` Signers[] — An array of signer objects each with at minimum the email field set (limit 10 signers per transaction). The request to notarize the document will be sent to that email address. - `signer_id` string — Signer ID - `email` string — Email is required unless you provide a recipient_group object. - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `phone_number` string — Signer phone number. A country code can be defined by using the `+` symbol. For example, `+11234567890` will set the country code to `+1` for the number `1234567890`. If no country code is specified the default will be the United States country code of `+1`. - `phone` object, nullable - `country_code` string — The country code for the phone number, e.g. 1 - `number` string — The phone number without the country code, e.g. 5551234567 - `address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `dob` string — The signer's date of birth. - `capacity` string, nullable — The signers capacity when signing on behalf of an entity, required when entity is present - `entity` string, nullable — Entity the signer is signing on behalf of, required when capacity is present - `external_id` string, nullable — A string representing an ID external to Proof's systems. Use this to associate a signer to an ID that your systems understand, such as a User ID. - `link_expired` boolean — Indicates if the signer's passwordless link has expired. - `personally_known_to_notary` boolean — If the signer is personally known to the notary. This can currently only be used on single signer transactions, or when the notary_id is specified on the signer. - `proof_requirement` ProofRequirement - `id_verification` ProofRequirementIdVerification - `selfie` boolean, required — Signer identity is verified through credential analysis and selfie comparison. SMS multi_factor_authentication is required with this for IAL2 compliant identity verification. - `knowledge_based_authentication` boolean, required — (KBA) Signer answers a series of personal identity questions. - `multi_factor_authentication` ProofRequirementMultiFactorAuthentication - `type` 'sms', required — Signer enters authentication code sent to their mobile phone. - `recipient_group` RecipientGroup - `shared_inbox_email` string — The email address that is shared by a group. Whomever has access to this email address can claim the transaction for themself. - `sdk_token` string, nullable — Equivalent to transaction_access_link; prefer using that instead. - `signatory_capacities` object[] — An array of signatory capacities for the signer when signing on behalf of multiple entities. - `capacity` string - `type` 'attorney_in_fact' | 'corporate_officer' | 'guardian_or_conservator' | 'general_partner' | 'limited_partner' | 'trustee' | 'other' - `representative_of` string - `primary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `secondary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `signing_requirement` 'esign' | 'identify' | 'verify', nullable — Override the document signing requirement for an individual signer. - `signing_status` 'incomplete' | 'in_progress' | 'complete', nullable - `transaction_access_link` string — A link to the transaction for this signer. - `vesting_type` 'borrower' | 'non_borrower' — Can be either `borrower` or `non_borrower`. Defaults to `borrower`. - `credential_assets` CredentialAssetObject[], nullable - `credential_type` 'primary' | 'secondary' | 'selfie' - `credential_images` CredentialImage[] - `url` string — URL of the image - `descriptor` 'back' | 'front' - `esign_authentication_records` PhotoValidationAttempt[], nullable - `validation_source` 'lexis-flex' | 'identity-verification-service' | 'lexis' | 'noop' | 'persona' | 'firebase' | 'null' | 'none' | 'notakred', nullable - `verified_at` string — An ISO-8601 formatted DateTime String. - `verification_method` string, nullable - `images` object - `front` string - `back` string, nullable - `selfie` string, nullable - `status` 'success' | 'failure' | 'unknown' | 'skipped' | 'pending' | 'action_required' | 'deleted', nullable - `document_address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `document_claimed_type` 'bank_account_statement' | 'bank_investment_loan_statement' | 'birth_certificate' | 'certificate_of_citizenship' | 'citizen_id' | 'credit_or_debit_card_statement' | 'deed_of_trust' | 'driver_license' | 'foreigner_id' | 'healthcare_insurance' | 'i_94' | 'id_card' | 'internal_passport' | 'keypass_id' | 'lease' | 'long_term_pass_card' | 'matricula_consular' | 'mortgage' | 'municipal_id' | 'my_number_card' | 'nbi' | 'nexus_card' | 'ofw' | 'organizational_membership_card' | 'pan' | 'passport' | 'passport_card' | 'paycheck_stub' | 'permanent_resident_card' | 'postal_id' | 'property_insurance' | 'property_tax_bill' | 'residency_permit' | 'school_id_card' | 'social_security_card' | 'sss' | 'travel_document' | 'tribal_id' | 'umid' | 'us_visa' | 'utility_bill' | 'vehicle_registration' | 'voter_registration_card' | 'work_permit' | 'other' | 'unknown' - `document_classification` string, nullable - `document_date_of_birth` string, nullable - `document_expiration_date` string, nullable - `document_first_name` string, nullable - `document_middle_name` string, nullable - `document_last_name` string, nullable - `document_issue_date` string, nullable - `document_issuer` string, nullable - `document_number` string, nullable - `verified` boolean - `failure_reasons` object[] - `check` string - `category` 'aamva_failure' | 'fraud' | 'image_quality' | 'ineligible_id' | 'kba_mismatch' | 'not_classified' | 'user_action_required' - `reasons` string[] - `required` boolean - `verification_type` 'id' | 'selfie' - `order` integer, nullable — Order the signers will sign in. Should be positive numbers starting with 1. Setting to the same order as another signer indicates they will sign at the same time. - `notary_id` string, nullable — User ID ("us_xxxxxxx") of the assigned Notary or "notarize". Eligible notaries must be a notary who is a member of your organization. Order must be utilized with this field, all notarization signers with the same order must have the same notary_id. - `suppress_communications` boolean, nullable - `verify_tool_configuration` VerifyToolConfiguration - `requirement` 'run' | 'pass' | 'none', required — Setting indicating whether or not the verify tool will be required to run or pass, or both - `cosigner` Cosigner - `first_name` string — First name - `last_name` string — Last name - `signing_requirement` 'esign' | 'identify' | 'verify', nullable — Override the document signing requirement for an individual signer. - `recording_jurisdiction_id` string — RECOMMENDED: The id of the recording jurisdiction the property address is within. If this is not provided we will attempt to find the jurisdiction based on the provided street_address. - `title_agency_id` string — Required for Lenders. The id of the title agency participating on the transaction. Returned in the /verify_address call. If title_agency_id is empty, contact with role of title_agent is required. - `draft` boolean — When set to true, the transaction will be created in a Draft state. This attribute is typically used when managing multi-document transactions. When the transaction is in draft state, transaction attributes can be modified and additional documents can be added to the bundle, using the documents API. To activate the transaction, the notarization_ready API endpoint must be called. - `expiration_time` string — An ISO-8601 formatted DateTime String, optionally including the timezone offset. If timezone offset is not provided, the account’s default timezone settings will be applied. This param sets time after which the signer is NOT permitted to connect with a notary to complete the transaction. If a signer attempts to complete the transaction after this time is reached, they will receive an error. Expiration time is optional, and no default is set if this parameter is left blank. Any transaction that expires is no longer editable, and a new transaction must be created. - `external_id` string — A string representing an ID external to Proof's systems. Use this to associate a transaction to an ID that your systems understand, such as an Order ID or system GUID. - `transaction_name` string — Short, human-readable name for the transaction - eg. Miguel's TPS notarization for Leeroy. Defaults to Untitled Transaction. - `title_underwriter_id` string — The id of the title underwriter participating on the transaction. Returned in the /verify_address call. - `transaction_type` 'refinance' | 'trailing_docs' | 'purchase_seller' | 'purchase_buyer_cash' | 'purchase_buyer_loan' | 'heloc' | 'loan_mod_borrower' | 'other' | 'hybrid_refinance' | 'hybrid_trailing_docs' | 'hybrid_purchase_seller' | 'hybrid_purchase_buyer_cash' | 'hybrid_purchase_buyer_loan' | 'hybrid_other' | 'wet_sign' | 'real_estate_esign' | 'real_estate_proof' — Accepted values: refinance, trailing_docs, purchase_seller, purchase_buyer_cash, purchase_buyer_loan, heloc, loan_mod_borrower, other, hybrid_refinance, hybrid_trailing_docs, hybrid_purchase_seller, hybrid_purchase_buyer_cash, hybrid_purchase_buyer_loan, hybrid_other, wet_sign, real_estate_esign, real_estate_proof. The refinance and purchase_buyer_loan transaction types require an eNote. Hybrid transactions are notarized off of the Notarize Network platform. Wet sign transactions do not require a `signers` parameter and can only have a document requirement of `esign_supervised`. - `message_to_signer` string — Message to signer using GitHub Flavored Markdown. Html, images, links, and code are stripped out. Can be used to provide instructions, thank customers, add additional context to the transaction, or simply to add a personal touch. The message will be added to the email sent to the signer. (30,000 character limit) - `message_subject` string — Subject line of email to signer. - `message_signature` string — Signature in email to signer. - `pdf_bookmarked` boolean — Split the document by bookmarks if it is a pdf - `require_secondary_id` boolean — Certain businesses and transaction types may need signers to provide two forms of photo identification. This feature enables you to require two forms on a transaction. If true, the signer cannot proceed to the notary meeting without first providing two forms of photo ID during the Proof identity verification process. If false (default), the signer can proceed to notary meeting after providing one form of photo ID. - `suppress_email` boolean — If sent as true during activation, Proof will not send a notification email to the signer when the transaction is activated. If you use this feature, you are responsible for providing the signer with the `transaction_access_link`. This value is not stored on the transaction and must be provided anytime the transaction is activated. - `notary_instructions` NotaryInstructions[] - `notary_note` string — 500 character limit. - `notary_id` string — User ID ("us_xxxxxxx") of the assigned Notary. Eligible notaries must be either a connected BYOT notary, or a BYON notary who is a member of your organization. Notary assignment is not a strict requirement. When this parameter is specified, the notary will be sent an SMS that the signer is about to enter the waiting room, but the notary can take any signer in the queue, and any available notary can take the signer. - `redirect` Redirect - `url` string — Valid url to redirect the user to once the meeting is complete - `message` string — The message to show the user when the redirect is shown - `street_address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `contacts` Contact[] - `first_name` string — First name of contact - `last_name` string — Last name of contact - `email` string — Email - `role` 'closer' | 'escrow_officer' | 'loan_officer' | 'loan_processor' | 'mortgage_broker' | 'other' | 'real_estate_agent' | 'title_agent' | 'attorney' — Accepted values: escrow_officer, loan_officer, real_estate_agent, title_agent, closer, other - `title` string, nullable — Only valid if role is set to "other". - `phone_number` string, nullable — 10 characters exactly. Dashes and other special characters are not allowed. Please use format "8885551111" - `shown_to_signer` boolean — If false, allows you to set a Proof-only contact. - `access_to_transaction` boolean — Gives the signer contact access to a transaction. - `organization_name` string, nullable — Use with contact role title_agent to invite a new Title Agent to collaborate on a Proof transaction. If provided for other roles, values will be disregarded. - `organization_address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `date_created` string — An ISO-8601 formatted DateTime String. - `date_updated` string — An ISO-8601 formatted DateTime String. - `notary_meeting_time` string, date-time — An ISO-8061 formatted DateTime String, optionally including the timezone offset. Meeting time will be shown to signer in default emails. Proof will not prevent the signer or notary from starting the meeting at any other time. - `organization_id` string — The organization id of a child account. If the authenticated account has child accounts, specifying this parameter will create the transaction in the provided child org. - `document_url_version` boolean — Optional param to test v2 document urls. - `documents` DocumentParams[] — Documents to be signed or notarized. Accepted as an array of document objects or simple document["resource"] field values. - `name` string — Plain language name given to the document. If this parameter is not provided, Proof will automatically assign a name using the end of the page path of the resource URL. - `document_url_version` boolean — Optional param to test v2 document urls. - `document` string - `requirement` string — Completion requirement for the document. Accepted values can be `notarization`, `esign`, `identity_confirmation` **([identity confirmation feature](https://dev.proof.com/docs/enterprise-features))**, `readonly`, and `non_essential`. Completion requirement for the document. If the value is set to `non_essential`, the document will be hidden from signers before the notary meeting and values for `customer_can_annotate` and `witness_required` will be ignored and set to false. `identity_confirmation` is used to support signing of PS Form 1583 for signers without a US SSN. Note: if `identity_confirmation` is set as the document requirement, ensure that all documents requiring notarization in the transaction also use `identity confirmation` as the requirement to avoid requiring KBA on the transaction. [Read more](https://dev.proof.com/docs/document-requirements) about document requirements. - `notarization_required` boolean - `witness_required` boolean — Boolean flag indicating whether an additional witness must be present for this document's signing. A witness is a third person, in addition to the signer and the notary, who must be physically located with the signer. - `esign_required` boolean - `identity_confirmation_required` boolean - `signing_requires_meeting` boolean - `customer_can_annotate` boolean — Boolean flag indicating whether a signer can add their own annotations onto the document. Defaults to false, limiting the signer to only filling out designated fields setup on the document or as directed by a notary. - `pdf_bookmarked` boolean — Boolean flag indicating whether the document is a bookmarked PDF. If passed true, the document will be split by bookmark into multiple documents. - `tracking_id` string — External tracking identifier such as a UUID string that can be useful for mapping documents back to your own system. - `text_tag_syntax` string — Syntax used by text tags within the document. - `signing_designations` SigningDesignation[] — This array contains a prescribed list of designations for signers and/or a notary to annotate the document. - `id` string - `signer_identifier` string — For signers, the external_id value set on the signers array when creating a transaction; for witnesses, `witness{n}` i.e. `witness1` or `witness2`; for notaries, `notary` - `page_number` integer — The page of the designation, starting at 0 - `x` integer — The X coordinate (from bottom left) - `y` integer — The Y coordinate (from bottom left) - `height` integer — Height - `width` integer — Width - `hint` string — Hint - `type` 'date_signed' | 'day_signed' | 'month_signed' | 'year_signed' | 'first_name' | 'middle_name' | 'last_name' | 'full_name' | 'signature' | 'initials' | 'checkmark' | 'radio_checkmark' | 'free_text' | 'signature_and_date' | 'dob' | 'email' | 'address_line1' | 'address_line2' | 'address_zip5' | 'address_state' | 'address_city' | 'representative_capacity_type' | 'disclosure' | 'notary_id' | 'seal' | 'commission_expiration_date' | 'commission_state' | 'county' | 'commission_county' | 'principal_id_type' | 'notary_city' — The type of field designation. Accepted values for signers: dob, email, address_line1, address_line2, address_zip5, address_state, address_city, representative_capacity_type. Accepted values for notaries: disclosure, notary_id, seal, commission_expiration_date, commission_state, county, commission_county, principal_id_type, notary_city. Universal types: date_signed, day_signed, month_signed, year_signed, first_name, middle_name, last_name, full_name, signature, initials, checkmark, radio_checkmark, free_text, signature_and_date - `designation_group_id` string, nullable - `signing_designation_group` SigningDesignationGroup - `name` string — The specified name of the group, type string. Use a naming convention of your choice, the only restrictions are that the name must be between 1 and 64 characters and can consist of alpha-numeric characters, hyphens, parentheses, and underscores. Valid regular expression for you tech nerds is /^[a-zA-Z0-9_-()]{1,64}$/ - `min_required` integer — a positive integer between 0 and N where N is the minimum number of designations in the group that must be fulfilled (checked). - `max_required` integer — a positive integer between min_required and N where N is the maximum number of designations in the group that are allowed to be fulfilled. NOTE: max_required cannot be set to greater than 1 for designation groups used with radio_checkmark type signing designations. - `optional` boolean — Non-notary designation that is not part of a group can be set as optional - `instruction` string — Instruction specific to this signing designation to be shown to the signer - `primary_designation` object, nullable - `id` string - `primary_designation_identifier` string — Unique identification string to denote this designation is the primary designation - `conditional_on_primary` string — Identification string that denotes this designation is conditional on the designation with the same value set for primary_designation_identifier - `document` DocumentParams - `name` string — Plain language name given to the document. If this parameter is not provided, Proof will automatically assign a name using the end of the page path of the resource URL. - `document_url_version` boolean — Optional param to test v2 document urls. - `document` string - `requirement` string — Completion requirement for the document. Accepted values can be `notarization`, `esign`, `identity_confirmation` **([identity confirmation feature](https://dev.proof.com/docs/enterprise-features))**, `readonly`, and `non_essential`. Completion requirement for the document. If the value is set to `non_essential`, the document will be hidden from signers before the notary meeting and values for `customer_can_annotate` and `witness_required` will be ignored and set to false. `identity_confirmation` is used to support signing of PS Form 1583 for signers without a US SSN. Note: if `identity_confirmation` is set as the document requirement, ensure that all documents requiring notarization in the transaction also use `identity confirmation` as the requirement to avoid requiring KBA on the transaction. [Read more](https://dev.proof.com/docs/document-requirements) about document requirements. - `notarization_required` boolean - `witness_required` boolean — Boolean flag indicating whether an additional witness must be present for this document's signing. A witness is a third person, in addition to the signer and the notary, who must be physically located with the signer. - `esign_required` boolean - `identity_confirmation_required` boolean - `signing_requires_meeting` boolean - `customer_can_annotate` boolean — Boolean flag indicating whether a signer can add their own annotations onto the document. Defaults to false, limiting the signer to only filling out designated fields setup on the document or as directed by a notary. - `pdf_bookmarked` boolean — Boolean flag indicating whether the document is a bookmarked PDF. If passed true, the document will be split by bookmark into multiple documents. - `tracking_id` string — External tracking identifier such as a UUID string that can be useful for mapping documents back to your own system. - `text_tag_syntax` string — Syntax used by text tags within the document. - `signing_designations` SigningDesignation[] — This array contains a prescribed list of designations for signers and/or a notary to annotate the document. - `id` string - `signer_identifier` string — For signers, the external_id value set on the signers array when creating a transaction; for witnesses, `witness{n}` i.e. `witness1` or `witness2`; for notaries, `notary` - `page_number` integer — The page of the designation, starting at 0 - `x` integer — The X coordinate (from bottom left) - `y` integer — The Y coordinate (from bottom left) - `height` integer — Height - `width` integer — Width - `hint` string — Hint - `type` 'date_signed' | 'day_signed' | 'month_signed' | 'year_signed' | 'first_name' | 'middle_name' | 'last_name' | 'full_name' | 'signature' | 'initials' | 'checkmark' | 'radio_checkmark' | 'free_text' | 'signature_and_date' | 'dob' | 'email' | 'address_line1' | 'address_line2' | 'address_zip5' | 'address_state' | 'address_city' | 'representative_capacity_type' | 'disclosure' | 'notary_id' | 'seal' | 'commission_expiration_date' | 'commission_state' | 'county' | 'commission_county' | 'principal_id_type' | 'notary_city' — The type of field designation. Accepted values for signers: dob, email, address_line1, address_line2, address_zip5, address_state, address_city, representative_capacity_type. Accepted values for notaries: disclosure, notary_id, seal, commission_expiration_date, commission_state, county, commission_county, principal_id_type, notary_city. Universal types: date_signed, day_signed, month_signed, year_signed, first_name, middle_name, last_name, full_name, signature, initials, checkmark, radio_checkmark, free_text, signature_and_date - `designation_group_id` string, nullable - `signing_designation_group` SigningDesignationGroup - `name` string — The specified name of the group, type string. Use a naming convention of your choice, the only restrictions are that the name must be between 1 and 64 characters and can consist of alpha-numeric characters, hyphens, parentheses, and underscores. Valid regular expression for you tech nerds is /^[a-zA-Z0-9_-()]{1,64}$/ - `min_required` integer — a positive integer between 0 and N where N is the minimum number of designations in the group that must be fulfilled (checked). - `max_required` integer — a positive integer between min_required and N where N is the maximum number of designations in the group that are allowed to be fulfilled. NOTE: max_required cannot be set to greater than 1 for designation groups used with radio_checkmark type signing designations. - `optional` boolean — Non-notary designation that is not part of a group can be set as optional - `instruction` string — Instruction specific to this signing designation to be shown to the signer - `primary_designation` object, nullable - `id` string - `primary_designation_identifier` string — Unique identification string to denote this designation is the primary designation - `conditional_on_primary` string — Identification string that denotes this designation is conditional on the designation with the same value set for primary_designation_identifier - `jurisdiction_eligibility_consent` string - `require_new_signer_verification` boolean — When set to false, Proof will not require a new signer to verify their email address before moving into the transaction flow. - `skip_closing_ops` boolean — Send to closing ops or not. Defaults to false. - `cc_recipient_emails` CcRecipientEmail[] — An array of email addresses to CC on the transaction. They will receive notification when it is sent and completed and be able to view the completed documents. - `config_id` string — The ID of the config used for this transaction. This will ensure that the transaction will load as expected in your dashboard if you need to make any edits. Once set this cannot be edited. Available values: ["hybrid_purchase_buyer_loan", "hybrid_refinance", "hybrid_trailing_docs", "identify", "lender_heloc", "lender_loan_mod_borrower", "lender_refinance", "notarization", "other", "purchase_buyer", "purchase_buyer_loan", "purchase_seller", "real_estate_identify", "real_estate_sign", "real_estate_verify", "sign", "title_heloc", "title_loan_mod_borrower", "trailing_docs", "verify"] ## Response `200` success - TransactionObject - `id` string - `activation_time` string, nullable — An ISO-8601 formatted DateTime String. - `attachments` Attachment[] - `date_created` string — Date Attachment was created/uploaded. - `name` string — Name of the attachment - `url` string — URL of the attachment - `audit_trail_url` string, nullable - `cc_recipient_emails` CcRecipientEmail[] - `charge_statement_url` string, nullable - `config_id` string, nullable - `contacts` Contact[] - `first_name` string — First name of contact - `last_name` string — Last name of contact - `email` string — Email - `role` 'closer' | 'escrow_officer' | 'loan_officer' | 'loan_processor' | 'mortgage_broker' | 'other' | 'real_estate_agent' | 'title_agent' | 'attorney' — Accepted values: escrow_officer, loan_officer, real_estate_agent, title_agent, closer, other - `title` string, nullable — Only valid if role is set to "other". - `phone_number` string, nullable — 10 characters exactly. Dashes and other special characters are not allowed. Please use format "8885551111" - `shown_to_signer` boolean — If false, allows you to set a Proof-only contact. - `access_to_transaction` boolean — Gives the signer contact access to a transaction. - `organization_name` string, nullable — Use with contact role title_agent to invite a new Title Agent to collaborate on a Proof transaction. If provided for other roles, values will be disregarded. - `organization_address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `date_created` string — An ISO-8601 formatted DateTime String. - `date_updated` string — An ISO-8601 formatted DateTime String. - `cosigner_info` Signer - `signer_id` string — Signer ID - `email` string, required — Email is required unless you provide a recipient_group object. - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `phone_number` string — Signer phone number. A country code can be defined by using the `+` symbol. For example, `+11234567890` will set the country code to `+1` for the number `1234567890`. If no country code is specified the default will be the United States country code of `+1`. - `phone` object, nullable - `country_code` string — The country code for the phone number, e.g. 1 - `number` string — The phone number without the country code, e.g. 5551234567 - `address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `dob` string — The signer's date of birth. - `capacity` string, nullable — The signers capacity when signing on behalf of an entity, required when entity is present - `entity` string, nullable — Entity the signer is signing on behalf of, required when capacity is present - `external_id` string, nullable — A string representing an ID external to Proof's systems. Use this to associate a signer to an ID that your systems understand, such as a User ID. - `link_expired` boolean — Indicates if the signer's passwordless link has expired. - `personally_known_to_notary` boolean — If the signer is personally known to the notary. This can currently only be used on single signer transactions, or when the notary_id is specified on the signer. - `proof_requirement` ProofRequirement - `id_verification` ProofRequirementIdVerification - `selfie` boolean, required — Signer identity is verified through credential analysis and selfie comparison. SMS multi_factor_authentication is required with this for IAL2 compliant identity verification. - `knowledge_based_authentication` boolean, required — (KBA) Signer answers a series of personal identity questions. - `multi_factor_authentication` ProofRequirementMultiFactorAuthentication - `type` 'sms', required — Signer enters authentication code sent to their mobile phone. - `recipient_group` RecipientGroup - `shared_inbox_email` string — The email address that is shared by a group. Whomever has access to this email address can claim the transaction for themself. - `sdk_token` string, nullable — Equivalent to transaction_access_link; prefer using that instead. - `signatory_capacities` object[] — An array of signatory capacities for the signer when signing on behalf of multiple entities. - `capacity` string - `type` 'attorney_in_fact' | 'corporate_officer' | 'guardian_or_conservator' | 'general_partner' | 'limited_partner' | 'trustee' | 'other' - `representative_of` string - `primary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `secondary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `signing_requirement` 'esign' | 'identify' | 'verify', nullable — Override the document signing requirement for an individual signer. - `signing_status` 'incomplete' | 'in_progress' | 'complete', nullable - `transaction_access_link` string — A link to the transaction for this signer. - `vesting_type` 'borrower' | 'non_borrower' — Can be either `borrower` or `non_borrower`. Defaults to `borrower`. - `credential_assets` CredentialAssetObject[], nullable - `credential_type` 'primary' | 'secondary' | 'selfie' - `credential_images` CredentialImage[] - `url` string — URL of the image - `descriptor` 'back' | 'front' - `esign_authentication_records` PhotoValidationAttempt[], nullable - `validation_source` 'lexis-flex' | 'identity-verification-service' | 'lexis' | 'noop' | 'persona' | 'firebase' | 'null' | 'none' | 'notakred', nullable - `verified_at` string — An ISO-8601 formatted DateTime String. - `verification_method` string, nullable - `images` object - `front` string - `back` string, nullable - `selfie` string, nullable - `status` 'success' | 'failure' | 'unknown' | 'skipped' | 'pending' | 'action_required' | 'deleted', nullable - `document_address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `document_claimed_type` 'bank_account_statement' | 'bank_investment_loan_statement' | 'birth_certificate' | 'certificate_of_citizenship' | 'citizen_id' | 'credit_or_debit_card_statement' | 'deed_of_trust' | 'driver_license' | 'foreigner_id' | 'healthcare_insurance' | 'i_94' | 'id_card' | 'internal_passport' | 'keypass_id' | 'lease' | 'long_term_pass_card' | 'matricula_consular' | 'mortgage' | 'municipal_id' | 'my_number_card' | 'nbi' | 'nexus_card' | 'ofw' | 'organizational_membership_card' | 'pan' | 'passport' | 'passport_card' | 'paycheck_stub' | 'permanent_resident_card' | 'postal_id' | 'property_insurance' | 'property_tax_bill' | 'residency_permit' | 'school_id_card' | 'social_security_card' | 'sss' | 'travel_document' | 'tribal_id' | 'umid' | 'us_visa' | 'utility_bill' | 'vehicle_registration' | 'voter_registration_card' | 'work_permit' | 'other' | 'unknown' - `document_classification` string, nullable - `document_date_of_birth` string, nullable - `document_expiration_date` string, nullable - `document_first_name` string, nullable - `document_middle_name` string, nullable - `document_last_name` string, nullable - `document_issue_date` string, nullable - `document_issuer` string, nullable - `document_number` string, nullable - `verified` boolean - `failure_reasons` object[] - `check` string - `category` 'aamva_failure' | 'fraud' | 'image_quality' | 'ineligible_id' | 'kba_mismatch' | 'not_classified' | 'user_action_required' - `reasons` string[] - `required` boolean - `verification_type` 'id' | 'selfie' - `notary_id` string, nullable — User ID ("us_xxxxxxx") of the assigned Notary or "notarize". Eligible notaries must be a notary who is a member of your organization. Order must be utilized with this field, all notarization signers with the same order must have the same notary_id. - `order` integer, nullable — Order the signers will sign in. Should be positive numbers starting with 1. Setting to the same order as another signer indicates they will sign at the same time. - `suppress_communications` boolean, nullable - `verify_tool_configuration` VerifyToolConfiguration - `requirement` 'run' | 'pass' | 'none', required — Setting indicating whether or not the verify tool will be required to run or pass, or both - `cost` number, float — Cost of the transaction. - `date_created` string, date-time — Date Transaction was created/uploaded. - `date_updated` string, date-time — Date Transaction was updated. - `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' - `documents` Document[] - `id` string - `allowed_actions` string[] — List of allowed actions on document. - `bundle_position` integer — Position to put document in bundle - `completion_state` string - `data` string, nullable — base64 encoded document. Present if base64 encoding was specified in request. Currently supported for get_document only. - `date_created` string — Date document was created/uploaded. - `date_updated` string — Date document was last updated. - `document_name` string — Name of document. - `esign_required` boolean — Boolean flag indicating whether the document requires esigning. - `final_document_url` string, nullable - `identity_confirmation_required` boolean — Boolean flag indicating whether the document requires identity confirmation. - `is_enote` boolean — Boolean flag indicating whether the document is an eNote. - `notarization_required` boolean — Boolean flag indicating whether the document requires notarization. If `true`, identity_confirmation_required must be `false`. If `false`, the document may still be e-signed in the notary meeting. At least one document in a transaction must require notarization or identity confirmation. - `permissions` string[] - `processing_error` string, nullable — Error message if document processing failed. - `processing_state` string, nullable — State of document processing. - `rejection_anecdote` string, nullable — Anecdote for document rejection. - `rejection_reason` string, nullable — Reason for document rejection. - `requirement` string — Completion requirement for the document. Accepted values can be `notarization`, `esign`, `identity_confirmation` **([identity confirmation feature](https://dev.proof.com/docs/enterprise-features))**, `readonly`, and `non_essential`. Completion requirement for the document. If the value is set to `non_essential`, the document will be hidden from signers before the notary meeting and values for `customer_can_annotate` and `witness_required` will be ignored and set to false. `identity_confirmation` is used to support signing of PS Form 1583 for signers without a US SSN. Note: if `identity_confirmation` is set as the document requirement, ensure that all documents requiring notarization in the transaction also use `identity confirmation` as the requirement to avoid requiring KBA on the transaction. [Read more](https://dev.proof.com/docs/document-requirements) about document requirements. - `signed_url` string, nullable — Signed URL for the final document PDF. - `signing_designation_groups` SigningDesignationGroup[] — This array contains a prescribed list of groups of designations for signers and/or a notary to annotate the document. - `name` string — The specified name of the group, type string. Use a naming convention of your choice, the only restrictions are that the name must be between 1 and 64 characters and can consist of alpha-numeric characters, hyphens, parentheses, and underscores. Valid regular expression for you tech nerds is /^[a-zA-Z0-9_-()]{1,64}$/ - `min_required` integer — a positive integer between 0 and N where N is the minimum number of designations in the group that must be fulfilled (checked). - `max_required` integer — a positive integer between min_required and N where N is the maximum number of designations in the group that are allowed to be fulfilled. NOTE: max_required cannot be set to greater than 1 for designation groups used with radio_checkmark type signing designations. - `signing_designations` SigningDesignation[] — This array contains a prescribed list of designations for signers and/or a notary to annotate the document. - `id` string - `signer_identifier` string — For signers, the external_id value set on the signers array when creating a transaction; for witnesses, `witness{n}` i.e. `witness1` or `witness2`; for notaries, `notary` - `page_number` integer — The page of the designation, starting at 0 - `x` integer — The X coordinate (from bottom left) - `y` integer — The Y coordinate (from bottom left) - `height` integer — Height - `width` integer — Width - `hint` string — Hint - `type` 'date_signed' | 'day_signed' | 'month_signed' | 'year_signed' | 'first_name' | 'middle_name' | 'last_name' | 'full_name' | 'signature' | 'initials' | 'checkmark' | 'radio_checkmark' | 'free_text' | 'signature_and_date' | 'dob' | 'email' | 'address_line1' | 'address_line2' | 'address_zip5' | 'address_state' | 'address_city' | 'representative_capacity_type' | 'disclosure' | 'notary_id' | 'seal' | 'commission_expiration_date' | 'commission_state' | 'county' | 'commission_county' | 'principal_id_type' | 'notary_city' — The type of field designation. Accepted values for signers: dob, email, address_line1, address_line2, address_zip5, address_state, address_city, representative_capacity_type. Accepted values for notaries: disclosure, notary_id, seal, commission_expiration_date, commission_state, county, commission_county, principal_id_type, notary_city. Universal types: date_signed, day_signed, month_signed, year_signed, first_name, middle_name, last_name, full_name, signature, initials, checkmark, radio_checkmark, free_text, signature_and_date - `designation_group_id` string, nullable - `signing_designation_group` SigningDesignationGroup - `name` string — The specified name of the group, type string. Use a naming convention of your choice, the only restrictions are that the name must be between 1 and 64 characters and can consist of alpha-numeric characters, hyphens, parentheses, and underscores. Valid regular expression for you tech nerds is /^[a-zA-Z0-9_-()]{1,64}$/ - `min_required` integer — a positive integer between 0 and N where N is the minimum number of designations in the group that must be fulfilled (checked). - `max_required` integer — a positive integer between min_required and N where N is the maximum number of designations in the group that are allowed to be fulfilled. NOTE: max_required cannot be set to greater than 1 for designation groups used with radio_checkmark type signing designations. - `optional` boolean — Non-notary designation that is not part of a group can be set as optional - `instruction` string — Instruction specific to this signing designation to be shown to the signer - `primary_designation` object, nullable - `id` string - `primary_designation_identifier` string — Unique identification string to denote this designation is the primary designation - `conditional_on_primary` string — Identification string that denotes this designation is conditional on the designation with the same value set for primary_designation_identifier - `signing_type` string - `tracking_id` string, nullable — The external tracking ID of the document. - `eo_transaction_id` string, nullable - `expiration_time` string, nullable - `expiry` string - `external_id` string, nullable - `file_number` string, nullable - `identity_report` object, nullable - `name` string - `url` string - `lender` object, nullable - `id` string - `name` string - `loan_number` string, nullable - `message_signature` string, nullable - `message_subject` string, nullable - `message_to_signer` string, nullable - `notarization_record` NotarizationRecordObject - `id` string - `meeting_start` string, date-time - `meeting_end` string, date-time - `notary_name` string - `notary_county_city` string - `notary_registration` string - `notary_source` 'In-house notary' | 'Custom Panel' | 'Notarize Network' — Indicates how the notary who fulfilled this session was sourced: In-house notary, Custom Panel, or Notarize Network. Reflects actual session fulfillment, not original routing. - `signer_info` Signer - `signer_id` string — Signer ID - `email` string, required — Email is required unless you provide a recipient_group object. - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `phone_number` string — Signer phone number. A country code can be defined by using the `+` symbol. For example, `+11234567890` will set the country code to `+1` for the number `1234567890`. If no country code is specified the default will be the United States country code of `+1`. - `phone` object, nullable - `country_code` string — The country code for the phone number, e.g. 1 - `number` string — The phone number without the country code, e.g. 5551234567 - `address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `dob` string — The signer's date of birth. - `capacity` string, nullable — The signers capacity when signing on behalf of an entity, required when entity is present - `entity` string, nullable — Entity the signer is signing on behalf of, required when capacity is present - `external_id` string, nullable — A string representing an ID external to Proof's systems. Use this to associate a signer to an ID that your systems understand, such as a User ID. - `link_expired` boolean — Indicates if the signer's passwordless link has expired. - `personally_known_to_notary` boolean — If the signer is personally known to the notary. This can currently only be used on single signer transactions, or when the notary_id is specified on the signer. - `proof_requirement` ProofRequirement - `id_verification` ProofRequirementIdVerification - `selfie` boolean, required — Signer identity is verified through credential analysis and selfie comparison. SMS multi_factor_authentication is required with this for IAL2 compliant identity verification. - `knowledge_based_authentication` boolean, required — (KBA) Signer answers a series of personal identity questions. - `multi_factor_authentication` ProofRequirementMultiFactorAuthentication - `type` 'sms', required — Signer enters authentication code sent to their mobile phone. - `recipient_group` RecipientGroup - `shared_inbox_email` string — The email address that is shared by a group. Whomever has access to this email address can claim the transaction for themself. - `sdk_token` string, nullable — Equivalent to transaction_access_link; prefer using that instead. - `signatory_capacities` object[] — An array of signatory capacities for the signer when signing on behalf of multiple entities. - `capacity` string - `type` 'attorney_in_fact' | 'corporate_officer' | 'guardian_or_conservator' | 'general_partner' | 'limited_partner' | 'trustee' | 'other' - `representative_of` string - `primary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `secondary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `signing_requirement` 'esign' | 'identify' | 'verify', nullable — Override the document signing requirement for an individual signer. - `signing_status` 'incomplete' | 'in_progress' | 'complete', nullable - `transaction_access_link` string — A link to the transaction for this signer. - `vesting_type` 'borrower' | 'non_borrower' — Can be either `borrower` or `non_borrower`. Defaults to `borrower`. - `credential_assets` CredentialAssetObject[], nullable - `credential_type` 'primary' | 'secondary' | 'selfie' - `credential_images` CredentialImage[] - `url` string — URL of the image - `descriptor` 'back' | 'front' - `esign_authentication_records` PhotoValidationAttempt[], nullable - `validation_source` 'lexis-flex' | 'identity-verification-service' | 'lexis' | 'noop' | 'persona' | 'firebase' | 'null' | 'none' | 'notakred', nullable - `verified_at` string — An ISO-8601 formatted DateTime String. - `verification_method` string, nullable - `images` object - `front` string - `back` string, nullable - `selfie` string, nullable - `status` 'success' | 'failure' | 'unknown' | 'skipped' | 'pending' | 'action_required' | 'deleted', nullable - `document_address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `document_claimed_type` 'bank_account_statement' | 'bank_investment_loan_statement' | 'birth_certificate' | 'certificate_of_citizenship' | 'citizen_id' | 'credit_or_debit_card_statement' | 'deed_of_trust' | 'driver_license' | 'foreigner_id' | 'healthcare_insurance' | 'i_94' | 'id_card' | 'internal_passport' | 'keypass_id' | 'lease' | 'long_term_pass_card' | 'matricula_consular' | 'mortgage' | 'municipal_id' | 'my_number_card' | 'nbi' | 'nexus_card' | 'ofw' | 'organizational_membership_card' | 'pan' | 'passport' | 'passport_card' | 'paycheck_stub' | 'permanent_resident_card' | 'postal_id' | 'property_insurance' | 'property_tax_bill' | 'residency_permit' | 'school_id_card' | 'social_security_card' | 'sss' | 'travel_document' | 'tribal_id' | 'umid' | 'us_visa' | 'utility_bill' | 'vehicle_registration' | 'voter_registration_card' | 'work_permit' | 'other' | 'unknown' - `document_classification` string, nullable - `document_date_of_birth` string, nullable - `document_expiration_date` string, nullable - `document_first_name` string, nullable - `document_middle_name` string, nullable - `document_last_name` string, nullable - `document_issue_date` string, nullable - `document_issuer` string, nullable - `document_number` string, nullable - `verified` boolean - `failure_reasons` object[] - `check` string - `category` 'aamva_failure' | 'fraud' | 'image_quality' | 'ineligible_id' | 'kba_mismatch' | 'not_classified' | 'user_action_required' - `reasons` string[] - `required` boolean - `verification_type` 'id' | 'selfie' - `notary_id` string, nullable — User ID ("us_xxxxxxx") of the assigned Notary or "notarize". Eligible notaries must be a notary who is a member of your organization. Order must be utilized with this field, all notarization signers with the same order must have the same notary_id. - `order` integer, nullable — Order the signers will sign in. Should be positive numbers starting with 1. Setting to the same order as another signer indicates they will sign at the same time. - `suppress_communications` boolean, nullable - `verify_tool_configuration` VerifyToolConfiguration - `requirement` 'run' | 'pass' | 'none', required — Setting indicating whether or not the verify tool will be required to run or pass, or both - `signers` object[] - `signer_id` string — Signer ID - `email` string, required — Email is required unless you provide a recipient_group object. - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `phone_number` string — Signer phone number. A country code can be defined by using the `+` symbol. For example, `+11234567890` will set the country code to `+1` for the number `1234567890`. If no country code is specified the default will be the United States country code of `+1`. - `phone` object, nullable - `country_code` string — The country code for the phone number, e.g. 1 - `number` string — The phone number without the country code, e.g. 5551234567 - `address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `dob` string — The signer's date of birth. - `capacity` string, nullable — The signers capacity when signing on behalf of an entity, required when entity is present - `entity` string, nullable — Entity the signer is signing on behalf of, required when capacity is present - `external_id` string, nullable — A string representing an ID external to Proof's systems. Use this to associate a signer to an ID that your systems understand, such as a User ID. - `link_expired` boolean — Indicates if the signer's passwordless link has expired. - `personally_known_to_notary` boolean — If the signer is personally known to the notary. This can currently only be used on single signer transactions, or when the notary_id is specified on the signer. - `proof_requirement` ProofRequirement - `id_verification` ProofRequirementIdVerification - `selfie` boolean, required — Signer identity is verified through credential analysis and selfie comparison. SMS multi_factor_authentication is required with this for IAL2 compliant identity verification. - `knowledge_based_authentication` boolean, required — (KBA) Signer answers a series of personal identity questions. - `multi_factor_authentication` ProofRequirementMultiFactorAuthentication - `type` 'sms', required — Signer enters authentication code sent to their mobile phone. - `recipient_group` RecipientGroup - `shared_inbox_email` string — The email address that is shared by a group. Whomever has access to this email address can claim the transaction for themself. - `sdk_token` string, nullable — Equivalent to transaction_access_link; prefer using that instead. - `signatory_capacities` object[] — An array of signatory capacities for the signer when signing on behalf of multiple entities. - `capacity` string - `type` 'attorney_in_fact' | 'corporate_officer' | 'guardian_or_conservator' | 'general_partner' | 'limited_partner' | 'trustee' | 'other' - `representative_of` string - `primary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `secondary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `signing_requirement` 'esign' | 'identify' | 'verify', nullable — Override the document signing requirement for an individual signer. - `signing_status` 'incomplete' | 'in_progress' | 'complete', nullable - `transaction_access_link` string — A link to the transaction for this signer. - `vesting_type` 'borrower' | 'non_borrower' — Can be either `borrower` or `non_borrower`. Defaults to `borrower`. - `credential_assets` CredentialAssetObject[], nullable - `credential_type` 'primary' | 'secondary' | 'selfie' - `credential_images` CredentialImage[] - `url` string — URL of the image - `descriptor` 'back' | 'front' - `esign_authentication_records` PhotoValidationAttempt[], nullable - `validation_source` 'lexis-flex' | 'identity-verification-service' | 'lexis' | 'noop' | 'persona' | 'firebase' | 'null' | 'none' | 'notakred', nullable - `verified_at` string — An ISO-8601 formatted DateTime String. - `verification_method` string, nullable - `images` object - `front` string - `back` string, nullable - `selfie` string, nullable - `status` 'success' | 'failure' | 'unknown' | 'skipped' | 'pending' | 'action_required' | 'deleted', nullable - `document_address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `document_claimed_type` 'bank_account_statement' | 'bank_investment_loan_statement' | 'birth_certificate' | 'certificate_of_citizenship' | 'citizen_id' | 'credit_or_debit_card_statement' | 'deed_of_trust' | 'driver_license' | 'foreigner_id' | 'healthcare_insurance' | 'i_94' | 'id_card' | 'internal_passport' | 'keypass_id' | 'lease' | 'long_term_pass_card' | 'matricula_consular' | 'mortgage' | 'municipal_id' | 'my_number_card' | 'nbi' | 'nexus_card' | 'ofw' | 'organizational_membership_card' | 'pan' | 'passport' | 'passport_card' | 'paycheck_stub' | 'permanent_resident_card' | 'postal_id' | 'property_insurance' | 'property_tax_bill' | 'residency_permit' | 'school_id_card' | 'social_security_card' | 'sss' | 'travel_document' | 'tribal_id' | 'umid' | 'us_visa' | 'utility_bill' | 'vehicle_registration' | 'voter_registration_card' | 'work_permit' | 'other' | 'unknown' - `document_classification` string, nullable - `document_date_of_birth` string, nullable - `document_expiration_date` string, nullable - `document_first_name` string, nullable - `document_middle_name` string, nullable - `document_last_name` string, nullable - `document_issue_date` string, nullable - `document_issuer` string, nullable - `document_number` string, nullable - `verified` boolean - `failure_reasons` object[] - `check` string - `category` 'aamva_failure' | 'fraud' | 'image_quality' | 'ineligible_id' | 'kba_mismatch' | 'not_classified' | 'user_action_required' - `reasons` string[] - `required` boolean - `verification_type` 'id' | 'selfie' - `notary_id` string, nullable — User ID ("us_xxxxxxx") of the assigned Notary or "notarize". Eligible notaries must be a notary who is a member of your organization. Order must be utilized with this field, all notarization signers with the same order must have the same notary_id. - `order` integer, nullable — Order the signers will sign in. Should be positive numbers starting with 1. Setting to the same order as another signer indicates they will sign at the same time. - `suppress_communications` boolean, nullable - `verify_tool_configuration` VerifyToolConfiguration - `requirement` 'run' | 'pass' | 'none', required — Setting indicating whether or not the verify tool will be required to run or pass, or both - `primary_front` string — URL of the front of the primary photo identification document. - `primary_back` string — URL of the back of the primary photo identification document. - `primary_type` string — Type of the primary photo identification document. - `primary_issuer` string — Issuer of the primary photo identification document. - `primary_expiry_date` string — Expiry date of the primary photo identification document. - `secondary_front` string — URL of the front of the secondary photo identification document. - `cosigner_info` Signer - `signer_id` string — Signer ID - `email` string, required — Email is required unless you provide a recipient_group object. - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `phone_number` string — Signer phone number. A country code can be defined by using the `+` symbol. For example, `+11234567890` will set the country code to `+1` for the number `1234567890`. If no country code is specified the default will be the United States country code of `+1`. - `phone` object, nullable - `country_code` string — The country code for the phone number, e.g. 1 - `number` string — The phone number without the country code, e.g. 5551234567 - `address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `dob` string — The signer's date of birth. - `capacity` string, nullable — The signers capacity when signing on behalf of an entity, required when entity is present - `entity` string, nullable — Entity the signer is signing on behalf of, required when capacity is present - `external_id` string, nullable — A string representing an ID external to Proof's systems. Use this to associate a signer to an ID that your systems understand, such as a User ID. - `link_expired` boolean — Indicates if the signer's passwordless link has expired. - `personally_known_to_notary` boolean — If the signer is personally known to the notary. This can currently only be used on single signer transactions, or when the notary_id is specified on the signer. - `proof_requirement` ProofRequirement - `id_verification` ProofRequirementIdVerification - `selfie` boolean, required — Signer identity is verified through credential analysis and selfie comparison. SMS multi_factor_authentication is required with this for IAL2 compliant identity verification. - `knowledge_based_authentication` boolean, required — (KBA) Signer answers a series of personal identity questions. - `multi_factor_authentication` ProofRequirementMultiFactorAuthentication - `type` 'sms', required — Signer enters authentication code sent to their mobile phone. - `recipient_group` RecipientGroup - `shared_inbox_email` string — The email address that is shared by a group. Whomever has access to this email address can claim the transaction for themself. - `sdk_token` string, nullable — Equivalent to transaction_access_link; prefer using that instead. - `signatory_capacities` object[] — An array of signatory capacities for the signer when signing on behalf of multiple entities. - `capacity` string - `type` 'attorney_in_fact' | 'corporate_officer' | 'guardian_or_conservator' | 'general_partner' | 'limited_partner' | 'trustee' | 'other' - `representative_of` string - `primary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `secondary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `signing_requirement` 'esign' | 'identify' | 'verify', nullable — Override the document signing requirement for an individual signer. - `signing_status` 'incomplete' | 'in_progress' | 'complete', nullable - `transaction_access_link` string — A link to the transaction for this signer. - `vesting_type` 'borrower' | 'non_borrower' — Can be either `borrower` or `non_borrower`. Defaults to `borrower`. - `credential_assets` CredentialAssetObject[], nullable - `credential_type` 'primary' | 'secondary' | 'selfie' - `credential_images` CredentialImage[] - `url` string — URL of the image - `descriptor` 'back' | 'front' - `esign_authentication_records` PhotoValidationAttempt[], nullable - `validation_source` 'lexis-flex' | 'identity-verification-service' | 'lexis' | 'noop' | 'persona' | 'firebase' | 'null' | 'none' | 'notakred', nullable - `verified_at` string — An ISO-8601 formatted DateTime String. - `verification_method` string, nullable - `images` object - `front` string - `back` string, nullable - `selfie` string, nullable - `status` 'success' | 'failure' | 'unknown' | 'skipped' | 'pending' | 'action_required' | 'deleted', nullable - `document_address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `document_claimed_type` 'bank_account_statement' | 'bank_investment_loan_statement' | 'birth_certificate' | 'certificate_of_citizenship' | 'citizen_id' | 'credit_or_debit_card_statement' | 'deed_of_trust' | 'driver_license' | 'foreigner_id' | 'healthcare_insurance' | 'i_94' | 'id_card' | 'internal_passport' | 'keypass_id' | 'lease' | 'long_term_pass_card' | 'matricula_consular' | 'mortgage' | 'municipal_id' | 'my_number_card' | 'nbi' | 'nexus_card' | 'ofw' | 'organizational_membership_card' | 'pan' | 'passport' | 'passport_card' | 'paycheck_stub' | 'permanent_resident_card' | 'postal_id' | 'property_insurance' | 'property_tax_bill' | 'residency_permit' | 'school_id_card' | 'social_security_card' | 'sss' | 'travel_document' | 'tribal_id' | 'umid' | 'us_visa' | 'utility_bill' | 'vehicle_registration' | 'voter_registration_card' | 'work_permit' | 'other' | 'unknown' - `document_classification` string, nullable - `document_date_of_birth` string, nullable - `document_expiration_date` string, nullable - `document_first_name` string, nullable - `document_middle_name` string, nullable - `document_last_name` string, nullable - `document_issue_date` string, nullable - `document_issuer` string, nullable - `document_number` string, nullable - `verified` boolean - `failure_reasons` object[] - `check` string - `category` 'aamva_failure' | 'fraud' | 'image_quality' | 'ineligible_id' | 'kba_mismatch' | 'not_classified' | 'user_action_required' - `reasons` string[] - `required` boolean - `verification_type` 'id' | 'selfie' - `notary_id` string, nullable — User ID ("us_xxxxxxx") of the assigned Notary or "notarize". Eligible notaries must be a notary who is a member of your organization. Order must be utilized with this field, all notarization signers with the same order must have the same notary_id. - `order` integer, nullable — Order the signers will sign in. Should be positive numbers starting with 1. Setting to the same order as another signer indicates they will sign at the same time. - `suppress_communications` boolean, nullable - `verify_tool_configuration` VerifyToolConfiguration - `requirement` 'run' | 'pass' | 'none', required — Setting indicating whether or not the verify tool will be required to run or pass, or both - `witnesses` Witness[] - `first_name` string - `middle_name` string - `last_name` string - `address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `credential_assets` CredentialAssetObject[] - `credential_type` 'primary' | 'secondary' | 'selfie' - `credential_images` CredentialImage[] - `url` string — URL of the image - `descriptor` 'back' | 'front' - `notarized_documents` Document[] - `id` string - `allowed_actions` string[] — List of allowed actions on document. - `bundle_position` integer — Position to put document in bundle - `completion_state` string - `data` string, nullable — base64 encoded document. Present if base64 encoding was specified in request. Currently supported for get_document only. - `date_created` string — Date document was created/uploaded. - `date_updated` string — Date document was last updated. - `document_name` string — Name of document. - `esign_required` boolean — Boolean flag indicating whether the document requires esigning. - `final_document_url` string, nullable - `identity_confirmation_required` boolean — Boolean flag indicating whether the document requires identity confirmation. - `is_enote` boolean — Boolean flag indicating whether the document is an eNote. - `notarization_required` boolean — Boolean flag indicating whether the document requires notarization. If `true`, identity_confirmation_required must be `false`. If `false`, the document may still be e-signed in the notary meeting. At least one document in a transaction must require notarization or identity confirmation. - `permissions` string[] - `processing_error` string, nullable — Error message if document processing failed. - `processing_state` string, nullable — State of document processing. - `rejection_anecdote` string, nullable — Anecdote for document rejection. - `rejection_reason` string, nullable — Reason for document rejection. - `requirement` string — Completion requirement for the document. Accepted values can be `notarization`, `esign`, `identity_confirmation` **([identity confirmation feature](https://dev.proof.com/docs/enterprise-features))**, `readonly`, and `non_essential`. Completion requirement for the document. If the value is set to `non_essential`, the document will be hidden from signers before the notary meeting and values for `customer_can_annotate` and `witness_required` will be ignored and set to false. `identity_confirmation` is used to support signing of PS Form 1583 for signers without a US SSN. Note: if `identity_confirmation` is set as the document requirement, ensure that all documents requiring notarization in the transaction also use `identity confirmation` as the requirement to avoid requiring KBA on the transaction. [Read more](https://dev.proof.com/docs/document-requirements) about document requirements. - `signed_url` string, nullable — Signed URL for the final document PDF. - `signing_designation_groups` SigningDesignationGroup[] — This array contains a prescribed list of groups of designations for signers and/or a notary to annotate the document. - `name` string — The specified name of the group, type string. Use a naming convention of your choice, the only restrictions are that the name must be between 1 and 64 characters and can consist of alpha-numeric characters, hyphens, parentheses, and underscores. Valid regular expression for you tech nerds is /^[a-zA-Z0-9_-()]{1,64}$/ - `min_required` integer — a positive integer between 0 and N where N is the minimum number of designations in the group that must be fulfilled (checked). - `max_required` integer — a positive integer between min_required and N where N is the maximum number of designations in the group that are allowed to be fulfilled. NOTE: max_required cannot be set to greater than 1 for designation groups used with radio_checkmark type signing designations. - `signing_designations` SigningDesignation[] — This array contains a prescribed list of designations for signers and/or a notary to annotate the document. - `id` string - `signer_identifier` string — For signers, the external_id value set on the signers array when creating a transaction; for witnesses, `witness{n}` i.e. `witness1` or `witness2`; for notaries, `notary` - `page_number` integer — The page of the designation, starting at 0 - `x` integer — The X coordinate (from bottom left) - `y` integer — The Y coordinate (from bottom left) - `height` integer — Height - `width` integer — Width - `hint` string — Hint - `type` 'date_signed' | 'day_signed' | 'month_signed' | 'year_signed' | 'first_name' | 'middle_name' | 'last_name' | 'full_name' | 'signature' | 'initials' | 'checkmark' | 'radio_checkmark' | 'free_text' | 'signature_and_date' | 'dob' | 'email' | 'address_line1' | 'address_line2' | 'address_zip5' | 'address_state' | 'address_city' | 'representative_capacity_type' | 'disclosure' | 'notary_id' | 'seal' | 'commission_expiration_date' | 'commission_state' | 'county' | 'commission_county' | 'principal_id_type' | 'notary_city' — The type of field designation. Accepted values for signers: dob, email, address_line1, address_line2, address_zip5, address_state, address_city, representative_capacity_type. Accepted values for notaries: disclosure, notary_id, seal, commission_expiration_date, commission_state, county, commission_county, principal_id_type, notary_city. Universal types: date_signed, day_signed, month_signed, year_signed, first_name, middle_name, last_name, full_name, signature, initials, checkmark, radio_checkmark, free_text, signature_and_date - `designation_group_id` string, nullable - `signing_designation_group` SigningDesignationGroup - `name` string — The specified name of the group, type string. Use a naming convention of your choice, the only restrictions are that the name must be between 1 and 64 characters and can consist of alpha-numeric characters, hyphens, parentheses, and underscores. Valid regular expression for you tech nerds is /^[a-zA-Z0-9_-()]{1,64}$/ - `min_required` integer — a positive integer between 0 and N where N is the minimum number of designations in the group that must be fulfilled (checked). - `max_required` integer — a positive integer between min_required and N where N is the maximum number of designations in the group that are allowed to be fulfilled. NOTE: max_required cannot be set to greater than 1 for designation groups used with radio_checkmark type signing designations. - `optional` boolean — Non-notary designation that is not part of a group can be set as optional - `instruction` string — Instruction specific to this signing designation to be shown to the signer - `primary_designation` object, nullable - `id` string - `primary_designation_identifier` string — Unique identification string to denote this designation is the primary designation - `conditional_on_primary` string — Identification string that denotes this designation is conditional on the designation with the same value set for primary_designation_identifier - `signing_type` string - `tracking_id` string, nullable — The external tracking ID of the document. - `verification_credentials` object - `retrieval_id` string - `retrieval_pin` string - `last_name` string, nullable - `date_completed` string - `signer_photo_identification` PhotoIdentification - `primary_front` string — URL of the front of the primary photo identification document. - `primary_back` string — URL of the back of the primary photo identification document. - `primary_type` string — Type of the primary photo identification document. - `primary_issuer` string — Issuer of the primary photo identification document. - `primary_expiry_date` string — Expiry date of the primary photo identification document. - `secondary_front` string — URL of the front of the secondary photo identification document. - `video_url` string — Download URL of the video recording of the meeting. - `chat_url` string, nullable — Download URL of the chat transcript of the meeting. - `notarization_records` NotarizationRecordObject[] - `id` string - `meeting_start` string, date-time - `meeting_end` string, date-time - `notary_name` string - `notary_county_city` string - `notary_registration` string - `notary_source` 'In-house notary' | 'Custom Panel' | 'Notarize Network' — Indicates how the notary who fulfilled this session was sourced: In-house notary, Custom Panel, or Notarize Network. Reflects actual session fulfillment, not original routing. - `signer_info` Signer - `signer_id` string — Signer ID - `email` string, required — Email is required unless you provide a recipient_group object. - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `phone_number` string — Signer phone number. A country code can be defined by using the `+` symbol. For example, `+11234567890` will set the country code to `+1` for the number `1234567890`. If no country code is specified the default will be the United States country code of `+1`. - `phone` object, nullable - `country_code` string — The country code for the phone number, e.g. 1 - `number` string — The phone number without the country code, e.g. 5551234567 - `address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `dob` string — The signer's date of birth. - `capacity` string, nullable — The signers capacity when signing on behalf of an entity, required when entity is present - `entity` string, nullable — Entity the signer is signing on behalf of, required when capacity is present - `external_id` string, nullable — A string representing an ID external to Proof's systems. Use this to associate a signer to an ID that your systems understand, such as a User ID. - `link_expired` boolean — Indicates if the signer's passwordless link has expired. - `personally_known_to_notary` boolean — If the signer is personally known to the notary. This can currently only be used on single signer transactions, or when the notary_id is specified on the signer. - `proof_requirement` ProofRequirement - `id_verification` ProofRequirementIdVerification - `selfie` boolean, required — Signer identity is verified through credential analysis and selfie comparison. SMS multi_factor_authentication is required with this for IAL2 compliant identity verification. - `knowledge_based_authentication` boolean, required — (KBA) Signer answers a series of personal identity questions. - `multi_factor_authentication` ProofRequirementMultiFactorAuthentication - `type` 'sms', required — Signer enters authentication code sent to their mobile phone. - `recipient_group` RecipientGroup - `shared_inbox_email` string — The email address that is shared by a group. Whomever has access to this email address can claim the transaction for themself. - `sdk_token` string, nullable — Equivalent to transaction_access_link; prefer using that instead. - `signatory_capacities` object[] — An array of signatory capacities for the signer when signing on behalf of multiple entities. - `capacity` string - `type` 'attorney_in_fact' | 'corporate_officer' | 'guardian_or_conservator' | 'general_partner' | 'limited_partner' | 'trustee' | 'other' - `representative_of` string - `primary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `secondary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `signing_requirement` 'esign' | 'identify' | 'verify', nullable — Override the document signing requirement for an individual signer. - `signing_status` 'incomplete' | 'in_progress' | 'complete', nullable - `transaction_access_link` string — A link to the transaction for this signer. - `vesting_type` 'borrower' | 'non_borrower' — Can be either `borrower` or `non_borrower`. Defaults to `borrower`. - `credential_assets` CredentialAssetObject[], nullable - `credential_type` 'primary' | 'secondary' | 'selfie' - `credential_images` CredentialImage[] - `url` string — URL of the image - `descriptor` 'back' | 'front' - `esign_authentication_records` PhotoValidationAttempt[], nullable - `validation_source` 'lexis-flex' | 'identity-verification-service' | 'lexis' | 'noop' | 'persona' | 'firebase' | 'null' | 'none' | 'notakred', nullable - `verified_at` string — An ISO-8601 formatted DateTime String. - `verification_method` string, nullable - `images` object - `front` string - `back` string, nullable - `selfie` string, nullable - `status` 'success' | 'failure' | 'unknown' | 'skipped' | 'pending' | 'action_required' | 'deleted', nullable - `document_address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `document_claimed_type` 'bank_account_statement' | 'bank_investment_loan_statement' | 'birth_certificate' | 'certificate_of_citizenship' | 'citizen_id' | 'credit_or_debit_card_statement' | 'deed_of_trust' | 'driver_license' | 'foreigner_id' | 'healthcare_insurance' | 'i_94' | 'id_card' | 'internal_passport' | 'keypass_id' | 'lease' | 'long_term_pass_card' | 'matricula_consular' | 'mortgage' | 'municipal_id' | 'my_number_card' | 'nbi' | 'nexus_card' | 'ofw' | 'organizational_membership_card' | 'pan' | 'passport' | 'passport_card' | 'paycheck_stub' | 'permanent_resident_card' | 'postal_id' | 'property_insurance' | 'property_tax_bill' | 'residency_permit' | 'school_id_card' | 'social_security_card' | 'sss' | 'travel_document' | 'tribal_id' | 'umid' | 'us_visa' | 'utility_bill' | 'vehicle_registration' | 'voter_registration_card' | 'work_permit' | 'other' | 'unknown' - `document_classification` string, nullable - `document_date_of_birth` string, nullable - `document_expiration_date` string, nullable - `document_first_name` string, nullable - `document_middle_name` string, nullable - `document_last_name` string, nullable - `document_issue_date` string, nullable - `document_issuer` string, nullable - `document_number` string, nullable - `verified` boolean - `failure_reasons` object[] - `check` string - `category` 'aamva_failure' | 'fraud' | 'image_quality' | 'ineligible_id' | 'kba_mismatch' | 'not_classified' | 'user_action_required' - `reasons` string[] - `required` boolean - `verification_type` 'id' | 'selfie' - `notary_id` string, nullable — User ID ("us_xxxxxxx") of the assigned Notary or "notarize". Eligible notaries must be a notary who is a member of your organization. Order must be utilized with this field, all notarization signers with the same order must have the same notary_id. - `order` integer, nullable — Order the signers will sign in. Should be positive numbers starting with 1. Setting to the same order as another signer indicates they will sign at the same time. - `suppress_communications` boolean, nullable - `verify_tool_configuration` VerifyToolConfiguration - `requirement` 'run' | 'pass' | 'none', required — Setting indicating whether or not the verify tool will be required to run or pass, or both - `signers` object[] - `signer_id` string — Signer ID - `email` string, required — Email is required unless you provide a recipient_group object. - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `phone_number` string — Signer phone number. A country code can be defined by using the `+` symbol. For example, `+11234567890` will set the country code to `+1` for the number `1234567890`. If no country code is specified the default will be the United States country code of `+1`. - `phone` object, nullable - `country_code` string — The country code for the phone number, e.g. 1 - `number` string — The phone number without the country code, e.g. 5551234567 - `address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `dob` string — The signer's date of birth. - `capacity` string, nullable — The signers capacity when signing on behalf of an entity, required when entity is present - `entity` string, nullable — Entity the signer is signing on behalf of, required when capacity is present - `external_id` string, nullable — A string representing an ID external to Proof's systems. Use this to associate a signer to an ID that your systems understand, such as a User ID. - `link_expired` boolean — Indicates if the signer's passwordless link has expired. - `personally_known_to_notary` boolean — If the signer is personally known to the notary. This can currently only be used on single signer transactions, or when the notary_id is specified on the signer. - `proof_requirement` ProofRequirement - `id_verification` ProofRequirementIdVerification - `selfie` boolean, required — Signer identity is verified through credential analysis and selfie comparison. SMS multi_factor_authentication is required with this for IAL2 compliant identity verification. - `knowledge_based_authentication` boolean, required — (KBA) Signer answers a series of personal identity questions. - `multi_factor_authentication` ProofRequirementMultiFactorAuthentication - `type` 'sms', required — Signer enters authentication code sent to their mobile phone. - `recipient_group` RecipientGroup - `shared_inbox_email` string — The email address that is shared by a group. Whomever has access to this email address can claim the transaction for themself. - `sdk_token` string, nullable — Equivalent to transaction_access_link; prefer using that instead. - `signatory_capacities` object[] — An array of signatory capacities for the signer when signing on behalf of multiple entities. - `capacity` string - `type` 'attorney_in_fact' | 'corporate_officer' | 'guardian_or_conservator' | 'general_partner' | 'limited_partner' | 'trustee' | 'other' - `representative_of` string - `primary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `secondary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `signing_requirement` 'esign' | 'identify' | 'verify', nullable — Override the document signing requirement for an individual signer. - `signing_status` 'incomplete' | 'in_progress' | 'complete', nullable - `transaction_access_link` string — A link to the transaction for this signer. - `vesting_type` 'borrower' | 'non_borrower' — Can be either `borrower` or `non_borrower`. Defaults to `borrower`. - `credential_assets` CredentialAssetObject[], nullable - `credential_type` 'primary' | 'secondary' | 'selfie' - `credential_images` CredentialImage[] - `url` string — URL of the image - `descriptor` 'back' | 'front' - `esign_authentication_records` PhotoValidationAttempt[], nullable - `validation_source` 'lexis-flex' | 'identity-verification-service' | 'lexis' | 'noop' | 'persona' | 'firebase' | 'null' | 'none' | 'notakred', nullable - `verified_at` string — An ISO-8601 formatted DateTime String. - `verification_method` string, nullable - `images` object - `front` string - `back` string, nullable - `selfie` string, nullable - `status` 'success' | 'failure' | 'unknown' | 'skipped' | 'pending' | 'action_required' | 'deleted', nullable - `document_address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `document_claimed_type` 'bank_account_statement' | 'bank_investment_loan_statement' | 'birth_certificate' | 'certificate_of_citizenship' | 'citizen_id' | 'credit_or_debit_card_statement' | 'deed_of_trust' | 'driver_license' | 'foreigner_id' | 'healthcare_insurance' | 'i_94' | 'id_card' | 'internal_passport' | 'keypass_id' | 'lease' | 'long_term_pass_card' | 'matricula_consular' | 'mortgage' | 'municipal_id' | 'my_number_card' | 'nbi' | 'nexus_card' | 'ofw' | 'organizational_membership_card' | 'pan' | 'passport' | 'passport_card' | 'paycheck_stub' | 'permanent_resident_card' | 'postal_id' | 'property_insurance' | 'property_tax_bill' | 'residency_permit' | 'school_id_card' | 'social_security_card' | 'sss' | 'travel_document' | 'tribal_id' | 'umid' | 'us_visa' | 'utility_bill' | 'vehicle_registration' | 'voter_registration_card' | 'work_permit' | 'other' | 'unknown' - `document_classification` string, nullable - `document_date_of_birth` string, nullable - `document_expiration_date` string, nullable - `document_first_name` string, nullable - `document_middle_name` string, nullable - `document_last_name` string, nullable - `document_issue_date` string, nullable - `document_issuer` string, nullable - `document_number` string, nullable - `verified` boolean - `failure_reasons` object[] - `check` string - `category` 'aamva_failure' | 'fraud' | 'image_quality' | 'ineligible_id' | 'kba_mismatch' | 'not_classified' | 'user_action_required' - `reasons` string[] - `required` boolean - `verification_type` 'id' | 'selfie' - `notary_id` string, nullable — User ID ("us_xxxxxxx") of the assigned Notary or "notarize". Eligible notaries must be a notary who is a member of your organization. Order must be utilized with this field, all notarization signers with the same order must have the same notary_id. - `order` integer, nullable — Order the signers will sign in. Should be positive numbers starting with 1. Setting to the same order as another signer indicates they will sign at the same time. - `suppress_communications` boolean, nullable - `verify_tool_configuration` VerifyToolConfiguration - `requirement` 'run' | 'pass' | 'none', required — Setting indicating whether or not the verify tool will be required to run or pass, or both - `primary_front` string — URL of the front of the primary photo identification document. - `primary_back` string — URL of the back of the primary photo identification document. - `primary_type` string — Type of the primary photo identification document. - `primary_issuer` string — Issuer of the primary photo identification document. - `primary_expiry_date` string — Expiry date of the primary photo identification document. - `secondary_front` string — URL of the front of the secondary photo identification document. - `cosigner_info` Signer - `signer_id` string — Signer ID - `email` string, required — Email is required unless you provide a recipient_group object. - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `phone_number` string — Signer phone number. A country code can be defined by using the `+` symbol. For example, `+11234567890` will set the country code to `+1` for the number `1234567890`. If no country code is specified the default will be the United States country code of `+1`. - `phone` object, nullable - `country_code` string — The country code for the phone number, e.g. 1 - `number` string — The phone number without the country code, e.g. 5551234567 - `address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `dob` string — The signer's date of birth. - `capacity` string, nullable — The signers capacity when signing on behalf of an entity, required when entity is present - `entity` string, nullable — Entity the signer is signing on behalf of, required when capacity is present - `external_id` string, nullable — A string representing an ID external to Proof's systems. Use this to associate a signer to an ID that your systems understand, such as a User ID. - `link_expired` boolean — Indicates if the signer's passwordless link has expired. - `personally_known_to_notary` boolean — If the signer is personally known to the notary. This can currently only be used on single signer transactions, or when the notary_id is specified on the signer. - `proof_requirement` ProofRequirement - `id_verification` ProofRequirementIdVerification - `selfie` boolean, required — Signer identity is verified through credential analysis and selfie comparison. SMS multi_factor_authentication is required with this for IAL2 compliant identity verification. - `knowledge_based_authentication` boolean, required — (KBA) Signer answers a series of personal identity questions. - `multi_factor_authentication` ProofRequirementMultiFactorAuthentication - `type` 'sms', required — Signer enters authentication code sent to their mobile phone. - `recipient_group` RecipientGroup - `shared_inbox_email` string — The email address that is shared by a group. Whomever has access to this email address can claim the transaction for themself. - `sdk_token` string, nullable — Equivalent to transaction_access_link; prefer using that instead. - `signatory_capacities` object[] — An array of signatory capacities for the signer when signing on behalf of multiple entities. - `capacity` string - `type` 'attorney_in_fact' | 'corporate_officer' | 'guardian_or_conservator' | 'general_partner' | 'limited_partner' | 'trustee' | 'other' - `representative_of` string - `primary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `secondary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `signing_requirement` 'esign' | 'identify' | 'verify', nullable — Override the document signing requirement for an individual signer. - `signing_status` 'incomplete' | 'in_progress' | 'complete', nullable - `transaction_access_link` string — A link to the transaction for this signer. - `vesting_type` 'borrower' | 'non_borrower' — Can be either `borrower` or `non_borrower`. Defaults to `borrower`. - `credential_assets` CredentialAssetObject[], nullable - `credential_type` 'primary' | 'secondary' | 'selfie' - `credential_images` CredentialImage[] - `url` string — URL of the image - `descriptor` 'back' | 'front' - `esign_authentication_records` PhotoValidationAttempt[], nullable - `validation_source` 'lexis-flex' | 'identity-verification-service' | 'lexis' | 'noop' | 'persona' | 'firebase' | 'null' | 'none' | 'notakred', nullable - `verified_at` string — An ISO-8601 formatted DateTime String. - `verification_method` string, nullable - `images` object - `front` string - `back` string, nullable - `selfie` string, nullable - `status` 'success' | 'failure' | 'unknown' | 'skipped' | 'pending' | 'action_required' | 'deleted', nullable - `document_address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `document_claimed_type` 'bank_account_statement' | 'bank_investment_loan_statement' | 'birth_certificate' | 'certificate_of_citizenship' | 'citizen_id' | 'credit_or_debit_card_statement' | 'deed_of_trust' | 'driver_license' | 'foreigner_id' | 'healthcare_insurance' | 'i_94' | 'id_card' | 'internal_passport' | 'keypass_id' | 'lease' | 'long_term_pass_card' | 'matricula_consular' | 'mortgage' | 'municipal_id' | 'my_number_card' | 'nbi' | 'nexus_card' | 'ofw' | 'organizational_membership_card' | 'pan' | 'passport' | 'passport_card' | 'paycheck_stub' | 'permanent_resident_card' | 'postal_id' | 'property_insurance' | 'property_tax_bill' | 'residency_permit' | 'school_id_card' | 'social_security_card' | 'sss' | 'travel_document' | 'tribal_id' | 'umid' | 'us_visa' | 'utility_bill' | 'vehicle_registration' | 'voter_registration_card' | 'work_permit' | 'other' | 'unknown' - `document_classification` string, nullable - `document_date_of_birth` string, nullable - `document_expiration_date` string, nullable - `document_first_name` string, nullable - `document_middle_name` string, nullable - `document_last_name` string, nullable - `document_issue_date` string, nullable - `document_issuer` string, nullable - `document_number` string, nullable - `verified` boolean - `failure_reasons` object[] - `check` string - `category` 'aamva_failure' | 'fraud' | 'image_quality' | 'ineligible_id' | 'kba_mismatch' | 'not_classified' | 'user_action_required' - `reasons` string[] - `required` boolean - `verification_type` 'id' | 'selfie' - `notary_id` string, nullable — User ID ("us_xxxxxxx") of the assigned Notary or "notarize". Eligible notaries must be a notary who is a member of your organization. Order must be utilized with this field, all notarization signers with the same order must have the same notary_id. - `order` integer, nullable — Order the signers will sign in. Should be positive numbers starting with 1. Setting to the same order as another signer indicates they will sign at the same time. - `suppress_communications` boolean, nullable - `verify_tool_configuration` VerifyToolConfiguration - `requirement` 'run' | 'pass' | 'none', required — Setting indicating whether or not the verify tool will be required to run or pass, or both - `witnesses` Witness[] - `first_name` string - `middle_name` string - `last_name` string - `address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `credential_assets` CredentialAssetObject[] - `credential_type` 'primary' | 'secondary' | 'selfie' - `credential_images` CredentialImage[] - `url` string — URL of the image - `descriptor` 'back' | 'front' - `notarized_documents` Document[] - `id` string - `allowed_actions` string[] — List of allowed actions on document. - `bundle_position` integer — Position to put document in bundle - `completion_state` string - `data` string, nullable — base64 encoded document. Present if base64 encoding was specified in request. Currently supported for get_document only. - `date_created` string — Date document was created/uploaded. - `date_updated` string — Date document was last updated. - `document_name` string — Name of document. - `esign_required` boolean — Boolean flag indicating whether the document requires esigning. - `final_document_url` string, nullable - `identity_confirmation_required` boolean — Boolean flag indicating whether the document requires identity confirmation. - `is_enote` boolean — Boolean flag indicating whether the document is an eNote. - `notarization_required` boolean — Boolean flag indicating whether the document requires notarization. If `true`, identity_confirmation_required must be `false`. If `false`, the document may still be e-signed in the notary meeting. At least one document in a transaction must require notarization or identity confirmation. - `permissions` string[] - `processing_error` string, nullable — Error message if document processing failed. - `processing_state` string, nullable — State of document processing. - `rejection_anecdote` string, nullable — Anecdote for document rejection. - `rejection_reason` string, nullable — Reason for document rejection. - `requirement` string — Completion requirement for the document. Accepted values can be `notarization`, `esign`, `identity_confirmation` **([identity confirmation feature](https://dev.proof.com/docs/enterprise-features))**, `readonly`, and `non_essential`. Completion requirement for the document. If the value is set to `non_essential`, the document will be hidden from signers before the notary meeting and values for `customer_can_annotate` and `witness_required` will be ignored and set to false. `identity_confirmation` is used to support signing of PS Form 1583 for signers without a US SSN. Note: if `identity_confirmation` is set as the document requirement, ensure that all documents requiring notarization in the transaction also use `identity confirmation` as the requirement to avoid requiring KBA on the transaction. [Read more](https://dev.proof.com/docs/document-requirements) about document requirements. - `signed_url` string, nullable — Signed URL for the final document PDF. - `signing_designation_groups` SigningDesignationGroup[] — This array contains a prescribed list of groups of designations for signers and/or a notary to annotate the document. - `name` string — The specified name of the group, type string. Use a naming convention of your choice, the only restrictions are that the name must be between 1 and 64 characters and can consist of alpha-numeric characters, hyphens, parentheses, and underscores. Valid regular expression for you tech nerds is /^[a-zA-Z0-9_-()]{1,64}$/ - `min_required` integer — a positive integer between 0 and N where N is the minimum number of designations in the group that must be fulfilled (checked). - `max_required` integer — a positive integer between min_required and N where N is the maximum number of designations in the group that are allowed to be fulfilled. NOTE: max_required cannot be set to greater than 1 for designation groups used with radio_checkmark type signing designations. - `signing_designations` SigningDesignation[] — This array contains a prescribed list of designations for signers and/or a notary to annotate the document. - `id` string - `signer_identifier` string — For signers, the external_id value set on the signers array when creating a transaction; for witnesses, `witness{n}` i.e. `witness1` or `witness2`; for notaries, `notary` - `page_number` integer — The page of the designation, starting at 0 - `x` integer — The X coordinate (from bottom left) - `y` integer — The Y coordinate (from bottom left) - `height` integer — Height - `width` integer — Width - `hint` string — Hint - `type` 'date_signed' | 'day_signed' | 'month_signed' | 'year_signed' | 'first_name' | 'middle_name' | 'last_name' | 'full_name' | 'signature' | 'initials' | 'checkmark' | 'radio_checkmark' | 'free_text' | 'signature_and_date' | 'dob' | 'email' | 'address_line1' | 'address_line2' | 'address_zip5' | 'address_state' | 'address_city' | 'representative_capacity_type' | 'disclosure' | 'notary_id' | 'seal' | 'commission_expiration_date' | 'commission_state' | 'county' | 'commission_county' | 'principal_id_type' | 'notary_city' — The type of field designation. Accepted values for signers: dob, email, address_line1, address_line2, address_zip5, address_state, address_city, representative_capacity_type. Accepted values for notaries: disclosure, notary_id, seal, commission_expiration_date, commission_state, county, commission_county, principal_id_type, notary_city. Universal types: date_signed, day_signed, month_signed, year_signed, first_name, middle_name, last_name, full_name, signature, initials, checkmark, radio_checkmark, free_text, signature_and_date - `designation_group_id` string, nullable - `signing_designation_group` SigningDesignationGroup - `name` string — The specified name of the group, type string. Use a naming convention of your choice, the only restrictions are that the name must be between 1 and 64 characters and can consist of alpha-numeric characters, hyphens, parentheses, and underscores. Valid regular expression for you tech nerds is /^[a-zA-Z0-9_-()]{1,64}$/ - `min_required` integer — a positive integer between 0 and N where N is the minimum number of designations in the group that must be fulfilled (checked). - `max_required` integer — a positive integer between min_required and N where N is the maximum number of designations in the group that are allowed to be fulfilled. NOTE: max_required cannot be set to greater than 1 for designation groups used with radio_checkmark type signing designations. - `optional` boolean — Non-notary designation that is not part of a group can be set as optional - `instruction` string — Instruction specific to this signing designation to be shown to the signer - `primary_designation` object, nullable - `id` string - `primary_designation_identifier` string — Unique identification string to denote this designation is the primary designation - `conditional_on_primary` string — Identification string that denotes this designation is conditional on the designation with the same value set for primary_designation_identifier - `signing_type` string - `tracking_id` string, nullable — The external tracking ID of the document. - `verification_credentials` object - `retrieval_id` string - `retrieval_pin` string - `last_name` string, nullable - `date_completed` string - `signer_photo_identification` PhotoIdentification - `primary_front` string — URL of the front of the primary photo identification document. - `primary_back` string — URL of the back of the primary photo identification document. - `primary_type` string — Type of the primary photo identification document. - `primary_issuer` string — Issuer of the primary photo identification document. - `primary_expiry_date` string — Expiry date of the primary photo identification document. - `secondary_front` string — URL of the front of the secondary photo identification document. - `video_url` string — Download URL of the video recording of the meeting. - `chat_url` string, nullable — Download URL of the chat transcript of the meeting. - `notary_id` string, nullable - `notary_instructions` NotaryInstructions[], nullable - `notary_note` string — 500 character limit. - `notary_meeting_time` string, date-time, nullable - `order_progress` 'received' | 'preparing_order' | 'on_hold_final_cd' | 'on_hold_enote' | 'on_hold_name_discrepancy' | 'on_hold_other' | 'in_qc' | 'awaiting_lender_approval', nullable - `organization_id` string - `recall_reason` string, nullable — Reason for recalling the transaction. - `recording_jurisdiction` object, nullable - `id` string - `name` string - `state` string - `recording_type` string - `supported` boolean, nullable — Whether erecording is supported at the recording location - `eligible` boolean, nullable — Allowed legally and by organizations preferences. - `eligible_title_agencies` TitleAgency[], nullable — The title agencies that are eligible for the recording location. - `id` string — The ID of the title agency. - `name` string — The name of the title agency. - `alta_id` string, nullable — The ALTA ID of the title agency. - `address` string, nullable — The address of the title agency. - `eligible_underwriters` Organization[], nullable — The list of title underwriters that the title agency works with. - `id` string — The ID of the organization. - `name` string — The name of the organization. - `company_notaries` boolean — Whether the title agency has company notaries. - `eligible_title_underwriters` Organization[], nullable — The title underwriters that are eligible for the recording location. - `id` string — The ID of the organization. - `name` string — The name of the organization. - `redirect` object, nullable - `redirect_msg` string, nullable - `redirect_url` string, nullable - `forced_redirect` boolean - `referral_campaign_id` string, nullable — The ID of the referral campaign that the transaction is associated with. - `referral_code` string, nullable — The referral code that the transaction is associated with. - `require_secondary_photo_id` boolean - `signer_info` Signer - `signer_id` string — Signer ID - `email` string, required — Email is required unless you provide a recipient_group object. - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `phone_number` string — Signer phone number. A country code can be defined by using the `+` symbol. For example, `+11234567890` will set the country code to `+1` for the number `1234567890`. If no country code is specified the default will be the United States country code of `+1`. - `phone` object, nullable - `country_code` string — The country code for the phone number, e.g. 1 - `number` string — The phone number without the country code, e.g. 5551234567 - `address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `dob` string — The signer's date of birth. - `capacity` string, nullable — The signers capacity when signing on behalf of an entity, required when entity is present - `entity` string, nullable — Entity the signer is signing on behalf of, required when capacity is present - `external_id` string, nullable — A string representing an ID external to Proof's systems. Use this to associate a signer to an ID that your systems understand, such as a User ID. - `link_expired` boolean — Indicates if the signer's passwordless link has expired. - `personally_known_to_notary` boolean — If the signer is personally known to the notary. This can currently only be used on single signer transactions, or when the notary_id is specified on the signer. - `proof_requirement` ProofRequirement - `id_verification` ProofRequirementIdVerification - `selfie` boolean, required — Signer identity is verified through credential analysis and selfie comparison. SMS multi_factor_authentication is required with this for IAL2 compliant identity verification. - `knowledge_based_authentication` boolean, required — (KBA) Signer answers a series of personal identity questions. - `multi_factor_authentication` ProofRequirementMultiFactorAuthentication - `type` 'sms', required — Signer enters authentication code sent to their mobile phone. - `recipient_group` RecipientGroup - `shared_inbox_email` string — The email address that is shared by a group. Whomever has access to this email address can claim the transaction for themself. - `sdk_token` string, nullable — Equivalent to transaction_access_link; prefer using that instead. - `signatory_capacities` object[] — An array of signatory capacities for the signer when signing on behalf of multiple entities. - `capacity` string - `type` 'attorney_in_fact' | 'corporate_officer' | 'guardian_or_conservator' | 'general_partner' | 'limited_partner' | 'trustee' | 'other' - `representative_of` string - `primary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `secondary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `signing_requirement` 'esign' | 'identify' | 'verify', nullable — Override the document signing requirement for an individual signer. - `signing_status` 'incomplete' | 'in_progress' | 'complete', nullable - `transaction_access_link` string — A link to the transaction for this signer. - `vesting_type` 'borrower' | 'non_borrower' — Can be either `borrower` or `non_borrower`. Defaults to `borrower`. - `credential_assets` CredentialAssetObject[], nullable - `credential_type` 'primary' | 'secondary' | 'selfie' - `credential_images` CredentialImage[] - `url` string — URL of the image - `descriptor` 'back' | 'front' - `esign_authentication_records` PhotoValidationAttempt[], nullable - `validation_source` 'lexis-flex' | 'identity-verification-service' | 'lexis' | 'noop' | 'persona' | 'firebase' | 'null' | 'none' | 'notakred', nullable - `verified_at` string — An ISO-8601 formatted DateTime String. - `verification_method` string, nullable - `images` object - `front` string - `back` string, nullable - `selfie` string, nullable - `status` 'success' | 'failure' | 'unknown' | 'skipped' | 'pending' | 'action_required' | 'deleted', nullable - `document_address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `document_claimed_type` 'bank_account_statement' | 'bank_investment_loan_statement' | 'birth_certificate' | 'certificate_of_citizenship' | 'citizen_id' | 'credit_or_debit_card_statement' | 'deed_of_trust' | 'driver_license' | 'foreigner_id' | 'healthcare_insurance' | 'i_94' | 'id_card' | 'internal_passport' | 'keypass_id' | 'lease' | 'long_term_pass_card' | 'matricula_consular' | 'mortgage' | 'municipal_id' | 'my_number_card' | 'nbi' | 'nexus_card' | 'ofw' | 'organizational_membership_card' | 'pan' | 'passport' | 'passport_card' | 'paycheck_stub' | 'permanent_resident_card' | 'postal_id' | 'property_insurance' | 'property_tax_bill' | 'residency_permit' | 'school_id_card' | 'social_security_card' | 'sss' | 'travel_document' | 'tribal_id' | 'umid' | 'us_visa' | 'utility_bill' | 'vehicle_registration' | 'voter_registration_card' | 'work_permit' | 'other' | 'unknown' - `document_classification` string, nullable - `document_date_of_birth` string, nullable - `document_expiration_date` string, nullable - `document_first_name` string, nullable - `document_middle_name` string, nullable - `document_last_name` string, nullable - `document_issue_date` string, nullable - `document_issuer` string, nullable - `document_number` string, nullable - `verified` boolean - `failure_reasons` object[] - `check` string - `category` 'aamva_failure' | 'fraud' | 'image_quality' | 'ineligible_id' | 'kba_mismatch' | 'not_classified' | 'user_action_required' - `reasons` string[] - `required` boolean - `verification_type` 'id' | 'selfie' - `notary_id` string, nullable — User ID ("us_xxxxxxx") of the assigned Notary or "notarize". Eligible notaries must be a notary who is a member of your organization. Order must be utilized with this field, all notarization signers with the same order must have the same notary_id. - `order` integer, nullable — Order the signers will sign in. Should be positive numbers starting with 1. Setting to the same order as another signer indicates they will sign at the same time. - `suppress_communications` boolean, nullable - `verify_tool_configuration` VerifyToolConfiguration - `requirement` 'run' | 'pass' | 'none', required — Setting indicating whether or not the verify tool will be required to run or pass, or both - `signers` Signers[] - `signer_id` string — Signer ID - `email` string — Email is required unless you provide a recipient_group object. - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `phone_number` string — Signer phone number. A country code can be defined by using the `+` symbol. For example, `+11234567890` will set the country code to `+1` for the number `1234567890`. If no country code is specified the default will be the United States country code of `+1`. - `phone` object, nullable - `country_code` string — The country code for the phone number, e.g. 1 - `number` string — The phone number without the country code, e.g. 5551234567 - `address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `dob` string — The signer's date of birth. - `capacity` string, nullable — The signers capacity when signing on behalf of an entity, required when entity is present - `entity` string, nullable — Entity the signer is signing on behalf of, required when capacity is present - `external_id` string, nullable — A string representing an ID external to Proof's systems. Use this to associate a signer to an ID that your systems understand, such as a User ID. - `link_expired` boolean — Indicates if the signer's passwordless link has expired. - `personally_known_to_notary` boolean — If the signer is personally known to the notary. This can currently only be used on single signer transactions, or when the notary_id is specified on the signer. - `proof_requirement` ProofRequirement - `id_verification` ProofRequirementIdVerification - `selfie` boolean, required — Signer identity is verified through credential analysis and selfie comparison. SMS multi_factor_authentication is required with this for IAL2 compliant identity verification. - `knowledge_based_authentication` boolean, required — (KBA) Signer answers a series of personal identity questions. - `multi_factor_authentication` ProofRequirementMultiFactorAuthentication - `type` 'sms', required — Signer enters authentication code sent to their mobile phone. - `recipient_group` RecipientGroup - `shared_inbox_email` string — The email address that is shared by a group. Whomever has access to this email address can claim the transaction for themself. - `sdk_token` string, nullable — Equivalent to transaction_access_link; prefer using that instead. - `signatory_capacities` object[] — An array of signatory capacities for the signer when signing on behalf of multiple entities. - `capacity` string - `type` 'attorney_in_fact' | 'corporate_officer' | 'guardian_or_conservator' | 'general_partner' | 'limited_partner' | 'trustee' | 'other' - `representative_of` string - `primary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `secondary_id_allow_list_by_country` IdAllowListByCountry, nullable — A dictionary of id allow lists by country code, e.g. { "US": [ "driver_license", "passport" ], "CA": ["passport"] }, where the key is a 2 digit ISO-3166 country code, and the value is an array of id types. Primary ID lists must only contain government IDs (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card"]). Secondary ID lists can contain government IDs or supplemental documents (["driver_license", "passport", "id_card", "passport_card", "work_permit", "permanent_resident_card", "social_security_card", "us_visa", "birth_certificate", "property_tax_bill", "voter_registration_card", "organizational_membership_card", "bank_investment_loan_statement", "paycheck_stub", "property_insurance", "utility_bill", "other", "lease", "mortgage", "deed_of_trust", "vehicle_registration", "i_94", "matricula_consular", "nexus_card", "school_id_card"]). By default, validation is only run on the primary ID. Validation can be run on the secondary ID (if it is a government ID) by changing your organization's configuration. To use Proof's default ID options, use null, or do not pass this field. - `signing_requirement` 'esign' | 'identify' | 'verify', nullable — Override the document signing requirement for an individual signer. - `signing_status` 'incomplete' | 'in_progress' | 'complete', nullable - `transaction_access_link` string — A link to the transaction for this signer. - `vesting_type` 'borrower' | 'non_borrower' — Can be either `borrower` or `non_borrower`. Defaults to `borrower`. - `credential_assets` CredentialAssetObject[], nullable - `credential_type` 'primary' | 'secondary' | 'selfie' - `credential_images` CredentialImage[] - `url` string — URL of the image - `descriptor` 'back' | 'front' - `esign_authentication_records` PhotoValidationAttempt[], nullable - `validation_source` 'lexis-flex' | 'identity-verification-service' | 'lexis' | 'noop' | 'persona' | 'firebase' | 'null' | 'none' | 'notakred', nullable - `verified_at` string — An ISO-8601 formatted DateTime String. - `verification_method` string, nullable - `images` object - `front` string - `back` string, nullable - `selfie` string, nullable - `status` 'success' | 'failure' | 'unknown' | 'skipped' | 'pending' | 'action_required' | 'deleted', nullable - `document_address` Address - `line1` string — House number and Street name - `line2` string — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `document_claimed_type` 'bank_account_statement' | 'bank_investment_loan_statement' | 'birth_certificate' | 'certificate_of_citizenship' | 'citizen_id' | 'credit_or_debit_card_statement' | 'deed_of_trust' | 'driver_license' | 'foreigner_id' | 'healthcare_insurance' | 'i_94' | 'id_card' | 'internal_passport' | 'keypass_id' | 'lease' | 'long_term_pass_card' | 'matricula_consular' | 'mortgage' | 'municipal_id' | 'my_number_card' | 'nbi' | 'nexus_card' | 'ofw' | 'organizational_membership_card' | 'pan' | 'passport' | 'passport_card' | 'paycheck_stub' | 'permanent_resident_card' | 'postal_id' | 'property_insurance' | 'property_tax_bill' | 'residency_permit' | 'school_id_card' | 'social_security_card' | 'sss' | 'travel_document' | 'tribal_id' | 'umid' | 'us_visa' | 'utility_bill' | 'vehicle_registration' | 'voter_registration_card' | 'work_permit' | 'other' | 'unknown' - `document_classification` string, nullable - `document_date_of_birth` string, nullable - `document_expiration_date` string, nullable - `document_first_name` string, nullable - `document_middle_name` string, nullable - `document_last_name` string, nullable - `document_issue_date` string, nullable - `document_issuer` string, nullable - `document_number` string, nullable - `verified` boolean - `failure_reasons` object[] - `check` string - `category` 'aamva_failure' | 'fraud' | 'image_quality' | 'ineligible_id' | 'kba_mismatch' | 'not_classified' | 'user_action_required' - `reasons` string[] - `required` boolean - `verification_type` 'id' | 'selfie' - `order` integer, nullable — Order the signers will sign in. Should be positive numbers starting with 1. Setting to the same order as another signer indicates they will sign at the same time. - `notary_id` string, nullable — User ID ("us_xxxxxxx") of the assigned Notary or "notarize". Eligible notaries must be a notary who is a member of your organization. Order must be utilized with this field, all notarization signers with the same order must have the same notary_id. - `suppress_communications` boolean, nullable - `verify_tool_configuration` VerifyToolConfiguration - `requirement` 'run' | 'pass' | 'none', required — Setting indicating whether or not the verify tool will be required to run or pass, or both - `status` string - `status_description` string - `street_address` StreetAddress - `full_address` string — The full address written as a single line. - `line1` string — House number and Street name - `line2` string, nullable — Unit number - `city` string — Town name - `state` string — Only two character state abbreviations are accepted. i.e. "CO". - `postal` string — Five or ten digit postal code. - `country` string — Only two character country codes are accepted. i.e. "US". - `title_agency` TitleAgency - `id` string — The ID of the title agency. - `name` string — The name of the title agency. - `alta_id` string, nullable — The ALTA ID of the title agency. - `address` string, nullable — The address of the title agency. - `eligible_underwriters` Organization[], nullable — The list of title underwriters that the title agency works with. - `id` string — The ID of the organization. - `name` string — The name of the organization. - `company_notaries` boolean — Whether the title agency has company notaries. - `title_underwriter` Organization - `id` string — The ID of the organization. - `name` string — The name of the organization. - `transaction_name` string - `transaction_type` string, nullable - `underwriter_override` boolean ## Other responses - `400` — Bad Request - `401` — Unauthorized - `404` — Not Found - `422` — Unprocessable Entity --- [API](https://skmtc.net/proof/apis/proof-business-api-specification.md) · [All operations](https://skmtc.net/proof/apis/proof-business-api-specification/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/proof/proof-business-api-specification/versions/1adaa0ea25cd/schema)