Skip to main

API Technical Specs

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

Get a Normalizations List

GET /v10/normalizations/(key)

Retrieve the data from a specified list to be optionally used during parsing.

This feature is not recommended and only available as an add-on. Reach out to for more information.


  • You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )
  • For custom normalization implementation, we recommend using the Sovren Normalization Editor utility, which provides a rich GUI for normalization management. You can download the utility from My Sovren Portal.

Path Parameters

ParameterData TypeDescription
keystringThe key for the normalization data list to retrieve.

Response Body

Information explaining the outcome of the transaction.
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
This message further describes the code providing additional detail.
The (GUID) id for a specific API transaction. Use this when contacting about issues.
The version of the parsing/matching engine running under-the-hood.
The version of the API.
How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.
How many credits the transaction costs.How many credits the transaction costs.
Information about the customer who made the API call.
The AccountId for the account.
The customer name on the account.
The client IP Address where the API call originated.
The region for the account, also known as the 'Data Center'.
The number of credits remaining to be used by the account.
The number of credits used by the account.
The number of requests that can be made at one time. If using sub-accounts, this is the maximum number of concurent requests across all accounts, not just this single sub-account.
The date that the current credits expire.
A Base64-encoded string of bytes representing the zip file containing normalization data.

Sample Response

{ ... 
{ ... 
"Code" :  "string","Message" :  "string","TransactionId" :  "string","EngineVersion" :  "string","ApiVersion" :  "string","TotalElapsedMilliseconds" :  0,"TransactionCost" :  0,{ ... 
"AccountId" :  "string","Name" :  "string","IPAddress" :  "string","Region" :  "string","CreditsRemaining" :  0,"CreditsUsed" :  0,"ExpirationDate" :  "2021-12-31","MaximumConcurrentRequests" :  0
"Value" :  ""