Geocode a Parsed Document🔗︎

HTTP Verb	Path
POST	/v9/geocoder

Get or insert geocode coordinate values (latitude/longitude) for a parsed document.

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🔗︎

The existing parsed JSON text of either a Resume or a Job.

Provider 🔗︎ string

Provider🔗︎

The Provider you wish to use to geocode the postal address (current options are "Google" or "Bing"). If not specified, we will default to Google. If passing a ProviderKey, this field is required.

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.

Sample JSON

{
  "ParsedDocument": "",
  "Provider": "",
  "ProviderKey": "",
  "PostalAddress": {
    "CountryCode": "",
    "PostalCode": "",
    "Region": "",
    "Municipality": "",
    "AddressLine": ""
  },
  "GeoCoordinates": {
    "Latitude": 0,
    "Longitude": 0
  }
}

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
`InsufficientData`	The address provided doesn't have enough granularity to be geocoded effectively
`CoordinatesNotFound`	The geocoding provider couldn't find any coordinates matching the provided address

Message 🔗︎ string

Message🔗︎

This message further describes the code providing additional detail.

Value 🔗︎ object

Value🔗︎

Contains response data for the transaction.

Value properties

GeoCodeResult 🔗︎ string

GeoCodeResult🔗︎

The results of the geocoding transaction. The result will be your ParsedDocument (either Resume or Job) with the geocoding results embedded in it.

CreditsRemaining 🔗︎ decimal

CreditsRemaining🔗︎

The number of remaining credits is returned withevery 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": {
    "GeoCodeResult": "",
    "CreditsRemaining": 0
  }
}