--- title: "Retrieve Meeting Records" method: GET path: "/v1/notarization_records" tags: ["Notarization Records"] --- # Retrieve Meeting Records `GET /v1/notarization_records` ## Query parameters - `limit` number - `offset` number - `document_url_version` 'v1' | 'v2' ## Response `200` successful - object - `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. ## Other responses - `401` — invalid api_key --- [API](https://skmtc.dev/proof/apis/proof-business-api-specification.md) · [All operations](https://skmtc.dev/proof/apis/proof-business-api-specification/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/proof/proof-business-api-specification/revisions/1adaa0ea25cd/schema)