Applicant Integration Fields Model (API)

This article documents the Radancy Standard Applicant Fields Model (API) used for applicant and application data integrations with an Applicant Tracking System (ATS).
 
It is intended for technical customer contacts and integration stakeholders who need to understand:
  • Which applicant and application fields are supported
  • Which fields are required versus recommended or optional
  • How data is structured and refreshed within Radancy CRM
This article is a reference guide and does not describe ATS‑specific configuration steps or field‑mapping instructions.

 

Field Requirement Levels

Each field in the applicant integration model is categorized as one of the following:
  • Required – Must be provided for the integration to function correctly
  • Recommended – Enables enhanced functionality such as matching, search, and segmentation
  • Optional – Not required, but useful when available
Additional indicators:
  • Trigger – Candidate profile fields update only on new application or application status change
  • Resume Parse – Some fields may be automatically populated via resume parsing, when supported
Field NameDescriptionRequiredEditable*Trigger
emailAddressString. Email address of candidateRequiredNo 
importCreationDateDateTimeOptional  
importUpdateDateDateTimeOptional  
atsProfileUpdateDateDateTimeRequired  
applicantIdString. The unique id of candidate from ATSRequiredNo 
startDateNullable DateTime. Applicant’s start date (Hired state)Required  
firstNameStringRecommended  
lastNameStringRecommended  
resumeAttachment. **Resume parseRecommended  
skillsString. Or derived through resume parseRecommended  
AddressConcrete object type   
countryString (Full name or ISO 2-Digit Alpha Country Code. If
ISO 3-Digit Alpha Country Code, not able to import to
CRM)
Optional  
stateString (Full name)Optional  
stateCodeString (2-Digit state code. State or StateCode, provide
either of them)
Optional  
cityStringOptional  
addressStringOptional  
address2StringOptional  
zipcodeStringOptional  
Phone Number(s)Array Type   
TypeInteger. Enum stands for phone type (1: HomePhone,
2: MobilePhone, 3: OfficePhone)
Optional  
ValueString. Phone numberOptional  
Education(s)Array Type   
schoolNameStringOptional  
MajorStringOptional  
degreeObtainedStringOptional  
startMonthNullable integerOptional  
startYearNullable integerOptional  
endMonthNullable integerOptional  
endYearNullable integerOptional  
IsCurrentBoolean. Is currently working or studying here?Optional  
Work Experience(s)Array Type   
companyNameStringOptional  
titleStringOptional  
workDescriptionStringOptional  
startMonthNullable integerOptional  
startYearNullable integerOptional  
endMonthNullable integerOptional  
endYearNullable integerOptional  
IsCurrentBoolean. Is currently working or studying here?Optional  
TagsArray Type   
tagString. Candidate tag set in ATS profile. Include Tag ID
attribute if available.
Optional  
Application(s)Array Type   
applicationIdString. Job application id from ATSRequiredNo

x

reqIdString. Job requisition idRequired  
titleString. Job titleRequired  
applicantIdString. The unique id of candidate from ATSRequired  
importCreationDateDateTimeOptional  
importUpdateDateDateTimeOptional  
atsUpdateDateDateTime. Job application update time from ATSRequired  
statusApplication Object type. Saves the current status of
this application
   
mainStatusString. Main status of current applicationRequired 

x

subStatusString. Sub status of current applicationRequired 

x

updatedDateTime. Job application update time from ATSRequired  
ProfileApplication Object type. Properties described below
in "Profile" cells
   
applicationDateNullable DateTimeOptional  
hireDateNullable DateTimeOptional  
startDateNullable DateTimeOptional  
ethnicityStringOptional  
genderStringOptional  
atsSourceStringOptional  
jobInformationApplication Object type. Saves job information of this
application.
   
businessUnitStringOptional  
departmentStringOptional  
functionStringOptional  
positionLevelStringOptional  
jobCategoryStringOptional  
jobCityStringOptional  
jobStateStringOptional  
jobPostalCodeStringOptional  
jobRegionStringOptional  
jobCountryStringOptional  
statusHistoryApplication Object type. List of all previous Status
types.
   
mainStatusStringRecommended  
subStatusStringRecommended  
updatedDateTimeRecommended  

Formatting Requirements

  • DateTime: YYYY-MM-DDThh:mm:ss
    • Example: 2021-02-20T04:05:27
  • Phone Numbers: Multiple formats allowed; validated during UAT

 

Was this article helpful?
0 out of 0 found this helpful