API Reference
Log in to see full request history
Body Params
string
required

Notarization Id Identifier from Vendor Side

string
required

Email id of Customer

string
required

First name of Customer

string
required

Last Name of Customer

string

Middle Name of Customer

string

The authentication mode the primary signer would be using when entering the singing session. Can be one of 'kba', 'biometrics' or 'skip'.

string

Address of Customer

string

Date of birth of Customer in yyyy/mm/dd format

string

City of Customer

string

State of Customer

string

Zipcode of Customer

string

Contact Method of customer for Notarization related updates. Email updates are sent by default

string

If contact_method is email, provide emailid here. If contact_method is mobile, provide mobile number here

string
Defaults to ron

Signing type for the session. Defaults to 'ron'

string
Defaults to closing

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

string
required

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

string

This is a required field, when signingType is selected as 'ipen'. 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

string

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

additional_signers
array of objects

If session has multiple signers, use this param to send those users's details

additional_signers
string

If session_type is closing, you can specify the Loan Number for the signing

string

If session_type is closing, you can specify the closing type from the list of allowed values

string

If session_type is closing and loan_session_type is other, you can specify the exact loan session type in this field

string

Any other details required for the session can be added here

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
string
Defaults to Acknowledgement

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

int32

Number of witnesses you require to join this session from BlueNotary network notaries

boolean

If you want BlueNotary invited notaries to perform ID authentication to enter the session

witnessDetails
array of objects

If you want to use your own know witnesses, then add details to it and you can skip noOfBNWitness parameter in this case.

witnessDetails
string

In case you want to use notary from BlueNotary network then specify state name of the notary from you want to get the documents notarized (If Required). The state name should be a valid USA state.

string
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.

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.

Responses

Language
Credentials
Request