Create Session

post

https://app.bluenotary.us/api/integrationsv2/sessions/

API endpoint to create a new session.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

signing_type

string

enum

Defaults to ron

Product to be used, can be "ron" (Remote Online Notarization), "esign" (eSignature only), "ipen" (In Person Notarization)

Allowed:

notarization_id

string

Hidden unique ID for this session - can be any alphanumeric string. After the session is completed, you'll receive this as a query parameter in the session completion page.

all_signers

array of objects

List of all the signers for the session

all_signers

session_type

string

enum

Defaults to closing

The type of session to be used for signing. Default is closing

Allowed:

notarization_timing_type

string

enum

If Notarization needs to be performed immediately choose notarize_now. If Notarization needs to be performed at given date and time, choose notarize later

Allowed:

session_timing

string

When notarization_type is notarize_later, session_timing is required. the format used is as follows : "2022-07-13T13:47:10-06:30"

session_notary_email

string

The notary email id of the user who is going to conduct the notarization for this session. Please make sure the business admin account you have has created the needed user as notary user. This is a required field, when signingType is selected as 'ipen'

state_specific_notary

string

enum

[Note: All states support cross-state notarization. Only use this for special cases]. You can specific a specific state from where the Notary can be picked. Greatly reduces the Notary Pool. States can be: "Alabama","Alaska","American Samoa","Arizona","Arkansas","California","Colorado","Connecticut","Delaware","District Of Columbia","Florida","Georgia","Guam","Hawaii","Idaho","Illinois","Indiana","Iowa","Kansas","Kentucky","Louisiana","Maine","Maryland","Massachusetts","Michigan","Minnesota","Mississippi","Missouri","Montana","Nebraska","Nevada","New Hampshire","New Jersey","New Mexico","New York","North Carolina","North Dakota","Ohio","Oklahoma","Oregon","Pennsylvania","Puerto Rico","Rhode Island","South Carolina","South Dakota","Tennessee","Texas","Utah","Vermont","Virginia","Washington","West Virginia","Wisconsin","Wyoming".

notarization_types

string

Defaults to Acknowledgement

The type of notarization for this session for ex. Acknowledgement, Jurat etc. Provide comma separated values in case of multiple.

witnesses

object

All witnesses needed for the session

session_documents

array of objects

The documents which are needed to be notarized. The document file types like pdf. jpg, png are supported for notarizations

session_documents

document_templates

array of strings

List of template ids which you want to use for this session. You can find the template ids from "Templates" section of your business admin BlueNotary account

document_templates

final_documents_delivery_mode

string

enum

Defaults to immediately

If you want the final signed document to not be sent to the signers upon completion of the notarization session, select notary_manual. By default, documents are delivered immediately upon session completion.

Allowed:

send_invite_after_pretagging

boolean

Defaults to false

If you do not want to send the session notarization invitation to all the respective signers immediately upon session creation, the invitation will be sent after the session notary, pretagger, or admin marks the document as pretagged.

esign_message

string

[Esign only] Add a common custom message sent to all recipients.

esign_subject

string

[Esign only] Add to customize the invitation email subject line. Default is Complete with BlueNotary: {{documentName}}

loan_details

object

Basic Loan Details for the session

session_configurations

object

Basic session configuration which you want to enable for only a session itself. It include document editing permissions for notary and auto expiring a session after a specific time.

Responses

200200

403403