This content provides an early look at an upcoming extension to the SEEK API. You may use it to scope integration effort, but the features described are not fully implemented and may be adjusted ahead of a production release.Check with your SEEK contact before starting any build work described here.
This feature will be available to Gold and Platinum partners only at
launch, with support for additional credentials and wider partner
availability planned in future.Don’t commence your build until you receive confirmation that we can
support the certification and release of your integration. We’ll get in
touch with remaining partners once Verify with SEEK Pass reaches general
availability.
HirerRelationshipChanged event.
The Developer Dashboard hirers page displays the SEEK hirers that you have a relationship with and lets you check whether they have the required CandidateVerification relationship.
Alternatively, the hiringOrganization query enables your software to retrieve the relationships on demand.Your software must provide a way for hirers to opt out of sending Verify with SEEK Pass requests to candidates.
Verify with SEEK Pass is enabled by default for all hirers that have onboarded to this feature.To check whether Verify with SEEK Pass is enabled for a given hirer, use the hiringOrganization query:QueryVariablesResult with Verify with SEEK Pass enabledResult with Verify with SEEK Pass disabled
CopyGraphQL Explorer
query ($id: String!) {
hiringOrganization(id: $id) {
id
name
seekApiCapabilities {
# If the disabledFeatures array is empty, Verify with SEEK Pass is enabled.
# If the disabledFeatures array contains the code "CandidateVerification", Verify with SEEK Pass is disabled.
disabledFeatures
}
}
}setDisabledFeatures mutation.
Pass the full list of feature codes you want disabled for that hirer; any feature not in the list remains enabled.- To disable Verify with SEEK Pass, include
CandidateVerificationin thedisabledFeaturesarray. - To enable Verify with SEEK Pass, pass an empty array (or omit
CandidateVerificationfrom the list).
MutationVariablesResult
CopyGraphQL Explorer
mutation ($input: SetDisabledFeaturesInput!) {
setDisabledFeatures(input: $input) {
disabledFeatures
}
}hiringOrganization query and setDisabledFeatures mutation (as documented above) for each of their SEEK accounts.Use the verifyCandidate mutation to initiate the verification process with SEEK Pass.This mutation requires a partner token to be triggered from your software’s backend.Your software may automatically trigger verification for hirers when a job application is submitted,
or manually,
out of band of a job application process.Only trigger this mutation for hirers that meet both of the following requirements:The metadata included in the query variables enables enhanced user support through the ID verification process.MutationVariablesResult (to be verified)Result (already verified)
CopyGraphQL Explorer
mutation ($input: VerifyCandidateInput!) {
verifyCandidate(input: $input) {
verificationStatusCode
... on VerifyCandidatePayload_Pending {
externalId
redirectUri
button {
label
uri
images {
accent
dark
light
}
}
}
}
}verificationStatusCode:COMPLETEindicates that the candidate is already verified and has already consented to share their verification resultsNo further action is necessary.PENDINGindicates that the candidate has remaining actions to completeDisplay a Verify with SEEK Pass button and link the candidate to theredirectUrito complete their verification. This could be in an email, or on a job application submission page in your software.Thebuttonobject provides:label: The localised button text (e.g., “Verify with SEEK Pass”)uri: The verification URL to navigate to when the button is clickedimages: Three SVG button variants (accent,dark,light) for different backgrounds
redirectUriin a new browser tab. It should be displayed after the candidate has submitted their application.
FORBIDDEN error,
your software may not have a Verify with SEEK Pass relationship with the hirer.Contact us if your software requires operations to verify candidates in
bulk.
redirectUri of the SEEK Pass identity verification flow.Verify your identity for your application to {COMPANY_NAME}
From: careers@hirer.exampleTo: candidate@mail.exampleHi {CANDIDATE_NAME},Thank you for applying for {ROLE} at {COMPANY_NAME} We're inviting you to verify your identity through SEEK Pass.It only takes a few minutes and adds a verified badge to your profile, helping us review it with greater confidence. While this step is optional, we encourage candidates to complete it as part of the application process.
Best regards,
The {COMPANY_NAME} Hiring TeamUnsubscribe
The {COMPANY_NAME} Hiring Team
Required copy for additional context on SEEK PassWhat is SEEK Pass?SEEK Pass is a secure digital passport used to verify and share work credentials. It helps employers review applications with confidence while protecting your privacy by sharing verification results, not your documents.Visit www.seekpass.co to learn more.
- The verification invitation must be presented as coming from the hirer, not from your software or from SEEK.
- Use hirer branding (e.g. logo, colours) and send from a hirer-owned address such as
careers@example.com. - Candidates should clearly recognise the email as a request from the employer they applied to.
- Hirers must be able to customise the content of the verification email. Your software should support editable copy (e.g. greeting, body text, sign-off) so each hirer can tailor the message. The section that explains Verify with SEEK Pass and contains the verification button must remain fixed. Hirers cannot change or remove this block.
- The verification email must include an unsubscribe option so candidates can opt out of future marketing or commercial emails from that hirer. This is required on a per-hirer basis: each hirer’s emails must offer a way for candidates to opt out of that hirer’s communications.
- Candidates should be able to re-subscribe to verification invitations from a specific hirer through the individual’s settings page. Your software is expected to support per-hirer preferences so a candidate can opt back in to verification emails from a hirer they previously unsubscribed from.
width attribute to half the original size of the exported button.HTML
Copy
<!-- The exported button is 618px by 96px (@2x) --><img
src="cid:vwsp-en-standard-accent.png"
width="309"
alt="Verify with SEEK Pass"
/>cid: scheme.
The attachment should include these headers:HTTP
Copy
Content-Type: image/png; name=vwsp-en-standard-accent.png
Content-ID: <vwsp-en-standard-accent.png>
Content-Transfer-Encoding: base64
Content-Disposition: inline; filename="vwsp-en-standard-accent.png"
<base64 image data>Content-ID value (excluding angle brackets) must match the filename referenced in your src="cid:..." attribute.To display verification results within a candidate or applicant list,
follow the steps on the next page along with this guide,
as both SEEK Profile and identity verification results should be retrieved from the same query.Use the response from the seekCandidateSummaries query to determine whether to show a verification result for each candidate:- If
identity.isVerifiedistrue, render the verification result - If
identity.isVerifiedisfalse, do not render the verification result
- Render the SEEK Pass badge to denote the verification resultYour software must not modify it.
- Surface the
formattedNamealongside the badgeThis allows hiring managers to easily verify that the verification was performed on the correct candidate.
- Display the SEEK Pass icon next to the candidate’s name. Retrieve the icon and its tooltip from the
identity.iconfield of theseekCandidateSummariesquery. - Display a tooltip when hovering over the icon. If the response
identity.icon.tooltipLabelcannot be used, the tooltip copy should be:Verified by SEEK Pass as {formattedName}. - Include a legend on your page with a badge that explains the meaning of the SEEK Pass icon.
Barista (Part-time)
| Name | Source | Status | Actions |
|---|---|---|---|
John Smith | SEEK | New | |
Sarah Johnson | Careers website | Shortlisted | |
Michael Brown | Other | Offered | |
Emma Wilson | SEEK | New | |
David Lee | Other | Shortlisted | |
Rachel Green | SEEK | New | |
James Taylor | Careers website | Shortlisted | |
Lisa Anderson | Other | Offered | |
Peter Wright | SEEK | New | |
Amy Chen | Careers website | Shortlisted |
Legend:
Verified by SEEK Pass
Contact us if your software requires webhook notifications for verification
results.
Use PNG buttons in emailsUse a PNG button asset in emails as SVGs may not render consistently or at
all in certain email clients.