Retrieve an anonymised candidate by candidate public ID

Request

Fetches details of an anonymised candidate by their unique public candidate ID.

Security

ApiKeyAuth

Path

publicIdstring, (base64-uuid)required

Unique public ID of the candidate to retrieve

Example:ABcd2EFgHIjkLMNOp3QR-S

curl -i -X GET \
  https://tc-api.redocly.app/_mock/openapi/v1/candidates/ABcd2EFgHIjkLMNOp3QR-S \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

An anonymised candidate's details

Bodyapplication/json

candidateCertificationsArray of objects(CandidateCertification)

List of certifications held by the candidate.

candidateCitizenshipsArray of objects(CandidateCitizenship)

List of citizenships held by the candidate.

candidateDestinationsArray of objects(Destination)

List of destinations related to the candidate.

candidateEducationsArray of objects(CandidateEducation)

List of educational achievements of the candidate.

candidateExamsArray of objects(CandidateExam)

List of exams taken by the candidate.

candidateLanguagesArray of objects(CandidateLanguage)

List of languages that the candidate is proficient in.

candidateMessagestring

Message written by the candidate.

candidateOccupationsArray of objects(CandidateOccupation)

List of occupations related to the candidate.

candidateSkillsArray of objects(CandidateSkill)

List of skills possessed by the candidate.

citystring

City of residence

Example:"Amman"

contactConsentTcPartnersboolean

Indicates whether the candidate has given consent to be contacted by TC partners.

Example:true

contactConsentRegistrationboolean

Indicates whether the candidate has given consent to be contacted regarding their registration and employment opportunities.

Example:true

countryobject(Country)

Country where candidate is currently located

genderstring(gender)

Candidate's gender.

Enum:"MALE""FEMALE""OTHER"

Example:"OTHER"

maxEducationLevelobject(EducationLevel)

The maximum education level of the candidate

nationalityobject(Country)

Nationality of the candidate.

howHeardAboutUsstring(how_heard_about_us)

How the candidate heard about the Talent Catalog.

Enum:"ONLINE_GOOGLE_SEARCH""FACEBOOK""INSTAGRAM""LINKEDIN""X""WHATSAPP""YOUTUBE""FRIEND_COLLEAGUE_REFERRAL""UNIVERSITY_SCHOOL_REFERRAL""EMPLOYER_REFERRAL"

Example:"FRIEND_COLLEAGUE_REFERRAL"

unhcrConsentstring(yes_no)

Indicates whether the candidate has given consent for UNHCR to be notified that they have registered on the Talent Catalog.

Enum:"NO_RESPONSE""YES""NO"

Example:"YES"

yearOfArrivalinteger, (int32)

Year of arrival in the country

Example:2010

publicIdstring, (base64-uuid)required

Universally unique identifier for the candidate

Example:"ABcd2EFgHIjkLMNOp3QR-S"

asylumYearstring, (date)

Date of asylum

Example:"2015-07-12"

arrestImprisonstring(yes_no_unsure)

Indicates whether the candidate has been arrested or imprisoned.

Enum:"NO_RESPONSE""YES""NO""UNSURE"

Example:"YES"

availDatestring, (date)

Date when the candidate becomes available for opportunities. A date without a time-zone in the ISO-8601 calendar system

Example:"2023-12-01"

availImmediatestring(yes_no)

Indicates whether the candidate is immediately available for opportunities.

Enum:"NO_RESPONSE""YES""NO"

Example:"YES"

availImmediateJobOpsstring

The type of job opportunities the candidate is qualified for.

Example:"Yes"

availImmediateReasonstring(avail_immediate_reason)

Reason for the candidate's immediate availability.

Enum:"FAMILY""HEALTH""CURRENT_WORK""STUDIES""OTHER"

Example:"FAMILY"

birthCountryobject(Country)

Country of birth

candidateDependantsArray of objects(Dependant)

List of dependants related to the candidate.

candidateVisaChecksArray of objects(CandidateVisaCheck)

List of visa checks related to the candidate.

canDrivestring(yes_no)

Indicates whether the candidate can drive.

Enum:"NO_RESPONSE""YES""NO"

Example:"YES"

conflictstring(yes_no)

Indicates whether the candidate has participated in a conflict.

Enum:"NO_RESPONSE""YES""NO"

Example:"NO"

covidVaccinatedstring(yes_no)

Vaccination status of the candidate.

Enum:"NO_RESPONSE""YES""NO"

Example:"YES"

covidVaccinatedDatestring, (date)

Date of the candidate's last COVID-19 vaccination.

Example:"2022-12-15"

covidVaccineNamestring

Name of the COVID-19 vaccine received by the candidate.

Example:"Pfizer-BioNTech"

