{"items":[{"type":"link","label":"Talent Catalog API","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"Talent Catalog API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://github.com/Talent-Catalog/tc-api-spec","url":"https://github.com/Talent-Catalog/tc-api-spec"},{"kind":"email","title":"Talent Catalog API Support","email":"api@talentcatalog.net","label":"api@talentcatalog.net","withCopyButton":true,"copyContent":"api@talentcatalog.net"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Gnu Affero General Public License","url":"https://www.gnu.org/licenses/agpl-3.0.html"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://test.api.tctalent.org","description":"Staging server"},{"url":"https://api.tctalent.org","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Talent Catalog API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Talent Catalog (TC) is a purpose-built platform designed to connect skilled displaced"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"populations with international job opportunities and refugee-focused support services."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Talent Catalog API allows third-party systems to connect to the TC platform."},"children":[]}]}]}]}],"sectionId":"/openapi"}],"sectionId":"/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/key-features"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Features"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Talent Catalog API offers the following capabilities:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search Candidate Profiles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Retrieve anonymised candidate data from the TC database."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter Search Results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Find candidates based on various criteria (e.g. location,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"occupation, or nationality)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Post Job Matches"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Match candidate profiles with relevant employment opportunities."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Post Service Matches"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Connect candidate profiles with appropriate support services."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register Candidates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Add new candidate registrations directly to the TC database."},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/key-features"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Talent Catalog API uses API Key Authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each request must include an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with your API key."},"children":[]}]}]}]}],"sectionId":"/openapi/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/getting-started"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact us to register for an API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the endpoints below to interact with the API."},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/getting-started"}]}]}},{"type":"link","label":"Key Features","link":"/openapi/section/key-features","routeSlug":"/openapi/section/key-features","content":null},{"type":"link","label":"Authentication","link":"/openapi/section/authentication","routeSlug":"/openapi/section/authentication","content":null},{"type":"link","label":"Getting Started","link":"/openapi/section/getting-started","routeSlug":"/openapi/section/getting-started","content":null},{"type":"group","label":"Candidates","link":"/openapi/candidates","routeSlug":"/openapi/candidates","items":[{"label":"Retrieve a page of anonymised candidates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/candidates/findcandidates","routeSlug":"/openapi/candidates/findcandidates","metadata":{"seo":{"title":"Retrieve a page of anonymised candidates","description":"Fetches a paginated array of anonymised candidates. Optionally filter candidates by their ISCO (International Standard Classification of Occupations) codes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"findCandidates","name":"Retrieve a page of anonymised candidates","isWebhook":false,"pointer":"/paths/~1v1~1candidates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a page of anonymised candidates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a paginated array of anonymised candidates. Optionally filter candidates by their ISCO (International Standard Classification of Occupations) codes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_14","description":"The page number for pagination"},{"name":"limit","in":"query","schemaId":"schema_15","description":"The number of results per page"},{"name":"location","in":"query","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of ISO 3166-1 alpha-2 location codes to filter candidates by their current location. Provide one or more ISO codes as a comma-separated list (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US,GB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"nationality","in":"query","schemaId":"schema_17","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of ISO 3166-1 alpha-2 nationality codes to filter candidates by their nationality. Provide one or more ISO codes as a comma-separated list (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FR,DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"occupation","in":"query","schemaId":"schema_18","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of ISCO codes to filter candidates by their occupations. Provide one or more ISCO codes as a comma-separated list (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1234,5678"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"includeEmployed","in":"query","schemaId":"schema_19","description":"Flag to include candidate profiles with an \"employed\" status in the results. Defaults to false."}],"pointer":"/paths/~1v1~1candidates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/candidates","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://test.api.tctalent.org","description":"Staging server"},{"url":"https://api.tctalent.org","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_14"},{"name":"limit","in":"query","required":false,"schemaId":"schema_15"},{"name":"location","in":"query","required":false,"example":"US,GB","schemaId":"schema_16"},{"name":"nationality","in":"query","required":false,"example":"FR,DE","schemaId":"schema_17"},{"name":"occupation","in":"query","required":false,"example":"1234,5678","schemaId":"schema_18"},{"name":"includeEmployed","in":"query","required":false,"schemaId":"schema_19"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/candidates","href":"candidates/findcandidates","openApiOperationId":"findCandidates","summary":"Retrieve a page of anonymised candidates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://test.api.tctalent.org","description":"Staging server"},{"url":"https://api.tctalent.org","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A page of anonymised candidates","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidatePage"}},"schemaId":"components/schemas/CandidatePage"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestParamError"}},"schemaId":"components/schemas/BadRequestParamError"},{"code":"401","description":"Unauthorised","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorisedError"}},"schemaId":"components/schemas/UnauthorisedError"},{"code":"500","description":"Internal server error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v1~1candidates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CandidatePage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidatePage"}}},{"code":"400","schemaId":"components/schemas/BadRequestParamError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestParamError"}}},{"code":"401","schemaId":"components/schemas/UnauthorisedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorisedError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidates/findcandidates"}],"panels":[]}]},"httpPath":"/v1/candidates"},{"label":"Retrieve an anonymised candidate by candidate public ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/candidates/getcandidatebypublicid","routeSlug":"/openapi/candidates/getcandidatebypublicid","metadata":{"seo":{"title":"Retrieve an anonymised candidate by candidate public ID","description":"Fetches details of an anonymised candidate by their unique public candidate ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCandidateByPublicId","name":"Retrieve an anonymised candidate by candidate public ID","isWebhook":false,"pointer":"/paths/~1v1~1candidates~1{publicId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an anonymised candidate by candidate public ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches details of an anonymised candidate by their unique public candidate ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"publicId","in":"path","schemaId":"schema_20","description":"Unique public ID of the candidate to retrieve","required":true}],"pointer":"/paths/~1v1~1candidates~1{publicId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/candidates/{publicId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://test.api.tctalent.org","description":"Staging server"},{"url":"https://api.tctalent.org","description":"Production server"}],"parameters":{"path":[{"name":"publicId","in":"path","required":true,"example":"ABcd2EFgHIjkLMNOp3QR-S","schemaId":"schema_20"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","204","400","401","404","500"],"pointer":"/v1/candidates/{publicId}","href":"candidates/getcandidatebypublicid","openApiOperationId":"getCandidateByPublicId","summary":"Retrieve an anonymised candidate by candidate public ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://test.api.tctalent.org","description":"Staging server"},{"url":"https://api.tctalent.org","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An anonymised candidate's details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Candidate"}},"schemaId":"components/schemas/Candidate"},{"code":"204","description":"No content - No candidates available for the requested page"},{"code":"400","description":"Bad request - Invalid candidate ID","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestParamError"}},"schemaId":"components/schemas/BadRequestParamError"},{"code":"401","description":"Unauthorised - Access token is missing or invalid","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorisedError"}},"schemaId":"components/schemas/UnauthorisedError"},{"code":"404","description":"Not found - Candidate not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}},"schemaId":"components/schemas/NotFoundError"},{"code":"500","description":"Internal server error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v1~1candidates~1{publicId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Candidate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Candidate"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequestParamError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestParamError"}}},{"code":"401","schemaId":"components/schemas/UnauthorisedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorisedError"}}},{"code":"404","schemaId":"components/schemas/NotFoundError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidates/getcandidatebypublicid"}],"panels":[]}]},"httpPath":"/v1/candidates/{publicId}"},{"label":"Retrieve a page of anonymised candidates in a saved list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/candidates/getcandidatesbypubliclistid","routeSlug":"/openapi/candidates/getcandidatesbypubliclistid","metadata":{"seo":{"title":"Retrieve a page of anonymised candidates in a saved list","description":"Fetches a paginated array of anonymised candidates belonging to a specific saved list, identified by its public ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCandidatesByPublicListId","name":"Retrieve a page of anonymised candidates in a saved list","isWebhook":false,"pointer":"/paths/~1v1~1candidates~1by-list~1{publicListId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a page of anonymised candidates in a saved list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a paginated array of anonymised candidates belonging to a specific saved list, identified by its public ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"publicListId","in":"path","schemaId":"schema_21","description":"The public ID of the saved list","required":true}],"pointer":"/paths/~1v1~1candidates~1by-list~1{publicListId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_14","description":"The page number for pagination"},{"name":"limit","in":"query","schemaId":"schema_15","description":"The number of results per page"}],"pointer":"/paths/~1v1~1candidates~1by-list~1{publicListId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/candidates/by-list/{publicListId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://test.api.tctalent.org","description":"Staging server"},{"url":"https://api.tctalent.org","description":"Production server"}],"parameters":{"path":[{"name":"publicListId","in":"path","required":true,"schemaId":"schema_21"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_14"},{"name":"limit","in":"query","required":false,"schemaId":"schema_15"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/candidates/by-list/{publicListId}","href":"candidates/getcandidatesbypubliclistid","openApiOperationId":"getCandidatesByPublicListId","summary":"Retrieve a page of anonymised candidates in a saved list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://test.api.tctalent.org","description":"Staging server"},{"url":"https://api.tctalent.org","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A page of anonymised candidates","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidatePage"}},"schemaId":"components/schemas/CandidatePage"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestParamError"}},"schemaId":"components/schemas/BadRequestParamError"},{"code":"401","description":"Unauthorised","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorisedError"}},"schemaId":"components/schemas/UnauthorisedError"},{"code":"500","description":"Internal server error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v1~1candidates~1by-list~1{publicListId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CandidatePage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidatePage"}}},{"code":"400","schemaId":"components/schemas/BadRequestParamError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestParamError"}}},{"code":"401","schemaId":"components/schemas/UnauthorisedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorisedError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidates/getcandidatesbypubliclistid"}],"panels":[]}]},"httpPath":"/v1/candidates/by-list/{publicListId}"},{"label":"Expression of interest in candidates for a job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/candidates/jobmatch","routeSlug":"/openapi/candidates/jobmatch","metadata":{"seo":{"title":"Expression of interest in candidates for a job","description":"Allows prospective employers or recruiters to indicate that one or more candidates look like they match the requirements of a job, and that they are interested in proceeding further with those candidates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"jobMatch","name":"Expression of interest in candidates for a job","isWebhook":false,"pointer":"/paths/~1v1~1candidates~1job-match/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Expression of interest in candidates for a job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows prospective employers or recruiters to indicate that one or more candidates look like they match the requirements of a job, and that they are interested in proceeding further with those candidates."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22","pointer":"/paths/~1v1~1candidates~1job-match/post/requestBody","description":"Information about the prospective employer or recruiter who has the job"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/candidates/job-match","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://test.api.tctalent.org","description":"Staging server"},{"url":"https://api.tctalent.org","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_22"}},"responseCodes":["201","400","401","403","404","500"],"pointer":"/v1/candidates/job-match","href":"candidates/jobmatch","openApiOperationId":"jobMatch","summary":"Expression of interest in candidates for a job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://test.api.tctalent.org","description":"Staging server"},{"url":"https://api.tctalent.org","description":"Production server"}],"schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully expressed interest in matching the candidates to the job","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}},"schemaId":"schema_23"},{"code":"400","description":"Bad request - Invalid request payload or candidate ID","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestBodyError"}},"schemaId":"components/schemas/BadRequestBodyError"},{"code":"401","description":"Unauthorised - Access token is missing or invalid","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorisedError"}},"schemaId":"components/schemas/UnauthorisedError"},{"code":"403","description":"Forbidden - You do not have permission to job match","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not found - Candidate(s) not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}},"schemaId":"components/schemas/NotFoundError"},{"code":"500","description":"Internal server error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v1~1candidates~1job-match/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_23","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}}},{"code":"400","schemaId":"components/schemas/BadRequestBodyError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestBodyError"}}},{"code":"401","schemaId":"components/schemas/UnauthorisedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorisedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/NotFoundError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidates/jobmatch"}],"panels":[]}]},"httpPath":"/v1/candidates/job-match"},{"label":"Offer to assist candidates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/candidates/offertoassistcandidates","routeSlug":"/openapi/candidates/offertoassistcandidates","metadata":{"seo":{"title":"Offer to assist candidates","description":"Allows candidate service providers to offer assistance to one or more candidates. For example, to invite eligible candidate's to access specialised services for education, migration or settlement support."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"offerToAssistCandidates","name":"Offer to assist candidates","isWebhook":false,"pointer":"/paths/~1v1~1candidates~1offer-to-assist/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Offer to assist candidates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows candidate service providers to offer assistance to one or more candidates. For example, to invite eligible candidate's to access specialised services for education, migration or settlement support."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24","pointer":"/paths/~1v1~1candidates~1offer-to-assist/post/requestBody","description":"Information about the prospective employer, recruiter or candidate service provider expressing interest in the candidate"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/candidates/offer-to-assist","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://test.api.tctalent.org","description":"Staging server"},{"url":"https://api.tctalent.org","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_24"}},"responseCodes":["201","400","401","403","404","500"],"pointer":"/v1/candidates/offer-to-assist","href":"candidates/offertoassistcandidates","openApiOperationId":"offerToAssistCandidates","summary":"Offer to assist candidates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://test.api.tctalent.org","description":"Staging server"},{"url":"https://api.tctalent.org","description":"Production server"}],"schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully expressed interest in the candidate","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25"},{"code":"400","description":"Bad request - Invalid request payload or candidate ID","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestBodyError"}},"schemaId":"components/schemas/BadRequestBodyError"},{"code":"401","description":"Unauthorised - Access token is missing or invalid","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorisedError"}},"schemaId":"components/schemas/UnauthorisedError"},{"code":"403","description":"Forbidden - You do not have permission to offer assistance to candidates","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not found - Candidate(s) not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}},"schemaId":"components/schemas/NotFoundError"},{"code":"500","description":"Internal server error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v1~1candidates~1offer-to-assist/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}}},{"code":"400","schemaId":"components/schemas/BadRequestBodyError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestBodyError"}}},{"code":"401","schemaId":"components/schemas/UnauthorisedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorisedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/NotFoundError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidates/offertoassistcandidates"}],"panels":[]}]},"httpPath":"/v1/candidates/offer-to-assist"},{"label":"Register a candidate with the Talent Catalog","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/candidates/registercandidate","routeSlug":"/openapi/candidates/registercandidate","metadata":{"seo":{"title":"Register a candidate with the Talent Catalog","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"registerCandidate","name":"Register a candidate with the Talent Catalog","isWebhook":false,"pointer":"/paths/~1v1~1candidates~1register/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register a candidate with the Talent Catalog","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26","pointer":"/paths/~1v1~1candidates~1register/post/requestBody","description":"Candidate information to register with the Talent Catalog"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/candidates/register","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://test.api.tctalent.org","description":"Staging server"},{"url":"https://api.tctalent.org","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_26"}},"responseCodes":["201","400","401","403","409","500"],"pointer":"/v1/candidates/register","href":"candidates/registercandidate","openApiOperationId":"registerCandidate","summary":"Register a candidate with the Talent Catalog"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://test.api.tctalent.org","description":"Staging server"},{"url":"https://api.tctalent.org","description":"Production server"}],"schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_26"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Candidate successfully registered with the Talent Catalog","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}},"schemaId":"schema_27"},{"code":"400","description":"Bad request - Invalid request payload","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestBodyError"}},"schemaId":"components/schemas/BadRequestBodyError"},{"code":"401","description":"Unauthorised - Access token is missing or invalid","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorisedError"}},"schemaId":"components/schemas/UnauthorisedError"},{"code":"403","description":"Forbidden - Access token does not have the required permissions","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"409","description":"Conflict - Candidate already registered","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictError"}},"schemaId":"components/schemas/ConflictError"},{"code":"500","description":"Internal server error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v1~1candidates~1register/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_27","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}}},{"code":"400","schemaId":"components/schemas/BadRequestBodyError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/BadRequestBodyError"}}},{"code":"401","schemaId":"components/schemas/UnauthorisedError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/UnauthorisedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"409","schemaId":"components/schemas/ConflictError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ConflictError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidates/registercandidate"}],"panels":[]}]},"httpPath":"/v1/candidates/register"}],"content":{"contentType":"group","meta":{"name":"Candidates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Candidates","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to anonymised candidates."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/candidates","summary":"Retrieve a page of anonymised candidates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/candidates/findcandidates","deprecated":false},{"title":"/v1/candidates/{publicId}","summary":"Retrieve an anonymised candidate by candidate public ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/candidates/getcandidatebypublicid","deprecated":false},{"title":"/v1/candidates/by-list/{publicListId}","summary":"Retrieve a page of anonymised candidates in a saved list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/candidates/getcandidatesbypubliclistid","deprecated":false},{"title":"/v1/candidates/job-match","summary":"Expression of interest in candidates for a job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/candidates/jobmatch","deprecated":false},{"title":"/v1/candidates/offer-to-assist","summary":"Offer to assist candidates","prefix":{"name":"post","color":"post"},"badges":[],"link":"/candidates/offertoassistcandidates","deprecated":false},{"title":"/v1/candidates/register","summary":"Register a candidate with the Talent Catalog","prefix":{"name":"post","color":"post"},"badges":[],"link":"/candidates/registercandidate","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/IdentifiableCandidate":{"id":"components/schemas/IdentifiableCandidate","kind":"json-schema","title":"IdentifiableCandidate","data":{"allOf":[{"$ref":"#/components/schemas/Candidate"},{"$ref":"#/components/schemas/IdentifiableCandidateRegistrationFields"},{"type":"object","properties":{"id":{"type":"string","description":"Unique Talent Catalog identifier for the candidate.","example":1234567},"candidateNumber":{"type":"string","description":"Unique candidate number.","example":"12345678"},"candidateDependants":{"type":"array","description":"List of dependants related to the candidate.","items":{"$ref":"#/components/schemas/IdentifiableDependant"}},"candidateVisaChecks":{"type":"array","description":"List of visa checks related to the candidate.","items":{"$ref":"#/components/schemas/IdentifiableCandidateVisaCheck"}},"externalId":{"type":"string","description":"External ID of the candidate.","example":"12345678"},"externalIdSource":{"type":"string","description":"Source of the external ID.","example":"source1"},"address1":{"type":"string","description":"Candidate's address line 1.","example":"123 Main St"},"partnerCandidate":{"description":"The candidate's partner (if also a candidate in the system)","allOf":[{"$ref":"#/components/schemas/IdentifiablePartner"}]},"registeredByPublicId":{"type":"string","format":"base64-uuid","description":"Anonymised public ID of the partner who registered the candidate or null if the candidate registered themselves.","example":"ABcd2EFgHIjkLMNOp3QR-S"},"regoIp":{"type":"string","description":"IP address of the candidate during registration.","example":"12.34.56.78"},"regoPartnerParam":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameter (p=) for partner during registration."},"children":[]}]}]}],"type":"string","example":"partner1"},"regoReferrerParam":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Referrer parameter (r=) during registration."},"children":[]}]}]}],"type":"string","example":"referrer1"},"regoUtmCampaign":{"description":"UTM campaign parameter during registration.","type":"string","example":"campaign1"},"regoUtmContent":{"description":"UTM content parameter during registration.","type":"string","example":"content1"},"regoUtmMedium":{"description":"UTM medium parameter during registration.","type":"string","example":"medium1"},"regoUtmSource":{"description":"UTM source parameter during registration.","type":"string","example":"source1"},"regoUtmTerm":{"description":"UTM term parameter during registration.","type":"string","example":"term1"},"unhcrFile":{"type":"string","description":"Candidate's UNHCR file number.","example":"12345678"},"unrwaFile":{"type":"string","description":"Candidate's UNRWA file number.","example":"12345678"},"textSearchId":{"type":"string","description":"The ID of the corresponding elastic search record.","example":"12345678"},"folderlink":{"type":"string","description":"Link to the corresponding folder containing the candidate's documents.","example":"https://drive.google.com/folder/12345678"},"folderlinkAddress":{"type":"string","description":"Link to the corresponding folder containing the candidate's address documents.","example":"https://drive.google.com/folder/12345678"},"folderlinkCharacter":{"type":"string","description":"Link to the corresponding folder containing the candidate's character documents.","example":"https://drive.google.com/folder/12345678"},"folderlinkEmployer":{"type":"string","description":"Link to the corresponding folder containing the candidate's employer documents.","example":"https://drive.google.com/folder/12345678"},"folderlinkEngagement":{"type":"string","description":"Link to the corresponding folder containing the candidate's engagement documents.","example":"https://drive.google.com/folder/12345678"},"folderlinkExperience":{"type":"string","description":"Link to the corresponding folder containing the candidate's experience documents.","example":"https://drive.google.com/folder/12345678"},"folderlinkFamily":{"type":"string","description":"Link to the corresponding folder containing the candidate's family documents.","example":"https://drive.google.com/folder/12345678"},"folderlinkIdentity":{"type":"string","description":"Link to the corresponding folder containing the candidate's identity documents.","example":"https://drive.google.com/folder/12345678"},"folderlinkImmigration":{"type":"string","description":"Link to the corresponding folder containing the candidate's immigration documents.","example":"https://drive.google.com/folder/12345678"},"folderlinkLanguage":{"type":"string","description":"Link to the corresponding folder containing the candidate's language documents.","example":"https://drive.google.com/folder/12345678"},"folderlinkMedical":{"type":"string","description":"Link to the corresponding folder containing the candidate's medical documents.","example":"https://drive.google.com/folder/12345678"},"folderlinkQualification":{"type":"string","description":"Link to the corresponding folder containing the candidate's qualification documents.","example":"https://drive.google.com/folder/12345678"},"folderlinkRegistration":{"type":"string","description":"Link to the corresponding folder containing the candidate's registration documents.","example":"https://drive.google.com/folder/12345678"},"sflink":{"type":"string","description":"Link to the corresponding Salesforce record.","example":"https://salesforce.com/record/12345678"},"videolink":{"type":"string","description":"Link to the corresponding candidate's video profile.","example":"https://drive.google.com/video/12345678"},"surveyType":{"description":"Survey type associated with the candidate.","allOf":[{"$ref":"#/components/schemas/SurveyType"}]},"contactConsentPartners":{"type":"boolean","description":"Indicates whether the candidate has given consent to be contacted by TC partners.","example":true}},"required":["candidateNumber"]}]}},"components/schemas/IdentifiableCandidatePage":{"id":"components/schemas/IdentifiableCandidatePage","kind":"json-schema","title":"IdentifiableCandidatePage","data":{"type":"object","description":"Page of identifiable candidate data","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/IdentifiableCandidate"}},"totalElements":{"type":"integer"},"totalPages":{"type":"integer"},"size":{"type":"integer"},"number":{"type":"integer"}}}},"components/schemas/IdentifiableDependant":{"id":"components/schemas/IdentifiableDependant","kind":"json-schema","title":"IdentifiableDependant","data":{"allOf":[{"$ref":"#/components/schemas/Dependant"},{"type":"object","properties":{"name":{"type":"string","description":"The name of the dependant.","example":"Jane Doe"},"dob":{"type":"string","description":"Dependant's date of birth. A date without a time-zone in the ISO-8601 calendar system.","format":"date","example":"1985-06-15"},"registeredNumber":{"type":"string","description":"The registration number of the dependant.","example":"12345678"}}}]}},"components/schemas/IdentifiableCandidateVisaCheck":{"id":"components/schemas/IdentifiableCandidateVisaCheck","kind":"json-schema","title":"IdentifiableCandidateVisaCheck","data":{"allOf":[{"$ref":"#/components/schemas/CandidateVisaCheck"},{"type":"object","properties":{"candidateVisaJobChecks":{"type":"array","description":"The job checks for the candidate's visa.","items":{"$ref":"#/components/schemas/IdentifiableCandidateVisaJobCheck"}}}}]}},"components/schemas/IdentifiableCandidateVisaJobCheck":{"id":"components/schemas/IdentifiableCandidateVisaJobCheck","kind":"json-schema","title":"IdentifiableCandidateVisaJobCheck","data":{"allOf":[{"$ref":"#/components/schemas/CandidateVisaJobCheck"},{"type":"object","properties":{"tbbEligibility":{"description":"The candidate is eligible for the Talent Catalog.","allOf":[{"$ref":"#/components/schemas/tc_eligibility_assessment"}]}}}]}},"components/schemas/CandidateCertification":{"id":"components/schemas/CandidateCertification","kind":"json-schema","title":"CandidateCertification","data":{"type":"object","description":"A certification that a candidate has achieved.","properties":{"name":{"type":"string","description":"The name of the certification.","example":"Certified Kubernetes Administrator"},"institution":{"type":"string","description":"The authority that issued the certification.","example":"Cloud Native Computing Foundation"},"dateCompleted":{"type":"string","format":"date","description":"The date the certification was achieved.","example":"2024-11-27"}},"required":["name","institution","dateCompleted"]}},"components/schemas/has_passport":{"id":"components/schemas/has_passport","kind":"json-schema","title":"has_passport","data":{"type":"string","enum":["NO_RESPONSE","VALID_PASSPORT","INVALID_PASSPORT","NO_PASSPORT"],"x-enum-varnames":["NO_RESPONSE","VALID_PASSPORT","INVALID_PASSPORT","NO_PASSPORT"],"example":"VALID_PASSPORT"}},"components/schemas/status":{"id":"components/schemas/status","kind":"json-schema","title":"status","data":{"type":"string","enum":["ACTIVE","INACTIVE","DELETED"],"x-enum-varnames":["ACTIVE","INACTIVE","DELETED"],"example":"ACTIVE"}},"components/schemas/Country":{"id":"components/schemas/Country","kind":"json-schema","title":"Country","data":{"type":"object","properties":{"isoCode":{"type":"string","description":"The ISO 3166-1 alpha-2 code for the country.","example":"GB"},"name":{"type":"string","description":"The name of the country.","example":"United Kingdom"},"status":{"type":"string","description":"The status of the country.","allOf":[{"$ref":"#/components/schemas/status"}]}},"required":["isoCode","name","status"]}},"components/schemas/CandidateCitizenship":{"id":"components/schemas/CandidateCitizenship","kind":"json-schema","title":"CandidateCitizenship","data":{"type":"object","description":"A candidate's citizenship information.","properties":{"hasPassport":{"type":"string","description":"Whether the candidate has a passport.","allOf":[{"$ref":"#/components/schemas/has_passport"}]},"passportExp":{"type":"string","format":"date","description":"The expiration date of the candidate's passport.","example":"2024-11-27"},"nationality":{"description":"The country of citizenship of the candidate.","$ref":"#/components/schemas/Country"}}}},"components/schemas/yes_no_unsure":{"id":"components/schemas/yes_no_unsure","kind":"json-schema","title":"yes_no_unsure","data":{"type":"string","enum":["NO_RESPONSE","YES","NO","UNSURE"],"x-enum-varnames":["NO_RESPONSE","YES","NO","UNSURE"],"example":"YES"}},"components/schemas/Destination":{"id":"components/schemas/Destination","kind":"json-schema","title":"Destination","data":{"type":"object","description":"A destination that a candidate is interested in.","properties":{"country":{"description":"The country of the destination.","allOf":[{"$ref":"#/components/schemas/Country"}]},"interest":{"type":"string","description":"The candidate's interest in the destination.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}]}}}},"components/schemas/education_type":{"id":"components/schemas/education_type","kind":"json-schema","title":"education_type","data":{"type":"string","enum":["ASSOCIATE","VOCATIONAL","BACHELOR","MASTERS","DOCTORAL"],"x-enum-varnames":["ASSOCIATE","VOCATIONAL","BACHELOR","MASTERS","DOCTORAL"],"example":"MASTERS"}},"components/schemas/EducationMajor":{"id":"components/schemas/EducationMajor","kind":"json-schema","title":"EducationMajor","data":{"type":"object","description":"An education major.","properties":{"id":{"type":"integer","format":"int64","description":"The unique identifier for the education major.","example":8713},"iscedCode":{"type":"string","description":"The ISCED code for the education major.","example":"0711"},"name":{"type":"string","description":"The name of the education major.","example":"Computer Science"},"status":{"type":"string","description":"The status of the education major.","allOf":[{"$ref":"#/components/schemas/status"}]}}}},"components/schemas/CandidateEducation":{"id":"components/schemas/CandidateEducation","kind":"json-schema","title":"CandidateEducation","data":{"type":"object","description":"An education achievement of a candidate","properties":{"educationType":{"type":"string","description":"The type of education.","allOf":[{"$ref":"#/components/schemas/education_type"}]},"country":{"$ref":"#/components/schemas/Country"},"educationMajor":{"description":"The major of the education.","allOf":[{"$ref":"#/components/schemas/EducationMajor"}]},"lengthOfCourseYears":{"type":"integer","description":"The length of the course in years.","example":4},"institution":{"type":"string","description":"The institution where the education was completed.","example":"University of Cambridge"},"courseName":{"type":"string","description":"The name of the course.","example":"Computer Science Tripos"},"yearCompleted":{"type":"integer","description":"The year the education was completed.","example":2024},"incomplete":{"type":"boolean","description":"Whether the education was completed.","example":false}}}},"components/schemas/exam":{"id":"components/schemas/exam","kind":"json-schema","title":"exam","data":{"type":"string","enum":["NO_RESPONSE","OET","OET_READ","OET_LIST","OET_LANG","IELTS_GEN","IELTS_ACA","TOEFL","OTHER","DET_OFFICIAL"],"x-enum-varnames":["NO_RESPONSE","OET","OET_READ","OET_LIST","OET_LANG","IELTS_GEN","IELTS_ACA","TOEFL","OTHER","DET_OFFICIAL"],"example":"IELTS_GEN"}},"components/schemas/CandidateExam":{"id":"components/schemas/CandidateExam","kind":"json-schema","title":"CandidateExam","data":{"type":"object","description":"An exam that a candidate has taken.","properties":{"exam":{"type":"string","description":"The type of the exam.","allOf":[{"$ref":"#/components/schemas/exam"}],"example":"OTHER"},"otherExam":{"type":"string","description":"The name of the exam if the exam type is \"Other\".","example":"Test of English for Aviation"},"score":{"type":"string","description":"The score of the exam.","example":"8.5"},"year":{"type":"integer","format":"int64","description":"The year the exam was taken.","example":2024}}}},"components/schemas/Language":{"id":"components/schemas/Language","kind":"json-schema","title":"Language","data":{"type":"object","properties":{"isoCode":{"type":"string","description":"The ISO code for the language.","example":"en"},"name":{"type":"string","description":"The name of the language.","example":"English"},"status":{"type":"string","description":"The status of the language.","allOf":[{"$ref":"#/components/schemas/status"}]}}}},"components/schemas/cefr_levels":{"id":"components/schemas/cefr_levels","kind":"json-schema","title":"cefr_levels","data":{"type":"string","enum":["A1","A2","B1","B2","C1","C2"],"x-enum-varnames":["A1","A2","B1","B2","C1","C2"],"example":"B2"}},"components/schemas/LanguageLevel":{"id":"components/schemas/LanguageLevel","kind":"json-schema","title":"LanguageLevel","data":{"type":"object","description":"A language proficiency level that a candidate has achieved.","properties":{"level":{"type":"integer","format":"int32","description":"The language proficiency level id.","example":351},"name":{"type":"string","description":"The name of the language proficiency level.","example":"Full Professional Proficiency"},"cefrLevel":{"type":"string","description":"The CEFR code for the language proficiency level.","allOf":[{"$ref":"#/components/schemas/cefr_levels"}]}}}},"components/schemas/CandidateLanguage":{"id":"components/schemas/CandidateLanguage","kind":"json-schema","title":"CandidateLanguage","data":{"type":"object","description":"The candidate's language proficiency.","properties":{"language":{"description":"The language that the candidate is proficient in.","allOf":[{"$ref":"#/components/schemas/Language"}]},"writtenLevel":{"description":"The candidate's written proficiency in this language.","allOf":[{"$ref":"#/components/schemas/LanguageLevel"}]},"spokenLevel":{"description":"The candidate's spoken proficiency in this language.","allOf":[{"$ref":"#/components/schemas/LanguageLevel"}]}}}},"components/schemas/Occupation":{"id":"components/schemas/Occupation","kind":"json-schema","title":"Occupation","data":{"type":"object","description":"An occupation.","properties":{"isco08Code":{"type":"string","description":"The ISCO-08 code for the occupation.","example":"2411"},"name":{"type":"string","description":"The name of the occupation.","example":"Accountant"},"status":{"type":"string","description":"The status of the occupation.","allOf":[{"$ref":"#/components/schemas/status"}]}}}},"components/schemas/CandidateJobExperience":{"id":"components/schemas/CandidateJobExperience","kind":"json-schema","title":"CandidateJobExperience","data":{"type":"object","description":"A job experience that a candidate has had","properties":{"country":{"$ref":"#/components/schemas/Country"},"companyName":{"type":"string","description":"The name of the company where the candidate worked.","example":"Acme Corporation"},"role":{"type":"string","description":"The role the candidate had at the company.","example":"Senior Software Engineer"},"startDate":{"type":"string","format":"date","description":"The date the candidate started working at the company.","example":"2020-11-27"},"endDate":{"type":"string","format":"date","description":"The date the candidate stopped working at the company.","example":"2024-11-27"},"fullTime":{"type":"boolean","description":"Whether the candidate worked full-time at the company.","example":true},"paid":{"type":"boolean","description":"Whether the candidate was paid for their work at the company.","example":true},"description":{"type":"string","description":"A description of the candidate's work at the company.","example":"Developed new features for the company's flagship product."}}}},"components/schemas/CandidateOccupation":{"id":"components/schemas/CandidateOccupation","kind":"json-schema","title":"CandidateOccupation","data":{"type":"object","description":"The candidate's occupation","properties":{"occupation":{"description":"The candidate's occupation.","allOf":[{"$ref":"#/components/schemas/Occupation"}]},"yearsExperience":{"type":"integer","description":"The number of years of experience the candidate has in this job.","example":5},"candidateJobExperiences":{"type":"array","description":"List of job experiences of the candidate in this occupation.","items":{"$ref":"#/components/schemas/CandidateJobExperience"}}}}},"components/schemas/CandidateSkill":{"id":"components/schemas/CandidateSkill","kind":"json-schema","title":"CandidateSkill","data":{"type":"object","description":"A skill associated with a candidate.","properties":{"skill":{"type":"string","description":"The name of the skill.","example":"Java"},"timePeriod":{"type":"string","description":"The duration the candidate has been using this skill.","example":"5 years"}}}},"components/schemas/gender":{"id":"components/schemas/gender","kind":"json-schema","title":"gender","data":{"type":"string","enum":["MALE","FEMALE","OTHER"],"x-enum-varnames":["MALE","FEMALE","OTHER"],"example":"OTHER"}},"components/schemas/EducationLevel":{"id":"components/schemas/EducationLevel","kind":"json-schema","title":"EducationLevel","data":{"type":"object","description":"The education level.","properties":{"level":{"type":"integer","format":"int32","description":"The level of education.","example":40},"status":{"description":"The status of the education level.","allOf":[{"$ref":"#/components/schemas/status"}]},"educationType":{"description":"The type of education.","allOf":[{"$ref":"#/components/schemas/education_type"}]}}}},"components/schemas/how_heard_about_us":{"id":"components/schemas/how_heard_about_us","kind":"json-schema","title":"how_heard_about_us","data":{"type":"string","enum":["ONLINE_GOOGLE_SEARCH","FACEBOOK","INSTAGRAM","LINKEDIN","X","WHATSAPP","YOUTUBE","FRIEND_COLLEAGUE_REFERRAL","UNIVERSITY_SCHOOL_REFERRAL","EMPLOYER_REFERRAL","EVENT_WEBINAR","INFORMATION_SESSION","COMMUNITY_CENTRE_POSTING_FLYERS","OUTREACH_WORKER","NGO","UNHCR","US_AFGHAN","ULYP","TECHFUGEES","AL_GHURAIR_FOUNDATION","OTHER"],"x-enum-varnames":["ONLINE_GOOGLE_SEARCH","FACEBOOK","INSTAGRAM","LINKEDIN","X","WHATSAPP","YOUTUBE","FRIEND_COLLEAGUE_REFERRAL","UNIVERSITY_SCHOOL_REFERRAL","EMPLOYER_REFERRAL","EVENT_WEBINAR","INFORMATION_SESSION","COMMUNITY_CENTRE_POSTING_FLYERS","OUTREACH_WORKER","NGO","UNHCR","US_AFGHAN","ULYP","TECHFUGEES","AL_GHURAIR_FOUNDATION","OTHER"],"example":"FRIEND_COLLEAGUE_REFERRAL"}},"components/schemas/yes_no":{"id":"components/schemas/yes_no","kind":"json-schema","title":"yes_no","data":{"type":"string","enum":["NO_RESPONSE","YES","NO"],"x-enum-varnames":["NO_RESPONSE","YES","NO"],"example":"YES"}},"components/schemas/AnonCandidateRegistrationFields":{"id":"components/schemas/AnonCandidateRegistrationFields","kind":"json-schema","title":"AnonCandidateRegistrationFields","data":{"type":"object","description":"Represents non identifiable Candidate data that originates in the original registration.","properties":{"candidateCertifications":{"type":"array","description":"List of certifications held by the candidate.","items":{"$ref":"#/components/schemas/CandidateCertification"}},"candidateCitizenships":{"type":"array","description":"List of citizenships held by the candidate.","items":{"$ref":"#/components/schemas/CandidateCitizenship"}},"candidateDestinations":{"type":"array","description":"List of destinations related to the candidate.","items":{"$ref":"#/components/schemas/Destination"}},"candidateEducations":{"type":"array","description":"List of educational achievements of the candidate.","items":{"$ref":"#/components/schemas/CandidateEducation"}},"candidateExams":{"type":"array","description":"List of exams taken by the candidate.","items":{"$ref":"#/components/schemas/CandidateExam"}},"candidateLanguages":{"type":"array","description":"List of languages that the candidate is proficient in.","items":{"$ref":"#/components/schemas/CandidateLanguage"}},"candidateMessage":{"type":"string","description":"Message written by the candidate."},"candidateOccupations":{"type":"array","description":"List of occupations related to the candidate.","items":{"$ref":"#/components/schemas/CandidateOccupation"}},"candidateSkills":{"type":"array","description":"List of skills possessed by the candidate.","items":{"$ref":"#/components/schemas/CandidateSkill"}},"city":{"type":"string","description":"City of residence","example":"Amman"},"contactConsentTcPartners":{"type":"boolean","description":"Indicates whether the candidate has given consent to be contacted by TC partners.","example":true},"contactConsentRegistration":{"type":"boolean","description":"Indicates whether the candidate has given consent to be contacted regarding their registration and employment opportunities.","example":true},"country":{"description":"Country where candidate is currently located","allOf":[{"$ref":"#/components/schemas/Country"}]},"gender":{"description":"Candidate's gender.","allOf":[{"$ref":"#/components/schemas/gender"}]},"maxEducationLevel":{"description":"The maximum education level of the candidate","allOf":[{"$ref":"#/components/schemas/EducationLevel"}]},"nationality":{"description":"Nationality of the candidate.","allOf":[{"$ref":"#/components/schemas/Country"}]},"howHeardAboutUs":{"description":"How the candidate heard about the Talent Catalog.","allOf":[{"$ref":"#/components/schemas/how_heard_about_us"}]},"unhcrConsent":{"description":"Indicates whether the candidate has given consent for UNHCR to be notified that they have registered on the Talent Catalog.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"yearOfArrival":{"type":"integer","format":"int32","description":"Year of arrival in the country","example":2010}}}},"components/schemas/avail_immediate_reason":{"id":"components/schemas/avail_immediate_reason","kind":"json-schema","title":"avail_immediate_reason","data":{"type":"string","enum":["FAMILY","HEALTH","CURRENT_WORK","STUDIES","OTHER"],"x-enum-varnames":["FAMILY","HEALTH","CURRENT_WORK","STUDIES","OTHER"],"example":"FAMILY"}},"components/schemas/dependant_relations":{"id":"components/schemas/dependant_relations","kind":"json-schema","title":"dependant_relations","data":{"type":"string","enum":["NO_RESPONSE","PARTNER","CHILD","PARENT","SIBLING","AUNT_UNCLE","GRANDPARENT","COUSIN","OTHER"],"x-enum-varnames":["NO_RESPONSE","PARTNER","CHILD","PARENT","SIBLING","AUNT_UNCLE","GRANDPARENT","COUSIN","OTHER"],"example":"CHILD"}},"components/schemas/registration":{"id":"components/schemas/registration","kind":"json-schema","title":"registration","data":{"type":"string","enum":["NO_RESPONSE","UNHCR","UNRWA","NEITHER","NA"],"x-enum-varnames":["NO_RESPONSE","UNHCR","UNRWA","NEITHER","NA"],"example":"UNHCR"}},"components/schemas/Dependant":{"id":"components/schemas/Dependant","kind":"json-schema","title":"Dependant","data":{"type":"object","description":"A dependant of a candidate.","properties":{"relation":{"description":"The relation of the dependant to the candidate.","allOf":[{"$ref":"#/components/schemas/dependant_relations"}]},"relationOther":{"type":"string","description":"The relation of the dependant to the candidate if the relation is \"Other\".","example":"Niece"},"yearOfBirth":{"type":"integer","format":"int32","description":"Year of birth of the candidate","example":1985},"gender":{"description":"The gender of the dependant.","allOf":[{"$ref":"#/components/schemas/gender"}]},"registered":{"description":"Whether and where the dependant is registered.","allOf":[{"$ref":"#/components/schemas/registration"}]},"healthConcern":{"description":"Any health concerns for the dependant.","allOf":[{"$ref":"#/components/schemas/yes_no"}],"example":"NO"}}}},"components/schemas/risk_level":{"id":"components/schemas/risk_level","kind":"json-schema","title":"risk_level","data":{"type":"string","enum":["NO_RESPONSE","LOW","MEDIUM","HIGH"],"x-enum-varnames":["NO_RESPONSE","LOW","MEDIUM","HIGH"],"example":"LOW"}},"components/schemas/document_status":{"id":"components/schemas/document_status","kind":"json-schema","title":"document_status","data":{"type":"string","enum":["NO_RESPONSE","VALID","EXPIRED","NONE"],"x-enum-varnames":["NO_RESPONSE","VALID","EXPIRED","NONE"],"example":"VALID"}},"components/schemas/family_relations":{"id":"components/schemas/family_relations","kind":"json-schema","title":"family_relations","data":{"type":"string","enum":["NO_RESPONSE","NO_RELATION","CHILD","PARENT","SIBLING","AUNT_UNCLE","GRANDPARENT","COUSIN","OTHER"],"x-enum-varnames":["NO_RESPONSE","NO_RELATION","CHILD","PARENT","SIBLING","AUNT_UNCLE","GRANDPARENT","COUSIN","OTHER"],"example":"CHILD"}},"components/schemas/Employer":{"id":"components/schemas/Employer","kind":"json-schema","title":"Employer","data":{"type":"object","description":"An anonymised employer.","properties":{"country":{"description":"The country where the employer is located.","allOf":[{"$ref":"#/components/schemas/Country"}]},"hasHiredInternationally":{"type":"boolean","description":"Whether the employer has hired internationally.","example":true}}}},"components/schemas/job_opportunity_stage":{"id":"components/schemas/job_opportunity_stage","kind":"json-schema","title":"job_opportunity_stage","data":{"type":"string","enum":["PROSPECT","BRIEFING","PITCHING","MOU","IDENTIFYING_ROLES","CANDIDATE_SEARCH","VISA_ELIGIBILITY","CV_PREPARATION","CV_REVIEW","RECRUITMENT_PROCESS","JOB_OFFER","TRAINING","VISA_PREPARATION","POST_HIRE_ENGAGEMENT","HIRING_COMPLETED","INELIGIBLE_EMPLOYER","INELIGIBLE_OCCUPATION","INELIGIBLE_REGION","NO_INTEREST","NO_JOB_OFFER","NO_PR_PATHWAY","NO_SUITABLE_CANDIDATES","NO_VISA","TOO_EXPENSIVE","TOO_HIGH_WAGE","TOO_LONG","MOU_ISSUE","TRAINING_NOT_COMPLETED"],"x-enum-varnames":["PROSPECT","BRIEFING","PITCHING","MOU","IDENTIFYING_ROLES","CANDIDATE_SEARCH","VISA_ELIGIBILITY","CV_PREPARATION","CV_REVIEW","RECRUITMENT_PROCESS","JOB_OFFER","TRAINING","VISA_PREPARATION","POST_HIRE_ENGAGEMENT","HIRING_COMPLETED","INELIGIBLE_EMPLOYER","INELIGIBLE_OCCUPATION","INELIGIBLE_REGION","NO_INTEREST","NO_JOB_OFFER","NO_PR_PATHWAY","NO_SUITABLE_CANDIDATES","NO_VISA","TOO_EXPENSIVE","TOO_HIGH_WAGE","TOO_LONG","MOU_ISSUE","TRAINING_NOT_COMPLETED"],"example":"CANDIDATE_SEARCH"}},"components/schemas/JobOpportunity":{"id":"components/schemas/JobOpportunity","kind":"json-schema","title":"JobOpportunity","data":{"type":"object","description":"A job opportunity.","properties":{"country":{"description":"The country where the job opportunity is located.","allOf":[{"$ref":"#/components/schemas/Country"}]},"employerEntity":{"description":"The anonymised employer details.","allOf":[{"$ref":"#/components/schemas/Employer"}]},"evergreen":{"type":"boolean","description":"Whether the job opportunity is evergreen.","example":true},"publishedDate":{"type":"string","format":"date-time","description":"The date the job opportunity was published.","example":"2021-01-01T00:00:00Z"},"stage":{"description":"The stage of the job opportunity.","allOf":[{"$ref":"#/components/schemas/job_opportunity_stage"}],"example":"VISA_PREPARATION"},"submissionDueDate":{"type":"string","format":"date","description":"The date submissions are due for the job opportunity.","example":"2021-01-01"},"hiringCommitment":{"type":"integer","format":"int64","description":"The number of candidates the employer has committed to hiring for this opportunity.","example":3},"employerHiredInternationally":{"type":"string","description":"Whether the employer had hired internationally prior to this opportunity.","example":"Yes"}}}},"components/schemas/other_visas":{"id":"components/schemas/other_visas","kind":"json-schema","title":"other_visas","data":{"type":"string","enum":["NO_RESPONSE","TEMP_SKILLED","SPECIAL_HUM","OTHER_HUM","DIRECT_ENT","POINTS_INDEP"],"x-enum-varnames":["NO_RESPONSE","TEMP_SKILLED","SPECIAL_HUM","OTHER_HUM","DIRECT_ENT","POINTS_INDEP"],"example":"TEMP_SKILLED"}},"components/schemas/visa_eligibility":{"id":"components/schemas/visa_eligibility","kind":"json-schema","title":"visa_eligibility","data":{"type":"string","enum":["NO_RESPONSE","YES","YES_BUT","DISCUSS_FURTHER","SEEK_ADVICE","NO"],"x-enum-varnames":["NO_RESPONSE","YES","YES_BUT","DISCUSS_FURTHER","SEEK_ADVICE","NO"],"example":"YES"}},"components/schemas/tc_eligibility_assessment":{"id":"components/schemas/tc_eligibility_assessment","kind":"json-schema","title":"tc_eligibility_assessment","data":{"type":"string","enum":["NO_RESPONSE","PROCEED","DISCUSS","DONT_PROCEED"],"x-enum-varnames":["NO_RESPONSE","PROCEED","DISCUSS","DONT_PROCEED"],"example":"PROCEED"}},"components/schemas/CandidateVisaJobCheck":{"id":"components/schemas/CandidateVisaJobCheck","kind":"json-schema","title":"CandidateVisaJobCheck","data":{"type":"object","description":"A job check related to a candidate's visa for a destination.","properties":{"jobOpp":{"description":"The job opportunity that's located in same destination associated with the visa check.","allOf":[{"$ref":"#/components/schemas/JobOpportunity"}]},"interest":{"description":"The candidate has genuine interest and desire to relocate for the job opportunity.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"qualification":{"description":"The candidate has relevant qualification for the job opportunity.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"occupation":{"description":"The occupation for the job opportunity.","allOf":[{"$ref":"#/components/schemas/Occupation"}]},"salaryTsmit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The salary for the job opportunity meets the TSMIT threshold (Australia visa check ONLY), see 'https://www.homeaffairs.gov.au/reports-and-pubs/files/tsmit_review_report.pdf'"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/yes_no"}]},"regional":{"description":"The job opportunity is in a regional area.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"eligible_494":{"description":"The candidate is eligible for the 494 visa (Australia visa check ONLY).","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"eligible_186":{"description":"The candidate is eligible for the 186 visa.(Australia visa check ONLY)","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"eligibleOther":{"description":"The candidate is eligible for another visa (Australia visa check ONLY).","allOf":[{"$ref":"#/components/schemas/other_visas"}]},"putForward":{"description":"The candidate has been put forward for the job opportunity.","allOf":[{"$ref":"#/components/schemas/visa_eligibility"}]},"tcEligibility":{"description":"The candidate is eligible for the Talent Catalog.","allOf":[{"$ref":"#/components/schemas/tc_eligibility_assessment"}]},"ageRequirement":{"type":"string","description":"The candidate meets the age requirement for the job opportunity.","example":"Yes"},"languagesRequired":{"type":"array","description":"An array of language IDs denoting the languages required for the job opportunity.","items":{"type":"integer","format":"int64"},"example":[1,2]},"languagesThresholdMet":{"description":"The candidate meets the language threshold for the job opportunity.","allOf":[{"$ref":"#/components/schemas/yes_no"}]}}}},"components/schemas/CandidateVisaCheck":{"id":"components/schemas/CandidateVisaCheck","kind":"json-schema","title":"CandidateVisaCheck","data":{"type":"object","description":"A check of a candidate's visa status.","properties":{"country":{"description":"The country of the visa.","allOf":[{"$ref":"#/components/schemas/Country"}]},"protection":{"description":"Meets international protection assessment.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"englishThreshold":{"description":"Meets the English language threshold for the visa.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"healthAssessment":{"description":"Meets health assessment for the visa.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"characterAssessment":{"description":"Meets character assessment for the visa.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"securityRisk":{"description":"Meets security risk assessment for the visa.","allOf":[{"$ref":"#/components/schemas/yes_no"}],"example":"NO"},"overallRisk":{"description":"The overall risk assessment status for the visa.","allOf":[{"$ref":"#/components/schemas/risk_level"}]},"validTravelDocs":{"description":"The validity status of the candidate's travel document (if exists).","allOf":[{"$ref":"#/components/schemas/document_status"}]},"pathwayAssessment":{"description":"Meets pathway assessment for the visa.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}]},"destinationFamily":{"description":"The closest relative of the candidate in the destination country (if exists).","allOf":[{"$ref":"#/components/schemas/family_relations"}],"example":"SIBLING"},"candidateVisaJobChecks":{"type":"array","description":"The job checks for the candidate's visa.","items":{"$ref":"#/components/schemas/CandidateVisaJobCheck"}}}}},"components/schemas/vaccination_status":{"id":"components/schemas/vaccination_status","kind":"json-schema","title":"vaccination_status","data":{"type":"string","enum":["NO_RESPONSE","FULL","PARTIAL"],"x-enum-varnames":["NO_RESPONSE","FULL","PARTIAL"],"example":"FULL"}},"components/schemas/int_recruit_reason":{"id":"components/schemas/int_recruit_reason","kind":"json-schema","title":"int_recruit_reason","data":{"type":"string","enum":["NO_RESPONSE","CANT_RETURN_HOME","CITIZENSHIP","EXPERIENCE","CHILDREN","OTHER"],"x-enum-varnames":["NO_RESPONSE","CANT_RETURN_HOME","CITIZENSHIP","EXPERIENCE","CHILDREN","OTHER"],"example":"CANT_RETURN_HOME"}},"components/schemas/left_home_reason":{"id":"components/schemas/left_home_reason","kind":"json-schema","title":"left_home_reason","data":{"type":"string","enum":["NO_RESPONSE","SAFETY","JOB","OTHER"],"x-enum-varnames":["NO_RESPONSE","SAFETY","JOB","OTHER"],"example":"SAFETY"}},"components/schemas/marital_status":{"id":"components/schemas/marital_status","kind":"json-schema","title":"marital_status","data":{"type":"string","enum":["NO_RESPONSE","MARRIED","ENGAGED","DEFACTO","SINGLE","DIVORCED","SEPARATED","WIDOWER"],"x-enum-varnames":["NO_RESPONSE","MARRIED","ENGAGED","DEFACTO","SINGLE","DIVORCED","SEPARATED","WIDOWER"],"example":"MARRIED"}},"components/schemas/ielts_status":{"id":"components/schemas/ielts_status","kind":"json-schema","title":"ielts_status","data":{"type":"string","enum":["NO_RESPONSE","YES_GENERAL","YES_ACADEMIC","NO","UNSURE"],"x-enum-varnames":["NO_RESPONSE","YES_GENERAL","YES_ACADEMIC","NO","UNSURE"],"example":"YES_GENERAL"}},"components/schemas/residence_status":{"id":"components/schemas/residence_status","kind":"json-schema","title":"residence_status","data":{"type":"string","enum":["NO_RESPONSE","LEGAL_RES","ILLEGAL_RES","OTHER"],"x-enum-varnames":["NO_RESPONSE","LEGAL_RES","ILLEGAL_RES","OTHER"],"example":"LEGAL_RES"}},"components/schemas/candidate_status":{"id":"components/schemas/candidate_status","kind":"json-schema","title":"candidate_status","data":{"type":"string","enum":["ACTIVE","AUTONOMOUS_EMPLOYMENT","DELETED","DRAFT","EMPLOYED","INCOMPLETE","INELIGIBLE","PENDING","UNREACHABLE","WITHDRAWN"],"x-enum-varnames":["ACTIVE","AUTONOMOUS_EMPLOYMENT","DELETED","DRAFT","EMPLOYED","INCOMPLETE","INELIGIBLE","PENDING","UNREACHABLE","WITHDRAWN"],"example":"ACTIVE"}},"components/schemas/not_registered_status":{"id":"components/schemas/not_registered_status","kind":"json-schema","title":"not_registered_status","data":{"type":"string","enum":["NO_RESPONSE","WAS_REGISTERED","NEVER_REGISTERED","REGISTERING","UNSURE","NA"],"x-enum-varnames":["NO_RESPONSE","WAS_REGISTERED","NEVER_REGISTERED","REGISTERING","UNSURE","NA"],"example":"NEVER_REGISTERED"}},"components/schemas/unhcr_status":{"id":"components/schemas/unhcr_status","kind":"json-schema","title":"unhcr_status","data":{"type":"string","enum":["NO_RESPONSE","MANDATE_REFUGEE","REGISTERED_ASYLUM","REGISTERED_STATELESS","REGISTERED_STATUS_UNKNOWN","NOT_REGISTERED","UNSURE","NA"],"x-enum-varnames":["NO_RESPONSE","MANDATE_REFUGEE","REGISTERED_ASYLUM","REGISTERED_STATELESS","REGISTERED_STATUS_UNKNOWN","NOT_REGISTERED","UNSURE","NA"],"example":"MANDATE_REFUGEE"}},"components/schemas/work_permit":{"id":"components/schemas/work_permit","kind":"json-schema","title":"work_permit","data":{"type":"string","enum":["NO_RESPONSE","YES_NOT_DESIRED","YES_DESIRED","NO"],"x-enum-varnames":["NO_RESPONSE","YES_NOT_DESIRED","YES_DESIRED","NO"],"example":"YES_DESIRED"}},"components/schemas/iso_timestamp":{"id":"components/schemas/iso_timestamp","kind":"json-schema","title":"ISO 8601 Timestamp","data":{"type":"string","format":"date-time","description":"ISO 8601 formatted timestamp. Created and modified timestamps are in UTC.","example":"2024-11-14T14:30:00Z","title":"ISO 8601 Timestamp","readOnly":true}},"components/schemas/Candidate":{"id":"components/schemas/Candidate","kind":"json-schema","title":"Candidate","data":{"allOf":[{"$ref":"#/components/schemas/AnonCandidateRegistrationFields"},{"type":"object","description":"Represents anon Candidate data that is created post registration","properties":{"publicId":{"type":"string","format":"base64-uuid","description":"Universally unique identifier for the candidate","example":"ABcd2EFgHIjkLMNOp3QR-S"},"asylumYear":{"type":"string","format":"date","description":"Date of asylum","example":"2015-07-12"},"arrestImprison":{"type":"string","description":"Indicates whether the candidate has been arrested or imprisoned.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}]},"availDate":{"type":"string","format":"date","description":"Date when the candidate becomes available for opportunities. A date without a time-zone in the ISO-8601 calendar system","example":"2023-12-01"},"availImmediate":{"type":"string","description":"Indicates whether the candidate is immediately available for opportunities.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"availImmediateJobOps":{"type":"string","description":"The type of job opportunities the candidate is qualified for.","example":"Yes"},"availImmediateReason":{"type":"string","description":"Reason for the candidate's immediate availability.","allOf":[{"$ref":"#/components/schemas/avail_immediate_reason"}]},"birthCountry":{"description":"Country of birth","allOf":[{"$ref":"#/components/schemas/Country"}]},"candidateDependants":{"type":"array","description":"List of dependants related to the candidate.","items":{"$ref":"#/components/schemas/Dependant"}},"candidateVisaChecks":{"type":"array","description":"List of visa checks related to the candidate.","items":{"$ref":"#/components/schemas/CandidateVisaCheck"}},"canDrive":{"description":"Indicates whether the candidate can drive.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"conflict":{"description":"Indicates whether the candidate has participated in a conflict.","allOf":[{"$ref":"#/components/schemas/yes_no"}],"example":"NO"},"covidVaccinated":{"description":"Vaccination status of the candidate.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"covidVaccinatedDate":{"type":"string","format":"date","description":"Date of the candidate's last COVID-19 vaccination.","example":"2022-12-15"},"covidVaccineName":{"type":"string","description":"Name of the COVID-19 vaccine received by the candidate.","example":"Pfizer-BioNTech"},"covidVaccinatedStatus":{"description":"COVID-19 vaccination status of the candidate.","allOf":[{"$ref":"#/components/schemas/vaccination_status"}]},"crimeConvict":{"description":"Indicates whether the candidate has a criminal conviction.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}],"example":"NO"},"destLimit":{"description":"Destination limits for the candidate.","allOf":[{"$ref":"#/components/schemas/yes_no"}],"example":"NO"},"drivingLicense":{"description":"Indicates the status of the candidate's driving license.","allOf":[{"$ref":"#/components/schemas/document_status"}]},"drivingLicenseCountry":{"description":"Country where the candidate's driving license was issued.","allOf":[{"$ref":"#/components/schemas/Country"}]},"drivingLicenseExp":{"type":"string","format":"date","description":"Expiry date of the candidate's driving license.","example":"2025-12-31"},"englishAssessmentScoreIelts":{"type":"string","description":"IELTS score of the candidate's English assessment.","example":"6.5"},"familyMove":{"description":"Indicates whether the candidate is moving with their family.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"frenchAssessmentScoreNclc":{"type":"integer","format":"int64","description":"NCLC (Canadian Language Benchmark) score of the candidate's French assessment.","example":10},"fullIntakeCompletedDate":{"type":"string","format":"date-time","description":"Date when the full intake was completed.","example":"2022-12-31T14:30:00Z"},"healthIssues":{"description":"Indicates whether the candidate has health issues.","allOf":[{"$ref":"#/components/schemas/yes_no"}],"example":"NO"},"homeLocation":{"type":"string","description":"Home location of the candidate before they became a refugee.","example":"Damascus"},"hostChallenges":{"type":"string","description":"Challenges faced by the candidate in the host country.","example":"Host country challenges"},"hostEntryLegally":{"description":"Indicates if the candidate entered the host country legally.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"hostEntryYear":{"type":"integer","description":"Year the candidate entered the host country.","example":2010},"ieltsScore":{"type":"number","format":"float","description":"IELTS score of the candidate.","example":7.5},"intRecruitReasons":{"type":"array","description":"Reasons for the candidate's international recruitment.","items":{"$ref":"#/components/schemas/int_recruit_reason"}},"intRecruitRural":{"description":"Indicates whether the candidate will work in a rural area.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}]},"leftHomeReasons":{"type":"array","description":"Reasons for the candidate leaving home.","items":{"$ref":"#/components/schemas/left_home_reason"}},"maritalStatus":{"description":"Marital status of the candidate.","allOf":[{"$ref":"#/components/schemas/marital_status"}]},"mediaWillingness":{"type":"string","description":"Indicates the candidate's willingness to participate in media activities","example":"Yes"},"militaryService":{"description":"Indicates whether the candidate has served in the military.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"militaryWanted":{"description":"Indicates whether the candidate is wanted for military service.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}],"example":"NO"},"militaryStart":{"type":"string","format":"date","description":"Start date of the candidate's military service.","example":"2010-01-01"},"militaryEnd":{"type":"string","format":"date","description":"End date of the candidate's military service.","example":"2015-01-01"},"miniIntakeCompletedDate":{"type":"string","format":"date-time","description":"Date when the mini intake was completed.","example":"2022-12-31T14:30:00Z"},"monitoringEvaluationConsent":{"description":"Indicates whether the candidate has given consent for monitoring and evaluation.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"numberDependants":{"type":"integer","format":"int64","description":"Number of dependants related to the candidate.","example":2},"partnerRegistered":{"description":"Indicates whether the candidate's partner is registered.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}]},"partnerPublicId":{"type":"string","format":"base64-uuid","description":"Anonymised public ID of the candidate's partner (if also a candidate in the system)","example":"ABcd2EFgHIjkLMNOp3QR-S"},"partnerCitizenship":{"type":"array","description":"Citizenship(s) of the candidate's partner.","items":{"type":"integer","format":"int64"},"example":[1,2]},"partnerEduLevel":{"description":"Education level of the candidate's partner.","allOf":[{"$ref":"#/components/schemas/EducationLevel"}]},"partnerEnglish":{"description":"Indicates whether the candidate's partner speaks English.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"partnerEnglishLevel":{"description":"English proficiency level of the candidate's partner.","allOf":[{"$ref":"#/components/schemas/LanguageLevel"}]},"partnerIelts":{"description":"Indicates whether the candidate's partner has taken the IELTS exam.","allOf":[{"$ref":"#/components/schemas/ielts_status"}]},"partnerIeltsScore":{"type":"string","description":"IELTS score of the candidate's partner.","example":"7.5"},"partnerIeltsYr":{"type":"integer","format":"int64","description":"Year the candidate's partner took the IELTS exam.","example":2020},"partnerOccupation":{"description":"Occupation of the candidate's partner.","allOf":[{"$ref":"#/components/schemas/Occupation"}]},"residenceStatus":{"description":"Residence status of the candidate.","allOf":[{"$ref":"#/components/schemas/residence_status"}]},"returnedHome":{"description":"Indicates whether the candidate has returned home.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}],"example":"NO"},"returnHomeSafe":{"description":"Indicates whether the candidate returned home safely.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}]},"returnHomeFuture":{"description":"Indicates whether the candidate plans to return home in the future.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}],"example":"NO"},"resettleThird":{"description":"Indicates whether the candidate has ever applied for resettlement or emigration to a 3rd country.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"status":{"description":"Status of the candidate.","allOf":[{"$ref":"#/components/schemas/candidate_status"}]},"unhcrNotRegStatus":{"description":"UNHCR not registered status of the candidate.","allOf":[{"$ref":"#/components/schemas/not_registered_status"}]},"unhcrRegistered":{"description":"Indicates whether the candidate is registered with UNHCR.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}]},"unhcrStatus":{"description":"UNHCR status of the candidate.","allOf":[{"$ref":"#/components/schemas/unhcr_status"}]},"unrwaNotRegStatus":{"description":"UNRWA not registered status of the candidate.","allOf":[{"$ref":"#/components/schemas/not_registered_status"}]},"unrwaRegistered":{"description":"Indicates whether the candidate is registered with UNRWA.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}],"example":"NO"},"visaIssues":{"description":"Indicates whether the candidate has had visa issues.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}],"example":"NO"},"visaReject":{"description":"Indicates whether the candidate has had a visa application rejected.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}],"example":"NO"},"workAbroad":{"description":"Indicates whether the candidate has worked abroad.","allOf":[{"$ref":"#/components/schemas/yes_no"}]},"workPermit":{"description":"Indicates whether the candidate has a work permit and if it is in the desired field.","allOf":[{"$ref":"#/components/schemas/work_permit"}]},"workPermitDesired":{"description":"Indicates whether the candidate desires a work permit.","allOf":[{"$ref":"#/components/schemas/yes_no_unsure"}]},"yearOfArrival":{"type":"integer","format":"int32","description":"Year of arrival in the country","example":2010},"yearOfBirth":{"type":"integer","format":"int32","description":"Year of birth of the candidate","example":1985},"createdDate":{"description":"Date when the candidate was created.","allOf":[{"$ref":"#/components/schemas/iso_timestamp"}]}},"required":["publicId"]}]}},"components/schemas/CandidatePage":{"id":"components/schemas/CandidatePage","kind":"json-schema","title":"CandidatePage","data":{"type":"object","description":"Page of anonymised candidate data","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Candidate"}},"totalElements":{"type":"integer"},"totalPages":{"type":"integer"},"size":{"type":"integer"},"number":{"type":"integer"}}}},"components/schemas/ErrorBase":{"id":"components/schemas/ErrorBase","kind":"json-schema","title":"ErrorBase","data":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type with a link to human-readable  documentation for the error.\n","example":"https://example.com/probs/doc"},"title":{"type":"string","description":"A short, human-readable summary of the problem type that does not change from occurrence to  occurrence of the problem.\n","example":"Invalid Pagination Parameter"},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem.\n"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.\n"},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem. It may be used to  provide further context.\n","example":"/v1/candidates?page=1"}}}},"components/schemas/BadRequestBase":{"id":"components/schemas/BadRequestBase","kind":"json-schema","title":"BadRequestBase","data":{"allOf":[{"$ref":"#/components/schemas/ErrorBase"},{"type":"object","properties":{"title":{"example":"Invalid Request"},"status":{"example":400}}}]}},"components/schemas/BadRequestParamError":{"id":"components/schemas/BadRequestParamError","kind":"json-schema","title":"BadRequestParamError","data":{"allOf":[{"$ref":"#/components/schemas/BadRequestBase"},{"type":"object","properties":{"detail":{"example":"A request parameter is invalid."}}}]}},"components/schemas/UnauthorisedError":{"id":"components/schemas/UnauthorisedError","kind":"json-schema","title":"UnauthorisedError","data":{"allOf":[{"$ref":"#/components/schemas/ErrorBase"},{"type":"object","properties":{"title":{"example":"Authentication required"},"status":{"example":401},"detail":{"example":"Invalid API key."}}}]}},"components/schemas/InternalServerError":{"id":"components/schemas/InternalServerError","kind":"json-schema","title":"InternalServerError","data":{"allOf":[{"$ref":"#/components/schemas/ErrorBase"},{"type":"object","properties":{"title":{"example":"Service Unavailable"},"status":{"example":500},"detail":{"example":"An unexpected error occurred. Please try again later."}}}]}},"components/schemas/NotFoundError":{"id":"components/schemas/NotFoundError","kind":"json-schema","title":"NotFoundError","data":{"allOf":[{"$ref":"#/components/schemas/ErrorBase"},{"type":"object","properties":{"title":{"example":"Resource not found"},"status":{"example":404},"detail":{"example":"Candidate with the provided publicId was not found."}}}]}},"components/schemas/BadRequestBodyError":{"id":"components/schemas/BadRequestBodyError","kind":"json-schema","title":"BadRequestBodyError","data":{"allOf":[{"$ref":"#/components/schemas/BadRequestBase"},{"type":"object","properties":{"detail":{"example":"Request body is missing required fields."}}}]}},"components/schemas/ForbiddenError":{"id":"components/schemas/ForbiddenError","kind":"json-schema","title":"ForbiddenError","data":{"allOf":[{"$ref":"#/components/schemas/ErrorBase"},{"type":"object","properties":{"title":{"example":"Forbidden"},"status":{"example":403},"detail":{"example":"You do not have permission to offer candidate services."}}}]}},"components/schemas/CandidateCoupon":{"id":"components/schemas/CandidateCoupon","kind":"json-schema","title":"CandidateCoupon","data":{"type":"object","description":"A candidate plus an optional coupon - used in offer to assist services","properties":{"publicId":{"type":"string","format":"base64-uuid","description":"The unique public ID of the candidate.","example":"ABcd2EFgHIjkLMNOp3QR-S"},"couponCode":{"type":"string","description":"An optional coupon code that the candidate may use for service access.","example":"COUPON2025"}},"required":["publicId"]}},"components/schemas/candidate_assistance_type":{"id":"components/schemas/candidate_assistance_type","kind":"json-schema","title":"candidate_assistance_type","data":{"type":"string","enum":["JOB_OPPORTUNITY","EDUCATION_SERVICE","MIGRATION_SERVICE","FINANCIAL_SUPPORT_SERVICE","SETTLEMENT_SERVICE","OTHER"],"x-enum-varnames":["JOB_OPPORTUNITY","EDUCATION_SERVICE","MIGRATION_SERVICE","FINANCIAL_SUPPORT_SERVICE","SETTLEMENT_SERVICE","OTHER"],"example":"JOB_OPPORTUNITY"}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"type":"object","description":"A user of the TC system.","properties":{"firstName":{"type":"string","description":"First name (and any middle names) of user.","example":"John"},"lastName":{"type":"string","description":"The last name of the user.","example":"Doe"},"email":{"type":"string","format":"email","description":"The email address of the user.","example":"john@doe.com"}}}},"components/schemas/IdentifiableCandidateRegistrationFields":{"id":"components/schemas/IdentifiableCandidateRegistrationFields","kind":"json-schema","title":"IdentifiableCandidateRegistrationFields","data":{"type":"object","description":"Identifiable Candidate data that originates in the original registration.","properties":{"identity":{"allOf":[{"$ref":"#/components/schemas/User"}]},"dob":{"type":"string","description":"Candidate's date of birth. A date without a time-zone in the ISO-8601 calendar system.","format":"date","example":"1985-06-15"},"linkedInLink":{"type":"string","description":"Candidate's LinkedIn profile URL.","example":"https://www.linkedin.com/in/johndoe"},"phone":{"type":"string","description":"Candidate's phone number.","example":"+1-234-567-890"},"unhcrNumber":{"type":"string","description":"Candidate's UNHCR number.","example":"12345678"},"unrwaNumber":{"type":"string","description":"Candidate's UNRWA number.","example":"12345678"},"whatsapp":{"type":"string","description":"Candidate's WhatsApp number.","example":"+1-234-567-890"}}}},"components/schemas/CandidateRegistration":{"id":"components/schemas/CandidateRegistration","kind":"json-schema","title":"CandidateRegistration","data":{"description":"Data required to register a candidate on the Talent Catalog.","allOf":[{"$ref":"#/components/schemas/IdentifiableCandidateRegistrationFields"},{"$ref":"#/components/schemas/AnonCandidateRegistrationFields"}]}},"components/schemas/ConflictError":{"id":"components/schemas/ConflictError","kind":"json-schema","title":"ConflictError","data":{"allOf":[{"$ref":"#/components/schemas/ErrorBase"},{"type":"object","properties":{"title":{"example":"Potential Duplicate"},"status":{"example":409},"detail":{"example":"A candidate with this email address already exists."}}}]}},"components/schemas/IdentifiablePartner":{"id":"components/schemas/IdentifiablePartner","kind":"json-schema","title":"IdentifiablePartner","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique Talent Catalog identifier for the candidate's partner.","example":1234567},"candidateNumber":{"type":"string","description":"Unique candidate number for the candidate's partner.","example":"12345678"},"publicId":{"type":"string","format":"base64-uuid","description":"Anonymised public ID of the candidate's partner","example":"ABcd2EFgHIjkLMNOp3QR-S"}}}},"components/schemas/SurveyType":{"id":"components/schemas/SurveyType","kind":"json-schema","title":"SurveyType","data":{"type":"object","description":"The type of survey.","properties":{"name":{"type":"string","description":"The name of the survey type.","example":"Employee Engagement"},"status":{"description":"The status of the survey type.","allOf":[{"$ref":"#/components/schemas/status"}]}}}},"schema_14":{"kind":"json-schema","data":{"type":"integer","default":0,"minimum":0},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"integer","default":10,"minimum":1,"maximum":100},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"string","example":"US,GB"},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","example":"FR,DE"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string","example":"1234,5678"},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"string","format":"base64-uuid","example":"ABcd2EFgHIjkLMNOp3QR-S"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"string"},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"object","properties":{"candidates":{"type":"array","description":"A list of candidate public IDs.","items":{"type":"object","properties":{"publicId":{"type":"string","format":"base64-uuid","description":"The unique public ID of the candidate.","example":"ABcd2EFgHIjkLMNOp3QR-S"}}}},"additionalNotes":{"type":"string","description":"Optional additional notes provided by the employer or recruiter","example":"Candidates' experience aligns with our job requirements. We would like to arrange interviews at the earliest convenience."}}},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"Success message","example":"Your interest has been successfully recorded."},"jobMatchId":{"type":"string","description":"The unique ID for the job match record","example":"job-match-7890"}}},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"object","properties":{"candidates":{"type":"array","description":"A list of candidate public IDs and optional coupon codes.","items":{"$ref":"#/components/schemas/CandidateCoupon"}},"reason":{"type":"string","description":"The reason for expressing interest in the candidate","allOf":[{"$ref":"#/components/schemas/candidate_assistance_type"}],"example":"EDUCATION_SERVICE"},"additionalNotes":{"type":"string","description":"Optional additional notes provided by the candidate service provider","example":"We would like to provide our services to these candidates."}}},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"Success message","example":"Your offer has been successfully recorded."},"offerId":{"type":"string","description":"The unique ID for the offer to assist record","example":"interest-7890"}}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","properties":{"registrarId":{"type":"string","description":"The unique identifier of organization supplying the registration data","example":"registrar-12345"},"registrationData":{"allOf":[{"$ref":"#/components/schemas/CandidateRegistration"}]}}},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"Success message","example":"Candidate successfully registered."},"publicId":{"type":"string","format":"base64-uuid","description":"The unique public ID assigned to the registered candidate","example":"ABcd2EFgHIjkLMNOp3QR-S"}}},"id":"schema_27"}},"exampleStore":{},"securitySchemeStore":{"ApiKeyAuth":{"id":"ApiKeyAuth","type":"apiKey","in":"header","paramName":"X-API-KEY"}},"servers":[{"url":"/_mock/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://test.api.tctalent.org","description":"Staging server"},{"url":"https://api.tctalent.org","description":"Production server"}],"logo":{"imageUrl":"./assets/tc-logo.png","href":"https://github.com/Talent-Catalog/tc-api-spec","altText":"Talent Catalog logo"},"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Talent Catalog API","description":"The Talent Catalog (TC) is a purpose-built platform designed to connect skilled displaced \npopulations with international job opportunities and refugee-focused support services.\n\nThe Talent Catalog API allows third-party systems to connect to the TC platform.\n\n### Key Features\nThe Talent Catalog API offers the following capabilities:\n- **Search Candidate Profiles**: Retrieve anonymised candidate data from the TC database.\n- **Filter Search Results**: Find candidates based on various criteria (e.g. location, \noccupation, or nationality).\n- **Post Job Matches**: Match candidate profiles with relevant employment opportunities.\n- **Post Service Matches**: Connect candidate profiles with appropriate support services.\n- **Register Candidates**: Add new candidate registrations directly to the TC database.\n\n### Authentication\nThe Talent Catalog API uses API Key Authentication.\n\nEach request must include an `X-API-Key` header with your API key.\n\n### Getting Started\n- Contact us to register for an API key.\n- Use the endpoints below to interact with the API.\n"}},"baseSlug":"/openapi","routesMapping":{}}