Request Body
DocumentAsBase64Stringrequiredstring
A Base64 encoded string of the resume 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, so that the Parser knows how to interpret dates in the document that are expressed as "current" or "as of" or similar. To find out why this is so important and how to calculate/find it, read here. Failing to pass a RevisionDate, or passing RevisionDates that are clearly improbable, may result in rejection of data and/or additional charges, and will utterly decimate the usefulness of AI Matching. Use of the RevisionDate field is subject to the Acceptable Use Policy.
OutputHtmloptionalbool
When true, the original file is converted to HTML and stored in the Html property.
OutputRtfoptionalbool
When true, the original file is converted to RTF and stored in the Rtf property.
OutputPdfoptionalbool
When true, the original file is converted to PDF and stored in the Pdf property as a byte array.
OutputCandidateImageoptionalbool
When true, if the document contains inline images, the image that is most likely to be a photo of the candidate is returned as a byte array.
Configurationoptionalstring
Optional parser configuration string to be used for parsing. If not specified, the default parser configuration will be used. For more information regarding the parser configuration string and assistance generating one, refer to the Parser Configuration Documentation.
SkillsDataoptionalstring[]
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.
NormalizerDataoptionalstring
Unavailable except in special cases. Please reach out to support@sovren.com.Name of your custom normalization data file. If no list is provided the Sovren builtin skills list will be used (english only). When using custom normalization files the language to be used is determined by the Parser (the default fall back language is English if the Parser cannot find a match).
GeocodeOptionsoptionalobject
Get or insert geocode coordinate values (latitude/longitude) during the parse transaction.
GeocodeOptions.IncludeGeocodingoptionalbool
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.Provideroptionalstring
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.ProviderKeyoptionalstring
The Provider Key for the specified Provider. If using Bing you must specify your own provider key.
GeocodeOptions.PostalAddressoptionalobject
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.CountryCodeoptionalstring
The ISO 3166-1 alpha-2 code indicating the country for the postal address.
GeocodeOptions.PostalAddress.PostalCodeoptionalstring
The postal code (or zip code) for the postal address
GeocodeOptions.PostalAddress.Regionoptionalstring
The region (i.e. State for U.S. addresses) for the postal address.
GeocodeOptions.PostalAddress.Municipalityoptionalstring
The municipality (i.e. City for U.S. addresses) for the postal address
GeocodeOptions.PostalAddress.AddressLineoptionalstring
The address line (i.e. Street address for U.S. address) for the postal address
GeocodeOptions.GeoCoordinatesoptionalobject
The geographic coordinates (latitude/longitude) for your postal address. Use this if youalready 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.Latitudeoptionalfloat
The latitude coordinate value.
GeocodeOptions.GeoCoordinates.Longitudeoptionalfloat
The longitude coordinate value.
IndexingOptionsoptionalobject
When your account is enabled for Matching/Searching you can automatically index documents during the parse transactions.
IndexingOptions.IndexIdoptionalstring
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.DocumentIdoptionalstring
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.CustomIdsoptionalstring[]
The custom ids you want the document to have.