Credit Goals

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=