Guide: Using the K-1 Upload Process via API

This guide describes how to use the K-1 upload process using the API.
A prerequisite for implementation is that you have been assigned your token and account number, which need to be sent when communicating with our API.

The upload process is asynchronous and consists of two key calls: uploading the PDF file and a separate API call to check the status of the request.

1. Uploading the File

The request is sent via the HTTP POST method:

curl -X 'POST' \
  'https://api-aggregator.k1x.io/api/k1-upload?instanceId=<INSTANCE_ID>' \
  -H 'accept: text/plain' \
  -H 'X-K1X-Account: <ACCOUNT>' \
  -H 'X-K1X-Token: <TOKEN>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@<FILE>;type=application/pdf'

Headers:

Parameter	Type	Description
`X-K1X-Account`	string	Required. K1X Account value.
`X-K1X-Token`	string	Required. K1X Token value.

The request body must contain the multipart/form-data content of the PDF file being uploaded.
A successful response will return a unique upload identifier that can be used to check the status of the upload.

Parameters:

Parameter	Type	Description
`instanceId`	Integer	Required. The identifier of the instance for which the file is being uploaded.

2. Checking the Status

The status is checked using the HTTP GET method with the following call:

curl -X 'GET' \
  'https://api-aggregator.k1x.io/api/k1-upload/status?uploadId=<UPLOAD_ID>' \
  -H 'X-K1X-Account: <ACCOUNT>' \
  -H 'X-K1X-Token: <TOKEN>'

Headers:

Parameter	Type	Description
`X-K1X-Account`	string	Required. K1X Account value.
`X-K1X-Token`	string	Required. K1X Token value.

Parameters:

Parameter	Type	Description
`uploadId`	uuid	Required. The upload identifier received upon a successful file upload.

A successful response will contain the status of the upload.

Possible statuses:

Submitted
InProcess
Processed
Error
Completed with errors