Create Candidate
Nxsys Umbrella - Production
https://api.nxsys.tech
Nxsys Umbrella - Production
https://api.nxsys.tech
POST
https://api.nxsys.tech
Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.nxsys.tech/nxsys/candidates/ireland' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"generalSetting": {
"agencyRef": "1234567890",
"title": "NONE",
"gender": "MALE",
"forename": "Michael",
"surname": "Smith",
"DOB": "1990-05-15",
"maritalStatus": "SINGLE",
"nationality": "British",
"address": [
"Address 1",
"Address 2",
"Address 3"
],
"city": "London",
"county": "Greater London",
"country": "AF",
"mobile": "07123456789",
"email": "sample@domain.com",
"registrationStatus": "ONGOING",
"dateOfJoining": "2024-01-01",
"payFrequency": "WEEKLY",
"payMethod": "BACS",
"jobDescription": "Software Engineer",
"annualSalary": 35000,
"rateHour": 15.5,
"hours": 40,
"emergencyName": "John Doe",
"emergencyAddress": [
"123 Main St",
"Apt 4B"
],
"emergencyCity": "London",
"emergencyCounty": "Greater London",
"emergencyCountry": "GB",
"emergencyMobile": "07123456789",
"emergencyEmail": "emergency@domain.com",
"rightToWorkStatus": "APPEAL",
"documentType": "BIOMETRIC_RESIDENCE_PERMIT",
"documentExpiryDate": null,
"document": null,
"department": null,
"pensionSetting": {
"scheme": "NEST",
"reference": "PEN123456",
"outsideUKWorker": true,
"lastAssessmentOn": "2019-08-24T14:15:22Z",
"dateOnClassifiedOn": "2019-08-24T14:15:22Z",
"ejhDate": "2019-08-24T14:15:22Z",
"postponementEndDate": "2019-08-24T14:15:22Z",
"memberId": null,
"membershipStartDate": "2019-08-24T14:15:22Z",
"optInDate": "2019-08-24T14:15:22Z",
"optOutDate": "2019-08-24T14:15:22Z",
"optState": "ignition"
},
"eircode": "D02 Y006",
"emergencyEircode": "D02 Y006",
"shareCodeVerified": null
},
"bankSetting": {
"bankName": "HSBC",
"accountName": "John Smith",
"accountNumber": "12345678",
"sortCode": "123456",
"buildingSocietyNumber": "BS123456",
"IBANReference": "GB29NWBK60161331926819",
"SWIFTNo": "NWBKGB2L",
"author": "admin",
"isInternalAccount": false,
"country": "AF"
},
"payrollSetting": {
"paymentModel": "PAYEE",
"cisStatus": "GROSS_0%",
"companyPayment": "COM-2",
"timesheetApprovalNeeded": "NOT_AVAILABLE",
"payrollApproveNeeded": "NOT_AVAILABLE",
"holidayPayMethod": "ROLLED_UP",
"holidayPayRate": null,
"taxBasis": "W1M1",
"employmentStatus": "THE_EMPLOYEES_FIRST_OR_ONLY_EMPLOYMENT",
"ppsNumber": "1234567AB",
"employmentId": "1234",
"includeInTimesheetRate": false,
"prsiEeClasses": "A0_A1",
"prsiExemption": "A1_PORTABLE_DOCUMENT",
"taxCreditFrequency": "641.02",
"taxCreditAnnual": "33333.04",
"taxRateCutOffPoints": [
"string"
],
"yearlyRateCutOff": "44443.88",
"yearlyRateCutOffFrequency": "854.69",
"uscExemption": "NOT_EXEMPT",
"USCTier": "USE3",
"frequency_zeroPointFive": "30",
"frequency_two": "40",
"frequency_fourPointFive": "50",
"frequency_eight": "0.00",
"annual_zeroPointFive": "1560.00",
"annual_two": "2080.00",
"annual_fourPointFive": "2600.00",
"totalLPTToBeDeducted": "1200",
"ascCalculationMethod": "NOT_APPLICABLE",
"directorShip": "NONE",
"cutOffPoints": null,
"totalPayLiableToTax": 0,
"totalTax": 0,
"totalPayLiableToUSC": 0,
"totalUSC": 0,
"totalPayLiableToASC": 0,
"totalASC": 0,
"openingBalance": {
"eePRSI": 0,
"eePension": 0,
"erPRSI": 0,
"erPension": 0,
"uscGross": 0,
"usc": 0,
"eePrsiGross": 0,
"erPrsiGross": 0,
"grossForTax": 0,
"pensionGross": 0,
"lptDeduction": 0,
"gross": 0,
"tax": 0,
"ssp": 0
},
"subcontractorRefNumber": "1234567890",
"holidayPayOpeningBalance": 0
}
}'Response Response Example
201 - Example 1
{
"data": {
"candidate": {
"id": "cnd-ie-123456",
"agencyRef": "IE-AGY-001",
"title": "Mr",
"gender": "Male",
"forename": "Seán",
"surname": "Murphy",
"DOB": "1990-01-01",
"maritalStatus": "SINGLE",
"nationality": "Irish",
"address": [
"123 Main Street",
"Dublin City Centre"
],
"city": "Dublin",
"county": "Dublin",
"eircode": "D02 Y006",
"country": "IE",
"mobile": "0871234567",
"email": "sean.murphy@example.ie",
"status": "ACTIVE",
"registrationStatus": "REGISTRATION_COMPLETE",
"dateOfJoining": "2024-01-01",
"payFrequency": "WEEKLY",
"dateLeft": null,
"reason": null,
"payMethod": "BACS",
"jobDescription": "Software Developer",
"annualSalary": 45000,
"rateHour": 22.5,
"hours": 40,
"emergencyName": "Máire Murphy",
"emergencyAddress": [
"456 Side Street"
],
"emergencyCity": "Dublin",
"emergencyCounty": "Dublin",
"emergencyCountry": "IE",
"emergencyEircode": "D04 X1Y2",
"emergencyMobile": "0871234568",
"emergencyEmail": "maire.murphy@example.ie",
"rightToWorkStatus": "IRISH_CITIZEN",
"documentType": "PASSPORT",
"documentExpiryDate": "2030-01-01",
"document": "https://example.com/document.pdf",
"shareCodeVerified": true,
"pensionSetting": {
"outsideUKWorker": false,
"lastAssessmentOn": "2024-01-15",
"dateOnClassifiedOn": "2024-01-20",
"ejhDate": "2024-02-01",
"postponementEndDate": "2024-03-01",
"memberId": "IE-MEM123456",
"membershipStartDate": "2024-01-10",
"optInDate": "2024-01-25",
"optOutDate": null,
"optState": "ignition"
},
"bank": {
"bankName": "Bank of Ireland",
"accountName": "Seán Murphy",
"accountNumber": "IE87654321",
"sortCode": "90-11-22",
"IBANReference": "IE29AIBK93115212345678",
"SWIFTNo": "BOFIIE2D",
"isInternalAccount": false,
"country": "IE"
},
"setting": {
"paymentModel": "PAYEE",
"cisStatus": "VERIFIED_20%",
"companyPayment": "COM-2",
"timesheetApprovalNeeded": "NOT_AVAILABLE",
"payrollApproveNeeded": false,
"holidayPayMethod": "NO_HOLIDAY_PAY",
"holidayPayRate": 12.07,
"taxBasis": "W1M1",
"employmentStatus": "AN_ADDITIONAL_EMPLOYMENT_OR_RECOMMENCEMENT",
"ppsNumber": "1234567AB",
"employmentId": "1234",
"includeInTimesheetRate": false,
"prsiEeClasses": "A8_A9",
"prsiExemption": "A1_PORTABLE_DOCUMENT",
"taxCreditFrequency": "641.02",
"taxCreditAnnual": "33333.04",
"taxRateCutOffPoints": [
{
"index": 1,
"yearlyRateCutOff": "44443.88",
"taxRatePercent": "20"
}
],
"yearlyRateCutOff": "44443.88",
"yearlyRateCutOffFrequency": "854.69",
"uscExemption": "NOT_EXEMPT",
"USCTier": "USE3",
"frequency_zeroPointFive": "30",
"frequency_two": "40",
"frequency_fourPointFive": "50",
"frequency_eight": "0.00",
"annual_zeroPointFive": "1560.00",
"annual_two": "2080.00",
"annual_fourPointFive": "2600.00",
"totalLPTToBeDeducted": "1200",
"ascCalculationMethod": "STANDARD_ACCRUAL",
"directorShip": "NONE",
"cutOffPoints": {
"type": "USE3",
"values": [
{
"index": 1,
"uscRatePercent": 0.5,
"yearlyUSCRateCutOff": "1560.00"
},
{
"index": 2,
"uscRatePercent": 2,
"yearlyUSCRateCutOff": "2080.00"
},
{
"index": 3,
"uscRatePercent": 4.5,
"yearlyUSCRateCutOff": "2600.00"
},
{
"index": 4,
"uscRatePercent": 8
}
]
},
"totalPayLiableToTax": 0,
"totalTax": 0,
"totalPayLiableToUSC": 0,
"totalUSC": 0,
"totalPayLiableToASC": 0,
"totalASC": 0,
"openingBalance": {
"eePRSI": 0,
"eePension": 0,
"erPRSI": 0,
"erPension": 0,
"uscGross": 0,
"usc": 0,
"eePrsiGross": 0,
"erPrsiGross": 0,
"grossForTax": 0,
"pensionGross": 0,
"lptDeduction": 0,
"gross": 0,
"tax": 0,
"ssp": 0
},
"subcontractorRefNumber": "1234567890"
}
},
"success": true
},
"success": true
}