Request Notary

Like many great things in the notary world, one of the first thing you'd do is send us your documents to be notarized. In this endpoint, we will learn how to request a document to be notarized online.

Endpoint

Method URI Headers Example
POST /client/request_notary 'Bearer {api_token}' Bearer ljbVhIAhdrJLHvrSqzb6dzblvd78wGs5LGyB

Params

Name Type Description
document array, file required The document that will be notarized using OnlineNotary.net platform. PDF files are supported. You may upload multiple documents as part of the upload.
signers array required At least one signer must be submitted.
signers[X][fullname] string required Full legal name of the signer.
signers[X][email] string required An Email Address for the signer.
signers[X][phone] string required Phone number of the signer
signers[X][same_location] boolean optional If this signer is going to connect at the same location as other signer(s) please set this to true
signers[X][same_conference] boolean optional If this signer is going to connect from different location but in the same video session as other the signer(s) please set this to true
recipients array required At least one document recipient must be submitted.
recipients[X][fullname] string required Name of the Document Recipient. This part is used in the email body when documents are sent.
recipients[X][email] string required Email where notarized document will be sent as an attachment.

Sample Params

{
    "document[0]" : "POA.pdf",
    "document[1]" : "POA2.pdf",
    "signers[0][fullname]" : "John Doe",
    "signers[0][email]" : "[email protected]",
    "signers[0][phone]" : "4083415122",
    "signers[0][same_location]": true,
    "signers[0][same_conference]": true,
    "recipients[0][fullname]" : "Jane Doe",
    "recipients[0][email]": "[email protected]"
}

{info} Once submitted, our API will respond back with one of the following responses: success, unauthenticated or fail.

Sample Response

Please note down the notary_url and notary id parameters. This is where you'd send your signer(s) to begin their eNotary process and later on use the id to get the notary status.

CODE 200

{success} When a document is submitted with at least one signer and one document recipient, you should expect a response code of 200.

{
    "status": "created",
    "notary": {
        "id": "846068B0-001E-11EB-9DB7-C7EAC0FB4B7F",
        "filename": "POA.pdf",
        "recipients": [],
        "signers": [
            {
                "notary_url": "https://app.onlinenotary.net/sign/u/check-system-requirements/86F2D0F0-001E-11EB-8BDB-619E7C34D094",
                "fullname": "John Doe",
                "email": "[email protected]",
                "turn": 1,
                "tech_check": 0,
                "signer_verified": 0,
                "signature_picked": 0,
                "id_scan": 0
            }
        ]
    }
}

CODE 422

{danger} If one of the required parameters is not submitted you will get the following responses back from our API endpoint.

    {
    "errors": {
        "document": [
        "document is required if document_url is not defined"
        ],
        "signers": [
        "The signers field is required."
        ],
        "recipients": [
        "The recipients field is required."
        ]
    }
    }

CODE 400

Response of 400 - unautheticated will be shown if a wrong API key is used. Please note currently we only support one API key per account and please ensure this is changed by your team once you move your workload in production environment.

{
    "success": false,
    "error": {
        "code": 0,
        "message": "Unauthenticated."
    }
}

Sample PHP Code Sample

In the following sample code, you will see what type of response you should be getting from our API endpoint. One of the most important response variables that you should be aware of is notary_url. The notary_url allows you to pass a particular website URL directly to your customer to begin they're notarization process using their smartphone, tablet, or a laptop device

$client = new Client();
$api_key = 'API_KEY_HERE';
$url = 'https://production.onlinenotary.net/api/v1/client/request_notary';        
$response = $client->request('POST', $url , 
[
    'multipart' => [
        [
            'name'     => 'document[0]',
            'contents' =>  fopen(public_path('path_to/sample-document.pdf'), 'r')
        ],
        [
            'name'     => 'signers[0][fullname]',
            'contents' => 'Signers Name'
        ],
        [
            'name'     => 'signers[0][email]',
            'contents' => '[email protected]',
        ],
        [
            'name'     => 'signers[0][phone]',
            'contents' => '877-726-1088'
        ],
        [
            'name'     => 'signers[0][same_conference]',
            'contents' => 'true'
        ],
        [
            'name'     => 'signers[0][same_location]',
            'contents' => 'true'
        ],
        [
            'name'     => 'recipients[0][fullname]',
            'contents' => 'Recipient Name'
        ],
        [
            'name'     => 'recipients[0][email]',
            'contents' => '[email protected]'
        ],
    ],
    'auth' => [
        null,
        $api_key
    ],
]);