v1

latestOpenAPI 3.0.02026-08-06100301483.8 KB
Entity

Creates a new candidate

If valid, the candidate will be created directly in Infinity.

Comments, Summary and Insights must not exceed the max upload size configured in Infinity.

A Photo must not exceed the max upload size configured in Infinity.

The max upload size can be retrieved from the /Reference/MaxUploadSize method (In KB).

All id fields must match reference data from the /Reference methods.

EAA and RightToWork fields can only be passed if the system is not set up to auto-populate EAA/Right to Work information

The auto-populate EAA/Right to Work setting can be retrieved from the /Reference/AutoPopulateCandidateEaaRightToWork method

The ContractualLegalLawfulBasis field can only be set to None, ContractualLegal or left blank.

The ConsentLegitimateInterestLawfulBasis field can only be set to None, DigitalConsent, VerbalConsent, LegitimateInterest, NotRequired or left blank. When set, the LawfulBasisStatusId field must be set to a valid value for the type of consent which can be retrieved from the /Reference/LawfulBasisStatuses method.

The Financials.WorkerTypeId only supports worker types with a territory of 'United Kingdom'.

The Financials.BankAccountNumber must be 8 digits when set

The Financials.BankSortCode must be 6 digits when set

The Financials.IBANNumber must be in a valid format when set according to the following RegEx [A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}

The Financials.SwiftCode must be in a valid format when set according to the following RegEx [A-Z]{6}[A-Z0-9]{2}[A-Z0-9]{0,3}

The Telecoms field can only contain one item set as IsPreferredTelecom

The Addresses field must have one item that is marked as SendByDefault if addresses are set. Each item must also have a unique address type.

If passed, the CustomFieldData must adhere to the field definitions retrieved from the /Reference/CustomFields method especially regarding item ids, in the case of combo boxes and multi-select lists, min/max values for dates and max length for text. Note that the Candidate creation request will fail if the custom data is not valid.

post/Entity/Candidate

Request body

TitleIdinteger nullable
Forenamestring nullable
Middlenamestring nullable
Surnamestring nullable
KnownAsstring nullable
GenderIdinteger nullable
MaritalStatusIdinteger nullable
DateOfBirthstring date-time nullable
NationalityIdinteger nullable
SecondNationalityIdinteger nullable
ThirdNationalityIdinteger nullable
FourthNationalityIdinteger nullable
EthnicOriginIdinteger nullable
CountryOfOriginIdinteger nullable
ThirdPartyOptOutboolean
MaximumWeeklyWorkingHoursOptOutboolean
ContractualLegalLawfulBasis'None' | 'DigitalConsent' | 'VerbalConsent' | 'LegitimateInterest' | 'ContractualLegal' | 'LegalObligation' | 'VitalInterests' | 'PublicTask' | 'NotRequired'
ConsentLegitimateInterestLawfulBasis'None' | 'DigitalConsent' | 'VerbalConsent' | 'LegitimateInterest' | 'ContractualLegal' | 'LegalObligation' | 'VitalInterests' | 'PublicTask' | 'NotRequired'
LawfulBasisReasonIdinteger nullable
LawfulBasisOtherReasonstring nullable
LawfulBasisStatusIdinteger nullable
OriginOfDataIdinteger nullable
LinkedInUrlstring nullable
XingUrlstring nullable
FacebookProfileUrlstring nullable
TwitterProfileUrlstring nullable
ICaptureWebIdstring nullable
Photostring byte nullable

A Base64 image to display against the candidate

The image cannot exceed the max upload size configured in Infinity.

StatusIdinteger nullable
AvailabilityDatestring date-time nullable
Sourcesinteger[] nullable
Alertstring nullable
IsPermanentboolean
IsContractboolean
IsTemporaryboolean
ExpectedRateCurrencyIdinteger nullable
PreferredLocationstring nullable
BasedInstring nullable
Relocateboolean
Transportboolean
NoticePeriodinteger
NoticePeriodIntervalIdinteger nullable
StudentVisaboolean
Consultantsinteger[] nullable

Depreciated. OwningConsultants can be used instead to supply a list of consultants and their roles.

AlternateCodestring nullable
RightToWorkboolean nullable
EAAboolean nullable
EaaRightToWorkExpirystring date-time nullable
EaaRightToWorkNeverExpiresboolean nullable
FestiveMailboolean
Commentsstring nullable
Summarystring nullable
Insightsstring nullable
ShortlistJobCodesstring[] nullable

A list of valid job codes to shortlist the candidate against e.g. JO0000000112

Response

OK

integer required