--- title: "Update Position Location for an Order" method: PATCH path: "/order/{orderId}" tags: ["Adjudication"] --- # Update Position Location for an Order `PATCH /order/{orderId}` Specifications: 1) Order must not be adjudicated to a final "pass" or "fail" status 2) At a minimum jobLocation.country is required when setting a fail adjudication decision. If the jobLocation.country is US, then all 4 parameters within the jobLocation array are required in order to determine whether the jurisdiction of the job requires additional notices to be provided.'' ## Path parameters - `orderId` string, required ## Request body - UpdatePositionRequest - `jobLocation` object, required - `country` string, required — Two-character country code - `region` string — Required for US – Two-character state code for US - `region2` string — Required for US – County must exist within the state passed - `city` string — Required for US – City must exist within the county passed ## Response `200` Success Response - OrderResponse - `resource` string - `id` string - `created` string, date-time - `updated` string, date-time - `masked` boolean - `packageType` 'PKG_BASIC' | 'PKG_STANDARD' | 'PKG_PRO' | 'PKG_EMPTY' - `workflow` 'EXPRESS' | 'INTERACTIVE' - `copyOfReport` boolean - `clientComments` string - `complianceTokens` ComplianceTokensResponse - `companyName` string — name of company for End User Company - `companyAddress` string — Street Address for End User Company - `companyCity` string — City for End User Company - `companyRegion` string — Region for End User Company - `companyCountry` string — Country for End User Company - `companyPostalCode` string — Postal Code for End User Company - `companyPhone` string — Phone Number for End User Company - `companyEmail` string — Email for End User Company - `jobLocation` JobLocationResponse - `country` string — Country of job location. Accurate Background uses ISO 3166 Country Codes. - `region` string — Region/State of job location. For US must provide state code. - `region2` string — Required for US – County must exist within the state passed - `city` string — City of job location - `referenceCodes` string[] - `candidateId` string - `candidate` CandidateModel - `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). - `candidateInfoComplete` boolean - `status` string - `result` string - `reports` object[] - `base64encodedHTML` string - `additionalProductTypes` AdditionalProductTypeResponse[] - `productType` string - `products` OrderProductResponse[] - `id` integer - `productType` string - `status` string - `result` string - `documents` OrderDocumentResponse[] - `documentId` string - `documentUrl` string - `documentName` string - `externalDocumentId` string - `percentageComplete` integer - `candidateInfoChanged` boolean - `source` string - `searchId` integer - `subjectId` integer - `submitted` string, date-time - `supportReferenceId` string ## 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)