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 Component
  • Card Credit Goals Component
  • CBaaS Credit Goals Component

Credit Goals

Was this page helpful?
Previous

Profile

Next
Built with

The Credit Goals components allow an end-user to view their credit score, credit history, and insights.
There are two components depending on the flow:

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

Steps

1. Authentication

Both components require a JWT with the following scope:

  • api:credit-insights:read

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:credit-insights:read scope. Useful if your platform cannot inject the token directly into the component.

3. Load Component

Choose the correct component based on the flow:

Card Credit Goals Component

https://component-embedded-sandbox.upwardli.com/en/credit-goals/?access_token=

CBaaS Credit Goals Component

https://component-embedded-sandbox.upwardli.com/credit-insights/?access_token=&cid=