For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get a Demo
Get StartedConceptsProductsGuidesUI ComponentsAPI Access
Get StartedConceptsProductsGuidesUI ComponentsAPI Access
    • Introduction
    • Onboarding
    • Card Management
    • Credit Goals
    • Profile
    • Component Messaging
Get a Demo
LogoLogo
On this page
  • Onboarding Steps
  • 1. Create Consumer
  • 2. Authentication
  • Required Scopes
  • 3. Load Upward UI Component
  • Parameters
  • Card Onboarding Component
  • Credit Builder Onboarding Component
  • Example — React Native

Onboarding

Was this page helpful?
Previous

Card Management

Next
Built with

The Onboarding components allow an end-user to complete end-to-end onboarding to the Upward Platform.
There are two separate onboarding flows:

  • Card Onboarding — for end-users applying for a Card program.
  • CBaaS Onboarding — for end-users onboarding to Credit Builder as a Service.

Onboarding Steps

1. Create Consumer

Partners must create a consumer via the Create Consumer API before loading the onboarding components. The onboarding UI component will be prefilled with the data provided.


2. Authentication

Both onboarding components require a JWT with specific scopes.

Required Scopes

  • Card Onboarding:
    api:card-management:read, api:lending:write, ui:client-onboarding

  • CBaaS Onboarding:
    ui:client-onboarding, api:consumer-profile:read, api:trade-line:read

See Auth API


3. Load Upward UI Component

At this step, load the correct component based on the flow:

Parameters

ParameterValueNotes
pcidGuid or SimilarA unique ID that your platform stores for this user.
access_tokenJWT Bearer TokenMust include the ui:client-onboarding scope. Useful if your platform cannot inject the token directly into the component.

Card Onboarding Component

  • Component URL:
    https://component-embedded-sandbox.upwardli.com/en/onboarding/card-product/?access_token=&pcid=

Credit Builder Onboarding Component

  • Component URL:
    https://component-embedded-sandbox.upwardli.com/onboarding/?access_token=&pcid=

Example — React Native

1export default function OnboardingScreen({ route }: Props) {
2const url = "Flow URL";
3return (
4 <SafeAreaView>
5 <View>
6 <JwtAuthWebview url={url} />
7 </View>
8 </SafeAreaView>
9);
10}