Geocode and Index a Document🔗︎

HTTP Verb	Path
POST	/v9/geocodeAndIndex

Geocodes a document and adds it to an index.

Info

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )

Request Body🔗︎

ParsedDocument 🔗︎ string required

ParsedDocument🔗︎

Parsed JSON from the Textkernel Resume or Job Parser.

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 youalready 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.

CustomIds 🔗︎ string[]

CustomIds🔗︎

The custom ids you want the document to have.

Sample JSON

{
  "ParsedDocument": "",
  "IndexIfGeocodeFails": false,
  "GeocodeOptions": {
    "Provider": "",
    "ProviderKey": "",
    "PostalAddress": {
      "CountryCode": "",
      "PostalCode": "",
      "Region": "",
      "Municipality": "",
      "AddressLine": ""
    },
    "GeoCoordinates": {
      "Latitude": 0,
      "Longitude": 0
    }
  },
  "IndexingOptions": {
    "IndexId": "",
    "DocumentId": "",
    "CustomIds": [
      ""
    ]
  }
}

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.

Value 🔗︎ object

Value🔗︎

Contains response data for the transaction.

Value properties

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

GeocodedParsedDocument 🔗︎ string

GeocodedParsedDocument🔗︎

Parsed document containing the geocoded coordinates.

Code 🔗︎ string

Code🔗︎

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

Message 🔗︎ string

Message🔗︎

Maps to the Response.Message parameter of a Geocode 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 Document Transaction.

Message 🔗︎ string

Message🔗︎

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

CreditsRemaining 🔗︎ decimal

CreditsRemaining🔗︎

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.

Sample JSON

{
  "Info": {
    "Code": "",
    "Message": ""
  },
  "Value": {
    "GeocodeResponse": {
      "GeocodedParsedDocument": "",
      "Code": "",
      "Message": ""
    },
    "IndexingResponse": {
      "Code": "",
      "Message": ""
    },
    "CreditsRemaining": 0
  }
}