Onboarding & Eligibility Examples

Explore operations for checking preliminary eligibility and managing the user onboarding/registration funnel.

1. Post Eligibility Check

Perform a lightweight eligibility check before full registration to determine if the user is likely to find scholarships on the platform. This is often used in landing pages and marketing funnels.

mutation CheckEligibility($input: PostEligibilityInput!) {
  viewer {
    postEligibility(input: $input) {
      success
    }
  }
}

Variables:

{
  "input": {
    "dob": "2005-06-15",
    "degreeType": "BACHELORS"
  }
}

2. Fetch Onboarding Plugins

Retrieve a list of available third-party offers or integrations (plugins) the user can engage with during the onboarding flow.

query GetOnboardingPlugins {
  viewer {
    onboarding {
      registrationCompletedAt
      plugins {
        id
        name
        text
        extra
      }
    }
  }
}

3. Submit Onboarding Plugins

Submit user choices or data for one or more onboarding plugins.

mutation SubmitPlugins($input: [OnboardingPluginSubmissionInput!]!) {
  viewer {
    onboarding {
      submitPlugins(input: $input) {
        id
        extra
      }
    }
  }
}

Variables:

{
  "input": [
    {
      "id": "plugin-123",
      "extra": {
        "optIn": true
      }
    }
  ]
}