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
  • Steps
  • 1. Authentication
  • 2. Parameters
  • 3. Load Profile Component
  • Card Profile Component
  • CBaaS Profile Component

Profile

Was this page helpful?
Previous

Component Messaging

Next
Built with

The Profile components allow an end-user to view and manage their account information.
There are two components depending on the flow:

  • Card Profile — for consumers onboarding via Card.
  • CBaaS Profile — for consumers onboarding via Credit Builder as a Service.

Steps

1. Authentication

Both components require a JWT with the following scope:

  • api:profile:read
  • api:profile:write

This token must be scoped to the current consumer.

See consumer scoped token API


2. Parameters

ParameterValueNotes
cidGuidThe upward_consumer_id property of the consumer. This maps to an ID your platform stores for the user. (Required for CBaaS component only)
access_tokenJWT Bearer TokenMust include the api:profile:read, api:profile:write scope. Useful if your platform cannot inject the token directly into the component.

3. Load Profile Component

Choose the correct component based on the flow:

Card Profile Component

https://component-embedded-sandbox.upwardli.com/consumer-profile/?access_token={$consumer_scoped_token}

CBaaS Profile Component

https://component-embedded-sandbox.upwardli.com/profile/?cid={$upward_consumer_id}&access_token={$consumer_scoped_token}