To invoke Notary API, you will need:
- transaction_id, a unique identifier for Staircase operations.
- collection_id, a unique identifier that contains Staircase V2 data that is going to send to the partner.
- vendor_name, a supported vendor name for this operation
- product_flow_name, a Staircase Connector flow name that is going to be executed in the process.
- callback_url, URL for getting result of this asynchronous operation.(optional)
To send a file to e-notary partner, there are some mandatory Staircase containers you should store in the collection that you provide in the input:
- documents container for storing the document itself, document id, document name.(optional, documents can be generated if it's missing)
- contact_point_emails container for storing signer email information.
- addresses container for storing subject property address information.
- loan_identifiers container for storing loan identifier information.
- terms_of_loans container for storing purpose type and note amount information
- contact_points container for establishing relationship between person and email.
- people container for signer name and establishing relationship between person and contact point.
- closing_information container for storing closing date information.
- sales_contracts container for storing sale price information.
Example Staircase Collection data:
{
"closing_information": [
{
"has_closing_date": {
"has_value": "2022-12-27"
},
"@type": "closing_information",
"@id": "01GMX7JA3NFZTXYJCQAYJB36C8"
}
],
"contact_point_emails": [
{
"@type": "contact_point_email",
"@id": "01GMX7JA3MJMZCS0GSZAB48RV0",
"has_contact_point_email_value": {
"has_value": "utku.ozdil@staircase.co"
}
},
{
"@type": "contact_point_email",
"@id": "01GMX7JA3MJMZCS0GSZAB48RV1",
"has_contact_point_email_value": {
"has_value": "utku.ozdil1@staircase.co"
}
}
],
"addresses": [
{
"has_address_line_1_text": {
"has_value": "TEST ROAD"
},
"has_state_code": {
"has_value": "AL"
},
"@type": "subject_property_address",
"@id": "sprop_RWbmV8HG5TRDHwutizUiRM",
"has_country_name": {
"has_value": "US"
},
"has_postal_code": {
"has_value": "35020"
},
"has_city_name": {
"has_value": "HELENA"
}
}
],
"loan_identifiers": [
{
"has_loan_identifier_type": {
"has_value": "lender_loan"
},
"@type": "loan_identifier",
"has_loan_identifier_value": {
"has_value": "STAIRCASE_DEMO"
},
"@id": "01GMX7JA3NDAYKA02ZC3P4TXWS"
}
],
"contact_points": [
{
"with_contact_point_email": [
"01GMX7JA3MJMZCS0GSZAB48RV0"
],
"@type": "contact_point",
"@id": "01GMX7JA3M17XW1C0N71T4TS1J"
},
{
"with_contact_point_email": [
"01GMX7JA3MJMZCS0GSZAB48RV1"
],
"@type": "contact_point",
"@id": "01GMX7JA3M17XW1C0N71T4TS1K"
}
],
"terms_of_loans": [
{
"has_loan_purpose_type": {
"has_value": "purchase"
},
"@id": "01GMX7JA3N7QV53DA8K922HB7N",
"has_note_amount": {
"has_value": 100000
},
"@type": "terms_of_loan"
}
],
"people": [
{
"has_full_name": {
"has_value": "STAIRCASE TEST USER"
},
"with_contact_point": [
"01GMX7JA3M17XW1C0N71T4TS1J"
],
"@id": "utku.ozdil@staircase.co",
"@type": "borrower"
},
{
"has_full_name": {
"has_value": "STAIRCASE TEST USER 2"
},
"with_contact_point": [
"01GMX7JA3M17XW1C0N71T4TS1K"
],
"@id": "utku.ozdil1@staircase.co",
"@type": "lender"
}
],
"sales_contracts": [
{
"@type": "sales_contract",
"has_sales_contract_amount": {
"has_value": 1000000
},
"@id": "01GMX7JA3NZSKH4QYQPTEJ2V6N"
}
]
}
Example Staircase Collection data for a document after Document generation:
{
"document_form_fields": [
{
"@id": "SignatureDate1",
"@type": "form_field_text",
"with_field_reference": [
"01GKXY7YJBJSMBK5PHZK1ZXZVK"
],
"with_signer": [
"BOR1"
]
},
{
"@id": "SignerSignature1",
"@type": "form_field_signature",
"with_field_reference": [
"01GKXY7YJB26S751TBTBNHN74E"
],
"with_signer": [
"BOR1"
]
}
],
"document_forms": [
{
"@id": "01GKXY7YJBY543NCPQXS51VP6S",
"@type": "document_form",
"with_document_form_field": [
"01GKXY7YJBAZ731PHEW6GR71KB",
"01GKXY7YJBCFD5XTRTQHFGJGKD"
]
}
],
"documents": [
{
"@id": "18566",
"@type": "document",
"has_document_name": {
"has_value": "Closing Disclosure (John Test)"
},
"has_staircase_blob_identifier": {
"has_value": "01GKXY7V1F3RGVGTW5FY28GWFT"
},
"with_document_form": [
"01GKXY7YJBY543NCPQXS51VP6S"
]
}
],
"field_references": [
{
"@id": "01GKXY7YJBJSMBK5PHZK1ZXZVK",
"@type": "field_reference",
"has_field_height_number": {
"has_value": 10
},
"has_field_width_number": {
"has_value": 40.68
},
"has_offset_from_left_number": {
"has_value": 256.1
},
"has_offset_from_top_number": {
"has_value": 188.56
},
"has_page_number_value": {
"has_value": "5"
}
},
{
"@id": "01GKXY7YJB26S751TBTBNHN74E",
"@type": "field_reference",
"has_field_height_number": {
"has_value": 15.4
},
"has_field_width_number": {
"has_value": 194.04
},
"has_offset_from_left_number": {
"has_value": 28.8
},
"has_offset_from_top_number": {
"has_value": 186.06
},
"has_page_number_value": {
"has_value": "5"
}
}
]
}
Example Staircase response for Retrieve File operation:
{
"closing_information": [
{
"has_closing_date": {
"has_value": "2022-12-27"
},
"@type": "closing_information",
"@id": "01GNVY2GKZZ154SCVTG3WT419K"
}
],
"contact_point_emails": [
{
"@type": "contact_point_email",
"@id": "01GNVY2GKZ2FW6FVKJW2NFB74W",
"has_contact_point_email_value": {
"has_value": "utku.ozdil@staircase.co"
}
},
{
"@type": "contact_point_email",
"@id": "01GNVY2GKZX4P8MN9QKW0HJ0N8",
"has_contact_point_email_value": {
"has_value": "utku.ozdil1@staircase.co"
}
}
],
"addresses": [
{
"has_address_line_1_text": {
"has_value": "TEST ROAD"
},
"has_state_code": {
"has_value": "AL"
},
"@type": "subject_property_address",
"@id": "sprop_XxdZMVAzMJ8ty9CrESh4PY",
"has_country_name": {
"has_value": "US"
},
"has_postal_code": {
"has_value": "35020"
},
"has_city_name": {
"has_value": "HELENA"
}
}
],
"documents": [
{
"@id": "filedoc_fdBXc9PRynQy4jg8dfLUPg",
"has_document_signed_indicator": {
"has_value": false
},
"has_staircase_blob_identifier": {
"has_value": "01GNVY2DDEM6K57HBBM4BP4C7P"
},
"@type": "document"
},
{
"@id": "filedoc_2KmscMkesntZnREiBSeTXP",
"has_document_signed_indicator": {
"has_value": false
},
"has_staircase_blob_identifier": {
"has_value": "01GNVY2EFXQGMS5PFK0FA047CE"
},
"@type": "document"
},
{
"@id": "filedoc_FRMjvbgyYY3FPYk8ParAkY",
"has_document_signed_indicator": {
"has_value": false
},
"has_staircase_blob_identifier": {
"has_value": "01GNVY2E9EG2BVPJD1DZJFT2TP"
},
"@type": "document"
},
{
"@id": "filedoc_LRNh6osA3PVDj5tnPDouai",
"has_document_signed_indicator": {
"has_value": false
},
"has_staircase_blob_identifier": {
"has_value": "01GNVY2DZ0M8W6Y1KJYBD7QYSD"
},
"@type": "document"
},
{
"@id": "filedoc_UuxRL8mjFD6HBkuqYbarNf",
"has_document_signed_indicator": {
"has_value": false
},
"has_staircase_blob_identifier": {
"has_value": "01GNVY2EQ9TRG4XBVYN6DG839W"
},
"@type": "document"
},
{
"@id": "filedoc_k2viwb7N92kN6XJohVNq42",
"has_document_signed_indicator": {
"has_value": false
},
"has_staircase_blob_identifier": {
"has_value": "01GNVY2DPHEFHQP4M5GTZX7MSZ"
},
"@type": "document"
}
],
"customer_requests": [
{
"@type": "customer_request",
"has_customer_request_identifier": {
"has_value": "file_L3uAMczFbzbUt4GqJhYsJ6"
},
"@id": "01GNVY2GKZ17BWFDFTZ0WGBFQH"
}
],
"loan_identifiers": [
{
"@type": "loan_identifier",
"has_loan_identifier_value": {
"has_value": "STAIRCASE_DEMO"
},
"@id": "01GNVY2GKZZ01V63234K08CZYJ"
}
],
"contact_points": [
{
"with_contact_point_email": [
"01GNVY2GKZ2FW6FVKJW2NFB74W"
],
"@type": "contact_point",
"@id": "01GNVY2GKZ1AXV165ZC57ZHB8M"
},
{
"with_contact_point_email": [
"01GNVY2GKZX4P8MN9QKW0HJ0N8"
],
"@type": "contact_point",
"@id": "01GNVY2GKZV669YHX85Q7ASNJT"
}
],
"terms_of_loans": [
{
"has_loan_purpose_type": {
"has_value": "purchase"
},
"@id": "01GNVY2GKZ1YJT6500TQ4CVRZZ",
"has_note_amount": {
"has_value": 100000
},
"@type": "terms_of_loan"
}
],
"people": [
{
"has_last_name": {
"has_value": "USER"
},
"with_contact_point": [
"01GNVY2GKZ1AXV165ZC57ZHB8M"
],
"@id": "01GNVY2GKZ9NMSCVZJQHJR41AF",
"has_first_name": {
"has_value": "STAIRCASE"
},
"has_middle_name": {
"has_value": "TEST"
},
"@type": "borrower"
},
{
"has_last_name": {
"has_value": "USER"
},
"with_contact_point": [
"01GNVY2GKZV669YHX85Q7ASNJT"
],
"@id": "01GNVY2GKZXB7GJ8M5S879MDZH",
"has_first_name": {
"has_value": "STAIRCASE"
},
"has_middle_name": {
"has_value": "TEST"
},
"@type": "person"
}
],
"sales_contracts": [
{
"@type": "sales_contract",
"has_sales_contract_amount": {
"has_value": 1000000
},
"@id": "01GNVY2GKZBBEZZK8YHFE0XNX4"
}
]
}
