EchoMark Public API (1.0.0)

Download OpenAPI specification:

This is the documentation for the EchoMark Public REST API. The EchoMark API requires that you have an existing EchoMark account, and that you have an API Client created within your EchoMark account. Administrators can create an API Client within the EchoMark web application EchoMark Public Rest API Implementation Guide.

All API endpoints require a JWT token to authenticate with. To get a JWT token for authentication, call the following endpoint with your client Id and client secret:

POST https://api.echomark.com/auth/oauth2/token
HEADERS: {
Authorization: Basic <Base64(ClientId:ClientSecret)>
}
BODY (x-www-form-urlencoded): {
grant_type: client_credentials,
audience: https://api.echomark.com/api,
resource: https://api.echomark.com/api
}

This will return an access token in the JSON response, or will return an error.

Once you have your token, you can add it as an authorization header for all of your requests to the EchoMark api: Authorization: Bearer <AccessToken>

Please contact https://support.echomark.com if you have any questions or difficulty with the APi.

upload

Endpoints related to uploading documents

Gets a pre-signed URL to use to upload a new original

Gets a pre-signed URL

Authorizations:
echomark_auth

Responses

Response samples

Content type
application/json
{}

Gets a set of pre-signed URLs for uploading a multi-part original

Gets a set of pre-signed URLs for multi-part uploads

Authorizations:
echomark_auth
Request Body schema: application/x-www-form-urlencoded
required
fileSizeInMb
required
number

The total size of the file to be uploaded in megabytes. This will determine how many parts to use.

Responses

Response samples

Content type
application/json
Example
{}

Communicate completion of a file upload to a presigned URL.

Provide the upload ID that was used to generate the presigned URL

Authorizations:
echomark_auth
Request Body schema: application/x-www-form-urlencoded
required
uploadId
required
string <uuid>

The original uploadId returned by a call to upload-url

mediaType
required
string
Enum: "application/pdf" "image/gif" "image/tiff" "image/jpeg" "image/png"

The media type of the file that was uploaded

fileName
required
string

The name of the file that was sent.

uploadType
string
Enum: "ORIGINAL" "ANALYSIS" "NOT_MARKABLE_ORIGINAL"

The type of upload this represents

artifactType
string
Enum: "SOURCE" "IMAGE" "TEXT"

If the type is "Analysis" then this should describe the type of artifact being uploaded

Array of objects
fileShareLinkId
string <uuid>

The link Id if this was a shared Secure View document

Responses

Response samples

Content type
application/json
{
  • "analysisId": "00000000-0000-0000-0000-0000000000000"
}

mark

API Endponts for marking and polling on status of marked copies.

Request a new marked copy for a specific recipient

Only a single recipients should be used.

Authorizations:
echomark_auth
Request Body schema: application/x-www-form-urlencoded
required
originalId
required
string <uuid>

The original ID that was returned by a call to submit-upload

recipients
required
Array of strings

The recipient(s) that will be receiving the marked copy(ies). If there is more than one recipient listed, each recipient will get a unique marked copy.

markingPolicyId
string <uuid>

The marking policy ID to use. If none is supplied, the default marking policy will be used.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the status and (optionally) download URL for the specified marked copy.

Returns a status and a download URL if it's available.

Authorizations:
echomark_auth
path Parameters
markedCopyId
required
string <uuid>

ID of the marked copy to check on

Responses

Response samples

Content type
application/json
{}