--- title: "Create candidate resource" method: POST path: "/candidate" tags: ["Candidate"] --- # Create candidate resource `POST /candidate` ## Request body - CandidateRequest - `firstName` string, required — First name of candidate. - `lastName` string, required - `middleName` string — Last name of candidate. - `suffix` string - `dateOfBirth` string, date — Required only for Express workflow. - `ssn` string — Social Security Number.
Required only for Express workflow. - `email` string, email, required — Some workflows require contacting the candidate via email. - `phone` string — Required only for Express workflow. - `address` string — Candidate’s street address. - `city` string — City candidate resides in. - `region` string — State candidate resides in. - `country` string — Country code of candidate. Accurate Background uses ISO 3166 Country Codes. - `postalCode` string — Candidate’s postal code. - `governmentId` CandidateGovernmentResponse - `country` string — Country code where the government identification was issued. - `type` string — Type of government Id (national identity card, etc.) - `number` string — Government Id number - `aliases` CandidateAliasResponse[] - `firstName` string - `lastName` string - `middleName` string - `educations` CandidateEducationResponse[] - `school` string — Required for EDU product only in Express workflow; School candidate attended. Only required if education information is entered. - `country` string — Required for EDU product only in Express workflow; Country code of school. Only required if education information is entered. Accurate Background uses ISO 3166 Country Codes. - `region` string — Required for EDU product only in Express workflow; State of school. Only required if education information is entered. - `city` string — Required for EDU product only in Express workflow; City of school. Only required if education information is entered. - `degree` string — Required for EDU product only in Express workflow; Candidate’s degree at school - `major` string — Required for EDU product only in Express workflow; Candidate’s major at school - `startDate` string — Required for EDU product only in Express workflow; In the format: yyyy-mm, start date candidate attended school. Only required if education information is entered. - `endDate` string — Required for EDU product only in Express workflow; In the format: yyyy-mm, end date candidate finished school. Only required if education information is entered. - `graduated` string — Required for EDU product only in Express workflow; Has the candidate graduated? - `graduationDate` string — Required for EDU product only in Express workflow; In the format: yyyy-mm, graduation date - `presentlyEnrolled` string — Required for EDU product only in Express workflow; Is the candidate currently in school? PresentlyEnrolled will default as "false" when no value is provided - `prevEmployed` boolean — Required for EMP product only in Express workflow, Indicates if candidate has previous employment history. prevEmployed will default as “false” when no value is provided. Only required if employment information is entered. - `employments` CandidateEmploymentResponse[] - `employer` string — Required for EMP product only in Express workflow, Name of company candidate was previously employed. Only required if PrevEmployed is “true”. - `country` string — Required for EMP product only in Express workflow, Country code of company. Only required if employment information is entered. Accurate Background uses ISO 3166 Country Codes. - `region` string — state of company. Only required if employment information is entered. - `city` string — Required for EMP product only in Express workflow; State of company. Only required if employment information is entered. - `startDate` string — Required for EMP product only in Express workflow; In the format: yyyy-mm, start date at company. Only required if employment information is entered. - `endDate` string — Required for EMP product only in Express workflow; In the format: yyyy-mm, end date at company. Only required if employment information is entered. - `presentlyEmployed` string — Required for EMP product only in Express workflow; Is this the candidate’s current employer? presentlyEmployed will default as “false” when no value is provided - `position` string — Required for EMP product only in Express workflow; Position at company - `supervisor` string — Required for EMP product only in Express workflow; Supervisor at company - `reasonForLeaving` string — Required for EMP product only in Express workflow; Reason for leaving company - `okToCall` string — Required for EMP product only in Express workflow; Is it ok to contact the employer? okToCall will default as “true” when no value is provided - `phone` string — Required for EMP product only in Express workflow; Employer’s phone number - `salary` string — Required for EMP product only in Express workflow; Salary at company - `contactEmail` string — Email of contact for employment verification. Required for Email Verification product. - `contactTitle` string — Title of contact for employment verification. Required for Email Verification product. - `contactPerson` string — Name of contact for employment verification. Required for Email Verification product. - `licenses` CandidateLicensesResponse[] - `category` string — Required for MVR and PLV products only in Express workflow; Allowed values: drivers-license , professional-license. Only required if license information is entered - `type` string — Required for MVR and PLV products only in Express workflow; Type of license (*only required for category professional-license) - `number` string — Required for MVR and PLV products only in Express workflow; License number - `issuingAuthority` string — Not required when category is drivers-license - `country` string — Required for MVR and PLV products only in Express workflow; - `region` string — Required for MVR and PLV products only in Express workflow; State of license - `city` string — Not required when category is drivers-license or professional-license - `convicted` boolean - `convictions` CandidateConvictionResponse[] - `convictionDate` string, date — Must be configured by reaching out to apisupport@accuratebackground.com; Date of conviction, in format: YYYY-MM-DD. Only required if convicted is true. - `description` string — Must be configured by reaching out to apisupport@accuratebackground.com; Details of conviction - `country` string — Must be configured by reaching out to apisupport@accuratebackground.com; Country code of conviction. Only required if convicted is true. - `region` string — Must be configured by reaching out to apisupport@accuratebackground.com; State of conviction - `region2` string — Must be configured by reaching out to apisupport@accuratebackground.com; County of conviction - `city` string — Must be configured by reaching out to apisupport@accuratebackground.com; City of conviction - `references` CandidateReferenceResponse[] - `name` string — Required for REF1 product only in Express workflow; Full name of reference. Only required if reference information is entered. - `relationship` string — Required for REF1 product only in Express workflow; Type of relationship to reference. Only required if reference information is entered. - `phone` string — Required for REF1 product only in Express workflow; Phone number of reference. Only required if reference information is entered. - `email` string, email — Required for REF1 product only in Express workflow; Email of reference - `country` string — Required for REF1 product only in Express workflow; Country code of reference - `region` string — Required for REF1 product only in Express workflow; State of reference - `city` string — Required for REF1 product only in Express workflow; City of reference - `postalCode` string — Required for REF1 product only in Express workflow; Postal code of reference - `addressHistory` CandidateAddressHistoryResponse[] - `address` string — Required only for Express workflow of non-US orders. Address of current or previous residence. - `address2` string — Address detail of current or previous residence like suite, apartment or room number. - `city` string — Required only for Express workflow of non-US orders. City of current or previous residence. - `region` string — Required for all workflows of non-US orders. Can be State or Province of current or previous residence. - `postalCode` string — Required only for Express workflow of non-US orders. Postal code of current or previous residence - `country` string — Required for all workflows of non-US orders. Country of current or previous residence. Uses ISO 3166 Country Codes. - `fromDate` string, date — Required only for Express workflow of non-US orders. Date when current or previous residency began (yyyy-mm-dd). - `toDate` string, date — Required only for Express workflow of non-US orders. Date when current or previous residency ended (yyyy-mm-dd). ## Response `200` Success Response - CandidateResponse - `resource` string - `id` string - `created` string, date-time - `updated` string, date-time - `revision` string - `masked` boolean - `firstName` string - `lastName` string - `middleName` string - `suffix` string - `dateOfBirth` string, date - `ssn` string - `email` string, email - `phone` string - `address` string - `city` string - `region` string - `country` string - `postalCode` string - `governmentId` CandidateGovernmentResponse - `country` string — Country code where the government identification was issued. - `type` string — Type of government Id (national identity card, etc.) - `number` string — Government Id number - `aliases` CandidateAliasResponse[] - `firstName` string - `lastName` string - `middleName` string - `educations` CandidateEducationResponse[] - `school` string — Required for EDU product only in Express workflow; School candidate attended. Only required if education information is entered. - `country` string — Required for EDU product only in Express workflow; Country code of school. Only required if education information is entered. Accurate Background uses ISO 3166 Country Codes. - `region` string — Required for EDU product only in Express workflow; State of school. Only required if education information is entered. - `city` string — Required for EDU product only in Express workflow; City of school. Only required if education information is entered. - `degree` string — Required for EDU product only in Express workflow; Candidate’s degree at school - `major` string — Required for EDU product only in Express workflow; Candidate’s major at school - `startDate` string — Required for EDU product only in Express workflow; In the format: yyyy-mm, start date candidate attended school. Only required if education information is entered. - `endDate` string — Required for EDU product only in Express workflow; In the format: yyyy-mm, end date candidate finished school. Only required if education information is entered. - `graduated` string — Required for EDU product only in Express workflow; Has the candidate graduated? - `graduationDate` string — Required for EDU product only in Express workflow; In the format: yyyy-mm, graduation date - `presentlyEnrolled` string — Required for EDU product only in Express workflow; Is the candidate currently in school? PresentlyEnrolled will default as "false" when no value is provided - `prevEmployed` boolean - `employments` CandidateEmploymentResponse[] - `employer` string — Required for EMP product only in Express workflow, Name of company candidate was previously employed. Only required if PrevEmployed is “true”. - `country` string — Required for EMP product only in Express workflow, Country code of company. Only required if employment information is entered. Accurate Background uses ISO 3166 Country Codes. - `region` string — state of company. Only required if employment information is entered. - `city` string — Required for EMP product only in Express workflow; State of company. Only required if employment information is entered. - `startDate` string — Required for EMP product only in Express workflow; In the format: yyyy-mm, start date at company. Only required if employment information is entered. - `endDate` string — Required for EMP product only in Express workflow; In the format: yyyy-mm, end date at company. Only required if employment information is entered. - `presentlyEmployed` string — Required for EMP product only in Express workflow; Is this the candidate’s current employer? presentlyEmployed will default as “false” when no value is provided - `position` string — Required for EMP product only in Express workflow; Position at company - `supervisor` string — Required for EMP product only in Express workflow; Supervisor at company - `reasonForLeaving` string — Required for EMP product only in Express workflow; Reason for leaving company - `okToCall` string — Required for EMP product only in Express workflow; Is it ok to contact the employer? okToCall will default as “true” when no value is provided - `phone` string — Required for EMP product only in Express workflow; Employer’s phone number - `salary` string — Required for EMP product only in Express workflow; Salary at company - `contactEmail` string — Email of contact for employment verification. Required for Email Verification product. - `contactTitle` string — Title of contact for employment verification. Required for Email Verification product. - `contactPerson` string — Name of contact for employment verification. Required for Email Verification product. - `licenses` CandidateLicensesResponse[] - `category` string — Required for MVR and PLV products only in Express workflow; Allowed values: drivers-license , professional-license. Only required if license information is entered - `type` string — Required for MVR and PLV products only in Express workflow; Type of license (*only required for category professional-license) - `number` string — Required for MVR and PLV products only in Express workflow; License number - `issuingAuthority` string — Not required when category is drivers-license - `country` string — Required for MVR and PLV products only in Express workflow; - `region` string — Required for MVR and PLV products only in Express workflow; State of license - `city` string — Not required when category is drivers-license or professional-license - `convicted` boolean — Must be configured by reaching out to apisupport@accuratebackground.com; Has candidate been convicted? - `convictions` CandidateConvictionResponse[] - `convictionDate` string, date — Must be configured by reaching out to apisupport@accuratebackground.com; Date of conviction, in format: YYYY-MM-DD. Only required if convicted is true. - `description` string — Must be configured by reaching out to apisupport@accuratebackground.com; Details of conviction - `country` string — Must be configured by reaching out to apisupport@accuratebackground.com; Country code of conviction. Only required if convicted is true. - `region` string — Must be configured by reaching out to apisupport@accuratebackground.com; State of conviction - `region2` string — Must be configured by reaching out to apisupport@accuratebackground.com; County of conviction - `city` string — Must be configured by reaching out to apisupport@accuratebackground.com; City of conviction - `references` CandidateReferenceResponse[] - `name` string — Required for REF1 product only in Express workflow; Full name of reference. Only required if reference information is entered. - `relationship` string — Required for REF1 product only in Express workflow; Type of relationship to reference. Only required if reference information is entered. - `phone` string — Required for REF1 product only in Express workflow; Phone number of reference. Only required if reference information is entered. - `email` string, email — Required for REF1 product only in Express workflow; Email of reference - `country` string — Required for REF1 product only in Express workflow; Country code of reference - `region` string — Required for REF1 product only in Express workflow; State of reference - `city` string — Required for REF1 product only in Express workflow; City of reference - `postalCode` string — Required for REF1 product only in Express workflow; Postal code of reference - `addressHistory` CandidateAddressHistoryResponse[] - `address` string — Required only for Express workflow of non-US orders. Address of current or previous residence. - `address2` string — Address detail of current or previous residence like suite, apartment or room number. - `city` string — Required only for Express workflow of non-US orders. City of current or previous residence. - `region` string — Required for all workflows of non-US orders. Can be State or Province of current or previous residence. - `postalCode` string — Required only for Express workflow of non-US orders. Postal code of current or previous residence - `country` string — Required for all workflows of non-US orders. Country of current or previous residence. Uses ISO 3166 Country Codes. - `fromDate` string, date — Required only for Express workflow of non-US orders. Date when current or previous residency began (yyyy-mm-dd). - `toDate` string, date — Required only for Express workflow of non-US orders. Date when current or previous residency ended (yyyy-mm-dd). ## Other responses - `400` — Bad Request - `401` — Unauthorized Response - `500` — Internal Server error --- [API](https://skmtc.dev/accuratebackground/apis/accurate-background-api.md) · [All operations](https://skmtc.dev/accuratebackground/apis/accurate-background-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/accuratebackground/accurate-background-api/revisions/a6ac3a5c01aa/schema)