Request Body
DocumentAsBase64Stringrequiredstring
A Base64 encoded string of the job order file bytes. This should use the standard 'base64' encoding as defined in RFC 4648 Section 4 (not the 'base64url' variant). .NET users can use the
Convert.ToBase64String(byte[])
method.RevisionDaterequiredstring
Mandatorydate, in YYYY-MM-DD format, representing the "current" or "as of" date used during parsing. This is useful when parsing older documents. Read more about this here.
OutputHtmlrequiredboolean
When true, the original file is converted to HTML and stored in the Html property.
OutputRtfrequiredboolean
When true, the original file is converted to RTF and stored in the Rtf property.
OutputPdfrequiredboolean
When true, the original file is converted to PDF and stored in the Pdf property as a byte array.
Configurationrequiredobject
Options that influence parser behavior.
Configuration.CountryCoderequiredstring
A 2-letter ISO 3166 code (or comma-delimited list of such codes) indicating the country to be assumed in cases where the location cannot be automatically detected. If multiple codes are specified, the first one is given the highest priority.
Configuration.Languagerequiredstring
An ISO 639-1 two letter language code indicating the language to be assumed in cases where the language cannot be automatically detected.
Configuration.KnownTyperequiredstring
Optionally specify a known type to enable special processing. Possible values include:
- Indeed
- Stride
- JOB_SUBMISSION_REPLY_TO_CANDIDATE
Configuration.IncludeRecruitingTermsrequiredboolean
Recruiting terms in skills and job titles are ignored by default, because these terms often appear in job orders that are unrelated to recruiting. If this job order is for a recruiting or human resources position, then set this to true.
Configuration.IncludeSupplementalTextrequiredboolean
The parser defaults to extracting data from only the text that precedes the place in job orders where they transition from describing the job itself to describing the company, hiring policies, background checks, benefits, etc. This division of text normally works well, but in some job orders it can occur in the wrong place. Set this to true to allow the parser to extract data from all of the text.
Configuration.PreferShorterJobTitlesrequiredboolean
The parser defaults to returning full job titles. Setting this option to true will shorten job titles by excluding trailing phrases that do not include job words, so that "Vice President" would be returned instead of "Vice President, Information Systems".
SkillsDatarequiredstring[]
Unavailable except in special cases. Please reach out to support@sovren.com.String[] of your custom skills list names and the Sovren "builtin" skills list. If no list is provided the Sovren builtin skills list will be used. The parser automatically detects language and looks for a corresponding skills list in that language, if no match is found this list is ignored.
NormalizerDatarequiredstring
Will be used in a future release.
GeocodeOptionsrequiredobject
Get or insert geocode coordinate values (latitude/longitude) during the parse transaction.
GeocodeOptions.IncludeGeocodingrequiredbool
When set to true we will automatically geocode the address that is parsed out leveraging an api call to our
/geocode
endpoint, and thus will be charged accordingly. This parameter defaults to false.GeocodeOptions.Providerrequiredstring
The Provider you wish to use to geocode the postal address (current options are "Google", "Bing", or "None"). If not specified, we will default to Google. If you are just trying to update the postal address in the document, please set this to "None".
If passing "Google" or "Bing", ProviderKey is requried.
If passing "Google" or "Bing", ProviderKey is requried.
GeocodeOptions.ProviderKeyrequiredstring
The Provider Key for the specified Provider. If using Bing you must specify your own provider key.
GeocodeOptions.PostalAddressrequiredobject
The postal address you wish to geocode. For best results, specify as many of the PostalAddress fields as possible. If provided, this address will be used to get the geocode coordinates instead of the address included in the ParsedDocument (if present), however, the address in the ParsedDocument will not be modified.
GeocodeOptions.PostalAddress.CountryCoderequiredstring
The ISO 3166-1 alpha-2 code indicating the country for the postal address.
GeocodeOptions.PostalAddress.PostalCoderequiredstring
The postal code (or zip code) for the postal address
GeocodeOptions.PostalAddress.Regionrequiredstring
The region (i.e. State for U.S. addresses) for the postal address.
GeocodeOptions.PostalAddress.Municipalityrequiredstring
The municipality (i.e. City for U.S. addresses) for the postal address
GeocodeOptions.PostalAddress.AddressLinerequiredstring
The address line (i.e. Street address for U.S. address) for the postal address
GeocodeOptions.GeoCoordinatesrequiredobject
The geographic coordinates (latitude/longitude) for your postal address. Use this if you already have latitude/longitude coordinatesand simply wish to add them to your parsed document. If provided, these values will be inserted into your ParsedDocument and the address included in the ParsedDocument (if present), will not be modified.
GeocodeOptions.GeoCoordinates.Latituderequiredfloat
The latitude coordinate value.
GeocodeOptions.GeoCoordinates.Longituderequiredfloat
The longitude coordinate value.
IndexingOptionsrequiredobject
When your account is enabled for Matching/Searching you can automatically index documents during the parse transactions.
IndexingOptions.IndexIdrequiredstring
When your account is enabled for Matching/Searching you can automatically index documents during the parse transactions. This determines what index to place the parsed document in. This is case-insensitive.
IndexingOptions.DocumentIdrequiredstring
When your account is enabled for Matching/Searching you can automatically index documents during the parse transactions. This determines what id to give to the parsed document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.
IndexingOptions.CustomIdsrequiredstring[]
The custom ids you want the document to have.