Sign in
program

Get program theme

Get the theme data (messages and CSS) for a program

get/program/{programId}/theme

Path parameters

programIdstring required

Unique identifier for the program

Query parameters

localestring

Optionally override locale to use for translations (defaults to using locale with HTTP request)

Response

The theme data for a program

customCssstring nullable required

Custom CSS to use when rendering the verification form

logoUrlstring nullable required

Deprecated, use the logoUrl in the ThemeChoices URL of the logo associated with this program.

privacyPolicyUrlstring nullable required

The URL to use for the privacy policy.

isTestModeboolean required

Whether or not the program is in test mode

openOrgSearchEnabledboolean

Flag indicating whether the end-user can supply an unknown org when attempting to verify.

isSmsNotifierConfiguredboolean

Flag indicating whether this program has an SMS Notifier configured.

smsLoopEnabledboolean required

Flag indicating whether this program requires SMS loop where phoneNumber is required.

docUploadEnabledboolean required

Flag indicating whether this program may perform the doc upload step.

emailLoopEnabledboolean required

Flag indicating whether this program may perform the email loop step.

ssoEnabledboolean required

Flag indicating whether this program may perform the SSO step.

overrideEnabledboolean required

Flag indicating whether this program may perform the override step.

threatMetrixEnabledboolean

Flag indicating whether this program is configured to use ThreatMetrix for additional fraud detection.

threatMetrixOrgIdstring nullable

The ThreatMetrix organization ID to use for device fingerprinting. May be account-specific or the global default.

ipqsDeviceFingerprintEnabledboolean

Flag indicating whether this program is configured to use IPQS Device Fingerprint for additional fraud detection.

idCheckAddOnEnabledboolean

If true, this program has the ID Check add-on. The program can then ask the person for a government ID.

strictMilitaryValidationEnabledboolean

Flag indicating whether this program uses strict military validation criteria.

transitionalMilitaryValidityDaysinteger nullable

The number of days before and after the active duty end date in which SheerID still accepts the military status. The value is null if the program does not enable transitional military status.

affinityProgramEnabledboolean

If true, successful verifications from this program may be shown offers from Affinity program partners

remainingRewardCodesinteger nullable required

The number of remaining reward codes for the program. Will be null if this should not be shown to the user.

externalUserIdRequiredboolean

If true, externalUserId is required for all verifications on this program.

captchaEnabledboolean

Flag indicating whether this program is configured to use Captcha.

fingerprintEnabledboolean

Flag indicating whether this program is configured to use Fingerprints device signal collection.

Changes