HEherondata
EndUsers

Start an embedded background check

Changed on
post/api/embed/background_check/trigger

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/embed/background_check/trigger
  • Auth
    API key in header x-api-key

Headers

X-Heron-Embed-Tokenstring required

Response

Background check state

deal_namestring required
open_in_heron_urlstring required
state'not_enabled' | 'not_run' | 'trial_exhausted' | 'missing_inputs' | 'running' | 'failed' | 'not_found' | 'complete' required

Changes