REST API: Add to Registry

Using the Registry REST API, you can add new meta-data information for any e-notary document into the registry.

Note that you must have a Security Key to access the API's.

For the SOAP version Click Here.

HTTP POST

To add a new record, make a HTTP POST request:

/REST/AddNewRegistry

Parameters

Required Parameters

You must POST the following parameters:

Parameter Description
json If this is being accessed from a client browser, for example using Jquery or you would like the data returned to be in the form of JSON, then you must enter the value for this parameter as "true".
SecurityKey The key given to you when you first signed up in order to access the data.
Digest The message digest or the fingerprint for the document that was generated by you. It is preferred that you use SHA256 when generating the digests; however, SHA1, SHA256, SHA384, and SHA512 are all accepted.
DigestType When you have generated the digest, you must specify which method was used. It is preferred that you use SHA256 when generating the digests. The parameter type is INTEGER.

1 - SHA1
2 - SHA256
3 - SHA384
4 - SHA512

For example: if SHA256 is used, you would enter the value 2 in your POST.

More Info
FileType The type of format or the type of file you're adding to the registry. The parameter type is INTEGER.

1 - Document. Such as PDF's.
2 - Image. Such as TIF's or PNG's
3 - Audio. Such as MP3's or Wav's.
4 - Video. Such as MPEG.
Country The two letter abbreviation or country code. For example, if in the United States, it would be "US".
NotaryActType The notarial act type. For example, if it's a Jurat, Acknowledgment, etc. 50 characters max.
NotaryName The name of the notary who performed the e-Notarization. 100 characters max.
NotaryEmail The email address of the notary who performed the e-Notarization. 100 characters max.
NotaryState The two letter abbreviation of the state where the notary is commissioned at the time of the e-Notarization. 2 characters max.
NotaryCommission The notary's commission number issued from the state. 30 characters max.
CommissionExpires When the notary's commission expires. The parameter type is DATE, and must be in the form of a date.
NumberofSigners The number of signers or participants for the notarial act. Enter 0 (zero) if none. The parameter type is INTEGER.
UniqueID A unique ID that can be used to also identify the document. For example, if you generate a GUID as the ID for each new document you create, then you would enter it into this parameter. 50 characters max.

Note: All the data must be URL Encoded.

Returned Data

Data is returned in the form of XML. If it's successful, it will return a Registry ID that you can save on your own systems to reference the new registry record. Click Here to view the returned XML.

 

SOAP API: Add to Registry

Using the Registry SOAP API, you can add new meta-data information for any e-notary document into the registry.

Note that you must have a Security Key to access the API's.

SOAP Endpoint

To add a new record using SOAP:

https://api.notarytrustregistry.com/SOAP/NotaryRegister.svc

SOAP Method

AddNewRegistry

Parameters

Required Parameters

Parameter Description
SecurityKey The key given to you when you first signed up in order to access the data.
Digest The message digest or the fingerprint for the document that was generated by you. It is preferred that you use SHA256 when generating the digests; however, SHA1, SHA256, SHA384, and SHA512 are all accepted.
DigestType When you have generated the digest, you must specify which method was used. It is preferred that you use SHA256 when generating the digests. The parameter type is INTEGER.

1 - SHA1
2 - SHA256
3 - SHA384
4 - SHA512

For example: if SHA256 is used, you would enter the value 2 in your POST.

More Info
FileType The type of format or the type of file you're adding to the registry. The parameter type is INTEGER.

1 - Document. Such as PDF's.
2 - Image. Such as TIF's or PNG's
3 - Audio. Such as MP3's or Wav's.
4 - Video. Such as MPEG.
Country The two letter abbreviation or country code. For example, if in the United States, it would be "US".
NotaryActType The notarial act type. For example, if it's a Jurat, Acknowledgment, etc. 50 characters max.
NotaryName The name of the notary who performed the e-Notarization. 100 characters max.
NotaryEmail The email address of the notary who performed the e-Notarization. 100 characters max.
NotaryState The two letter abbreviation of the state where the notary is commissioned at the time of the e-Notarization. 2 characters max.
NotaryCommission The notary's commission number issued from the state. 30 characters max.
CommissionExpires When the notary's commission expires. The parameter type is DATE.
NumberofSigners The number of signers or participants for the notarial act. Enter 0 (zero) if none. The parameter type is INTEGER.
UniqueID A unique ID that can be used to also identify the document. For example, if you generate a GUID as the ID for each new document you create, then you would enter it into this parameter. 50 characters max.

Returned Data

Data is returned in the form of XML. If it's successful, it will return a Registry ID that you can save on your own systems to reference the new registry record. Click Here to view the returned XML.

Returned XML Error
<?xml version="1.0"?>
<RegistryResponse>
	<Errors>
		<SecurityKey>missing</SecurityKey>
		<Digest>missing</Digest>
		<DigestType>invalid</DigestType>
		<Country>missing</Country>
		<NotaryActType>missing</NotaryActType>
		<NotaryName>missing</NotaryName>
		<NotaryEmail>invalid</NotaryEmail>
		<NotaryState>missing</NotaryState>
		<NotaryCommission>missing</NotaryCommission>
		<CommissionExpires>invalid</CommissionExpires>
	</Errors>
</RegistryResponse>
Returned XML Success
<?xml version="1.0"?>
<RegistryResponse>
	<RegistryID>1234abcd-abcd-efgh-1234-abcdefgh1234</RegistryID>
</RegistryResponse>
Generating Digests

There are lots of different companies that produce libraries, wrappers, components, etc., and lots of online resources for generating Secure Hash Algorithms (SHA) digests. Programming knowledge may be required with most components.

Companies / Components

Resources / Samples