Skip to main content
POST
Register document upload metadata

Authorizations

Authorization
string
header
required

Use Authorization: Bearer pyai_live_... (or pyai_test_...).

Path Parameters

id
string
required

Body

application/json
document_request_id
string
required
object_ref
string
required

Opaque object-storage reference. Never a document body or public URL.

Pattern: ^obj_[A-Za-z0-9_-]{20,}$
file_name
string
required
Maximum string length: 255
mime_type
string
required
size_bytes
integer
required
Required range: x >= 1
sha256
string
required

Lowercase SHA-256 content hash.

Pattern: ^[0-9a-f]{64}$
generation
string

Optional immutable object generation returned by storage.

Pattern: ^[1-9][0-9]*$

Response

Upload metadata registered

id
string
required
Example:

"ncc_..."

object
string
required
Allowed value: "telephony.compliance_case"
project_id
string
required
kind
enum<string>
required
Available options:
new_number,
port_in
country
enum<string>
required
Available options:
US,
CA,
IN,
GB,
AU
state
enum<string>
required
Available options:
collecting_evidence,
extracting,
needs_review,
ready_for_submission,
submitted,
cancelled
rules_snapshot
object
required

Immutable rules, source identifiers, thresholds, retry caps, parallelism, wall-clock, cost, and retention configuration frozen when the case started.

document_requests
object[]
required
uploads
object[]
required
extractions
object[]
required

Terminal processing attempts. Extracted personal values are masked in API views.

timeline
object[]
required
version
integer
required
Required range: x >= 1
number_type
string
capabilities
string[]
use_case
string
carrier
string
deprecated

Deprecated compatibility field. Always pyai_network.

Allowed value: "pyai_network"
network_status
string
continuation_reason
string | null
terminal_reason
enum<string> | null
Available options:
network_review_submitted,
cancelled_by_customer,
null
attestation_requests
object[]
corrections
object[]

Correction audit metadata. Corrected PII values are intentionally omitted from API views.

matches
object[]
attestations
object[]
carrier_packets
object[]
deprecated

Deprecated compatibility field. Always empty.

submissions
object[]
deprecated

Deprecated compatibility field. Always empty; use network operations.

created_at
integer
updated_at
integer
retention_delete_at
integer