Documentation Release Notes Downloads FAQs

Create a Session

POST /v9/apply/session

Create a new session with Sovren Apply.

Notes

Request Headers

Header Data Type Required Description
Sovren-AccountId string Yes The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey string Yes The Service key that is provided to you for access to your account’s available credits.
Content-Type string Yes Indicates the media type of the incoming request body. Supported values are application/json and application/xml.
Accept string No Controls the media type of the response body. Supported values are application/json and application/xml. If not specified the response will default to JSON.

Request Body

{
  "ReturnUrl": "",
  "ConfigurationString": "",
  "OutputHtml": false,
  "OutputRtf": false,
  "OutputCandidateImage": false,
  "OutputPdf": false,
  "IndexingOptions": {
    "IndexId": "",
    "DocumentId": "",
    "CustomIds": [
      ""
    ]
  },
  "SkillsData": [
    ""
  ],
  "NormalizerData": ""
}
        
Field Data Type Required Description
ReturnUrl string Yes The URL to redirect the candidate to after the Sovren Apply session is completed.
ConfigurationString string No 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.
OutputHtml boolean No When true, the original file is converted to HTML and stored in the Html property.
OutputRtf boolean No When true, the original file is converted to RTF and stored in the Rtf property.
OutputPdf boolean No When true, the original file is converted to PDF and stored in the Pdf property as a byte array.
OutputCandidateImage boolean No 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.
IndexingOptions.IndexId string No 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.
IndexingOptions.DocumentId string No 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. If no id is given, the Sovren Apply Session Key will be used.
IndexingOptions.CustomIds string[] No The custom ids you want the document to have.
SkillsData string[] No 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.
NormalizerData string No 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).

Response Body

{
    "Info": {
        "Code": "",
        "Message": ""
    },
    "Value": {
        "SessionUrl": "",
        "SessionKey": "",
        "CreditsRemaining": 0
  }
}
Field Data Type Description
Info.Code string A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:

Success – Successful transaction

MissingParameter - A required parameter wasn't provided

InvalidParameter - A parameter was incorrectly specified

AuthenticationError - An error occurred with the credentials provided
Info.Message string This message further describes the code providing additional detail.
Value.SessionUrl string The unique URL for this session. Never save this URL! To retrieve the URL for a session, call the Get Session endpoint.
Value.SessionKey string The unique key for this session. Be sure to save this value to retrieve the resume data for this session using the Get Session and Get Session Details endpoints.
Value.CreditsRemaining decimal The number of remaining credits is returned with every response. Please ensure that you set up monitoring of this value to ensure that you don't experience an outage by letting your credits reach 0.

Get Session

GET /v9/apply/session/{sessionKey}

Retrieve the data from the specified Sovren Apply session.

Notes

Request Headers

Header Data Type Required Description
Sovren-AccountId string Yes The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey string Yes The Service key that is provided to you for access to your account’s available credits.
Content-Type string Yes Indicates the media type of the incoming request body. Supported values are application/json and application/xml.
Accept string No Controls the media type of the response body. Supported values are application/json and application/xml. If not specified the response will default to JSON.

Path Parameters

Parameter Data Type Description
sessionKey string The unique key for the Sovren Apply session.

Response Body

{
    "Info": {
        "Code": "",
        "Message": ""
    },            
    "Value": {
        "IsComplete": false,
        "SessionUrl": ""
    }
}
Field Data Type Description
Info.Code string A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:

Success – Successful transaction

MissingParameter - A required parameter wasn't provided

InvalidParameter - A parameter was incorrectly specified

AuthenticationError - An error occurred with the credentials provided

DataNotFound - Data with the specified name wasn't found
Info.Message string This message further describes the code providing additional detail.
Value.IsComplete bool Indicator that determines if the candidate completed the Sovren Apply session. If true, the resume data is able to be retrieved using the Get Session Details endpoint.
Value.SessionUrl string The unique URL for the session.

Get Session Details

GET /v9/applysession/{sessionKey}/details

Retrieve the resume data from the specified Sovren Apply session.

Notes

Request Headers

Header Data Type Required Description
Sovren-AccountId string Yes The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey string Yes The Service key that is provided to you for access to your account’s available credits.
Content-Type string Yes Indicates the media type of the incoming request body. Supported values are application/json and application/xml.
Accept string No Controls the media type of the response body. Supported values are application/json and application/xml. If not specified the response will default to JSON.

Path Parameters

Parameter Data Type Description
sessionKey string The unique key for the Sovren Apply session.

Response Body

{
    "Info": {
        "Code": "",
        "Message": ""
    },            
    "Value": {
        "IsComplete": false,
        "Text": "",
        "Html": "",
        "Rtf": "",
        "Pdf": "",
        "CandidateImage": "",
        "CandidateImageExtension": "",
        "ParsedDocument": "",
        "ScrubbedParsedDocument": "",
        "FileName": "",
        "FileBytes": "",
        "IndexId": "",
        "DocumentId": ""
    }
}
Field Data Type Description
Info.Code string A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:

Success – Successful transaction

MissingParameter - A required parameter wasn't provided

InvalidParameter - A parameter was incorrectly specified

AuthenticationError - An error occurred with the credentials provided

DataNotFound - Data with the specified name wasn't found
Info.Message string This message further describes the code providing additional detail.
Value.IsComplete bool Indicator that determines if the candidate completed the Sovren Apply session. If true, the resume data is able to be retrieved using the Get Session Details endpoint.
Value.Text string The plain text of the resume.
Value.Html string HTML version of the input file.
Value.Rtf string RTF version of the input file, if OutputRtf was set to true.
Value.Pdf string The base 64 encoded string of the PDF version of the input file, if OutputPdf was set to true.
Value.CandidateImage string If a candidate photo was extracted, it will be output in this field as a base 64 encoded string of the byte array.
Value.CandidateImageExtension string If a candidate photo was extracted, the appropriate file extension for the photo will be output for this field (e.g. ".png").
Value.ParsedDocument string The parser results in XML or JSON string format. The type is determined by the ACCEPT header in the request.
Value.ScrubbedParsedDocument string This property is the Value.ParsedDocument with all of the PII scrubbed out.
Value.FileName string The file name of the uploaded resume.
Value.FileBytes string A Base64 encoded string of the resume file bytes. This uses the standard 'base64' encoding as defined in RFC 4648 Section 4 (not the 'base64url' variant). .NET users can use the Convert.FromBase64String(string) method to get the document byte array.
Value.IndexId string The id for the index where the document was added.
Value.DocumentId string The id for the document in the index.