Skip to main content
GET
Get one segment

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Intake ID

sid
string<uuid>
required

Segment (document) ID

Response

Segment

id
string<uuid>

Document ID.

intake_id
string<uuid>
index
integer

0-based page order.

page_start
integer | null
page_end
integer | null
document_type
string | null
document_category
string | null
schema_id
string | null
fields
object | null

Extracted fields for this document type.

derived_fields
object | null
external_fields
object | null
validation_result
enum<string> | null

Null for segments that are not candidates for the requested requirement.

Available options:
VALID,
INVALID,
NOT_SUPPORTED
validations
object | null
attestations
object[]
expires_at
string<date> | null
redacted_at
string<date-time> | null
scan_status
enum<string>
Available options:
PENDING,
SUCCESS,
FAILED
fraud
object | null
error
object | null
file
object | null
created_at
string<date-time>
updated_at
string<date-time> | null