Skip to main

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.

Getting Started

Deprecated | New features and bug fixes will no longer be deployed to this version. Plan your upgrade now.

The ParsingService is a SOAP web service which provides resume/CV conversion and parsing, returning converted documents in any of several available formats, and parsed/extracted data in XML format. The API is described as follows. Your access to any feature is governed by your Terms of Service.


The SOAP API can be accessed through the following URLs:

TypeData Center (US)Data Center (EU)
BEWARE: The WSDL specifies the unencrypted HTTP URL, not the encrypted HTTPS URL. This means that SOAP clients that are automatically generated from the WSDL will default to using the unencrypted HTTP URL. To encrypt your communications using HTTPS, make sure that you explicitly set the URL of your SOAP client.


Parser Config String Builder - This spreadsheet can be used to build the parser configuration string.

Document Conversion Result Codes - Contains all possible result codes that can be returned by the Document Converter.

Sovren HR-XML Resume Guide (VERY IMPORTANT) - Contains the HR-XML schema definition and samples.

Job Order XML Guide - Contains the Job Order XML schema definition and samples.


The following standalone applications are available for code-free testing of the service:

Working samples with source code are provided for the following programming languages (with more to come).


Please visit the Tools & Utilities section within My Sovren Portal for access to all utility applications.

Customizing Lists

The following web methods provide API calls that allow you to manage your own custom lists so you can apply them during parse time. For custom skills implementation, please download the Sovren Skills Editor utility available within My Sovren Portal which provides a rich GUI for skills managment.

Performance Tuning Tips

Compress the Request

Gzip compress the FileBytes data to significantly reduce average network transfer times and network utilization. Compressible file types like DOC and HTML are typically reduced in size by 80%.

Compress the Response

Add the HTTP request header "Accept-Encoding: gzip, deflate" to allow the response to be compressed. A reduction of 80% is typical.

Reduce Roundtrips

Some HTTP clients automatically enable the HTTP request header "Expect: 100-Continue" for POST requests, which causes the client to send a header-only request, wait for a positive response from the server, and then send the body of the request. This results in two full roundtrips to the server for every request. If your roundtrip time (e.g. ping time) is 100 ms, then you're adding 100 ms to every request for no reason. We recommend that you disable the "Expect: 100-Continue" behavior for your SOAP/HTTP connection. In .NET environments, set Expect100Continue = false.

Verify Changes

Once you have made changes, it is important to verify that those changes have actually taken effect and are producing the desired results. Use a tool like Fiddler to capture and view the HTTP conversation. Verify that you are incurring only one roundtrip per request and that the request FileBytes and response XML are compressed.