Skip to main content
POST
Mark a Supplier-held Document as stored

Authorizations

Authorization
string
header
required

Canonical form uses underscore only: tcs_test_<public_id> or tcs_live<public_id>_. Scopes: supplier_submissions:create:basic, supplier_submissions:create:application, supplier_submissions:read, supplier_submissions:correct, supplier_submissions:promote. Effective permission is account ∩ credential ∩ environment. HMAC pepper is SUPPLIER_API_KEY_PEPPER.

Headers

X-Request-Id
string

Optional caller correlation id. Tera always returns X-Request-Id; that header is the only correlation identifier.

Required string length: 1 - 128

Body

application/json
external_reference
string
required
Required string length: 1 - 128
document_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Supplier-held Document stored against the supplier reference.

document_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
category
enum<string>
required
Available options:
bank_statements,
accounts,
id
scan_status
string
required
Allowed value: "pending_scan"