Sharing a candidate

Sharing a candidate

The details of a candidate can be uploaded to the SEEK API. This information is used to identify candidates that exist in your software and in SEEK’s Talent Search database when returning search results, reducing the time hirers spend cross-referencing candidate information with your software. Candidates that exist in both systems are referred to as shared candidates.
Shared candidates shown on the Talent Search website will have a badge indicating that they are shared, the date the candidate was last updated in your software and on SEEK, and a deep link back to your software.
Talent Search requires that changes to candidate information within your software be reflected in the SEEK API within 60 seconds .
Shared candidate results

Data structure

An uploaded Candidate object is structured as follows:
An uploaded candidate has the following CandidatePerson fields:
  • Name
  • Email addresses, with at least one required
  • Optional phone numbers
  • Optional home locations
Each uploaded candidate has a single CandidateProfile containing:
  • Create and update dates
  • Profile actions that deep link into your software
  • Preferred work locations
Each uploaded candidate is scoped to a specific SEEK hirer and integration partner. A candidate uploaded via your software is only accessible to that hirer, and is not accessible to other integration partners who may have a relationship with the hirer.

Operations

Upload a candidate

The uploadCandidate mutation adds a new candidate and their profile. You should use this mutation whenever a new candidate is created in your software. This includes candidates you create in your software using profiles purchased from Talent Search.
To avoid unintentional duplication of data, SEEK enforces uniqueness on an email address of the candidate. Requests to share a candidate require a seekPrimaryEmailAddress field with a value that matches one of the given email address values in the person.communication field . A request to upload an existing candidate will receive an UploadCandidatePayload_Conflict result. The existing candidate will not be updated; you can select their details from the conflict result.
Up to 20 interaction history items can be provided in the seekProcessHistory field during initial upload. Individual items can be later created, modified and deleted using the relevant interaction history operations. SEEK strongly recommends providing the first 20 interaction history items when backfilling an existing candidate. This maximises the rate your software can backfill candidates while reducing load on SEEK’s systems.
Keep track of the IDs assigned to the candidate, their profile and their interaction history to perform subsequent update and delete operations. The UploadCandidatePayload_Success.candidateProcessHistoryItems field contains the uploaded interaction history in input order for ease of correlation.
MutationVariablesSuccess resultConflict result
mutation ($input: UploadCandidateInput!) {
  uploadCandidate(input: $input) {
    ... on UploadCandidatePayload_Success {
      candidate {
        documentId {
          value
        }
        profiles {
          profileId {
            value
          }
        }
      }
      candidateProcessHistoryItems {
        id {
          value
        }
      }
    }

    ... on UploadCandidatePayload_Conflict {
      conflictingCandidate {
        documentId {
          value
        }
        profiles {
          profileId {
            value
          }
        }
      }
    }
  }
}

Update an uploaded candidate

The following mutations update an uploaded candidate and their profile. You should use these mutations whenever an existing candidate is updated in your software. This includes candidates you update in your software using profiles purchased from Talent Search.
These mutations can be batched together in a single request for sync-like behaviour:
MutationVariablesSuccess resultConflict result
mutation updateUploadedCandidate(
  $documentId: String!
  $person: CandidatePersonInput!
  $seekPrimaryEmailAddress: String!
  $profileId: String!
  $seekActions: [CandidateProcessActionInput!]!
  $createDateTime: DateTime!
  $updateDateTime: DateTime!
  $positionPreferences: [PositionPreferenceInput!]!
) {
  updateUploadedCandidatePerson(
    input: {
      candidate: {
        documentId: $documentId
        person: $person
        seekPrimaryEmailAddress: $seekPrimaryEmailAddress
      }
    }
  ) {
    ... on UpdateUploadedCandidatePersonPayload_Success {
      candidate {
        documentId {
          value
        }
      }
    }

    ... on UpdateUploadedCandidatePersonPayload_Conflict {
      conflictingCandidate {
        documentId {
          value
        }
      }
    }
  }

  updateUploadedCandidateProfileActions(
    input: {
      candidateProfile: { profileId: $profileId, seekActions: $seekActions }
    }
  ) {
    candidateProfile {
      candidate {
        documentId {
          value
        }
      }
    }
  }

  updateUploadedCandidateProfileDates(
    input: {
      candidateProfile: {
        profileId: $profileId
        createDateTime: $createDateTime
        updateDateTime: $updateDateTime
      }
    }
  ) {
    candidateProfile {
      candidate {
        documentId {
          value
        }
      }
    }
  }

  updateUploadedCandidateProfilePositionPreferences(
    input: {
      candidateProfile: {
        profileId: $profileId
        positionPreferences: $positionPreferences
      }
    }
  ) {
    candidateProfile {
      candidate {
        documentId {
          value
        }
      }
    }
  }
}

Delete an uploaded candidate

The deleteUploadedCandidate mutation deletes an uploaded candidate and their profile.
This will erase all uploaded details of the candidate from SEEK’s systems.
MutationVariablesResult
mutation ($input: DeleteUploadedCandidateInput!) {
  deleteUploadedCandidate(input: $input) {
    candidate {
      documentId {
        value
      }
      profiles {
        profileId {
          value
        }
      }
    }
  }
}