Safety Net Blueprint — Client Reference: Eligibility

Determinations (2)

▶ listDeterminations() You can provide a client instance returned by `createClient()` instead of API ref → #

eligibility.listDeterminations({
  query: { applicationId?: string, q?: string, limit?: number, offset?: number, sort?: string },
})

Parameters

applicationId	string	query	optional
q search →	string	query	optional
limit	number	query	optional
offset	number	query	optional
sort	string	query	optional

▶ getDetermination(determinationId) Get determination API ref → #

eligibility.getDetermination({ path: { determinationId: string } })

Parameters

determinationId

string

path

required

Decisions (2)

▶ listDecisions(determinationId) List decisions API ref → #

eligibility.listDecisions({
  path: { determinationId: string },
  query: { limit?: number, offset?: number, sort?: string },
})

Parameters

determinationId	string	path	required
limit	number	query	optional
offset	number	query	optional
sort	string	query	optional

▶ getDecision(determinationId, decisionId) Get decision API ref → #

eligibility.getDecision({
  path: { determinationId: string, decisionId: string },
})

Parameters

determinationId	string	path	required
decisionId	string	path	required

Flag Expedited (1)

▶ flagExpeditedDetermination(determinationId) Flag expedited determination API ref → #

eligibility.flagExpeditedDetermination({
  path: { determinationId: string },
})

Parameters

determinationId

string

path

required

Complete (1)

▶ completeDetermination(determinationId) Complete determination API ref → #

eligibility.completeDetermination({ path: { determinationId: string } })

Parameters

determinationId

string

path

required

Withdraw (1)

▶ withdrawDetermination(determinationId) Withdraw determination API ref → #

eligibility.withdrawDetermination({ path: { determinationId: string } })

Parameters

determinationId

string

path

required

Approve (1)

▶ approveDecision(determinationId) Approve decision API ref → #

eligibility.approveDecision({
  path: { determinationId: string },
  body: { ... },
})

Parameters

determinationId	string	path	required
body	object	body	required

Deny (1)

▶ denyDecision(determinationId) Deny decision API ref → #

eligibility.denyDecision({
  path: { determinationId: string },
  body: { ... },
})

Parameters

determinationId	string	path	required
body	object	body	required

Mark Ineligible (1)

▶ markIneligibleDecision(determinationId) Mark ineligible decision API ref → #

eligibility.markIneligibleDecision({
  path: { determinationId: string },
  body: { ... },
})

Parameters

determinationId	string	path	required
body	object	body	required

Constants (3)

▶ DecisionPath enum (2 values) #

'auto'
'manual'

▶ DecisionStatus enum (4 values) #

'pending'
'approved'
'denied'
'ineligible'

▶ DeterminationStatus enum (4 values) #

'pending'
'in_progress'
'completed'
'withdrawn'

Types (12)

▶ Determination 3 fields #

interface Determination {
  applicationId: string
  status: enum: "pending", "in_progress", "completed", "withdrawn"
  expeditedFlagged: boolean
}

▶ Decision 9 fields #

interface Decision {
  determinationId: string
  applicationId?: string
  memberId: string
  program: enum: "snap", "medicaid", "chip", "tanf", "aca"
  status: enum: "pending", "approved", "denied", "ineligible"
  path?: enum: "auto", "manual"
  decidedAt?: string
  denialReasonCode?: string
  electronicChecks?: array[object]
}

▶ DeterminationList 4 fields #

interface DeterminationList {
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}

▶ DecisionList 4 fields #

interface DecisionList {
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}

▶ ElectronicCheckSummary 3 fields #

interface ElectronicCheckSummary {
  serviceType?: string
  result?: string
  checkedAt?: string
}

▶ ApproveDecisionRequest 1 field #

interface ApproveDecisionRequest {
  path: enum: "auto", "manual"
}

▶ DenyDecisionRequest 2 fields #

interface DenyDecisionRequest {
  path: enum: "auto", "manual"
  denialReasonCode: string
}

▶ MarkIneligibleRequest 2 fields #

interface MarkIneligibleRequest {
  path: enum: "auto", "manual"
  denialReasonCode: string
}

▶ DeterminationWritable 3 fields #

interface DeterminationWritable {
  applicationId: string
  status: enum: "pending", "in_progress", "completed", "withdrawn"
  expeditedFlagged: boolean
}

▶ DecisionWritable 9 fields #

interface DecisionWritable {
  determinationId: string
  applicationId?: string
  memberId: string
  program: enum: "snap", "medicaid", "chip", "tanf", "aca"
  status: enum: "pending", "approved", "denied", "ineligible"
  path?: enum: "auto", "manual"
  decidedAt?: string
  denialReasonCode?: string
  electronicChecks?: array[object]
}

▶ DeterminationListWritable 4 fields #

interface DeterminationListWritable {
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}

▶ DecisionListWritable 4 fields #

interface DecisionListWritable {
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}