API Credentials for Offline Jobs

Parameters

durationSeconds

• Type: int32
• Range: 900 to 43200
• Description: The duration, in seconds, that the credentials should remain valid. Value must be between 900 and 43200 seconds. If not provided, defaults to 3600 seconds.

job_type

• Type: string
• Required: Yes
• Description: The type of offline job to initialize. Supported values are: place_match, transaction_match.

X-Places-Api-Version

• Type: string
• Enum: required
• Defaults to: 2025-06-17
• Description: The version of the API to use.

Responses

200 success

Object:

• access_key_id: string
• secret_access_key: string
• session_token: string
• job_id: string
• input_uri: string
• output_uri: string

400 Bad request

500 Internal server error

Example Request

curl --request POST \
     --url https://places-api.foursquare.com/offline-jobs/initialize \
     --header 'X-Places-Api-Version: 2025-06-17' \
     --header 'accept: application/json'

Example Response

{
  "access_key_id": "string",
  "secret_access_key": "string",
  "session_token": "string",
  "job_id": "string",
  "input_uri": "string",
  "output_uri": "string"
}