covidVaccinatedStatusstring(vaccination_status)

COVID-19 vaccination status of the candidate.

Enum:"NO_RESPONSE""FULL""PARTIAL"

Example:"FULL"

crimeConvictstring(yes_no_unsure)

Indicates whether the candidate has a criminal conviction.

Enum:"NO_RESPONSE""YES""NO""UNSURE"

Example:"NO"

destLimitstring(yes_no)

Destination limits for the candidate.

Enum:"NO_RESPONSE""YES""NO"

Example:"NO"

drivingLicensestring(document_status)

Indicates the status of the candidate's driving license.

Enum:"NO_RESPONSE""VALID""EXPIRED""NONE"

Example:"VALID"

drivingLicenseCountryobject(Country)

Country where the candidate's driving license was issued.

drivingLicenseExpstring, (date)

Expiry date of the candidate's driving license.

Example:"2025-12-31"

englishAssessmentScoreIeltsstring

IELTS score of the candidate's English assessment.

Example:"6.5"

familyMovestring(yes_no)

Indicates whether the candidate is moving with their family.

Enum:"NO_RESPONSE""YES""NO"

Example:"YES"

frenchAssessmentScoreNclcinteger, (int64)

NCLC (Canadian Language Benchmark) score of the candidate's French assessment.

Example:10

fullIntakeCompletedDatestring, (date-time)

Date when the full intake was completed.

Example:"2022-12-31T14:30:00Z"

healthIssuesstring(yes_no)

Indicates whether the candidate has health issues.

Enum:"NO_RESPONSE""YES""NO"

Example:"NO"

homeLocationstring

Home location of the candidate before they became a refugee.

Example:"Damascus"

hostChallengesstring

Challenges faced by the candidate in the host country.

Example:"Host country challenges"

hostEntryLegallystring(yes_no)

Indicates if the candidate entered the host country legally.

Enum:"NO_RESPONSE""YES""NO"

Example:"YES"

hostEntryYearinteger

Year the candidate entered the host country.

Example:2010

ieltsScorenumber, (float)

IELTS score of the candidate.

Example:7.5

intRecruitReasonsArray of strings(int_recruit_reason)

Reasons for the candidate's international recruitment.

Items Enum:"NO_RESPONSE""CANT_RETURN_HOME""CITIZENSHIP""EXPERIENCE""CHILDREN""OTHER"

Example:

[
  "CANT_RETURN_HOME"
]

intRecruitRuralstring(yes_no_unsure)

Indicates whether the candidate will work in a rural area.

Enum:"NO_RESPONSE""YES""NO""UNSURE"

Example:"YES"

leftHomeReasonsArray of strings(left_home_reason)

Reasons for the candidate leaving home.

Items Enum:"NO_RESPONSE""SAFETY""JOB""OTHER"

Example:

[
  "SAFETY"
]

maritalStatusstring(marital_status)

Marital status of the candidate.

Enum:"NO_RESPONSE""MARRIED""ENGAGED""DEFACTO""SINGLE""DIVORCED""SEPARATED""WIDOWER"

Example:"MARRIED"

mediaWillingnessstring

Indicates the candidate's willingness to participate in media activities

Example:"Yes"

militaryServicestring(yes_no)

Indicates whether the candidate has served in the military.

Enum:"NO_RESPONSE""YES""NO"

Example:"YES"

militaryWantedstring(yes_no_unsure)

Indicates whether the candidate is wanted for military service.

Enum:"NO_RESPONSE""YES""NO""UNSURE"

Example:"NO"

militaryStartstring, (date)

Start date of the candidate's military service.

Example:"2010-01-01"

militaryEndstring, (date)

End date of the candidate's military service.

Example:"2015-01-01"

miniIntakeCompletedDatestring, (date-time)

Date when the mini intake was completed.

Example:"2022-12-31T14:30:00Z"

monitoringEvaluationConsentstring(yes_no)

Indicates whether the candidate has given consent for monitoring and evaluation.

Enum:"NO_RESPONSE""YES""NO"

Example:"YES"

numberDependantsinteger, (int64)

Number of dependants related to the candidate.

Example:2

partnerRegisteredstring(yes_no_unsure)

Indicates whether the candidate's partner is registered.

Enum:"NO_RESPONSE""YES""NO""UNSURE"

Example:"YES"

partnerPublicIdstring, (base64-uuid)

Anonymised public ID of the candidate's partner (if also a candidate in the system)

Example:"ABcd2EFgHIjkLMNOp3QR-S"

partnerCitizenshipArray of integers, (int64)

Citizenship(s) of the candidate's partner.

Example:

[
  1,
  2
]

partnerEduLevelobject(EducationLevel)

Education level of the candidate's partner.

