Appendix Workaround
A reference guide of objects returned by the Notarize API.
The details Field
Used in the user_failed_transaction event. A user can fail a transaction for a number of reasons.
Attributes
| value | description |
|---|---|
| User Exceeded Authentication Attempts | The user failed to pass the knowledge authentication questions 2+ times in a 24 hour period. |
{
"event": "user_failed_transaction",
"data": {
"transaction_id": "ot_ny695pd",
"details": "User Exceeded Authentication Attempts"
}
}
The status Field
Used in the transaction_status_update event. A transaction changes between one of the following status states.
A transaction may not go through every state. For example, if
suppress_emailis set tofalsewhen creating a transaction, thereceivedstate may never be entered; similarly, thesentstate would be entered, but no email was actually sent.
Attributes
| value | description |
|---|---|
| started | The transaction was created, but has not been sent to the signer. Transactions that have a state of started can be modified. |
| sent | The transaction was sent by Notarize to the signer. For RealEstate: the transaction is only sent after the title documents have been added and a clear-to-close has provided by you and the title agency. |
| received | The signer has received and opened the invitation email. |
| completed | The transaction was completed successfully and the completed documents can be recalled. |
| deleted | The transaction was deleted in the UI or via API. |
| expired | Expiration date on the transaction was passed before the transaction was completed. |
{
"event": "transaction_status_update",
"data": {
"transaction_id": "ot_wd3y67d",
"status": "received"
}
}
The cosigner Object
Object passed in when creating or updating a transaction_object.
Arguments
| name | description |
|---|---|
| first_name (string) optional | First name of the cosigner. |
| last_name (string) optional | Last name of the cosigner. |
{
"first_name": "Joe",
"last_name": "Bernstein"
}
The cosigner_info Object
Returned as part of the transaction object.
In the context of a transaction, the cosigner_info object will only contain information provided by you during the creation of the transaction. In the context of a notarization_record, the cosigner_info object will contain the information provided by the cosigner.
Attributes
| name | description |
|---|---|
| first_name (string) | First name of the cosigner. |
| last_name (string) | Last name of the cosigner. |
| email (string) | Email address of the cosigner. |
| dob (string) | Date of birth of the cosigner. |
| address (address JSON object) | Address of the cosigner. |
{
"email": "[email protected]",
"first_name": "Cosigner",
"last_name": "Signerson",
"dob": "1996-05-19",
"address": {
"line1": "1005 Langley Street",
"line2": "Apt. 101",
"city": "Victoria",
"state": "CA",
"postal": "91210",
"country": "US"
}
}
The document Object
Attributes
| name | description |
|---|---|
| id (string) | A unique identifier for the document. |
| date_created (string) | Date this document was created, in ISO-8601 format. |
| date_updated (string) | Date this document was updated, in ISO-8601 format. |
| document_name (string) | Name of the document. |
| *permissions (array) | Possible values are CUSTOMER_CAN_ANNOTATE, WITNESS_REQUIRED, COLLATERAL_DOCUMENT, IDENTITY_CONFIRMATION_REQUIRED, and NOTARIZATION_REQUIRED. |
| bundle_position (integer) | 0 indexed position of the document within the bundle. |
| is_enote (boolean) | A boolean indicating that the document is an eNote document. |
{
"id": "do_0004af63-7b4e-422d-93d2-4f053dea39c2",
"date_created": "2017-05-09T16:46:39.767123Z",
"date_updated": "2017-05-09T16:46:39.767123Z",
"document_name": "Document.pdf",
"permissions": [
"NOTARIZATION_REQUIRED"
],
"bundle_position": 0,
"is_enote": false
}
The eNote Object
eNote objects are simply document objects except that the is_enote attribute of the document is true.
The notarized_document Object
Returned in the Recall Completed Documents endpoint.
Attributes
| name | description |
|---|---|
| notarial_acts (array of strings) | The notarial act performed during the notary meeting on this document. Specified by notary. A single document can have multiple notarial acts. Possible notarial acts are: acknowledgement, copy_certification, verification_of_fact, oath_affirmation, jurat. |
| document_url (string) | A signed S3 link of the notarized document. |
{
"notarial_acts": [
"copy_certification",
"acknowledgement"
],
"document_url": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/document.pdf?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D"
}
The notarization_record Object
Attributes
| name | description |
|---|---|
| id (string) | ID of the notarization record. |
| meeting_start (string) | Date the notary meeting started, in ISO-8601 format. |
| meeting_end (string) | Date the notary meeting ended, in ISO-8601 format. |
| notary_name (string) | The name of the notary agent who conducted the notary meeting. |
| notary_registration (string) | The registration number of the notary agent who conducted the notary meeting. |
| signer_info (object) | A signer_info object with information given by the signer. This may differ from the signer_info attached to a transaction eg. the user used a different spelling of their name. |
| notarized_documents (array of objects) | An array of notarized_document objects. |
| verification_credentials (object) | A verification_credentials object. |
| signer_photo_identification (object) | A signer_photo_identification object. |
{
"id": "me_rnykzyn",
"meeting_start": "2016-10-01T18:52:44.725Z",
"meeting_end": "2016-10-01T18:58:54.245Z",
"notary_name": "Leeroy Jenkins",
"notary_registration": "1337",
"signer_info": {
"email": "[email protected]",
"first_name": "Miguel",
"last_name": "Lee"
},
"notarized_documents": [
{
"notarial_acts": [
"copy_certification",
"acknowledgement"
],
"document_url": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/document.pdf?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D"
}
],
"verification_credentials": {
"retrieval_id": "CTJHT32H",
"retrieval_pin": "7RNTNN",
"last_name": "Lee",
"date_completed": "10/19/2016"
},
"signer_photo_identification": {
"primary_front": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_front.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D",
"primary_back": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_back.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D",
"secondary_front": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_back.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D"
}
}
The recording_jurisdiction Object
Note
Only for the RealEstate API.
Attributes
| name | description |
|---|---|
| id (string) | A unique identifier for the recording jurisdiction. |
| name (string) | The name of the recording jurisdiction. |
| state (string) | The US state the recording jurisdiction exists within. |
| supported (boolean) | Whether a fully online closing can be performed in this area. |
| eligible_title_agencies (collection of title_agency objects) | Any title agencies who are eligible to participate in a transaction in this area. Only present for lender users. |
| eligible_title_underwriters (collection of title_underwriter objects) | Any title underwriters who are eligible to participate in a transaction in this area. Only present for title_agency users. |
{
"id": "rl6rn64np",
"name": "Suffolk",
"state": "MA",
"supported": true,
"eligible_title_agencies": [],
"eligible_title_underwriters": []
}
The signer Object
Object passed in when creating or updating a transaction object.
Arguments
| name | description |
|---|---|
| email (string) required | The email address of the primary signer. |
| first_name (string) optional | The first name of the primary signer. |
| last_name (string) optional | The last name of the primary signer. |
{
"email": "[email protected]",
"first_name": "Signer",
"last_name": "Signerson"
}
The signer_info Object
Returned as part of the notarization and transaction record.
In the context of a transaction, the signer_info object will only contain information provided by you during the creation of the transaction. In the context of a notarization_record, the signer_info object will contain the information provided by the signer.
Attributes
| name | description |
|---|---|
| first_name (string) | The first name of the primary signer. |
| last_name (string) | The last name of the primary signer. |
| email (string) | The email address of the primary signer. |
| transaction_access_link (string) | |
| dob (string) | Date of birth in MM-DD-YYYY format. |
| address (address JSON object) | Address of the primary signer. |
{
"email": "[email protected]",
"first_name": "Signer",
"last_name": "Signerson",
"transaction_access_link": "https://app.notarize.com/activate-transaction?bundle_id=some-bundle-id&code=some-code&[email protected]",
"dob": "1996-05-19",
"address": {
"line1": "1005 Langley Street",
"line2": "Apt. 101",
"city": "Victoria",
"state": "CA",
"postal": "91210",
"country": "US"
}
}
The signer_photo_identification Object
The signer_photo_identification object is only returned with a notarization_record for partners with this feature enabled. Please contact [email protected] if you need signer ID images returned.
Attributes
| name | description |
|---|---|
| primary_front (string) | A signed S3 link of the front of the signer's primary photo identification. |
| primary_back (string) | A signed S3 link of the back of the signer's primary photo identification. |
| secondary_front (string) | A signed S3 link of the front of the signer's secondary photo identification. Only returned if a secondary form of identification was captured. |
{
"primary_front": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_front.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D",
"primary_back": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_back.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D",
"secondary_front": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_back.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D"
}
The street_address Object
Returned as part of the transaction object, and used as input for transaction creation and verifying an address
When this object is returned, the full_address attribute will be set, but this attribute cannot be used currently as input.
Attributes
| name | description |
|---|---|
| line1 (string) | The first line of the address. |
| line2 (string) | The second line of the address. |
| city (string) | The city/town of the address. |
| state (string) | The two character abbreviation for the US state of the address. |
| zip_code (string) | The ZIP code for the address. |
| full_address (string) | The combined street address. Only included in responses. |
{
"line1": "745 Boylston St.",
"line2": "Suite 600",
"city": "Boston",
"state": "MA",
"zip_code": "02116",
"full_address": "745 Boylston St. Suite 600 Boston MA 02116"
}
The title_agency Object
Attributes
| name | description |
|---|---|
| id (string) | A unique identifier for the title agency. |
| name (string) | The name of the title agency. |
| alta_id (string) | The ALTA Universal ID for the title agency. |
| elligible_underwriters (collection of title_underwriter objects) | Any title underwriters who are eligible to participate in a transaction with this title agency. |
{
"id": "or8znm4dd",
"name": "Title Agency Company",
"alta_id": "123",
"eligible_underwriters": []
}
The title_underwriter Object
Attributes
| name | description |
|---|---|
| id (string) | A unique identifier for the title underwriter. |
| name (string) | The name of the title underwriter. |
{
"id": "oryxdwjnk",
"name": "Title Underwriter Company"
}
The transaction Object
If you'd like broader details on what the transaction experience is like, or how to create, modify, and handle transactions from the Notarize app, see our Transactions guide.
Attributes
| name | description |
|---|---|
| id (string) | A unique identifier for the transaction. |
| date_created (string) | Date this transaction was created, in ISO-8601 format. |
| date_updated (string) | Date this transaction was updated, in ISO-8601 format. |
| transaction_name (string) | Short, human-readable name for the transaction - eg. Miguel's TPS notarization for Leeroy. Only returned if transaction_name was set when the transaction was created. |
| transaction_type (string - Business API) (enumeration - Real Estate API) | Short, human-readable description of the transaction. Can be used to categorize transactions by their purpose or by general type. Only returned if transaction_type was set when the transaction was created. |
| require_secondary_photo_id (boolean) | When true, the signer cannot proceed to a notary meeting without providing two forms of photo ID for verification. When false, only one form of photo ID is required. |
| loan_number (string) Real Estate API only | 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. However, once an eNote is added to the transaction, the loan_number value is overwritten with the loan number that is embedded within the eNote to avoid the potential for conflict. |
| 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. |
| activation_time (string) Real Estate API only | An ISO-8061 formatted DateTime String, optionally including a timezone offset. If timezone offset is not provided, the Notarize for Mortgage 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. |
| expiration_time (string) Real Estate API only | An ISO-8061 formatted DateTime String, optionally including the timezone offset. If timezone offset is not provided, the accounts default timezone settings will be applied. This param sets an expiration period on the transaction. |
| documents (object) | The list of document objects that make up the transaction bundle. |
| signer_info (object) | A signer_info object which only includes information that you set when creating the transaction. |
| cosigner_info (object) | A cosigner_info object which inlcudes the cosigner information set when creating the transaction. |
| street_address (object) | A street_address object representing the street_address associated with the transaction. |
| recording_jurisdiction (object) Real Estate API only | A recording_jurisdiction object representing the recording_jurisdiction associated with the transaction. |
| title_agency (object) Real Estate API only | A title_agency object representing the title_agency associated with the transaction. |
| title_underwriter (object) Real Estate API only | A title_underwriter object representing the title_underwriter associated with the transaction. |
| status (string) | Set to one of the status values. |
| notarization_record (string) | An ID to retrieve the notarization_record for this transaction, including the notarized document. Only returned if the transaction's status is completed. |
| message_to_signer (string) Business API only | 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. Only returned if a message_to_signer was provided during transaction creation. |
| message_signature (string) Business API only | A message signature to append to message_to_signer. Only returned if a message_signature was provided during transaction creation. |
{
"id": "ot_anpr8qn",
"date_created": "2016-10-01T18:52:44.725Z",
"date_updated": "2016-10-02T20:13:54.245Z",
"transaction_name": "Johnson Refi - San Antonio",
"transaction_type": "30 Year Owner/Occupied Refinance",
"require_secondary_photo_id": true,
"loan_number": "12345678",
"file_number": "87654321",
"activation_time": "2017-09-03T18:37:42.000-03:00",
"expiration_time": "2017-09-06T18:37:42-03:00",
"documents": [
{
"id": "do_0004af63-7b4e-422d-93d2-4f053dea39c2",
"date_created": "2017-05-09T16:46:39.767123Z",
"date_updated": "2017-05-09T16:46:39.767123Z",
"document_name": "pdf.pdf",
"allowed_actions": [
"NOTARIZATION_REQUIRED"
],
"bundle_position": 0
},
{
"id": "do_d0e14332-bc40-493d-b710-48719bf077b5",
"date_created": "2017-05-09T16:46:40.685716Z",
"date_updated": "2017-05-09T16:46:40.685716Z",
"document_name": "pdf-sample.pdf",
"allowed_actions": [
"NOTARIZATION_REQUIRED"
],
"bundle_position": 1
}
],
"signer_info": {
"email": "[email protected]",
"first_name": "Signer",
"last_name": "Signerson",
"transaction_access_link": "https://app.notarize.com/activate-transaction?bundle_id=some-bundle-id&code=some-code&[email protected]"
},
"cosigner_info": {
"first_name": "Bill",
"last_name": "Mann"
},
"street_address": {
"line1": "745 Boylston St.",
"line2": "Suite 600",
"city": "Boston",
"state": "MA",
"zip_code": "02116",
"full_address": "745 Boylston St. Suite 600 Boston MA 02116"
},
"recording_jurisdiction": {
"id": "rl6rn64np",
"name": "Suffolk",
"state": "MA",
"supported": true
},
"title_agency": {
"id": "or8znm4dd",
"name": "Title Agency Company",
"alta_id": "123"
},
"title_underwriter": {
"id": "oryxdwjnk",
"name": "Title Underwriter Company"
},
"status": "completed",
"notarization_record": "me_rnykzyn"
}
The verification_credentials Object
The verification_credentials object holds all the information required for anyone to verify the notarized document at Proof's Verification Portal.
This information may be useful to include in transactional emails that your service sends to relying parties, or for display in a secure dashboard or other internal systems. You should be selective and careful about who can access the information since it can be used to retrieve the notarized document as well as personal information of the signer.
Attributes
| name | description |
|---|---|
| retrieval_id (string) | Document ID in the verification portal. |
| retrieval_pin (string) | Document PIN in the verification portal. |
| last_name (string) | The signer's last name. |
| date_completed (string) | Date of notarization in ISO-8601 format. |
{
"retrieval_id": "CTJHT32H",
"retrieval_pin": "7RNTNN",
"last_name": "Lee",
"date_completed": "10/19/2016"
}
One H2 Header
Updated 9 months ago