Skip to main

API Technical Specs

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

Autocomplete Professions

POST /v10/professions/autocomplete

Returns normalized professions that begin with a given prefix, based on the chosen language(s). Each profession is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the profession is included in the results.


  • You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )
  • To minimize the number of requests, it is recommended to set a delay between each keystroke before sending a new request.

Scope of use

The purpose of this endpoint is to provide real-time autocompletions for user input based on our Taxonomy. It is not permitted to cache, store, or utilize responses from this endpoint for the purpose of limiting request volume, or to create replicas or derivatives of the Service and the Taxonomy.

Request Body

The job title prefix to be completed. Must contain at least 1 character.
The language(s) used to search for matching professions (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes.
The maximum number of returned professions. The default is 10 and the maximum is 100.
The language to ouput the found professions in (default is en). Must be one of the supported ISO codes.

Sample Request

{ ... 
"Prefix" :  "","Limit" :  10,[ ... 
"OutputLanguage" :  ""

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
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.
Contains response data for the transaction.
A list of professions that match the given Prefix.
The code ID of this profession in the Professions Taxonomy.
The description of the found profession in the requested language.

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
{ ... 
[ ... 
"Description" :  "string","CodeId" :  0