curl --request GET \
--url https://api.numeralhq.com/tax/certificate-uploads/{upload_id} \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Version: <x-api-version>'import requests
url = "https://api.numeralhq.com/tax/certificate-uploads/{upload_id}"
headers = {
"X-API-Version": "<x-api-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-API-Version': '<x-api-version>', Authorization: 'Bearer <token>'}
};
fetch('https://api.numeralhq.com/tax/certificate-uploads/{upload_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.numeralhq.com/tax/certificate-uploads/{upload_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: Bearer <token>",
"X-API-Version: <x-api-version>"
],
]);
$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.numeralhq.com/tax/certificate-uploads/{upload_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Version", "<x-api-version>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.numeralhq.com/tax/certificate-uploads/{upload_id}")
.header("X-API-Version", "<x-api-version>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.numeralhq.com/tax/certificate-uploads/{upload_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Version"] = '<x-api-version>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "upl_4470",
"object": "tax.certificate_upload",
"status": "completed",
"customer": {
"id": "cust_6126acaf-7379-411a-8ada-00005bac0715",
"reference_customer_id": "20506"
},
"certificate_ids": [
"cert_a8f3d2c1-1b9a-4c5e-8d7e-6f4a3b2c1d0e"
],
"error_message": null,
"created_at": "2026-09-15T16:58:02.000Z",
"livemode": true,
"document_url": "https://numeral-ecm-documents.s3.amazonaws.com/uploads/upl_4470.pdf?X-Amz-Expires=3600&X-Amz-Signature=..."
}{
"code": 400,
"type": "MISSING_FIELD",
"message": "Required field 'address_country' is missing"
}{
"code": 404,
"type": "CERTIFICATE_UPLOAD_NOT_FOUND",
"message": "Certificate upload not found"
}Get Certificate Upload
Retrieve a single certificate upload, including a link to the submitted document
curl --request GET \
--url https://api.numeralhq.com/tax/certificate-uploads/{upload_id} \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Version: <x-api-version>'import requests
url = "https://api.numeralhq.com/tax/certificate-uploads/{upload_id}"
headers = {
"X-API-Version": "<x-api-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-API-Version': '<x-api-version>', Authorization: 'Bearer <token>'}
};
fetch('https://api.numeralhq.com/tax/certificate-uploads/{upload_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.numeralhq.com/tax/certificate-uploads/{upload_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: Bearer <token>",
"X-API-Version: <x-api-version>"
],
]);
$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.numeralhq.com/tax/certificate-uploads/{upload_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Version", "<x-api-version>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.numeralhq.com/tax/certificate-uploads/{upload_id}")
.header("X-API-Version", "<x-api-version>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.numeralhq.com/tax/certificate-uploads/{upload_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Version"] = '<x-api-version>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "upl_4470",
"object": "tax.certificate_upload",
"status": "completed",
"customer": {
"id": "cust_6126acaf-7379-411a-8ada-00005bac0715",
"reference_customer_id": "20506"
},
"certificate_ids": [
"cert_a8f3d2c1-1b9a-4c5e-8d7e-6f4a3b2c1d0e"
],
"error_message": null,
"created_at": "2026-09-15T16:58:02.000Z",
"livemode": true,
"document_url": "https://numeral-ecm-documents.s3.amazonaws.com/uploads/upl_4470.pdf?X-Amz-Expires=3600&X-Amz-Signature=..."
}{
"code": 400,
"type": "MISSING_FIELD",
"message": "Required field 'address_country' is missing"
}{
"code": 404,
"type": "CERTIFICATE_UPLOAD_NOT_FOUND",
"message": "Certificate upload not found"
}document_url for the originally submitted document. This is the polling
endpoint — after
POST /tax/certificates,
call it until status leaves processing, then read certificate_ids.
upload_id accepts the upl_* form (upl_4471) or the bare numeric form
(4471).
X-API-Version: 2026-03-01 header — older versions
return INVALID_REQUEST (400). Certificate endpoints are live-only — using a
sk_test_* key returns TESTMODE_NOT_SUPPORTED (400). Uploads outside your
account return CERTIFICATE_UPLOAD_NOT_FOUND (404) — unknown, malformed, and
other-account ids are indistinguishable by design.Polling
processing is the only non-terminal status. completed populates
certificate_ids, failed populates error_message, and duplicate is
assigned at submit time. Once the status is terminal it will not change, so
you can stop polling.
Each id in certificate_ids is a cert_* id usable with
GET /tax/certificates/{certificate_id}
to read the certificate’s own status, jurisdictions, and download URL.
The document_url field
document_url is a pre-signed URL pointing to the document you submitted.
It expires one hour after the response is issued — re-fetch the upload
to mint a fresh URL. It may be non-null while status is still
processing.
document_url is null (not omitted) when no document is attached to the
upload. The upload metadata is still returned — the response is 200, not
404.
document_url as confidential. Anyone with the URL can download the
document until the URL expires. Do not log, cache past the TTL, or expose
the URL on a public page.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Must be 2026-03-01 or later. Older versions return INVALID_REQUEST (400).
2026-03-01 Path Parameters
The upload id (upl_4471) or its bare numeric form (4471).
Response
Certificate upload detail (includes pre-signed document_url)
A certificate upload — the asynchronous processing job created by POST /tax/certificates.
Upload id, upl_<number>. Endpoints that accept an upload id also accept the bare numeric form.
"upl_4471"
The type of object: tax.certificate_upload
"tax.certificate_upload"
Processing state of a certificate upload. This is a separate vocabulary from certificate status — an upload is a processing job, a certificate is its output. processing is the only non-terminal state; completed (certificates produced), failed (see error_message), and duplicate (same document already submitted) are terminal.
processing, completed, failed, duplicate The customer supplied at submission. null when the upload was submitted without a customer — attribution then happens during processing.
Show child attributes
Show child attributes
Certificates produced by this upload, usable with the certificate endpoints. Empty while status is processing; populated at completed. One document can yield multiple certificates.
Human-readable reason processing failed. Also set on duplicate uploads when the original upload had failed, so you can see why re-submitting the same bytes will not help.
Always true — these endpoints are live-only.
true Pre-signed URL to the originally submitted document. Valid for one hour — refetch the upload to mint a new URL. May be non-null while status is still processing. null (response still 200) when no document is attached. Not returned by the list endpoint. Treat as confidential.