Request Body
UIOptionsoptionalobject
Object representing various options for generating the UI.
UIOptions.Usernameoptionalstring
The username of the current user. *If you do not provide this, the user will be required to login when they view the page.
UIOptions.Styleoptionalobject
Specifies custom style options for this session.
UIOptions.Style.PrimaryColoroptionalstring
An HTML color used to generate several related colors for various UI elements. For example:
#077799.UIOptions.Style.HeaderColoroptionalstring
An HTML color used for the background of the section/accordian headers. For example:
#077799.UIOptions.Style.SquareCornersoptionalboolean
true to use square corners for UI elements. Default is false for rounded corners.UIOptions.Style.FontFamilyoptionalstring
A CSS font-family to use for all UI elements. For example:
Arial.UIOptions.Style.FontUrloptionalstring
If you'd like to use a non-standard font, specify the URL where that font can be downloaded here. For example:
https://fonts.googleapis.com/css2?family=Montserrat:wght@400;500;600;700&display=swap. Note that you also need to define the FontFamily if you use this option.MatchDetailsrequiredobject
The information about the match result for this session. These properties should be filled from a Bimetric Score API response.
MatchDetails.Resultrequiredobject
A single entry from one of the following result lists:
MatchDetails.AppliedCategoryWeightsrequiredobject
The AppliedCategoryWeights object from the API call that generated the above Result. One of:
MatchDetails.SourceDocumentTyperequiredstring
The type of document the job was scored against. Either
Resume or Job.MatchDetails.JobDatarequiredobject
The Sovren parsed job object that will be used (along with the match result above) to populate the details view.
MatchDetails.HtmlDocumentoptionalstring
The HTML job to be displayed in the details view. If you do not provide this, only the plain text for the job is shown. The only allowed HTML string is the one generated by Sovren in a Parse API when you set OutputHtml to true. See here: Parsed Job HTML.