Skip to main content
POST
/
api
/
v1
/
contract
/
upload
Contract Upload Api
curl --request POST \
  --url https://api.justpaid.io/api/v1/contract/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form customer_uuid=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form file=@example-file
{
  "process_status_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "message": "Contract uploaded successfully and is being processed"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
​
file
file
required

The contract PDF file to upload

​
customer_uuid
string<uuid>

Optional UUID of the customer for this contract

Response

Contract uploaded successfully

Response schema for contract upload.

Attributes: process_status_uuid (UUID): The UUID of the contract processing status. message (str): A message indicating the status of the upload.

​
process_status_uuid
string<uuid>
required

The UUID of the contract processing status. Use this to track the contract parsing progress.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
message
string
required

A message indicating the status of the upload.

Example:

"Contract uploaded successfully and is being processed"