--- title: "Retrieve Meeting Record" method: GET path: "/mortgage/v2/notarization_records/{id}" tags: ["Notarization Records"] --- # Retrieve Meeting Record `GET /mortgage/v2/notarization_records/{id}` ## Request - Base URL: `https://api.proof.com` - URL: `https://api.proof.com/mortgage/v2/notarization_records/{id}` - Auth: API key in header `ApiKey` ## Path parameters - `id` string, required ## Query parameters - `document_url_version` 'v1' | 'v2' ## Response `200` successful - 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` NotarizationRecordSignerObject - `signer_id` string, nullable: Signer ID - `email` string: Email - `first_name` string: First name - `middle_name` string, nullable: Middle name - `last_name` string: Last name - `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. - `signers` object[] - `signer_id` string, nullable: Signer ID - `email` string: Email - `first_name` string: First name - `middle_name` string, nullable: Middle name - `last_name` string: Last name - `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. - `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` NotarizationRecordSignerObject - `signer_id` string, nullable: Signer ID - `email` string: Email - `first_name` string: First name - `middle_name` string, nullable: Middle name - `last_name` string: Last name - `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. - `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](doc: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](doc: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' | '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, 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 - `404`: invalid id --- [API](https://skmtc.dev/proof/apis/proof-real-estate-api-specification.md) - [All operations](https://skmtc.dev/proof/apis/proof-real-estate-api-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/proof/apis/proof-real-estate-api-specification/revisions/30d9780cb628?raw)