RefappRefapp

Results pushed to your endpoint

View as Markdown
PUTYour endpoint

Refapp sends this request to your system. Nothing here is called by you.

Sent to the URL pattern configured for your account, with {projectId} and {candidateId} replaced by your ids and the credential you gave us in the Authorization header. Sent when the candidate is created, on every state change and on completion. Answer with any 2xx.

Body

application/json, required

  • typestringrequired
    Always "partner-results"
  • idstringrequired
  • attributesobjectrequired
    Show properties
    • statusstringrequired
      One of "sending", "sent", "pending", "completed", "failed"
    • summarystringrequired
    • urlstring
    • candidateLinkobject
      Show properties
      • urlstringrequired
      • descriptionstringrequired
      • typestring
        One of "report-url", "report-pdf-data", "candidate-url"
    • candidateSubmissionPageLinkobject
      Show properties
      • urlstringrequired
      • descriptionstringrequired
      • typestring
        One of "report-url", "report-pdf-data", "candidate-url"
    • assessmentobject
      Show properties
      • typestring
        Always "reference-check"
      • scorenumber
      • totalnumber
      • remainingToSubmitnumber
      • completednumber
      • declinednumber
      • fraudWarningsarray of string
    • attachmentsarray of object
      Show item properties
      • urlstringrequired
      • descriptionstringrequired
      • typestring
        One of "report-url", "report-pdf-data", "candidate-url"
    • criteriaobject

      Values to route the candidate on, keyed by criterion id. moving_criteria in GET /webhooks/account-integration/config is the source of truth for the criteria and values that this account receives. This reference shows only the criteria and values that exist today. A criterion is left out until it has a value. Criteria and values can be added or removed at any time. Refapp avoids breaking changes, so a new criterion or value is more likely than a removed one or a changed value type. Ignore ids and values that you do not know.

      Show properties
      • background_check_outcomestring

        Where the background check stands. anomalies_* once it found anomalies: pending until a reviewer approves or rejects them. declined when the candidate declined. More values can be added.

        One of "in_progress", "clear", "anomalies_pending_review", "anomalies_approved", "anomalies_rejected", "declined"
      • reference_check_fraudstring

        warning while a fraud warning is active on the candidate. More values can be added.

        One of "positive", "warning"
      • reference_check_referees_overduestring

        overdue once the deadline for adding referees has passed and the candidate has not added all requested referees. More values can be added.

        One of "overdue", "not_overdue"
      • reference_check_behavioursstring

        warning when a behavioural trait fell outside the target range, insufficient when too few referees answered to compare against the benchmark. More values can be added.

        One of "positive", "warning", "insufficient"
      • reference_check_cwbstring

        warning when a referee reported a counterproductive work behaviour. More values can be added.

        One of "positive", "warning"
      • reference_check_recommendationnumber

        How strongly the referees recommend the candidate, in percent.

        minimum: 0 · maximum: 100
      • (any other key)string | number
    • detailsobject

      Text in the account's language to show to a recruiter. The keys are names and labels, which can change. Routing rules must use criteria, not details.

      Show properties
      • (any other key)string | object
        Show alternatives
        • Alternative 1string
        • Alternative 2object
          Show properties
          • (any other key)string

What to answer

2XX

Received.