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.
Gets a set of pre-signed URLs for multi-part uploads
| fileSizeInMb required | number The total size of the file to be uploaded in megabytes. This will determine how many parts to use. |
{- "uploadId": "00000000-0000-0000-0000-000000000000",
- "provider": "AWS",
}Provide the upload ID that was used to generate the presigned URL
| uploadId required | string <uuid> The original uploadId returned by a call to |
| 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 |
{- "analysisId": "00000000-0000-0000-0000-0000000000000"
}Only a single recipients should be used.
| originalId required | string <uuid> The original ID that was returned by a call to |
| 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. |
[- {
- "markedCopyId": "00000000-0000-0000-0000-000000000000",
- "status": "PENDING",
- "originalId": "00000000-0000-0000-0000-000000000000",
- "recipient": "foo@example.com"
}
]Returns a status and a download URL if it's available.
| markedCopyId required | string <uuid> ID of the marked copy to check on |
{- "markedCopyId": "00000000-0000-0000-0000-000000000000",
- "originalId": "00000000-0000-0000-0000-000000000000",
- "status": "PENDING",
}