Skip to content

Register a candidate with the Talent Catalog

Request

Allows API users to register a candidate with the Talent Catalog by providing candidate information using the IdentifiableCandidate schema. Users should provide as much information as possible, including all required fields.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Candidate information to register with the Talent Catalog

registrarIdstring

The unique identifier of organization supplying the registration data

Example:"registrar-12345"
registrationDataobject(CandidateRegistration)

Data required to register a candidate on the Talent Catalog.

curl -i -X POST \
  https://tc-api.redocly.app/_mock/openapi/v1/candidates/register \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "registrarId": "registrar-12345",
    "registrationData": {
      "identity": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "john@doe.com"
      },
      "dob": "1985-06-15",
      "linkedInLink": "https://www.linkedin.com/in/johndoe",
      "phone": "+1-234-567-890",
      "unhcrNumber": "12345678",
      "unrwaNumber": "12345678",
      "whatsapp": "+1-234-567-890",
      "candidateCertifications": [
        {
          "name": "Certified Kubernetes Administrator",
          "institution": "Cloud Native Computing Foundation",
          "dateCompleted": "2024-11-27"
        }
      ],
      "candidateCitizenships": [
        {
          "hasPassport": "VALID_PASSPORT",
          "passportExp": "2024-11-27",
          "nationality": {
            "isoCode": "GB",
            "name": "United Kingdom",
            "status": "ACTIVE"
          }
        }
      ],
      "candidateDestinations": [
        {
          "country": {
            "isoCode": "GB",
            "name": "United Kingdom",
            "status": "ACTIVE"
          },
          "interest": "YES"
        }
      ],
      "candidateEducations": [
        {
          "educationType": "MASTERS",
          "country": {
            "isoCode": "GB",
            "name": "United Kingdom",
            "status": "ACTIVE"
          },
          "educationMajor": {
            "id": 8713,
            "iscedCode": "0711",
            "name": "Computer Science",
            "status": "ACTIVE"
          },
          "lengthOfCourseYears": 4,
          "institution": "University of Cambridge",
          "courseName": "Computer Science Tripos",
          "yearCompleted": 2024,
          "incomplete": false
        }
      ],
      "candidateExams": [
        {
          "exam": "OTHER",
          "otherExam": "Test of English for Aviation",
          "score": "8.5",
          "year": 2024
        }
      ],
      "candidateLanguages": [
        {
          "language": {
            "isoCode": "en",
            "name": "English",
            "status": "ACTIVE"
          },
          "writtenLevel": {
            "level": 351,
            "name": "Full Professional Proficiency",
            "cefrLevel": "B2"
          },
          "spokenLevel": {
            "level": 351,
            "name": "Full Professional Proficiency",
            "cefrLevel": "B2"
          }
        }
      ],
      "candidateMessage": "string",
      "candidateOccupations": [
        {
          "occupation": {
            "isco08Code": "2411",
            "name": "Accountant",
            "status": "ACTIVE"
          },
          "yearsExperience": 5,
          "candidateJobExperiences": [
            {
              "country": {
                "isoCode": "GB",
                "name": "United Kingdom",
                "status": "ACTIVE"
              },
              "companyName": "Acme Corporation",
              "role": "Senior Software Engineer",
              "startDate": "2020-11-27",
              "endDate": "2024-11-27",
              "fullTime": true,
              "paid": true,
              "description": "Developed new features for the company'\''s flagship product."
            }
          ]
        }
      ],
      "candidateSkills": [
        {
          "skill": "Java",
          "timePeriod": "5 years"
        }
      ],
      "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
    }
  }'

Responses

Candidate successfully registered with the Talent Catalog

Bodyapplication/json
messagestring

Success message

Example:"Candidate successfully registered."
publicIdstring, (base64-uuid)

The unique public ID assigned to the registered candidate

Example:"ABcd2EFgHIjkLMNOp3QR-S"
Response
{
  "message": "Candidate successfully registered.",
  "publicId": "ABcd2EFgHIjkLMNOp3QR-S"
}