Skip to content
Tx Platform
Geocode and Index a Resume

Geocode and Index a Resume🔗︎

HTTP Verb Path
POST /v10/geocodeAndIndex/resume

Geocodes a document and adds it to an index.

Info

Request Body🔗︎

ResumeData 🔗︎ object required

ResumeData🔗︎

Parsed ResumeData from the Textkernel CV/Resume Parser. See Parse a Resume

IndexIfGeocodeFails 🔗︎ bool

IndexIfGeocodeFails🔗︎

Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

GeocodeOptions 🔗︎ object required

GeocodeOptions🔗︎

Settings to determine the form of geocoding for the transaction.

GeocodeOptions properties

Provider 🔗︎ string

Provider🔗︎

The Provider you wish to use to geocode the postal address (current options are "Google", "Bing", or "None"). If not specified, we will default to Google. If you are just trying to update the postal address in the document, please set this to "None". If passing "Google" or "Bing", ProviderKey is requried.

ProviderKey 🔗︎ string

ProviderKey🔗︎

The Provider Key for the specified Provider. If using Bing you must specify your own provider key.

PostalAddress 🔗︎ object

PostalAddress🔗︎

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.

PostalAddress properties

CountryCode 🔗︎ string

CountryCode🔗︎

The ISO 3166-1 alpha-2 code indicating the country for the postal address.

PostalCode 🔗︎ string

PostalCode🔗︎

The postal code (or zip code) for the postal address

Region 🔗︎ string

Region🔗︎

The region (i.e. State for U.S. addresses) for the postal address.

Municipality 🔗︎ string

Municipality🔗︎

The municipality (i.e. City for U.S. addresses) for the postal address

AddressLine 🔗︎ string

AddressLine🔗︎

The address line (i.e. Street address for U.S. address) for the postal address

GeoCoordinates 🔗︎ object

GeoCoordinates🔗︎

The geographic coordinates (latitude/longitude) for your postal address. Use this if you already have latitude/longitude coordinates and 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.

GeoCoordinates properties

Latitude 🔗︎ float

Latitude🔗︎

The latitude coordinate value.

Longitude 🔗︎ float

Longitude🔗︎

The longitude coordinate value.

IndexingOptions 🔗︎ object required

IndexingOptions🔗︎

Settings to specify where to store the document.

!!! warning "Skills Normalization must be included to index documents using V2 Skills Taxonomy. These algorithms ignore raw skills and only consider the normalized skill concepts for skills category scoring. This leads to improved scoring and ranking because normalization produces less false negatives than simple exact keyword matching."

IndexingOptions properties

IndexId 🔗︎ string required

IndexId🔗︎

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.

DocumentId 🔗︎ string required

DocumentId🔗︎

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.

UserDefinedTags 🔗︎ string[]

UserDefinedTags🔗︎

The user-defined tags you want the document to have.

Sample JSON 
{
  "ResumeData": "...",
  "IndexIfGeocodeFails": false,
  "GeocodeOptions": {
    "Provider": "",
    "ProviderKey": "",
    "PostalAddress": {
      "CountryCode": "",
      "PostalCode": "",
      "Region": "",
      "Municipality": "",
      "AddressLine": ""
    },
    "GeoCoordinates": {
      "Latitude": 0,
      "Longitude": 0
    }
  },
  "IndexingOptions": {
    "IndexId": "",
    "DocumentId": "",
    "UserDefinedTags": [
      ""
    ]
  }
}

Response Body🔗︎

Info 🔗︎ object

Info🔗︎

Information explaining the outcome of the transaction.

Info properties

Code 🔗︎ string

Code🔗︎

Code Description
Success Successful transaction
MissingParameter A required parameter wasn't provided
InvalidParameter A parameter was incorrectly specified
AuthenticationError An error occurred with the credentials provided
Unauthorized Your account doesn't have permission to perform this operation
DataNotFound Data with the specified name wasn't found
Message 🔗︎ string

Message🔗︎

This message further describes the code providing additional detail.

TransactionId 🔗︎ string

TransactionId🔗︎

The (GUID) id for a specific API transaction. Use this when contacting support@textkernel.com about issues.

EngineVersion 🔗︎ string

EngineVersion🔗︎

The version of the parsing/matching engine running under-the-hood.

ApiVersion 🔗︎ string

ApiVersion🔗︎

The version of the API.

TotalElapsedMilliseconds 🔗︎ integer

TotalElapsedMilliseconds🔗︎

How long the transaction took on Textkernel's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

TransactionCost 🔗︎ decimal

TransactionCost🔗︎

How many credits the transaction costs.How many credits the transaction costs.

CustomerDetails 🔗︎ object

CustomerDetails🔗︎

Information about the customer who made the API call.

CustomerDetails properties

AccountId 🔗︎ string

AccountId🔗︎

The AccountId for the account.

Name 🔗︎ string

Name🔗︎

The customer name on the account.

IPAddress 🔗︎ string

IPAddress🔗︎

The client IP Address where the API call originated.

Region 🔗︎ string

Region🔗︎

The region for the account, also known as the 'Data Center'.

CreditsRemaining 🔗︎ decimal

CreditsRemaining🔗︎

The number of credits remaining to be used by the account.

CreditsUsed 🔗︎ decimal

CreditsUsed🔗︎

The number of credits used by the account.

MaximumConcurrentRequests 🔗︎ integer

MaximumConcurrentRequests🔗︎

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.

ExpirationDate 🔗︎ date

ExpirationDate🔗︎

The date that the current credits expire.

Value 🔗︎ object

Value🔗︎

Contains response data for the transaction.

Value properties

ResumeData 🔗︎ object

ResumeData🔗︎

The main output from the Textkernel CV/Resume Parser containing the geocoded coordinates. See Parse a Resume

GeocodeResponse 🔗︎ object

GeocodeResponse🔗︎

If Request.GeocodeOptions.IncludeGeocoding is set to true (thus geocoding is executed), this object will be populated with a response.

GeocodeResponse properties

Code 🔗︎ string

Code🔗︎

Maps to the Response.Code parameter of a Geocode Resume Transaction.

Message 🔗︎ string

Message🔗︎

Maps to the Response.Message parameter of a Geocode Resume Transaction.

IndexingResponse 🔗︎ object

IndexingResponse🔗︎

If Request.IndexingOptions contains any specified parameters, this object will be populated with a response.

IndexingResponse properties

Code 🔗︎ string

Code🔗︎

Maps to the Response.Code parameter of a Index a Resume Transaction.

Message 🔗︎ string

Message🔗︎

Maps to the Response.Message parameter of a Index a Resume Transaction.

Sample JSON 
{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "TransactionCost": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  },
  "Value": {
    "ResumeData": {
    },
    "GeocodeResponse": {
      "Code": "",
      "Message": ""
    },
    "IndexingResponse": {
      "Code": "",
      "Message": ""
    }
  }
}