Request Body
ParsedDocumentrequiredstring
Parsed JSON from the Sovren Resume or Job Order Parser.
IndexIfGeocodeFailsrequiredbool
Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.
GeocodeOptionsrequiredobject
Settings to determine the form of geocoding for the transaction.
GeocodeOptions.Providerrequiredstring
The Provider you wish to use to geocode the postal address (current options are "Google" or "Bing"). If not specified, we will default to Google.
If passing a ProviderKey, this field is required.
If passing a ProviderKey, this field is required.
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 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.Latituderequiredfloat
The latitude coordinate value.
GeocodeOptions.GeoCoordinates.Longituderequiredfloat
The longitude coordinate value.
IndexingOptionsrequiredobject
Settings to specify where to store the document.
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.