SMsmartrecruiters
candidates

Status of candidate consent

Get candidate consent status

get/candidates/{id}/consent

Request

  • Base URL
    https://api.smartrecruiters.com
  • URL
    https://api.smartrecruiters.com/candidates/{id}/consent
  • Auth
    • API key in header x-smarttoken
    • or OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: candidates_read

Response

Candidate's latest consent status

datestring date-time

Available when status is ACQUIRED

status'REQUIRED' | 'PENDING' | 'ACQUIRED' required
  • REQUIRED - no request for consent yet,
  • PENDING - consent requested,
  • ACQUIRED - consent provided by a candidate

Changes

No recorded changes to this operation across all 1 revision of this API.