Explorer/Client Reference/Intake
Intake packages/clients/generated/intake
Domain: intake · API spec: packages/resolved/intake-openapi.yaml · State machine: packages/resolved/intake-state-machine.yamlView full API reference →

Applications (5)

▶ listApplications() You can provide a client instance returned by `createClient()` instead of API ref → 
intake.listApplications({
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ createApplication() Create an application API ref → 
intake.createApplication({ body: { ... } })
Parameters
body object body required
▶ deleteApplication(applicationId) Delete an application API ref → 
intake.deleteApplication({ path: { applicationId: string } })
Parameters
applicationId string path required
▶ getApplication(applicationId) Get an application API ref → 
intake.getApplication({ path: { applicationId: string } })
Parameters
applicationId string path required
▶ updateApplication(applicationId) Update an application API ref → 
intake.updateApplication({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required

Members (5)

▶ listApplicationMembers(applicationId) List application members API ref → 
intake.listApplicationMembers({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ createApplicationMember(applicationId) Add a member API ref → 
intake.createApplicationMember({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required
▶ deleteApplicationMember(applicationId, memberId) Remove a member API ref → 
intake.deleteApplicationMember({
  path: { applicationId: string, memberId: string },
})
Parameters
applicationId string path required
memberId string path required
▶ getApplicationMember(applicationId, memberId) Get a member API ref → 
intake.getApplicationMember({
  path: { applicationId: string, memberId: string },
})
Parameters
applicationId string path required
memberId string path required
▶ updateApplicationMember(applicationId, memberId) Update a member API ref → 
intake.updateApplicationMember({
  path: { applicationId: string, memberId: string },
  body: { ... },
})
Parameters
applicationId string path required
memberId string path required
body object body required

Household Info (2)

▶ getHousehold(applicationId) Get household API ref → 
intake.getHousehold({ path: { applicationId: string } })
Parameters
applicationId string path required
▶ updateHousehold(applicationId) Update household API ref → 
intake.updateHousehold({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required

Tax Filers (5)

▶ listTaxFilers(applicationId) List tax filers API ref → 
intake.listTaxFilers({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string, memberId?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
memberId string query optional
▶ createTaxFiler(applicationId) Add tax filer API ref → 
intake.createTaxFiler({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required
▶ deleteTaxFiler(applicationId, taxFilerId) Delete tax filer API ref → 
intake.deleteTaxFiler({
  path: { applicationId: string, taxFilerId: string },
})
Parameters
applicationId string path required
taxFilerId string path required
▶ getTaxFiler(applicationId, taxFilerId) Get tax filer API ref → 
intake.getTaxFiler({
  path: { applicationId: string, taxFilerId: string },
})
Parameters
applicationId string path required
taxFilerId string path required
▶ updateTaxFiler(applicationId, taxFilerId) Update tax filer API ref → 
intake.updateTaxFiler({
  path: { applicationId: string, taxFilerId: string },
  body: { ... },
})
Parameters
applicationId string path required
taxFilerId string path required
body object body required

Health Plans (5)

▶ listHealthPlans(applicationId) List health plans API ref → 
intake.listHealthPlans({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ createHealthPlan(applicationId) Add health plan API ref → 
intake.createHealthPlan({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required
▶ deleteHealthPlan(applicationId, healthPlanId) Delete health plan API ref → 
intake.deleteHealthPlan({
  path: { applicationId: string, healthPlanId: string },
})
Parameters
applicationId string path required
healthPlanId string path required
▶ getHealthPlan(applicationId, healthPlanId) Get health plan API ref → 
intake.getHealthPlan({
  path: { applicationId: string, healthPlanId: string },
})
Parameters
applicationId string path required
healthPlanId string path required
▶ updateHealthPlan(applicationId, healthPlanId) Update health plan API ref → 
intake.updateHealthPlan({
  path: { applicationId: string, healthPlanId: string },
  body: { ... },
})
Parameters
applicationId string path required
healthPlanId string path required
body object body required

Health Enrollments (5)

▶ listHealthEnrollments(applicationId) List health enrollments API ref → 
intake.listHealthEnrollments({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string, memberId?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
memberId string query optional
▶ createHealthEnrollment(applicationId) Add health enrollment API ref → 
intake.createHealthEnrollment({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required
▶ deleteHealthEnrollment(applicationId, healthEnrollmentId) Delete health enrollment API ref → 
intake.deleteHealthEnrollment({
  path: { applicationId: string, healthEnrollmentId: string },
})
Parameters
applicationId string path required
healthEnrollmentId string path required
▶ getHealthEnrollment(applicationId, healthEnrollmentId) Get health enrollment API ref → 
intake.getHealthEnrollment({
  path: { applicationId: string, healthEnrollmentId: string },
})
Parameters
applicationId string path required
healthEnrollmentId string path required
▶ updateHealthEnrollment(applicationId, healthEnrollmentId) Update health enrollment API ref → 
intake.updateHealthEnrollment({
  path: { applicationId: string, healthEnrollmentId: string },
  body: { ... },
})
Parameters
applicationId string path required
healthEnrollmentId string path required
body object body required

Child Support (2)

▶ getChildSupport(applicationId) Get child support API ref → 
intake.getChildSupport({ path: { applicationId: string } })
Parameters
applicationId string path required
▶ updateChildSupport(applicationId) Update child support API ref → 
intake.updateChildSupport({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required

Contacts (5)

▶ listContacts(applicationId) List contacts API ref → 
intake.listContacts({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ createContact(applicationId) Add contact API ref → 
intake.createContact({ path: { applicationId: string }, body: { ... } })
Parameters
applicationId string path required
body object body required
▶ deleteContact(applicationId, contactId) Delete contact API ref → 
intake.deleteContact({
  path: { applicationId: string, contactId: string },
})
Parameters
applicationId string path required
contactId string path required
▶ getContact(applicationId, contactId) Get contact API ref → 
intake.getContact({
  path: { applicationId: string, contactId: string },
})
Parameters
applicationId string path required
contactId string path required
▶ updateContact(applicationId, contactId) Update contact API ref → 
intake.updateContact({
  path: { applicationId: string, contactId: string },
  body: { ... },
})
Parameters
applicationId string path required
contactId string path required
body object body required

Organizations (5)

▶ listOrganizations(applicationId) List organizations API ref → 
intake.listOrganizations({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ createOrganization(applicationId) Add organization API ref → 
intake.createOrganization({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required
▶ deleteOrganization(applicationId, organizationId) Delete organization API ref → 
intake.deleteOrganization({
  path: { applicationId: string, organizationId: string },
})
Parameters
applicationId string path required
organizationId string path required
▶ getOrganization(applicationId, organizationId) Get organization API ref → 
intake.getOrganization({
  path: { applicationId: string, organizationId: string },
})
Parameters
applicationId string path required
organizationId string path required
▶ updateOrganization(applicationId, organizationId) Update organization API ref → 
intake.updateOrganization({
  path: { applicationId: string, organizationId: string },
  body: { ... },
})
Parameters
applicationId string path required
organizationId string path required
body object body required

Person Relationships (5)

▶ listPersonRelationships(applicationId) List person relationships API ref → 
intake.listPersonRelationships({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ createPersonRelationship(applicationId) Add person relationship API ref → 
intake.createPersonRelationship({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required
▶ deletePersonRelationship(applicationId, personRelationshipId) Delete person relationship API ref → 
intake.deletePersonRelationship({
  path: { applicationId: string, personRelationshipId: string },
})
Parameters
applicationId string path required
personRelationshipId string path required
▶ getPersonRelationship(applicationId, personRelationshipId) Get person relationship API ref → 
intake.getPersonRelationship({
  path: { applicationId: string, personRelationshipId: string },
})
Parameters
applicationId string path required
personRelationshipId string path required
▶ updatePersonRelationship(applicationId, personRelationshipId) Update person relationship API ref → 
intake.updatePersonRelationship({
  path: { applicationId: string, personRelationshipId: string },
  body: { ... },
})
Parameters
applicationId string path required
personRelationshipId string path required
body object body required

Authorized Representatives (5)

▶ listAuthorizedRepresentatives(applicationId) List authorized representatives API ref → 
intake.listAuthorizedRepresentatives({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ createAuthorizedRepresentative(applicationId) Add authorized representative API ref → 
intake.createAuthorizedRepresentative({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required
▶ deleteAuthorizedRepresentative(applicationId, authorizedRepresentativeId) Delete authorized representative API ref → 
intake.deleteAuthorizedRepresentative({
  path: { applicationId: string, authorizedRepresentativeId: string },
})
Parameters
applicationId string path required
authorizedRepresentativeId string path required
▶ getAuthorizedRepresentative(applicationId, authorizedRepresentativeId) Get authorized representative API ref → 
intake.getAuthorizedRepresentative({
  path: { applicationId: string, authorizedRepresentativeId: string },
})
Parameters
applicationId string path required
authorizedRepresentativeId string path required
▶ updateAuthorizedRepresentative(applicationId, authorizedRepresentativeId) Update authorized representative API ref → 
intake.updateAuthorizedRepresentative({
  path: { applicationId: string, authorizedRepresentativeId: string },
  body: { ... },
})
Parameters
applicationId string path required
authorizedRepresentativeId string path required
body object body required

Signatures (5)

▶ listSignatures(applicationId) List signatures API ref → 
intake.listSignatures({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ createSignature(applicationId) Add signature API ref → 
intake.createSignature({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required
▶ deleteSignature(applicationId, signatureId) Delete signature API ref → 
intake.deleteSignature({
  path: { applicationId: string, signatureId: string },
})
Parameters
applicationId string path required
signatureId string path required
▶ getSignature(applicationId, signatureId) Get signature API ref → 
intake.getSignature({
  path: { applicationId: string, signatureId: string },
})
Parameters
applicationId string path required
signatureId string path required
▶ updateSignature(applicationId, signatureId) Update signature API ref → 
intake.updateSignature({
  path: { applicationId: string, signatureId: string },
  body: { ... },
})
Parameters
applicationId string path required
signatureId string path required
body object body required

Sponsors (5)

▶ listSponsors(applicationId) List sponsors API ref → 
intake.listSponsors({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string, memberId?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
memberId string query optional
▶ createSponsor(applicationId) Add sponsor API ref → 
intake.createSponsor({ path: { applicationId: string }, body: { ... } })
Parameters
applicationId string path required
body object body required
▶ deleteSponsor(applicationId, sponsorId) Delete sponsor API ref → 
intake.deleteSponsor({
  path: { applicationId: string, sponsorId: string },
})
Parameters
applicationId string path required
sponsorId string path required
▶ getSponsor(applicationId, sponsorId) Get sponsor API ref → 
intake.getSponsor({
  path: { applicationId: string, sponsorId: string },
})
Parameters
applicationId string path required
sponsorId string path required
▶ updateSponsor(applicationId, sponsorId) Update sponsor API ref → 
intake.updateSponsor({
  path: { applicationId: string, sponsorId: string },
  body: { ... },
})
Parameters
applicationId string path required
sponsorId string path required
body object body required

Jobs (5)

▶ listJobs(applicationId) List jobs API ref → 
intake.listJobs({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string, memberId?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
memberId string query optional
▶ createJob(applicationId) Add job API ref → 
intake.createJob({ path: { applicationId: string }, body: { ... } })
Parameters
applicationId string path required
body object body required
▶ deleteJob(applicationId, jobId) Delete job API ref → 
intake.deleteJob({ path: { applicationId: string, jobId: string } })
Parameters
applicationId string path required
jobId string path required
▶ getJob(applicationId, jobId) Get job API ref → 
intake.getJob({ path: { applicationId: string, jobId: string } })
Parameters
applicationId string path required
jobId string path required
▶ updateJob(applicationId, jobId) Update job API ref → 
intake.updateJob({
  path: { applicationId: string, jobId: string },
  body: { ... },
})
Parameters
applicationId string path required
jobId string path required
body object body required

Incomes (5)

▶ listIncome(applicationId) List income API ref → 
intake.listIncome({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string, memberId?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
memberId string query optional
▶ createIncome(applicationId) Add income API ref → 
intake.createIncome({ path: { applicationId: string }, body: { ... } })
Parameters
applicationId string path required
body object body required
▶ deleteIncome(applicationId, incomeId) Delete income API ref → 
intake.deleteIncome({
  path: { applicationId: string, incomeId: string },
})
Parameters
applicationId string path required
incomeId string path required
▶ getIncome(applicationId, incomeId) Get income API ref → 
intake.getIncome({ path: { applicationId: string, incomeId: string } })
Parameters
applicationId string path required
incomeId string path required
▶ updateIncome(applicationId, incomeId) Update income API ref → 
intake.updateIncome({
  path: { applicationId: string, incomeId: string },
  body: { ... },
})
Parameters
applicationId string path required
incomeId string path required
body object body required

Assets (5)

▶ listAssets(applicationId) List assets API ref → 
intake.listAssets({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string, memberId?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
memberId string query optional
▶ createAsset(applicationId) Add asset API ref → 
intake.createAsset({ path: { applicationId: string }, body: { ... } })
Parameters
applicationId string path required
body object body required
▶ deleteAsset(applicationId, assetId) Delete asset API ref → 
intake.deleteAsset({ path: { applicationId: string, assetId: string } })
Parameters
applicationId string path required
assetId string path required
▶ getAsset(applicationId, assetId) Get asset API ref → 
intake.getAsset({ path: { applicationId: string, assetId: string } })
Parameters
applicationId string path required
assetId string path required
▶ updateAsset(applicationId, assetId) Update asset API ref → 
intake.updateAsset({
  path: { applicationId: string, assetId: string },
  body: { ... },
})
Parameters
applicationId string path required
assetId string path required
body object body required

Asset Disposals (5)

▶ listAssetDisposals(applicationId) List asset disposals API ref → 
intake.listAssetDisposals({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string, memberId?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
memberId string query optional
▶ createAssetDisposal(applicationId) Add asset disposal API ref → 
intake.createAssetDisposal({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required
▶ deleteAssetDisposal(applicationId, assetDisposalId) Delete asset disposal API ref → 
intake.deleteAssetDisposal({
  path: { applicationId: string, assetDisposalId: string },
})
Parameters
applicationId string path required
assetDisposalId string path required
▶ getAssetDisposal(applicationId, assetDisposalId) Get asset disposal API ref → 
intake.getAssetDisposal({
  path: { applicationId: string, assetDisposalId: string },
})
Parameters
applicationId string path required
assetDisposalId string path required
▶ updateAssetDisposal(applicationId, assetDisposalId) Update asset disposal API ref → 
intake.updateAssetDisposal({
  path: { applicationId: string, assetDisposalId: string },
  body: { ... },
})
Parameters
applicationId string path required
assetDisposalId string path required
body object body required

Expenses (5)

▶ listExpenses(applicationId) List expenses API ref → 
intake.listExpenses({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string, memberId?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
memberId string query optional
▶ createExpense(applicationId) Add expense API ref → 
intake.createExpense({ path: { applicationId: string }, body: { ... } })
Parameters
applicationId string path required
body object body required
▶ deleteExpense(applicationId, expenseId) Delete expense API ref → 
intake.deleteExpense({
  path: { applicationId: string, expenseId: string },
})
Parameters
applicationId string path required
expenseId string path required
▶ getExpense(applicationId, expenseId) Get expense API ref → 
intake.getExpense({
  path: { applicationId: string, expenseId: string },
})
Parameters
applicationId string path required
expenseId string path required
▶ updateExpense(applicationId, expenseId) Update expense API ref → 
intake.updateExpense({
  path: { applicationId: string, expenseId: string },
  body: { ... },
})
Parameters
applicationId string path required
expenseId string path required
body object body required

Disability Benefits (5)

▶ listDisabilityBenefits(applicationId) List disability benefits API ref → 
intake.listDisabilityBenefits({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string, memberId?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
memberId string query optional
▶ createDisabilityBenefit(applicationId) Add disability benefit API ref → 
intake.createDisabilityBenefit({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required
▶ deleteDisabilityBenefit(applicationId, disabilityBenefitId) Delete disability benefit API ref → 
intake.deleteDisabilityBenefit({
  path: { applicationId: string, disabilityBenefitId: string },
})
Parameters
applicationId string path required
disabilityBenefitId string path required
▶ getDisabilityBenefit(applicationId, disabilityBenefitId) Get disability benefit API ref → 
intake.getDisabilityBenefit({
  path: { applicationId: string, disabilityBenefitId: string },
})
Parameters
applicationId string path required
disabilityBenefitId string path required
▶ updateDisabilityBenefit(applicationId, disabilityBenefitId) Update disability benefit API ref → 
intake.updateDisabilityBenefit({
  path: { applicationId: string, disabilityBenefitId: string },
  body: { ... },
})
Parameters
applicationId string path required
disabilityBenefitId string path required
body object body required

Deductions (5)

▶ listDeductions(applicationId) List deductions API ref → 
intake.listDeductions({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string, memberId?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
memberId string query optional
▶ createDeduction(applicationId) Add deduction API ref → 
intake.createDeduction({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required
▶ deleteDeduction(applicationId, deductionId) Delete deduction API ref → 
intake.deleteDeduction({
  path: { applicationId: string, deductionId: string },
})
Parameters
applicationId string path required
deductionId string path required
▶ getDeduction(applicationId, deductionId) Get deduction API ref → 
intake.getDeduction({
  path: { applicationId: string, deductionId: string },
})
Parameters
applicationId string path required
deductionId string path required
▶ updateDeduction(applicationId, deductionId) Update deduction API ref → 
intake.updateDeduction({
  path: { applicationId: string, deductionId: string },
  body: { ... },
})
Parameters
applicationId string path required
deductionId string path required
body object body required

Verifications (5)

▶ listApplicationVerifications(applicationId) List application verifications API ref → 
intake.listApplicationVerifications({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ createApplicationVerification(applicationId) Create a verification obligation API ref → 
intake.createApplicationVerification({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required
▶ deleteApplicationVerification(applicationId, verificationId) Delete a verification obligation API ref → 
intake.deleteApplicationVerification({
  path: { applicationId: string, verificationId: string },
})
Parameters
applicationId string path required
verificationId string path required
▶ getApplicationVerification(applicationId, verificationId) Get a verification obligation API ref → 
intake.getApplicationVerification({
  path: { applicationId: string, verificationId: string },
})
Parameters
applicationId string path required
verificationId string path required
▶ updateApplicationVerification(applicationId, verificationId) Update a verification obligation API ref → 
intake.updateApplicationVerification({
  path: { applicationId: string, verificationId: string },
  body: { ... },
})
Parameters
applicationId string path required
verificationId string path required
body object body required

Interview (2)

▶ getInterview(applicationId) Get the interview API ref → 
intake.getInterview({ path: { applicationId: string } })
Parameters
applicationId string path required
▶ updateInterview(applicationId) Update the interview API ref → 
intake.updateInterview({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required

Submit (1)

▶ submitApplication(applicationId) Submit application API ref → 
intake.submitApplication({ path: { applicationId: string } })
Parameters
applicationId string path required

Open (1)

▶ openApplication(applicationId) Open application API ref → 
intake.openApplication({ path: { applicationId: string } })
Parameters
applicationId string path required

Complete Review (1)

▶ completeReviewApplication(applicationId) Complete review application API ref → 
intake.completeReviewApplication({ path: { applicationId: string } })
Parameters
applicationId string path required

Submit For Approval (1)

▶ submitForApprovalApplication(applicationId) Submit for approval application API ref → 
intake.submitForApprovalApplication({ path: { applicationId: string } })
Parameters
applicationId string path required

Approve Determination (1)

▶ approveDeterminationApplication(applicationId) Approve determination application API ref → 
intake.approveDeterminationApplication({
  path: { applicationId: string },
})
Parameters
applicationId string path required

Reject Determination (1)

▶ rejectDeterminationApplication(applicationId) Reject determination application API ref → 
intake.rejectDeterminationApplication({
  path: { applicationId: string },
})
Parameters
applicationId string path required

Close (1)

▶ closeApplication(applicationId) Close application API ref → 
intake.closeApplication({ path: { applicationId: string } })
Parameters
applicationId string path required

Withdraw (1)

▶ withdrawApplication(applicationId) Withdraw application API ref → 
intake.withdrawApplication({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required

Satisfy (1)

▶ satisfyVerification(applicationId) Satisfy verification API ref → 
intake.satisfyVerification({ path: { applicationId: string } })
Parameters
applicationId string path required

Mark Inconclusive (1)

▶ markInconclusiveVerification(applicationId) Mark inconclusive verification API ref → 
intake.markInconclusiveVerification({ path: { applicationId: string } })
Parameters
applicationId string path required

Waive (1)

▶ waiveVerification(applicationId) Waive verification API ref → 
intake.waiveVerification({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required

Mark Cannot Verify (1)

▶ markCannotVerifyVerification(applicationId) Mark cannot verify verification API ref → 
intake.markCannotVerifyVerification({
  path: { applicationId: string },
  body: { ... },
})
Parameters
applicationId string path required
body object body required

Review (10)

▶ getApplicationReview(applicationId) Get applicationReview API ref → 
intake.getApplicationReview({ path: { applicationId: string } })
Parameters
applicationId string path required
▶ getApplicationReviewDemographicsSection(applicationId) Get applicationReview demographics section panel API ref → 
intake.getApplicationReviewDemographicsSection({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ getApplicationReviewIdentitySection(applicationId) Get applicationReview identity section panel API ref → 
intake.getApplicationReviewIdentitySection({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ getApplicationReviewIncomeSection(applicationId) Get applicationReview income section panel API ref → 
intake.getApplicationReviewIncomeSection({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ getApplicationReviewEmploymentSection(applicationId) Get applicationReview employment section panel API ref → 
intake.getApplicationReviewEmploymentSection({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ getApplicationReviewHealthCoverageSection(applicationId) Get applicationReview health-coverage section panel API ref → 
intake.getApplicationReviewHealthCoverageSection({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ getApplicationReviewAssetsSection(applicationId) Get applicationReview assets section panel API ref → 
intake.getApplicationReviewAssetsSection({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ getApplicationReviewContactSection(applicationId) Get applicationReview contact section panel API ref → 
intake.getApplicationReviewContactSection({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ getApplicationReviewExpensesSection(applicationId) Get applicationReview expenses section panel API ref → 
intake.getApplicationReviewExpensesSection({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ getApplicationReviewHouseholdSection(applicationId) Get applicationReview household section panel API ref → 
intake.getApplicationReviewHouseholdSection({
  path: { applicationId: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional

Review Progress (6)

▶ listReviewProgressBySection(applicationId, section) List ReviewProgress state records for a section API ref → 
intake.listReviewProgressBySection({
  path: { applicationId: string, section: string },
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})
Parameters
applicationId string path required
section string path required
q search → string query optional
limit number query optional
offset number query optional
sort string query optional
▶ updateReviewProgressBySection(applicationId, section) Update ReviewProgress state for a section API ref → 
intake.updateReviewProgressBySection({
  path: { applicationId: string, section: string },
  body: { ... },
})
Parameters
applicationId string path required
section string path required
body object body required
▶ replaceReviewProgressBySection(applicationId, section) Replace ReviewProgress state for a section API ref → 
intake.replaceReviewProgressBySection({
  path: { applicationId: string, section: string },
  body: { ... },
})
Parameters
applicationId string path required
section string path required
body object body required
▶ getReviewProgressByItem(applicationId, section, itemId) Get ReviewProgress state for a collection item API ref → 
intake.getReviewProgressByItem({
  path: { applicationId: string, section: string, itemId: string },
})
Parameters
applicationId string path required
section string path required
itemId string path required
▶ updateReviewProgressByItem(applicationId, section, itemId) Update ReviewProgress state for a collection item API ref → 
intake.updateReviewProgressByItem({
  path: { applicationId: string, section: string, itemId: string },
  body: { ... },
})
Parameters
applicationId string path required
section string path required
itemId string path required
body object body required
▶ replaceReviewProgressByItem(applicationId, section, itemId) Replace ReviewProgress state for a collection item API ref → 
intake.replaceReviewProgressByItem({
  path: { applicationId: string, section: string, itemId: string },
  body: { ... },
})
Parameters
applicationId string path required
section string path required
itemId string path required
body object body required

Constants (20)

▶ Annotations map — annotations compiled from intake-annotations*.yaml at generation time 
intake.Annotations.schema['field/path']      // field annotations
intake.Annotations.operations['action-id']   // operation annotations
intake.Annotations.events['event.type']      // event annotations
Sub-maps
schemaField-level annotations keyed by JSON path
operationsState machine action and OpenAPI operation annotations
eventsAsyncAPI event channel annotations
▶ ApplicationReviewSections enum (9 values)
'demographics'
'identity'
'income'
'employment'
'health-coverage'
'assets'
'contact'
'expenses'
'household'
▶ AssetType enum (6 values)
'liquid'
'vehicle'
'real_property'
'retirement_account'
'insurance'
'other'
▶ DeductionFrequency enum (7 values)
'one_time_only'
'weekly'
'every_two_weeks'
'twice_monthly'
'monthly'
'yearly'
'variable'
▶ DeductionType enum (12 values)
'alimony_paid'
'capital_losses'
'early_withdrawal_penalty'
'student_loan_interest'
'domestic_production_activities'
'reimbursement_of_expenses'
'hsa_deduction'
'moving_expenses'
'traditional_ira_contribution'
'reservist_performing_artist_government_official_expenses'
'other'
'prior_period'
▶ ExpenseType enum (7 values)
'rent'
'mortgage'
'dependent_care'
'medical'
'child_support'
'alimony'
'other'
▶ HealthPlanType enum (12 values)
'employer_sponsored'
'cobra'
'medicare'
'tricare'
'va'
'marketplace'
'peace_corps'
'chip'
'medicaid'
'tribal_health_services'
'other_federal'
'other'
▶ ImmigrantStatus enum (12 values)
'lawful_permanent_resident'
'refugee'
'asylee'
'deportation_withheld'
'parolee'
'conditional_entrant'
'cuban_haitian_entrant'
'amerasian'
'battered_non_citizen'
'trafficking_victim'
'temporary_protected_status'
'other'
▶ IncomeChangeReason enum (6 values)
'stopped_working'
'hours_reduced'
'new_job'
'change_in_employment'
'marital_status_change'
'other'
▶ IncomeFrequency enum (7 values)
'daily'
'weekly'
'every_two_weeks'
'twice_monthly'
'monthly'
'yearly'
'variable'
▶ IncomeType enum (9 values)
'employed'
'self_employed'
'unearned'
'lump_sum'
'in_kind_support'
'tribal'
'education_grant'
'other'
'prior_period'
▶ InKindSupportType enum (4 values)
'shelter'
'food'
'utilities'
'other'
▶ InsurancePolicyType enum (4 values)
'term'
'permanent'
'burial'
'other'
▶ JobEndReason enum (2 values)
'voluntary_separation'
'involuntary_separation'
▶ JobStatus enum (3 values)
'active'
'on_strike'
'ended'
▶ JobType enum (2 values)
'employed'
'self_employed'
▶ LumpSumType enum (9 values)
'lawsuit_settlement'
'insurance_settlement'
'social_security_ssi_ssdi_payment'
'veterans'
'inheritance'
'surrender_of_annuity'
'life_insurance_payout'
'lottery_gambling_winnings'
'other'
▶ PremiumFrequency enum (5 values)
'weekly'
'every_two_weeks'
'twice_monthly'
'monthly'
'yearly'
▶ RealPropertyUse enum (5 values)
'primary_residence'
'rental'
'self_employment'
'for_sale'
'other'
▶ UnearnedIncomeType enum (23 values)
'unemployment'
'kinship_payment'
'veterans_programs'
'adoption_and_refugee_services'
'ssi_or_ssdi'
'private_disability'
'workers_compensation'
'disability_from_veterans_programs'
'legal_settlement'
'scholarship'
'educational_grant'
'work_study'
'spousal_support'
'child_support'
'retirement_or_pension'
'investment_interest_and_dividends'
'social_security_retirement'
'rental_income'
'gambling_or_lottery_winnings'
'gifts_or_donations'
'loan_or_mortgage_income'
'research_participation'
'other'

Types (126)

▶ Application 7 fields
interface Application {
programsAppliedFor?: array[enum: "snap", "medicaid", "chip", "tanf"]
channel?: enum: "online", "in_person", "phone", "mail"
ebt?: object
registerToVote?: boolean
deniesIevsConsent?: boolean
expeditedSnap?: object
utilities?: object
}
▶ ApplicationCreate 7 fields
interface ApplicationCreate {
programsAppliedFor?: array[enum: "snap", "medicaid", "chip", "tanf"]
channel?: enum: "online", "in_person", "phone", "mail"
ebt?: object
registerToVote?: boolean
deniesIevsConsent?: boolean
expeditedSnap?: object
utilities?: object
}
▶ ApplicationUpdate 7 fields
interface ApplicationUpdate {
programsAppliedFor?: array[enum: "snap", "medicaid", "chip", "tanf"]
channel?: enum: "online", "in_person", "phone", "mail"
ebt?: object
registerToVote?: boolean
deniesIevsConsent?: boolean
expeditedSnap?: object
utilities?: object
}
▶ ApplicationList 4 fields
interface ApplicationList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ ApplicationMember 19 fields
interface ApplicationMember {
roles?: array[enum: "primary_applicant", "household_member", "non_applying_member", "authorized_representative", "absent_parent"]
programsAppliedFor?: array[enum: "snap", "medicaid", "chip", "tanf"]
purchasesAndPreparesFood?: boolean
isMigrantFarmWorker?: boolean
hasThirdPartyLiabilityClaim?: boolean
personId?: string
personalInformation?: object
contact?: object
residency?: object
citizenship?: object
retroactiveMedicalCoverage?: object
disability?: object
studentStatus?: object
pregnancy?: object
fosterCare?: object
military?: object
institutionalStatus?: object
priorConvictions?: object
tribalStatus?: object
}
▶ ApplicationMemberCreate 19 fields
interface ApplicationMemberCreate {
roles?: array[enum: "primary_applicant", "household_member", "non_applying_member", "authorized_representative", "absent_parent"]
programsAppliedFor?: array[enum: "snap", "medicaid", "chip", "tanf"]
purchasesAndPreparesFood?: boolean
isMigrantFarmWorker?: boolean
hasThirdPartyLiabilityClaim?: boolean
personId?: string
personalInformation?: object
contact?: object
residency?: object
citizenship?: object
retroactiveMedicalCoverage?: object
disability?: object
studentStatus?: object
pregnancy?: object
fosterCare?: object
military?: object
institutionalStatus?: object
priorConvictions?: object
tribalStatus?: object
}
▶ ApplicationMemberUpdate 19 fields
interface ApplicationMemberUpdate {
roles?: array[enum: "primary_applicant", "household_member", "non_applying_member", "authorized_representative", "absent_parent"]
programsAppliedFor?: array[enum: "snap", "medicaid", "chip", "tanf"]
purchasesAndPreparesFood?: boolean
isMigrantFarmWorker?: boolean
hasThirdPartyLiabilityClaim?: boolean
personId?: string
personalInformation?: object
contact?: object
residency?: object
citizenship?: object
retroactiveMedicalCoverage?: object
disability?: object
studentStatus?: object
pregnancy?: object
fosterCare?: object
military?: object
institutionalStatus?: object
priorConvictions?: object
tribalStatus?: object
}
▶ ApplicationMemberList 4 fields
interface ApplicationMemberList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ PersonMatch 2 fields
interface PersonMatch {
matchStatus?: enum: "confirmed", "review_required", "no_match"
candidates?: array[object]
}
▶ PersonMatchCandidate 2 fields
interface PersonMatchCandidate {
personId: string
confidenceScore: number
}
▶ ApplicationMemberProgramDetermination 3 fields
interface ApplicationMemberProgramDetermination {
program: string
outcome?: enum: "approved", "denied"
determinedAt?: string
}
▶ IncomeUpdate 7 fields
interface IncomeUpdate {
type?: enum (9 values)
typeOther?: string
amount: number
frequency: enum (7 values)
dateReceived?: string
changeReason?: enum (6 values)
changeExplanation?: string
}
▶ IncomeList 4 fields
interface IncomeList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ Expense 4 fields
interface Expense {
type?: enum (7 values)
typeOther?: string
amount: number
legallyObligatedAmount?: number
}
▶ ExpenseCreate 4 fields
interface ExpenseCreate {
type?: enum (7 values)
typeOther?: string
amount: number
legallyObligatedAmount?: number
}
▶ ExpenseUpdate 4 fields
interface ExpenseUpdate {
type?: enum (7 values)
typeOther?: string
amount: number
legallyObligatedAmount?: number
}
▶ ExpenseList 4 fields
interface ExpenseList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ AssetUpdate 3 fields
interface AssetUpdate {
type?: enum (6 values)
typeOther?: string
value: number
}
▶ AssetList 4 fields
interface AssetList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ JobUpdate 10 fields
interface JobUpdate {
type?: enum: "employed", "self_employed"
status: enum: "active", "on_strike", "ended"
hoursPerWeek?: number
isTemporary?: boolean
startDate?: string
endDate?: string
endReason?: enum: "voluntary_separation", "involuntary_separation"
strikeStartDate?: string
lastPaycheckDate?: string
lastPaycheckGrossAmount?: number
}
▶ JobList 4 fields
interface JobList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ HealthPlanUpdate 4 fields
interface HealthPlanUpdate {
type?: enum (12 values)
typeOther?: string
premiumAmount?: number
premiumFrequency?: enum: "weekly", "every_two_weeks", "twice_monthly", "monthly", "yearly"
}
▶ HealthPlanList 4 fields
interface HealthPlanList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ HealthEnrollment 9 fields
interface HealthEnrollment {
healthPlanId?: string
jobId?: string
role: enum: "subscriber", "dependent"
startDate?: string
endDate?: string
eligibleDate?: string
enrollmentStatus?: enum: "eligible", "enrolled", "pending", "ended"
prefersSeparateMailing?: boolean
sponsor?: object
}
▶ HealthEnrollmentCreate 9 fields
interface HealthEnrollmentCreate {
healthPlanId?: string
jobId?: string
role: enum: "subscriber", "dependent"
startDate?: string
endDate?: string
eligibleDate?: string
enrollmentStatus?: enum: "eligible", "enrolled", "pending", "ended"
prefersSeparateMailing?: boolean
sponsor?: object
}
▶ HealthEnrollmentUpdate 9 fields
interface HealthEnrollmentUpdate {
healthPlanId?: string
jobId?: string
role: enum: "subscriber", "dependent"
startDate?: string
endDate?: string
eligibleDate?: string
enrollmentStatus?: enum: "eligible", "enrolled", "pending", "ended"
prefersSeparateMailing?: boolean
sponsor?: object
}
▶ HealthEnrollmentList 4 fields
interface HealthEnrollmentList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ AssetDisposal 5 fields
interface AssetDisposal {
type?: enum (6 values)
typeOther?: string
dateOfDisposal: string
amountReceived: number
fairMarketValue: number
}
▶ AssetDisposalCreate 5 fields
interface AssetDisposalCreate {
type?: enum (6 values)
typeOther?: string
dateOfDisposal: string
amountReceived: number
fairMarketValue: number
}
▶ AssetDisposalUpdate 5 fields
interface AssetDisposalUpdate {
type?: enum (6 values)
typeOther?: string
dateOfDisposal: string
amountReceived: number
fairMarketValue: number
}
▶ AssetDisposalList 4 fields
interface AssetDisposalList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ Deduction 5 fields
interface Deduction {
type?: enum (12 values)
typeOther?: string
frequency?: enum (7 values)
amount: number
annualAmount?: number
}
▶ DeductionCreate 5 fields
interface DeductionCreate {
type?: enum (12 values)
typeOther?: string
frequency?: enum (7 values)
amount: number
annualAmount?: number
}
▶ DeductionUpdate 5 fields
interface DeductionUpdate {
type?: enum (12 values)
typeOther?: string
frequency?: enum (7 values)
amount: number
annualAmount?: number
}
▶ DeductionList 4 fields
interface DeductionList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ DisabilityBenefit 5 fields
interface DisabilityBenefit {
programType?: enum: "ssi", "ssdi"
status?: enum (6 values)
applicationDate?: string
startDate?: string
endDate?: string
}
▶ DisabilityBenefitCreate 5 fields
interface DisabilityBenefitCreate {
programType?: enum: "ssi", "ssdi"
status?: enum (6 values)
applicationDate?: string
startDate?: string
endDate?: string
}
▶ DisabilityBenefitUpdate 5 fields
interface DisabilityBenefitUpdate {
programType?: enum: "ssi", "ssdi"
status?: enum (6 values)
applicationDate?: string
startDate?: string
endDate?: string
}
▶ DisabilityBenefitList 4 fields
interface DisabilityBenefitList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ Contact 4 fields
interface Contact {
name: object
primaryAddress?: object
primaryPhone?: string
email?: string
}
▶ ContactCreate 4 fields
interface ContactCreate {
name: object
primaryAddress?: object
primaryPhone?: string
email?: string
}
▶ ContactUpdate 4 fields
interface ContactUpdate {
name: object
primaryAddress?: object
primaryPhone?: string
email?: string
}
▶ ContactList 4 fields
interface ContactList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ Organization 4 fields
interface Organization {
name: string
ein?: string
address?: object
phone?: string
}
▶ OrganizationCreate 4 fields
interface OrganizationCreate {
name: string
ein?: string
address?: object
phone?: string
}
▶ OrganizationUpdate 4 fields
interface OrganizationUpdate {
name: string
ein?: string
address?: object
phone?: string
}
▶ OrganizationList 4 fields
interface OrganizationList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ PersonRelationship 3 fields
interface PersonRelationship {
from: object
to: object
relationshipTypes: array[enum (12 values)]
}
▶ PersonRelationshipCreate 3 fields
interface PersonRelationshipCreate {
from: object
to: object
relationshipTypes: array[enum (12 values)]
}
▶ PersonRelationshipUpdate 3 fields
interface PersonRelationshipUpdate {
from: object
to: object
relationshipTypes: array[enum (12 values)]
}
▶ PersonRelationshipList 4 fields
interface PersonRelationshipList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ AuthorizedRepresentative 6 fields
interface AuthorizedRepresentative {
type: enum: "member", "contact", "organization"
id: string
inCareOf?: object
receivesNotices?: boolean
appointedByMemberId?: string
programs?: array[enum: "snap", "medicaid", "chip", "tanf", "aca"]
}
▶ AuthorizedRepresentativeCreate 6 fields
interface AuthorizedRepresentativeCreate {
type: enum: "member", "contact", "organization"
id: string
inCareOf?: object
receivesNotices?: boolean
appointedByMemberId?: string
programs?: array[enum: "snap", "medicaid", "chip", "tanf", "aca"]
}
▶ AuthorizedRepresentativeUpdate 6 fields
interface AuthorizedRepresentativeUpdate {
type: enum: "member", "contact", "organization"
id: string
inCareOf?: object
receivesNotices?: boolean
appointedByMemberId?: string
programs?: array[enum: "snap", "medicaid", "chip", "tanf", "aca"]
}
▶ AuthorizedRepresentativeList 4 fields
interface AuthorizedRepresentativeList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ TaxFiler 8 fields
interface TaxFiler {
filingJointlyWithSpouse?: boolean
spouse?: object
claimingDependents?: boolean
dependents?: array[object]
expectedToBeClaimedByNonHouseholdMember?: boolean
personClaiming?: object
isNonCustodialParent?: boolean
hasDomesticViolenceTaxFilingException?: boolean
}
▶ TaxFilerCreate 8 fields
interface TaxFilerCreate {
filingJointlyWithSpouse?: boolean
spouse?: object
claimingDependents?: boolean
dependents?: array[object]
expectedToBeClaimedByNonHouseholdMember?: boolean
personClaiming?: object
isNonCustodialParent?: boolean
hasDomesticViolenceTaxFilingException?: boolean
}
▶ TaxFilerUpdate 8 fields
interface TaxFilerUpdate {
filingJointlyWithSpouse?: boolean
spouse?: object
claimingDependents?: boolean
dependents?: array[object]
expectedToBeClaimedByNonHouseholdMember?: boolean
personClaiming?: object
isNonCustodialParent?: boolean
hasDomesticViolenceTaxFilingException?: boolean
}
▶ TaxFilerList 4 fields
interface TaxFilerList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ Sponsor 7 fields
interface Sponsor {
sponsoredMemberId?: string
type?: enum: "member", "contact"
ssn?: string
spouse?: object
householdSize?: number
income?: number
livesWithSponsored?: boolean
}
▶ SponsorCreate 7 fields
interface SponsorCreate {
sponsoredMemberId?: string
type?: enum: "member", "contact"
ssn?: string
spouse?: object
householdSize?: number
income?: number
livesWithSponsored?: boolean
}
▶ SponsorUpdate 7 fields
interface SponsorUpdate {
sponsoredMemberId?: string
type?: enum: "member", "contact"
ssn?: string
spouse?: object
householdSize?: number
income?: number
livesWithSponsored?: boolean
}
▶ SponsorList 4 fields
interface SponsorList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ Signature 4 fields
interface Signature {
signer: object
purpose: enum (6 values)
signedAt: string
signatureMethod: enum: "electronic", "wet_signature", "verbal"
}
▶ SignatureCreate 4 fields
interface SignatureCreate {
signer: object
purpose: enum (6 values)
signedAt: string
signatureMethod: enum: "electronic", "wet_signature", "verbal"
}
▶ SignatureUpdate 4 fields
interface SignatureUpdate {
signer: object
purpose: enum (6 values)
signedAt: string
signatureMethod: enum: "electronic", "wet_signature", "verbal"
}
▶ SignatureList 4 fields
interface SignatureList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ ApplicationChildSupport 2 fields
interface ApplicationChildSupport {
goodCauseChildSupportWaiver?: boolean
parentsOutsideHome?: array[object]
}
▶ ApplicationChildSupportUpdate 2 fields
interface ApplicationChildSupportUpdate {
goodCauseChildSupportWaiver?: boolean
parentsOutsideHome?: array[object]
}
▶ ApplicationHousehold 4 fields
interface ApplicationHousehold {
roomers?: array[object]
utilitiesIncludedInRent?: boolean
isSubsidizedHousing?: boolean
receivedTanfInAnotherState?: boolean
}
▶ ApplicationHouseholdUpdate 4 fields
interface ApplicationHouseholdUpdate {
roomers?: array[object]
utilitiesIncludedInRent?: boolean
isSubsidizedHousing?: boolean
receivedTanfInAnotherState?: boolean
}
▶ Verification 5 fields
interface Verification {
status?: enum: "pending", "inconclusive", "satisfied", "waived", "cannot_verify"
sourceId?: string
sourceType?: enum: "member", "income"
category?: enum: "citizenship", "identity", "immigration", "income", "residency"
verificationType?: enum: "document", "electronic"
}
▶ VerificationCreate 5 fields
interface VerificationCreate {
status?: enum: "pending", "inconclusive", "satisfied", "waived", "cannot_verify"
sourceId?: string
sourceType?: enum: "member", "income"
category?: enum: "citizenship", "identity", "immigration", "income", "residency"
verificationType?: enum: "document", "electronic"
}
▶ VerificationUpdate 5 fields
interface VerificationUpdate {
status?: enum: "pending", "inconclusive", "satisfied", "waived", "cannot_verify"
sourceId?: string
sourceType?: enum: "member", "income"
category?: enum: "citizenship", "identity", "immigration", "income", "residency"
verificationType?: enum: "document", "electronic"
}
▶ VerificationList 4 fields
interface VerificationList {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ Interview 3 fields
interface Interview {
waiverStatus?: enum: "pending", "granted", "denied"
waiverReason?: string
completedAt?: string
}
▶ InterviewUpdate 3 fields
interface InterviewUpdate {
waiverStatus?: enum: "pending", "granted", "denied"
waiverReason?: string
completedAt?: string
}
▶ VerificationDocumentRequest 5 fields
interface VerificationDocumentRequest {
noticeId: string
type: enum: "document_request_citizenship_verification", "document_request_identity_verification", "document_request_immigration_verification", "document_request_income_verification", "document_request_residency_verification"
sentAt: string
dueAt?: string
channel?: enum: "email", "in_person", "mail", "portal"
}
▶ WithdrawApplicationRequest 1 field
interface WithdrawApplicationRequest {
reason: string
}
▶ WaiveVerificationRequest 1 field
interface WaiveVerificationRequest {
reason: string
}
▶ MarkCannotVerifyRequest 1 field
interface MarkCannotVerifyRequest {
reason: string
}
▶ ReviewProgressWritable 2 fields
interface ReviewProgressWritable {
status?: enum: "not_started", "in_progress", "complete", "flagged"
notes?: object
}
▶ ReviewProgress 2 fields
interface ReviewProgress {
status?: enum: "not_started", "in_progress", "complete", "flagged"
notes?: object
}
▶ ReviewProgressListResponse 5 fields
interface ReviewProgressListResponse {
items: array[object]
total: number
limit: number
offset: number
hasNext: boolean
}
▶ ApplicationWritable 7 fields
interface ApplicationWritable {
programsAppliedFor?: array[enum: "snap", "medicaid", "chip", "tanf"]
channel?: enum: "online", "in_person", "phone", "mail"
ebt?: object
registerToVote?: boolean
deniesIevsConsent?: boolean
expeditedSnap?: object
utilities?: object
}
▶ ApplicationListWritable 4 fields
interface ApplicationListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ ApplicationMemberWritable 19 fields
interface ApplicationMemberWritable {
roles?: array[enum: "primary_applicant", "household_member", "non_applying_member", "authorized_representative", "absent_parent"]
programsAppliedFor?: array[enum: "snap", "medicaid", "chip", "tanf"]
purchasesAndPreparesFood?: boolean
isMigrantFarmWorker?: boolean
hasThirdPartyLiabilityClaim?: boolean
personId?: string
personalInformation?: object
contact?: object
residency?: object
citizenship?: object
retroactiveMedicalCoverage?: object
disability?: object
studentStatus?: object
pregnancy?: object
fosterCare?: object
military?: object
institutionalStatus?: object
priorConvictions?: object
tribalStatus?: object
}
▶ ApplicationMemberListWritable 4 fields
interface ApplicationMemberListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ IncomeListWritable 4 fields
interface IncomeListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ ExpenseWritable 4 fields
interface ExpenseWritable {
type?: enum (7 values)
typeOther?: string
amount: number
legallyObligatedAmount?: number
}
▶ ExpenseListWritable 4 fields
interface ExpenseListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ AssetListWritable 4 fields
interface AssetListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ JobListWritable 4 fields
interface JobListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ HealthPlanListWritable 4 fields
interface HealthPlanListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ HealthEnrollmentWritable 9 fields
interface HealthEnrollmentWritable {
healthPlanId?: string
jobId?: string
role: enum: "subscriber", "dependent"
startDate?: string
endDate?: string
eligibleDate?: string
enrollmentStatus?: enum: "eligible", "enrolled", "pending", "ended"
prefersSeparateMailing?: boolean
sponsor?: object
}
▶ HealthEnrollmentListWritable 4 fields
interface HealthEnrollmentListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ AssetDisposalWritable 5 fields
interface AssetDisposalWritable {
type?: enum (6 values)
typeOther?: string
dateOfDisposal: string
amountReceived: number
fairMarketValue: number
}
▶ AssetDisposalListWritable 4 fields
interface AssetDisposalListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ DeductionWritable 5 fields
interface DeductionWritable {
type?: enum (12 values)
typeOther?: string
frequency?: enum (7 values)
amount: number
annualAmount?: number
}
▶ DeductionListWritable 4 fields
interface DeductionListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ DisabilityBenefitWritable 5 fields
interface DisabilityBenefitWritable {
programType?: enum: "ssi", "ssdi"
status?: enum (6 values)
applicationDate?: string
startDate?: string
endDate?: string
}
▶ DisabilityBenefitListWritable 4 fields
interface DisabilityBenefitListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ ContactWritable 4 fields
interface ContactWritable {
name: object
primaryAddress?: object
primaryPhone?: string
email?: string
}
▶ ContactListWritable 4 fields
interface ContactListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ OrganizationWritable 4 fields
interface OrganizationWritable {
name: string
ein?: string
address?: object
phone?: string
}
▶ OrganizationListWritable 4 fields
interface OrganizationListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ PersonRelationshipWritable 3 fields
interface PersonRelationshipWritable {
from: object
to: object
relationshipTypes: array[enum (12 values)]
}
▶ PersonRelationshipListWritable 4 fields
interface PersonRelationshipListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ AuthorizedRepresentativeWritable 6 fields
interface AuthorizedRepresentativeWritable {
type: enum: "member", "contact", "organization"
id: string
inCareOf?: object
receivesNotices?: boolean
appointedByMemberId?: string
programs?: array[enum: "snap", "medicaid", "chip", "tanf", "aca"]
}
▶ AuthorizedRepresentativeListWritable 4 fields
interface AuthorizedRepresentativeListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ TaxFilerWritable 8 fields
interface TaxFilerWritable {
filingJointlyWithSpouse?: boolean
spouse?: object
claimingDependents?: boolean
dependents?: array[object]
expectedToBeClaimedByNonHouseholdMember?: boolean
personClaiming?: object
isNonCustodialParent?: boolean
hasDomesticViolenceTaxFilingException?: boolean
}
▶ TaxFilerListWritable 4 fields
interface TaxFilerListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ SponsorWritable 7 fields
interface SponsorWritable {
sponsoredMemberId?: string
type?: enum: "member", "contact"
ssn?: string
spouse?: object
householdSize?: number
income?: number
livesWithSponsored?: boolean
}
▶ SponsorListWritable 4 fields
interface SponsorListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ SignatureWritable 4 fields
interface SignatureWritable {
signer: object
purpose: enum (6 values)
signedAt: string
signatureMethod: enum: "electronic", "wet_signature", "verbal"
}
▶ SignatureListWritable 4 fields
interface SignatureListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ ApplicationChildSupportWritable 2 fields
interface ApplicationChildSupportWritable {
goodCauseChildSupportWaiver?: boolean
parentsOutsideHome?: array[object]
}
▶ ApplicationHouseholdWritable 4 fields
interface ApplicationHouseholdWritable {
roomers?: array[object]
utilitiesIncludedInRent?: boolean
isSubsidizedHousing?: boolean
receivedTanfInAnotherState?: boolean
}
▶ VerificationWritable 4 fields
interface VerificationWritable {
sourceId?: string
sourceType?: enum: "member", "income"
category?: enum: "citizenship", "identity", "immigration", "income", "residency"
verificationType?: enum: "document", "electronic"
}
▶ VerificationCreateWritable 4 fields
interface VerificationCreateWritable {
sourceId?: string
sourceType?: enum: "member", "income"
category?: enum: "citizenship", "identity", "immigration", "income", "residency"
verificationType?: enum: "document", "electronic"
}
▶ VerificationUpdateWritable 4 fields
interface VerificationUpdateWritable {
sourceId?: string
sourceType?: enum: "member", "income"
category?: enum: "citizenship", "identity", "immigration", "income", "residency"
verificationType?: enum: "document", "electronic"
}
▶ VerificationListWritable 4 fields
interface VerificationListWritable {
total: number
limit: number
offset: number
hasNext?: boolean
}
▶ InterviewWritable 3 fields
interface InterviewWritable {
waiverStatus?: enum: "pending", "granted", "denied"
waiverReason?: string
completedAt?: string
}
▶ InterviewUpdateWritable 3 fields
interface InterviewUpdateWritable {
waiverStatus?: enum: "pending", "granted", "denied"
waiverReason?: string
completedAt?: string
}
▶ ReviewProgressWritable2 2 fields
interface ReviewProgressWritable2 {
status?: enum: "not_started", "in_progress", "complete", "flagged"
notes?: object
}
▶ ReviewProgressListResponseWritable 5 fields
interface ReviewProgressListResponseWritable {
items: array[object]
total: number
limit: number
offset: number
hasNext: boolean
}