Skip to main content

CreateDependentInput

Input for creating a new dependent

input CreateDependentInput {
  accountHolderUid: ID!
  address: PhysicalAddressInput
  benefitEnrollments: [DependentBenefitEnrollmentInput!]
  dateOfBirth: LocalDate!
  email: EmailAddress
  externalReferenceId: String
  firstName: String!
  lastName: String!
  phoneNumber: PhoneNumber
  relationshipType: DependentRelationshipType!
  ssn: String
}

Fields​

CreateDependentInput.accountHolderUid ● ID! non-null scalar​

First Dollar User ID of the account holder

CreateDependentInput.address ● PhysicalAddressInput input​

The dependent's physical address

CreateDependentInput.benefitEnrollments ● [DependentBenefitEnrollmentInput!] list input​

Optional benefit enrollments to create with the dependent. This is not atomic: the dependent is created first, then each enrollment. If an enrollment fails, the mutation returns an error, but the dependent and any enrollments created before the failure are kept. Use the dependents query to find them, and createDependentBenefitEnrollment to add a missing enrollment.

CreateDependentInput.dateOfBirth ● LocalDate! non-null scalar​

The dependent's date of birth

CreateDependentInput.email ● EmailAddress scalar​

The dependent's email address

CreateDependentInput.externalReferenceId ● String scalar​

Idempotency key. A request sent again with the same key returns the first successful result and does not create another dependent. Keys do not expire. The request body is not compared, so use a new key for a different request. This value is not stored on the dependent or its enrollments.

CreateDependentInput.firstName ● String! non-null scalar​

The dependent's first name

CreateDependentInput.lastName ● String! non-null scalar​

The dependent's last name

CreateDependentInput.phoneNumber ● PhoneNumber scalar​

The dependent's phone number

CreateDependentInput.relationshipType ● DependentRelationshipType! non-null enum​

Relationship type between dependent and account holder

CreateDependentInput.ssn ● String scalar​

The dependent's SSN for user creation

Member Of​

createDependent mutation