Skip to content

Geos

Represents a candidate geography.

Operations

Create a new Geo

Request

Creates a new Geo resource.

Note: Attempting to create a new Geo with the same name/state combination will result in an 409 error

Security
basic_auth
Bodyapplication/jsonrequired
namestringrequired

Human-readable name of the Geo.

Example:"San Francisco"
statestringrequired

US state for the Geo.

Example:"CA"
citystring

A major city within the input state.

Example:"San Francisco"
curl -i -X POST \
  -u '<username>:<password>' \
  https://docs.checkr.com/_mock/apis/openapi/geos \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "San Francisco",
    "state": "CA",
    "city": "San Francisco"
  }'

Responses

Geo was successfully created

Bodyapplication/json
idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"
objectstringread-only
Value:"geo"
uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/geos/e44aa283528e6fde7d542194"
created_atstring, (date-time)

Time at which the Geo was created.

Example:"2015-01-18T12:34:00Z"
namestring

Human-readable name of the Geo.

Example:"SF CA"
citystring

City for the Geo.

Example:"San Francisco"
statestring

State for the Geo.

Example:"CA"
deleted_atstring or null, (date-time)

Time at which the Geo was deleted.

Example:null
Response
{
  "id": "e44aa283528e6fde7d542194",
  "object": "geo",
  "uri": "/v1/geos/e44aa283528e6fde7d542194",
  "created_at": "2015-01-18T12:34:00Z",
  "name": "SF CA",
  "city": "San Francisco",
  "state": "CA",
  "deleted_at": null
}
© Checkr, Inc.