Skip to main content
POST
assessment.result.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by assessment.invitation.create or assessment.invitations.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

score
number | null
required

Assessment score from 0 to 100; null for a trait profile.

Required range: 0 <= x <= 100
passed
boolean | null
required

Whether the pass threshold was met; null for a trait profile.

gradingStatus
enum<string>
required

Grading progress; pending and partial are normal states.

Available options:
pending,
partial,
complete,
other
finalizationStatus
enum<string>
required

Whether the integrity verdict is still pending or final.

Available options:
pending_verdict,
final,
other
revision
integer
required

Grade revision number; zero is the initial result.

Required range: 0 <= x <= 9007199254740991
integrityVerdict
enum<string> | null
required

Integrity verdict, or null while unavailable.

Available options:
clean,
flagged,
terminated,
indeterminate,
other
proctoringRisk
enum<string>
required

Proctoring risk level.

Available options:
low,
medium,
high,
critical,
other
trustScore
number | null
required

Trust score from 0 to 100, or null while unavailable.

Required range: 0 <= x <= 100
recommendation
enum<string> | null
required

Assessment recommendation, or null while unavailable.

Available options:
pass,
review,
fail,
other
reportStatus
enum<string>
required

Evidence analysis progress.

Available options:
pending_analysis,
ready,
other
integrityReportStatus
enum<string>
required

Signed report progress; failed needs operator attention and will not resolve by waiting.

Available options:
ready,
pending,
failed,
other
completedAt
string<date-time>

When the assessment completed.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
environment
enum<string>

Whether this was a test or live assessment.

Available options:
test,
live
reportGenerationError
object | null

Report failure time and attempt count only.

grading
object[]

Per-question grades mapped to current question serving positions (as of this read), never upstream identifiers.

Maximum array length: 1000
scoringMode
string

Present for trait scoring instead of pass/fail scoring.

Allowed value: "profile"
traitProfile
object[]

Trait scores, when this assessment uses profile scoring.

Maximum array length: 200