partnerEnglishstring(yes_no)

Indicates whether the candidate's partner speaks English.

Enum:"NO_RESPONSE""YES""NO"

Example:"YES"

partnerEnglishLevelobject(LanguageLevel)

English proficiency level of the candidate's partner.

partnerIeltsstring(ielts_status)

Indicates whether the candidate's partner has taken the IELTS exam.

Enum:"NO_RESPONSE""YES_GENERAL""YES_ACADEMIC""NO""UNSURE"

Example:"YES_GENERAL"

partnerIeltsScorestring

IELTS score of the candidate's partner.

Example:"7.5"

partnerIeltsYrinteger, (int64)

Year the candidate's partner took the IELTS exam.

Example:2020

partnerOccupationobject(Occupation)

Occupation of the candidate's partner.

residenceStatusstring(residence_status)

Residence status of the candidate.

Enum:"NO_RESPONSE""LEGAL_RES""ILLEGAL_RES""OTHER"

Example:"LEGAL_RES"

returnedHomestring(yes_no_unsure)

Indicates whether the candidate has returned home.

Enum:"NO_RESPONSE""YES""NO""UNSURE"

Example:"NO"

returnHomeSafestring(yes_no_unsure)

Indicates whether the candidate returned home safely.

Enum:"NO_RESPONSE""YES""NO""UNSURE"

Example:"YES"

returnHomeFuturestring(yes_no_unsure)

Indicates whether the candidate plans to return home in the future.

Enum:"NO_RESPONSE""YES""NO""UNSURE"

Example:"NO"

resettleThirdstring(yes_no)

Indicates whether the candidate has ever applied for resettlement or emigration to a 3rd country.

Enum:"NO_RESPONSE""YES""NO"

Example:"YES"

statusstring(candidate_status)

Status of the candidate.

Enum:"ACTIVE""AUTONOMOUS_EMPLOYMENT""DELETED""DRAFT""EMPLOYED""INCOMPLETE""INELIGIBLE""PENDING""UNREACHABLE""WITHDRAWN"

Example:"ACTIVE"

unhcrNotRegStatusstring(not_registered_status)

UNHCR not registered status of the candidate.

Enum:"NO_RESPONSE""WAS_REGISTERED""NEVER_REGISTERED""REGISTERING""UNSURE""NA"

Example:"NEVER_REGISTERED"

unhcrRegisteredstring(yes_no_unsure)

Indicates whether the candidate is registered with UNHCR.

Enum:"NO_RESPONSE""YES""NO""UNSURE"

Example:"YES"

unhcrStatusstring(unhcr_status)

UNHCR status of the candidate.

Enum:"NO_RESPONSE""MANDATE_REFUGEE""REGISTERED_ASYLUM""REGISTERED_STATELESS""REGISTERED_STATUS_UNKNOWN""NOT_REGISTERED""UNSURE""NA"

Example:"MANDATE_REFUGEE"

unrwaNotRegStatusstring(not_registered_status)

UNRWA not registered status of the candidate.

Enum:"NO_RESPONSE""WAS_REGISTERED""NEVER_REGISTERED""REGISTERING""UNSURE""NA"

Example:"NEVER_REGISTERED"

unrwaRegisteredstring(yes_no_unsure)

Indicates whether the candidate is registered with UNRWA.

Enum:"NO_RESPONSE""YES""NO""UNSURE"

Example:"NO"

visaIssuesstring(yes_no_unsure)

Indicates whether the candidate has had visa issues.

Enum:"NO_RESPONSE""YES""NO""UNSURE"

Example:"NO"

visaRejectstring(yes_no_unsure)

Indicates whether the candidate has had a visa application rejected.

Enum:"NO_RESPONSE""YES""NO""UNSURE"

Example:"NO"

workAbroadstring(yes_no)

Indicates whether the candidate has worked abroad.

Enum:"NO_RESPONSE""YES""NO"

Example:"YES"

workPermitstring(work_permit)

Indicates whether the candidate has a work permit and if it is in the desired field.

Enum:"NO_RESPONSE""YES_NOT_DESIRED""YES_DESIRED""NO"

Example:"YES_DESIRED"

workPermitDesiredstring(yes_no_unsure)

Indicates whether the candidate desires a work permit.

Enum:"NO_RESPONSE""YES""NO""UNSURE"

Example:"YES"

yearOfBirthinteger, (int32)

Year of birth of the candidate

Example:1985

createdDatestring, (date-time)(ISO 8601 Timestamp)read-only

Date when the candidate was created.

Example:"2024-11-14T14:30:00Z"

Response

