NotaryLive Order Creation API Changelogs

Back to Docs
Return to NotaryLive

Changelog

Version 3.0.0

  • Remove options array parameter; all parameters that used to go in the options array are now passed as top-level parameters
  • Update endpoint /iframe/create to /whitelabel/create
  • Update document_notarized webhook event to documents_notarized
  • Remove order_expired webhook event; return order_canceled instead
  • Update the link_to_document property in the documents_notarized webhook event to links_to_documents, and update the corresponding value to always be an array, regardless of the number of document links
  • Add endpoint /order/video, giving secure download access to the video recording of the notarization
  • Add video_ready_for_download webhook event
  • Update endpoint /order/ids to use GET request instead of POST
  • Add document_tags parameter for the /order/create and /whitelabel/create endpoints
  • Update the participants property in the documents_notarized webhook event from a string to an array of objects
  • Add the has_additional_client_steps parameter for the /order/create endpoint
  • Add the notary parameter for the /order/create and /whitelabel/create endpoints

Version 2.0.0

  • Modify request body format to include the following new parameters; for more info click here
    • Add options array parameter that accepts more order/iframe creation customization features
    • Add options.charge_to
    • Add options.client_can_add_or_remove_participants
    • Add options.client_can_change_names
    • Add options.company_email
    • Add options.confirmation_btn_text
    • Add options.confirmation_btn_url
    • Add options.disable_followup_session_email
    • Add options.disable_kba_retake_email
    • Add options.expired_order_redirect
    • Add options.instructions
    • Add options.internal_id
    • Add options.limit_doc_editing
    • Add options.receive_files_as_attachments
    • Add options.requires_proof_of_address
    • Add options.send_initial_session_link_email
    • Add options.sender_message
    • Add options.skip_upload_doc_page
    • Add options.skip_edit_doc_page
    • Add options.template_id
    • Add options.uszoom_session_type
    • Add options.webhook_url
    • Add participants
    • Add participants.*.email
    • Add participants.*.first_name
    • Add participants.*.last_name
    • Add participants.*.preupload_id
    • Add participants.*.type
    • Add participants.*.participant_id_type
    • Add participants.*.participant_proof_of_address_requested
    • Add templated_documents_fields
    • Add templated_documents_fields.*.fields
    • Add templated_documents_fields.*.file_id
    • Add sandbox_header
  • Add endpoints /order/ids, /order/status, and /id/upload
  • Add participants value to document_notarized webhook event
  • Add the has_additional_client_steps parameter for the /order/create endpoint
  • Add the notary parameter for the /order/create and /iframe/create endpoints

Version 1.0.0

  • Initial release