Get One Document

curl --request GET \
  --url https://api.upwell.com/api/rest/documents/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.upwell.com/api/rest/documents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.upwell.com/api/rest/documents/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upwell.com/api/rest/documents/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.upwell.com/api/rest/documents/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "document": {
    "createdAt": "<unknown>",
    "id": "<string>",
    "name": "<string>",
    "status": "<string>"
  }
}

{
  "error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
  "code": "constraint-violation"
}

Documents

Get One Document

Get a document by id — the status check for API uploads. status of UPLOAD_CONTENT_REJECTED means the uploaded bytes failed content verification (not a valid PDF) and the document will never be parsed; re-upload with a new sourceSystemId (rejection is terminal: re-presigning the same sourceSystem+sourceSystemId returns 400 DOCUMENT_ALREADY_UPLOADED). Multi-document uploads: a purchase-order / vendor-invoice PDF containing several documents of that type is automatically split and each one is parsed individually — status becomes SPLIT_FOR_PROCESSING while the pieces parse, PROCESSING_COMPLETED when every piece has produced its record, and PROCESSING_FAILED if any piece permanently fails to parse (records for the pieces that did parse remain available, and a later successful re-parse of the failed piece transitions the document to PROCESSING_COMPLETED); the records appear incrementally on the by-document list endpoints. A null/other status with no parsed record yet means parsing is still in progress.

GET

api

rest

documents

{id}

Get One Document

curl --request GET \
  --url https://api.upwell.com/api/rest/documents/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.upwell.com/api/rest/documents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.upwell.com/api/rest/documents/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upwell.com/api/rest/documents/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.upwell.com/api/rest/documents/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "document": {
    "createdAt": "<unknown>",
    "id": "<string>",
    "name": "<string>",
    "status": "<string>"
  }
}

{
  "error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
  "code": "constraint-violation"
}

Authorizations

Authorization

string

header

required

Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.

Path Parameters

string

required

"id" is required (enter it either in parameters or request body)

Response

Responses for GET /api/rest/documents/{id}

document

Documents · object | null

Documents table

Show child attributes

⌘I