{
  "candidateCertifications": [
    { … }
  ],
  "candidateCitizenships": [
    { … }
  ],
  "candidateDestinations": [
    { … }
  ],
  "candidateEducations": [
    { … }
  ],
  "candidateExams": [
    { … }
  ],
  "candidateLanguages": [
    { … }
  ],
  "candidateMessage": "string",
  "candidateOccupations": [
    { … }
  ],
  "candidateSkills": [
    { … }
  ],
  "city": "Amman",
  "contactConsentTcPartners": true,
  "contactConsentRegistration": true,
  "country": {
    "isoCode": "GB",
    "name": "United Kingdom",
    "status": "ACTIVE"
  },
  "gender": "OTHER",
  "maxEducationLevel": {
    "level": 40,
    "status": "ACTIVE",
    "educationType": "MASTERS"
  },
  "nationality": {
    "isoCode": "GB",
    "name": "United Kingdom",
    "status": "ACTIVE"
  },
  "howHeardAboutUs": "FRIEND_COLLEAGUE_REFERRAL",
  "unhcrConsent": "YES",
  "yearOfArrival": 2010,
  "publicId": "ABcd2EFgHIjkLMNOp3QR-S",
  "asylumYear": "2015-07-12",
  "arrestImprison": "YES",
  "availDate": "2023-12-01",
  "availImmediate": "YES",
  "availImmediateJobOps": "Yes",
  "availImmediateReason": "FAMILY",
  "birthCountry": {
    "isoCode": "GB",
    "name": "United Kingdom",
    "status": "ACTIVE"
  },
  "candidateDependants": [
    { … }
  ],
  "candidateVisaChecks": [
    { … }
  ],
  "canDrive": "YES",
  "conflict": "NO",
  "covidVaccinated": "YES",
  "covidVaccinatedDate": "2022-12-15",
  "covidVaccineName": "Pfizer-BioNTech",
  "covidVaccinatedStatus": "FULL",
  "crimeConvict": "NO",
  "destLimit": "NO",
  "drivingLicense": "VALID",
  "drivingLicenseCountry": {
    "isoCode": "GB",
    "name": "United Kingdom",
    "status": "ACTIVE"
  },
  "drivingLicenseExp": "2025-12-31",
  "englishAssessmentScoreIelts": "6.5",
  "familyMove": "YES",
  "frenchAssessmentScoreNclc": 10,
  "fullIntakeCompletedDate": "2022-12-31T14:30:00Z",
  "healthIssues": "NO",
  "homeLocation": "Damascus",
  "hostChallenges": "Host country challenges",
  "hostEntryLegally": "YES",
  "hostEntryYear": 2010,
  "ieltsScore": 7.5,
  "intRecruitReasons": [
    "CANT_RETURN_HOME"
  ],
  "intRecruitRural": "YES",
  "leftHomeReasons": [
    "SAFETY"
  ],
  "maritalStatus": "MARRIED",
  "mediaWillingness": "Yes",
  "militaryService": "YES",
  "militaryWanted": "NO",
  "militaryStart": "2010-01-01",
  "militaryEnd": "2015-01-01",
  "miniIntakeCompletedDate": "2022-12-31T14:30:00Z",
  "monitoringEvaluationConsent": "YES",
  "numberDependants": 2,
  "partnerRegistered": "YES",
  "partnerPublicId": "ABcd2EFgHIjkLMNOp3QR-S",
  "partnerCitizenship": [
    1,
    2
  ],
  "partnerEduLevel": {
    "level": 40,
    "status": "ACTIVE",
    "educationType": "MASTERS"
  },
  "partnerEnglish": "YES",
  "partnerEnglishLevel": {
    "level": 351,
    "name": "Full Professional Proficiency",
    "cefrLevel": "B2"
  },
  "partnerIelts": "YES_GENERAL",
  "partnerIeltsScore": "7.5",
  "partnerIeltsYr": 2020,
  "partnerOccupation": {
    "isco08Code": "2411",
    "name": "Accountant",
    "status": "ACTIVE"
  },
  "residenceStatus": "LEGAL_RES",
  "returnedHome": "NO",
  "returnHomeSafe": "YES",
  "returnHomeFuture": "NO",
  "resettleThird": "YES",
  "status": "ACTIVE",
  "unhcrNotRegStatus": "NEVER_REGISTERED",
  "unhcrRegistered": "YES",
  "unhcrStatus": "MANDATE_REFUGEE",
  "unrwaNotRegStatus": "NEVER_REGISTERED",
  "unrwaRegistered": "NO",
  "visaIssues": "NO",
  "visaReject": "NO",
  "workAbroad": "YES",
  "workPermit": "YES_DESIRED",
  "workPermitDesired": "YES",
  "yearOfBirth": 1985,
  "createdDate": "2024-11-14T14:30:00Z"
}