Checks

Create a reference check

post/checks

Request

  • Base URL: https://verifyref.com/api/v1
  • URL: https://verifyref.com/api/v1/checks
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Request body

candidateNamestring required
candidateEmailstring email required
candidateIdstring

Talent pool candidate ID

addToTalentPoolboolean
candidateProvidedReferencesboolean
externalIdstring
externalSource'bullhorn' | 'zoho_recruit' | 'sap_successfactors' | 'workday' | 'greenhouse' | 'lever' | 'other'
metadataobject
jobIdstring
questionnaireIdstring
questionnaireTitlestring
questionnaireDescriptionstring

Response

Check created

successboolean
checkIdstring
statusstring
jobIdstring nullable
externalIdstring nullable
externalSourcestring nullable
sandboxboolean
idempotentReplayboolean

Changes

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