Sign in

v1

latestOpenAPI 3.0.12026-07-135210550.0 KB
Analyze Agreements

Create Agreement: Create Upload URL

Returns an AWS S3 URL upon success for subsequent file uploads. On a successful response, execute a PUT request to the AWS S3 URL with the file.

Knowledge Base Example: https://help.linksquares.com/hc/en-us/articles/10849398433559-Analyze-API-Sample-Use-Cases#01H7AP6S3RDH2AF5SGGFX5P8DR

AWS Documentation: https://docs.aws.amazon.com/AmazonS3/latest/userguide/PresignedUrlUploadObject.html

post/analyze/v1/agreements

Request body

file_namestring required
namestring
agreement_typestring
tagsstring[]
approve_agreementboolean
parent_agreement_idstring

Response

successful

upload_idstring required

UUID of the Upload

namestring required

The custom name of the document being uploaded

typestring required

The Agreement Type of the Upload

file_namestring required

The name of the file being uploaded

statusstring required

Status of the Upload

urlstring required

AWS Presigned Upload URL

parent_agreement_idstring nullable required

UUID of the Parent Agreement

tagsstring[] nullable required

Example response

{
  "upload_id": "f6cb5f59-ea46-4371-9739-570e83c5da27",
  "name": "Example Agreement Name",
  "type": "Master Agreement",
  "file_name": "example_agreement_name.pdf",
  "status": "Initialized",
  "url": "https://linksquares-agreement-api-upload-test.s3.amazonaws.com/3f4f51c8-15d9-11ee-8c7f-1f7f5cacceef/4037a5e0-15d9-11ee-8c7f-9ffe3bde9219/new%20file%20name.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIARONR2CMFGDRHHB3F%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230628T172852Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Security-Token=unused-test-session-key&X-Amz-Signature=2d3739f49a682547d1f52c3ab0b32709ec39df9954b8a05e1abb2588414276cf",
  "parent_agreement_id": "7d3a7092-ecf7-4342-b96f-2a751133e14d",
  "terms": [
    {
      "name": "Effective Date",
      "value": "2022-12-25"
    }
  ]
}