Skip to content

Account

The Account resource includes account information and settings. Account information can be updated from the Dashboard. Some Account settings, like available_screenings, can be updated only by Checkr. Contact our Customer Success team for more information.

Operations

Retrieve authenticated account details

Request

Returns Account details for the authenticated account.

Security
basic_auth
curl -i -X GET \
  -u '<username>:<password>' \
  https://docs.checkr.com/_mock/apis/openapi/account

Responses

Account details

Bodyapplication/json
idstring

The ID of the Account.

Note: The returned Account ID is dependent on the API token used to make the call.

  • If an account-level API token is used, the ID of the account associated with the Live API Token will be returned.
  • If a partner OAuth token is used, the ID of the account (or customer's account) connected to the OAuth application will be returned.
objectstring
Value:"account"
account_deauthorizationobject

Account deauthorization details if account has been deauthorized.

adverse_action_emailstring, (email)

Email used to send pre- and post- Adverse Action notices on behalf of the Account to candidates. This address will also receive undeliverable notices if an Adverse Action notice isn't deliverable to a candidate.

Example:"john.doe@example.com"
api_authorizedboolean

Determines whether Account is authorized to use the API to order background checks.

Default:false
Example:true
authorizedboolean

Determines whether Account is credentialed to order background checks.

Default:false
Example:true
available_screeningsArray of strings

List of screening types available for the Account.

Example:
[
  "county_civil_search",
  "county_criminal_search",
  "municipal_criminal_search",
  "education_verification",
  "employment_verification",
  "federal_civil_search",
  "federal_criminal_search",
  "motor_vehicle_report",
  "national_criminal_search",
  "sex_offender_search",
  "ssn_trace",
  "state_criminal_search",
  "international_adverse_media_search",
  "international_education_verification"
]
billing_emailstring, (email)

Email that is used for Checkr to contact you about invoices and other billing communication.

Example:"john.doe@example.com"
companyobject

Company details

compliance_contact_emailstring, (email)

Email for the main point of contact on your side to communicate with Checkr about compliance issues or updates. This is also where we'll send you the results of candidate disputes (for example, if we changed the information on a report).

Example:"compliance.team@example.com"
created_atstring, (date-time)

Time at which the Account was created.

Example:"2020-01-07T00:26:49Z"
default_compliance_citystring or null

Fallback compliance city if candidate location is not provided.

Example:"San Francisco"
default_compliance_statestring or null

Fallback compliance state if candidate location is not provided. Format: ISO 3166-2:US.

Example:"CA"
geos_requiredboolean

Determines whether a Geo must be provided to order a Report.

Default:false
namestring

Name of Account displayed in the Dashboard.

Example:"Acme Corp"
purposestring

Permissible purpose to run background checks. Determines which background checks the Account is credentialed for.

Default:"employment"
Enum:"employment""business""insurance""tenant"
segmentation_enabledboolean

Determines whether Hierarchy/Nodes is enabled on the Account.

Default:true
support_emailstring or null, (email)

Email address used for candidates to contact you if they need to supply evidence of rehabilitation or other context during the Adverse Action process.

Example:"support@example.com"
support_phonestring or null

Phone number used for candidates to contact you if they need to supply evidence of rehabilitation or other context during the Adverse Action process.

Example:"206-555-0188"
technical_contact_emailstring, (email)

The main point of contact on your side to communicate with Checkr about technical issues or updates.

Example:"jane.smith@example.com"
uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/accounts/e44aa283528e6fde7d542194"
uri_namestring[a-z0-9-_]+

Unique slug referencing the Account. This appears in some Account-specific URL paths.

Example:"acme-corp"
Response
{
  "id": "string",
  "object": "account",
  "account_deauthorization": {
    "reason": "nonpayment"
  },
  "adverse_action_email": "john.doe@example.com",
  "api_authorized": true,
  "authorized": true,
  "available_screenings": [
    "county_civil_search",
    "county_criminal_search",
    "municipal_criminal_search",
    "education_verification",
    "employment_verification",
    "federal_civil_search",
    "federal_criminal_search",
    "motor_vehicle_report",
    "national_criminal_search",
    "sex_offender_search",
    "ssn_trace",
    "state_criminal_search",
    "international_adverse_media_search",
    "international_education_verification"
  ],
  "billing_email": "john.doe@example.com",
  "company": {
    "name": "Acme Corporation",
    "dba_name": "ACME",
    "street": "123 Main St",
    "city": "Wilmington",
    "state": "DE",
    "zipcode": "19801",
    "phone": "206-555-0100",
    "website": "https://example.com",
    "industry": "52-59",
    "incorporation_state": "DE",
    "incorporation_type": "llc"
  },
  "compliance_contact_email": "compliance.team@example.com",
  "created_at": "2020-01-07T00:26:49Z",
  "default_compliance_city": "San Francisco",
  "default_compliance_state": "CA",
  "geos_required": false,
  "name": "Acme Corp",
  "purpose": "employment",
  "segmentation_enabled": true,
  "support_email": "support@example.com",
  "support_phone": "206-555-0188",
  "technical_contact_email": "jane.smith@example.com",
  "uri": "/v1/accounts/e44aa283528e6fde7d542194",
  "uri_name": "acme-corp"
}
© Checkr, Inc.