Welcome to the National Notary Association platform on the Cloud. profiles.nna-platform.com provides services to support profiles. Service responsibilities include managing profiles, contact information, and qualifications for organizations, customers, users, notaries, and signing agents.
This documentation describes a RESTful API that provides programmatic access to interact with the platform. Usage of the API is via the HTTP protocol. The GET, POST, PUT, PATCH and DELETE requests are all used. Resource representations are in JSON.
Following is a brief description of the resouces that are available in this API.
Provides county lookups by name or county code.
A customer is a special type of user that doesn't require an invitation to join an organization. This resource provides functionality to maintain customer profiles. To add a customer with logon credentials, use the Customers resource in the Identity service.
Provides language lookups by ISO 6391 or 6393 codes.
Provides a list of mobile platforms. A mobile platform is a combination of operating system (iOS, Android, Windows), and form factor (smart phone, tablet).
An organization is a group of people with a specific purpose. In the context of the platform, organizations usually represent companies. This resource provides functionality to maintain organization profiles.
A partner is an organization that has a relationship with another organization. The partner type defines the type of relationship, customer or vendor.
A signing agent is an agent whose function is to obtain a formal signature of an appearer to a document. They commonly specialize in the notarization of real estate transfer and loan document signings. This resource provides functionality to maintain signing agent profiles, contact information, and qualifications.
Provides a list of special business designations.
Provides functionality to get a list of states, or a state with county information.
A User represents a person's identity in the platform and is a member of an organization. This resource provides functionality to maintain user profiles. Use the Identity service to add users.
The following table describes HTTP request headers that will be used.
| Header | Description | Required | Example |
|---|---|---|---|
|
Host |
The domain name of the server. |
Yes. |
Host: profiles.nna-platform.com |
|
Content-Type |
Describes the representation of the request message body. Must be 'application/json'. |
Yes, on requests that contain a message body. |
Content-Type: application/json |
|
Authorization |
Identifies the authorized user making the request. |
Yes, unless the request provides an API Key in the URL. |
Authorization: Bearer {token} |
|
Accept-Language |
Restricts the set of natural languages that are preferred as a response to the request. |
No. Currently, only 'en-US' is supported. |
Accept-Language: en-US |
The following table describes possible custom response headers.
| Header | Description |
|---|---|
|
nna-message-id |
The message id for the request. This is only returned if there was an error. |
|
nna-error-code |
If an error occurred while submitting the request, an error code is returned. |
The following table describes HTTP status codes that may be returned.
| Code | Description |
|---|---|
|
200 |
The request was successfully completed. |
|
202 |
The request has been accepted for processing, but the processing has not been completed. |
|
204 |
The server fulfilled the request, but does not need to return a response message body. |
|
400 |
Bad request. |
|
401 |
Not authorized. |
|
404 |
The request specified a URI of a resource that does not exist. |
|
405 |
The HTTP verb specified in the request (DELETE, GET, HEAD, POST, PUT) is not supported for this request URI. |
|
429 |
Too Many Requests. Rate limited. |
|
500 |
The server encountered an unexpected condition which prevented it from fulfilling the request. |
|
501 |
The server does not currently support the functionality required to fulfill the request. |
|
503 |
The server is currently unable to handle the request. |