Skip to main content
GET
Get a case

Authorizations

X-API-Key
string
header
required

A tenant-scoped API key provisioned by Frayme.

Path Parameters

caseId
string
required

The case identifier returned by POST /cases.

Response

The case.

caseId
string
requestId
string
workflowId
string
workflowVersion
integer
type
enum<string>
Available options:
KYC,
KYB,
Transaction
status
enum<string>

Lifecycle only, not the outcome. received — workflow not yet finished (result absent). in_review — paused in a manual-review queue. completed — inspect result.decision.value.

Available options:
received,
in_review,
completed
createdAt
string<date-time>
completedAt
string<date-time>
payload
object
metadata
object
subject
object

Typed business attributes used for entity resolution and review. Set exactly one sub-struct, and it must match type: transaction for Transaction, person for KYC, business for KYB.

result
object

Present only once the workflow has completed.