RequiredAction

amountintegerrequired

Amount of the offer in currency

currencystringrequired

ISO 4217 code for the currency of the offer

Allowed values:USDCADAUDEURGBPSEKDKK

Example

textstringrequired

Display text for the CTA

bullet_pointsarray[string]

List of text bullet points to display in the CTA

button_labelstringrequired

Label for the button

funding_cycleintegerrequired

Number of user funding cycles.

Example

Allowed values:complete_applicationprovide_additional_infoselect_offercomplete_kycsign_contract

banner_stateAny Of

Legacy field. Will be removed in future updates.

BannerStatestring

Allowed values:continue_applicationcontinue_embedded_applicationindicative_offergeneric_offer

dismissal_keyAny Of

Opaque key identifying which CTA was dismissed.

Variant 1string

Example

emailAny Of

The email of the user

Variant 1string(email)

first_nameAny Of

The first name of the user

Variant 1string

last_nameAny Of

The last name of the user

Variant 1string

phone_numberAny Of

The phone number of the user in E.164 format

Variant 1string

Example

Offer