Skip to main

API Technical Specs

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

Geocode a Parsed Document

POST /v9/geocoder

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

Names

Request Body

ParsedDocumentrequiredstring
The existing parsed JSON text of either a Resume or a Job Order.
Providerrequiredstring
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.
ProviderKeyrequiredstring
The Provider Key for the specified Provider. If using Bing you must specify your own provider key.
PostalAddressrequiredobject
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.CountryCoderequiredstring
The ISO 3166-1 alpha-2 code indicating the country for the postal address.
PostalAddress.PostalCoderequiredstring
The postal code (or zip code) for the postal address.
PostalAddress.Regionrequiredstring
The region (i.e. State for U.S. addresses) for the postal address.
PostalAddress.Municipalityrequiredstring
The municipality (i.e. City for U.S. addresses) for the postal address
PostalAddress.AddressLinerequiredstring
The address line (i.e. Street address for U.S. address) for the postal address
GeoCoordinatesrequiredobject
The geographic coordinates (latitude/longitude) for your postal address. Use this if you already have latitude/longitude coordinatesand 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.Latituderequiredfloat
The latitude coordinate value.
GeoCoordinates.Longituderequiredfloat
The longitude coordinate value.

Sample Request

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

Response Body

Infoobject
Information explaining the outcome of the transaction.
Info.Codestring
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

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
Info.Messagestring
This message further describes the code providing additional detail.
Valueobject
Contains response data for the transaction.
Value.GeoCodeResultstring
The results of the geocoding transaction. The result will be your ParsedDocument (either Resume or Job Order) with the geocoding results embedded in it.
Value.CreditsRemainingdecimal
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 Response

{ ... 
{ ... 
"Code" :  "","Message" :  ""
},
{ ... 
"GeoCodeResult" :  "","CreditsRemaining" :  0
}
}