Personal Information
The Personal Information section of candidate order contains the candidate's personal information.
Personal Information fields
Field Name | Description | Type | Min | Max | Client Entry | Candidate Entry | Value Set |
---|---|---|---|---|---|---|---|
MobilePhone | The candidate's mobile phone details | GenericTelephone | Allowed | Allowed | |||
HomePhone | The candidate's home phone details | GenericTelephone | Allowed | Allowed | |||
GenericTelephone.PhoneNumber | The candidate's phone number | String (telephone) | Allowed | Allowed | |||
GenericTelephone.CountryCode | The candidate's home phone details | String | Allowed | Allowed | country | ||
Gender | The candidate's gender | String | Mandatory | Allowed | gender | ||
DateOfBirth | The candidate's of birth | String (date) | Mandatory | Mandatory | |||
PurchaseOrderNumber | Your reference to the order | String | 1 | 50 | Allowed | Allowed | |
OtherReference | Another reference for your use | String | 1 | 128 | Allowed | Allowed | |
PositionAppliedFor | The job role that the candidate has applied for | String | 1 | 60 | Allowed | Allowed | |
ApplicantNotes | Any additional notes pertinant to the order | String | 1 | 1024 | Allowed | Allowed | |
FSAApproved | Indicates whether the candidate is FCA/PRA approved | Boolean | Allowed | Allowed | |||
HasValidDrivingLicense[1] | Indicates whether the candidate has a valid driving licence | Boolean | Allowed | Not allowed | |||
ApplicantType | Indicates the type of applicant | String | Mandatory | Allowed | applicanttype | ||
CurrentNationality | Indicates the applicant's current nationality | String | Mandatory[2] | Not allowed | country | ||
CandidateEmail | The candidate's email address | String (email) | Allowed | Mandatory | |||
BirthCertificationNumber | The candidate's birth certificate number | String | 1 | 50 | Allowed | Not allowed | |
MotherMaidenName | The candidate's mother's maiden name | String (name) | Allowed[3] | Not allowed | |||
NationalityAtBirth | The candidate's nationality at birth | String | Allowed[3] | Not allowed | country | ||
CountryOfBirth | The country the candidate was born in | String | Allowed[3] | Not allowed | country | ||
TownOfBirth | The town the candidate was born in | String | 1 | 50 | Allowed[3] | Not allowed | |
VisaNationality | The candidate's visa nationality | String | Allowed[4] | Not allowed | country | ||
BirthCertificateCountry | The candidate's birth certificate issuing country | String | Allowed[4] | Not allowed | country | ||
EUNationalIdCardCountry | The candidate's EU ID card issuing country | String | Allowed[4] | Not allowed | country |
- If true, the candidate must supply a valid driving licence.
- Mandatory if the candidate doesn't have a valid passport. If the candidate does have a passport this field is not allowed.
- Mandatory if the order contains a Criminal Record (Basic Disclosure Scotland) check.
- Mandatory if the order contains a Criminal Record (Basic Disclosure Scotland) check. Else the field is not allowed.
- Additional validation for DBS Identity Document selections:
- If the document Id contains Passport the following fields become mandatory
- Identity.PassportDocument.PassportIssuingCountry
- Identity.PassportDocument.PassportNumber
- Identity.PassportDocument.PassportIssueDate
- Identity.PassportDocument.PassportExpiryDate
- If the document Id contains Driving License the following fields become mandatory
- PersonalInfo.HasValidDrivingLicense
- Identity.DrivingDocument.DriverLicenseType
- Identity.DrivingDocument.DriverLicenseIssuingCountry
- Identity.DrivingDocument.DriverLicenseNumber
- Identity.DrivingDocument.DriverLicenseDate
- Id the document Id contains Birth Certificate the following fields become mandatory
- PersonalInfo.BirthCertificationNumber
- PersonalInfo.BirthCertificateCountry
- * Applicant must be at least 16 years old
- Letter From Head Teacher
- Applicant must be under 20 years old to use a letter from head teacher as proof of identity
- Candidate email
- All email domain names are validated therefore rachel141@example.com will return an error whereas rachel141@hotmail.com will be accepted
- If the document Id contains Passport the following fields become mandatory
Client entry example
An example client entry personal information section
"PersonalInfo": {
"MobilePhone": {
"PhoneNumber": "077777777777",
"CountryCode": "CN"
},
"HomePhone": {
"PhoneNumber": "01111111111",
"CountryCode": "CN"
},
"Gender": "Male",
"DateOfBirth": "1992-09-28",
"PurchaseOrderNumber": "ABC123",
"OtherReference": "ABC123",
"PositionAppliedFor": "Engineer",
"ApplicantNotes": "Candidate is on holiday for 2 weeks",
"FSAApproved": false,
"HasValidDrivingLicense": true,
"ApplicantType": "Candidate",
"CurrentNationality": "CN",
"CandidateEmail": "api@verifile.co.uk",
"BirthCertificationNumber": "225197",
"MotherMaidenName": "Maiden",
"NationalityAtBirth": "CN",
"CountryOfBirth": "CN",
"TownOfBirth": "Beijing",
"BirthCertificateCountry": "CN"
}
Candidate entry example
An example candidate entry personal information section
"PersonalInfo": {
"MobilePhone": {
"PhoneNumber": "077777777777",
"CountryCode": "CN"
},
"HomePhone": {
"PhoneNumber": "01111111111",
"CountryCode": "CN"
},
"Gender": "Male",
"DateOfBirth": "1992-09-28",
"PurchaseOrderNumber": "ABC123",
"OtherReference": "ABC123",
"PositionAppliedFor": "Engineer",
"ApplicantNotes": "Candidate is on holiday for 2 weeks",
"FSAApproved": false,
"ApplicantType": "Candidate",
"CandidateEmail": "api@verifile.co.uk"
}