{"items":[{"type":"link","label":"API Reference","link":"/apis/openapi","routeSlug":"/apis/openapi","content":{"contentType":"overview","meta":{"name":"API Reference"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/apis/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/apis/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://checkr.com","url":"https://checkr.com"},{"kind":"email","title":"Checkr","email":"clients@checkr.com","label":"clients@checkr.com","withCopyButton":true,"copyContent":"clients@checkr.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Proprietary","url":"https://www.checkr.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"API Reference (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Checkr is a RESTful API-driven background screening service. For guides and reference (Introduction, Getting Started, Webhooks, and more), use the sidebar navigation."}],"sectionId":"/apis/openapi"}],"sectionId":"/apis/openapi"}]}]}},{"type":"separator","label":"Core Resources","content":null},{"type":"group","label":"Candidates","link":"/apis/openapi/candidates","routeSlug":"/apis/openapi/candidates","items":[{"label":"Create a new Candidate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/candidates/createcandidate","routeSlug":"/apis/openapi/candidates/createcandidate","metadata":{"seo":{"title":"Create a new Candidate","description":"Creates a new Candidate resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCandidate","name":"Create a new Candidate","isWebhook":false,"pointer":"/paths/~1candidates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Candidate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Candidate resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"candidates/createcandidate/request/required-attributes","deepLinkHash":"/candidates/createcandidate#candidates/createcandidate/request/required-attributes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required attributes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Candidate resource’s required attributes vary depending on its intended use. If this resource is to be used in conjunction with the Invitations API (in which the invitation apply form collects the Candidate's personal information), the only strictly required Candidate attribute is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this resource is to be used to generate any other report type, other personal information is also required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes required to generate a Report include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"middle_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_middle_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dob"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes required to generate a Report with a criminal check screening:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssn"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zipcode"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes required to generate a report with a Motor Vehicle Record (MVR) screening:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"driver_license_number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"driver_license_state"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#driver-license-validation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Driver License validation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Reference section for a list of valid input by state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes recommended to generate a report with an Identity Document Verification screening:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (mobile phone number)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation for these attributes is performed when requesting a Report, as the requirements depend on the Package."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checkr's product incorporates SSN field controls designed to not accept SSNs with the following characteristics:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSNs without exactly 9 numeric characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSNs that start with 666 (666-34-3768)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSNs that start with 9 (967-65-4325)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSNs that are a single digit (111-11-1111)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSNs that are sequential digits (123-45-6789)"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_89"}},"schemaId":"schema_89","pointer":"/paths/~1candidates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/candidates","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_89"}},"responseCodes":["201","400","401","403"],"pointer":"/candidates","href":"candidates/createcandidate","openApiOperationId":"createCandidate","summary":"Create a new Candidate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_89","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_89"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Candidate was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Candidate"}},"schemaId":"components/schemas/Candidate"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Candidate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Candidate"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidates/createcandidate"}],"panels":[]}]},"httpPath":"/candidates"},{"label":"List existing Candidates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/candidates/listofcandidates","routeSlug":"/apis/openapi/candidates/listofcandidates","metadata":{"seo":{"title":"List existing Candidates","description":"Lists existing Candidates with the input parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOfCandidates","name":"List existing Candidates","isWebhook":false,"pointer":"/paths/~1candidates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Candidates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists existing Candidates with the input parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call will not return candidates with non-US "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"work_locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/candidates/getcandidate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /candidates/{id}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve candidates outside the US."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"email","in":"query","schemaId":"schema_90","description":"Returns candidates with the input email address."},{"name":"full_name","in":"query","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns candidates with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"adjudication","in":"query","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns candidates with the input adjudication. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no adjudication has been made."},"children":[]}]}]}]},{"name":"custom_id","in":"query","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns candidates with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"created_after","in":"query","schemaId":"schema_91","description":"Returns candidates created after the input date."},{"name":"created_before","in":"query","schemaId":"schema_91","description":"Returns candidates created before the input date."},{"name":"report_adjudicated_after","in":"query","schemaId":"schema_91","description":"Returns candidates adjudicated after the input date."},{"name":"report_adjudicated_before","in":"query","schemaId":"schema_91","description":"Returns candidates adjudicated before the input date."},{"name":"report_adjudicator_email","in":"query","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns candidates with a report adjudicated by someone with input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adjudicator_email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"report_revised_after","in":"query","schemaId":"schema_91","description":"Returns candidates with a report revised after the input date."},{"name":"report_revised_before","in":"query","schemaId":"schema_91","description":"Returns candidates with a report revised before the input date."},{"name":"driver_license_number","in":"query","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns candidates with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"driver_license_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"geo_id","in":"query","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns candidates with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geo_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"program_id","in":"query","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns candidates with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"program_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"metadata","in":"query","schemaId":"schema_92","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns candidates matching the input key-values. Input keys will be matched exactly. Input values will be pre- and post-pended with wildcards. (For example: A query for 1234 will return results for *1234*.)"},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_93","description":"Specifies the page number to retrieve."},{"name":"per_page","in":"query","schemaId":"schema_93","description":"Indicates how many records each page should contain. The default value is 25 records."}],"pointer":"/paths/~1candidates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/candidates","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"email","in":"query","schemaId":"schema_90"},{"name":"full_name","in":"query","schemaId":"schema_90"},{"name":"adjudication","in":"query","schemaId":"schema_90"},{"name":"custom_id","in":"query","schemaId":"schema_90"},{"name":"created_after","in":"query","schemaId":"schema_91"},{"name":"created_before","in":"query","schemaId":"schema_91"},{"name":"report_adjudicated_after","in":"query","schemaId":"schema_91"},{"name":"report_adjudicated_before","in":"query","schemaId":"schema_91"},{"name":"report_adjudicator_email","in":"query","schemaId":"schema_90"},{"name":"report_revised_after","in":"query","schemaId":"schema_91"},{"name":"report_revised_before","in":"query","schemaId":"schema_91"},{"name":"driver_license_number","in":"query","schemaId":"schema_90"},{"name":"geo_id","in":"query","schemaId":"schema_90"},{"name":"program_id","in":"query","schemaId":"schema_90"},{"name":"metadata","in":"query","schemaId":"schema_92"},{"name":"page","in":"query","required":false,"schemaId":"schema_93"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/candidates","href":"candidates/listofcandidates","openApiOperationId":"listOfCandidates","summary":"List existing Candidates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Candidates","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidates/listofcandidates"}],"panels":[]}]},"httpPath":"/candidates"},{"label":"Update an existing Candidate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/candidates/updatecandidate","routeSlug":"/apis/openapi/candidates/updatecandidate","metadata":{"seo":{"title":"Update an existing Candidate","description":"Updates an existing Candidate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCandidate","name":"Update an existing Candidate","isWebhook":false,"pointer":"/paths/~1candidates~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing Candidate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing Candidate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempts to update a field that cannot be updated will return a 400 error stating \"... cannot be updated”. For example, attempting to update an SSN will return 400 stating \"Candidate SSN can not be updated because it has reports”."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geo_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replace"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" all existing Geos. To keep existing geos, include their IDs in the update request. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geo_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be updated if the candidate's work location is outside the US."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only fields with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can be updated after a Report has been ordered for a Candidate with the exception of the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"previous_driver_license_number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"previous_driver_license_state"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"copy_requested"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"geo_ids"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating metadata with an empty value (null or empty object) will delete existing metadata. Individual keys may also be set and unset."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adding a new key-value pair will maintain all existing key-value pairs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Providing a new value for an existing key will update the old value to the new value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Providing an empty value for an existing key will remove that key from the metadata object."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When all keys in the metadata object have empty values, the object will be deleted."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Candidate"}},"schemaId":"components/schemas/Candidate","pointer":"/paths/~1candidates~1{id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/candidates/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Candidate"}},"responseCodes":["200","400","401","403"],"pointer":"/candidates/{id}","href":"candidates/updatecandidate","openApiOperationId":"updateCandidate","summary":"Update an existing Candidate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"components/schemas/Candidate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Candidate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Candidate was successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Candidate"}},"schemaId":"components/schemas/Candidate"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Candidate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Candidate"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidates/updatecandidate"}],"panels":[]}]},"httpPath":"/candidates/{id}"},{"label":"Retrieve an existing Candidate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/candidates/getcandidate","routeSlug":"/apis/openapi/candidates/getcandidate","metadata":{"seo":{"title":"Retrieve an existing Candidate","description":"Retrieves an existing Candidate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCandidate","name":"Retrieve an existing Candidate","isWebhook":false,"pointer":"/paths/~1candidates~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Candidate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing Candidate.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma delimited string specifying the resources to be embedded in the returned Candidate object. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#embedding-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedding Resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"reports,geos"}],"pointer":"/paths/~1candidates~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/candidates/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[{"name":"include","in":"query","required":false,"example":"reports,geos","schemaId":"schema_95"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/candidates/{id}","href":"candidates/getcandidate","openApiOperationId":"getCandidate","summary":"Retrieve an existing Candidate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Candidate details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Candidate"}},"schemaId":"components/schemas/Candidate"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Candidate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Candidate"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidates/getcandidate"}],"panels":[]}]},"httpPath":"/candidates/{id}"},{"label":"Request PII removal for a Candidate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/candidates/deletecandidate","routeSlug":"/apis/openapi/candidates/deletecandidate","metadata":{"seo":{"title":"Request PII removal for a Candidate","description":"Requests the removal of PII from an existing Candidate"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCandidate","name":"Request PII removal for a Candidate","isWebhook":false,"pointer":"/paths/~1candidates~1{id}~1pii/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request PII removal for a Candidate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Requests the removal of PII from an existing Candidate\n\nRequesting the removal of PII from a candidate who has already had PII removed will result in an error.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{id}~1pii/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_96"}},"schemaId":"schema_96","pointer":"/paths/~1candidates~1{id}~1pii/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/candidates/{id}/pii","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_96"}},"responseCodes":["200","400","401","403"],"pointer":"/candidates/{id}/pii","href":"candidates/deletecandidate","openApiOperationId":"deleteCandidate","summary":"Request PII removal for a Candidate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_96","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_96"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Candidate details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Candidate"}},"schemaId":"components/schemas/Candidate"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadPiiRequestError"}},"schemaId":"components/schemas/BadPiiRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates~1{id}~1pii/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Candidate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Candidate"}}},{"code":"400","schemaId":"components/schemas/BadPiiRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadPiiRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidates/deletecandidate"}],"panels":[]}]},"httpPath":"/candidates/{id}/pii"}],"content":{"contentType":"group","meta":{"name":"Candidates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Candidates","showPageActions":true},{"nodeType":"markdoc","content":"Candidates represent people who have applied for positions within your company,\nand have agreed to a background check. Use the Candidate object\nto collect all Personally Identifiable Information (PII) for a candidate,\nand all relevant Checkr information, including any generated Reports, or attached Geos."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/candidates","summary":"Create a new Candidate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/candidates/createcandidate","deprecated":false},{"title":"/candidates","summary":"List existing Candidates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/candidates/listofcandidates","deprecated":false},{"title":"/candidates/{id}","summary":"Update an existing Candidate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/candidates/updatecandidate","deprecated":false},{"title":"/candidates/{id}","summary":"Retrieve an existing Candidate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/candidates/getcandidate","deprecated":false},{"title":"/candidates/{id}/pii","summary":"Request PII removal for a Candidate","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/candidates/deletecandidate","deprecated":false}]}]}]}]}},{"type":"group","label":"Reports","link":"/apis/openapi/reports","routeSlug":"/apis/openapi/reports","items":[{"label":"Create a new Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/reports/createreport","routeSlug":"/apis/openapi/reports/createreport","metadata":{"seo":{"title":"Create a new Report","description":"Creates a new Report resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createReport","name":"Create a new Report","isWebhook":false,"pointer":"/paths/~1reports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Report resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes: "},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This resource does not support the creation of reports for packages with international screenings; use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/invitations"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/invitations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for these orders. However, "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International MVR-only packages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are supported via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/reports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API. If required documentation is missing for the International MVR, Checkr will raise an exception to the candidate to provide it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Employment Verifications, Education Verifications, and Credit Checks may not be initiated using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/reports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API. Please use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/invitations"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/invitations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to initiate the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/#section/Getting-Started/Create-an-Invitation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checkr-Hosted Apply Flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when ordering background checks that include any of these screening types."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity Verification (IDV) may not be initiated using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/reports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API. Please use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/invitations"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/invitations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an IDV-enabled package to order an Identity Verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating a Report which includes an Occupational Health or Drug"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check will automatically issue an email invitation to the candidate to schedule their appointment at a clinic of their choice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consent_document_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required. Upload each consent PDF with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/documents/uploaddocument"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload a Candidate Document"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and pass the returned document ids."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_97"}},"schemaId":"schema_97","pointer":"/paths/~1reports/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/reports","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_97"}},"responseCodes":["200","400","401","403","404"],"pointer":"/reports","href":"reports/createreport","openApiOperationId":"createReport","summary":"Create a new Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_97","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_97"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Report"}},"schemaId":"components/schemas/Report"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PackageNotFoundError"}},"schemaId":"components/schemas/PackageNotFoundError"}],"pointer":"/paths/~1reports/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Report","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Report"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/PackageNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PackageNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/createreport"}],"panels":[]}]},"httpPath":"/reports"},{"label":"Update an existing Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/reports/updatereport","routeSlug":"/apis/openapi/reports/updatereport","metadata":{"seo":{"title":"Update an existing Report","description":"Updates the package or adjudication for an existing Report resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateReport","name":"Update an existing Report","isWebhook":false,"pointer":"/paths/~1reports~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"package"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adjudication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an existing Report resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to update reports which include the candidate's Social Security Number. To update a Report which does not include an SSN, first use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/candidates/updatecandidate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update Candidate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to add the candidate’s SSN before updating the report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"package"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adjudication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint may also be used to update international reports for candidates which do not include an SSN."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"className":"alert alert-info"}},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Package of a Report cannot be updated if it has an Adverse Action with the status: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To proceed, cancel the Adverse Action or create a new Report."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Report's ID.","required":true}],"pointer":"/paths/~1reports~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_98"}},"schemaId":"schema_98","pointer":"/paths/~1reports~1{id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/reports/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_98"}},"responseCodes":["200","400","401","403"],"pointer":"/reports/{id}","href":"reports/updatereport","openApiOperationId":"updateReport","summary":"Update an existing Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_98","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_98"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report was successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Report"}},"schemaId":"components/schemas/Report"},{"code":"400","description":"Pre-existing Adverse Action","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PreExistingAdverseActionError"}},"schemaId":"components/schemas/PreExistingAdverseActionError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1reports~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Report","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Report"}}},{"code":"400","schemaId":"components/schemas/PreExistingAdverseActionError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PreExistingAdverseActionError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/updatereport"}],"panels":[]}]},"httpPath":"/reports/{id}"},{"label":"Retrieve an existing Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/reports/getreport","routeSlug":"/apis/openapi/reports/getreport","metadata":{"seo":{"title":"Retrieve an existing Report","description":"Returns an existing Report with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReport","name":"Retrieve an existing Report","isWebhook":false,"pointer":"/paths/~1reports~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Report with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Report's ID.","required":true}],"pointer":"/paths/~1reports~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_99","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma delimited string specifying the resources to be embedded in the returned Report object. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#embedding-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedding Resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"candidate,drug_screening,identity_verification"}],"pointer":"/paths/~1reports~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[{"name":"include","in":"query","required":false,"example":"candidate,drug_screening,identity_verification","schemaId":"schema_99"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/reports/{id}","href":"reports/getreport","openApiOperationId":"getReport","summary":"Retrieve an existing Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Report"}},"schemaId":"components/schemas/Report"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1reports~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Report","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Report"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/getreport"}],"panels":[]}]},"httpPath":"/reports/{id}"},{"label":"Complete an existing Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/reports/completereport","routeSlug":"/apis/openapi/reports/completereport","metadata":{"seo":{"title":"Complete an existing Report","description":"Cancels all pending or suspended screenings and completes the report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"completeReport","name":"Complete an existing Report","isWebhook":false,"pointer":"/paths/~1reports~1{id}~1complete/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete an existing Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels all pending or suspended screenings and completes the report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to complete reports which include pending or suspended screenings. If a report is completed with pending or suspended screenings, the following events will be triggered:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all in-progress screenings within the report will be updated to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cancellation reason and the reason’s description will be added to each canceled screening."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checkr will issue webhooks upon report completion."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If all screenings are canceled, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report.canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook will be issued."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If at least one screening has a result before the report is completed, Checkr will issue two webhooks: first, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report.updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", followed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report.complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Report's ID.","required":true}],"pointer":"/paths/~1reports~1{id}~1complete/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/reports/{id}/complete","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/reports/{id}/complete","href":"reports/completereport","openApiOperationId":"completeReport","summary":"Complete an existing Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report was successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Report"}},"schemaId":"components/schemas/Report"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1reports~1{id}~1complete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Report","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Report"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/completereport"}],"panels":[]}]},"httpPath":"/reports/{id}/complete"},{"label":"Retrieve progressive checkpoint status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/reports/getreportprogressivestatus","routeSlug":"/apis/openapi/reports/getreportprogressivestatus","metadata":{"seo":{"title":"Retrieve progressive checkpoint status","description":"Returns checkpoint-level progress for an Enterprise Progressive Report:nested report identity and status, whether continuation is still eligible,when eligibility expires, and an ordered list of checkpoints."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReportProgressiveStatus","name":"Retrieve progressive checkpoint status","isWebhook":false,"pointer":"/paths/~1reports~1{id}~1progressive~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve progressive checkpoint status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns checkpoint-level progress for an Enterprise Progressive Report:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nested report identity and status, whether continuation is still eligible,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when eligibility expires, and an ordered list of checkpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each checkpoint lists the products it runs and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_review"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That object's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" distinguish waiting on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a review action, a customer-applied decision, auto-progress, and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"checkpoints with no gate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when polling after a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Webhooks/Report-events"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report.paused"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook, or alongside"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/reviewActionReport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply a review action to a Report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the Report does not exist or does not have progressive"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"checkpoint status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Report's ID.","required":true}],"pointer":"/paths/~1reports~1{id}~1progressive~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{id}/progressive/status","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/reports/{id}/progressive/status","href":"reports/getreportprogressivestatus","openApiOperationId":"getReportProgressiveStatus","summary":"Retrieve progressive checkpoint status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Progressive checkpoint status for the Report","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProgressiveStatus"}},"schemaId":"components/schemas/ProgressiveStatus"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1reports~1{id}~1progressive~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProgressiveStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProgressiveStatus"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/getreportprogressivestatus"}],"panels":[]}]},"httpPath":"/reports/{id}/progressive/status"},{"label":"Apply a review action to a Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/reports/reviewactionreport","routeSlug":"/apis/openapi/reports/reviewactionreport","metadata":{"seo":{"title":"Apply a review action to a Report","description":"Applies a review action decision to a paused Report. When a Report is paused awaiting a Review Action, use this endpoint to continue or skip remaining screenings. To inspect which checkpoint is waiting, use Retrieve progressive checkpoint status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reviewActionReport","name":"Apply a review action to a Report","isWebhook":false,"pointer":"/paths/~1reports~1{id}~1review_action/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply a review action to a Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies a review action decision to a paused Report. When a Report is paused awaiting a Review Action, use this endpoint to continue or skip remaining screenings. To inspect which checkpoint is waiting, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getReportProgressiveStatus"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve progressive checkpoint status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Report's ID.","required":true}],"pointer":"/paths/~1reports~1{id}~1review_action/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_100"}},"schemaId":"schema_100","pointer":"/paths/~1reports~1{id}~1review_action/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/reports/{id}/review_action","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_100"}},"responseCodes":["200","400","401","403","404"],"pointer":"/reports/{id}/review_action","href":"reports/reviewactionreport","openApiOperationId":"reviewActionReport","summary":"Apply a review action to a Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_100","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_100"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Review action decision was successfully applied.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1reports~1{id}~1review_action/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/reviewactionreport"}],"panels":[]}]},"httpPath":"/reports/{id}/review_action"}],"content":{"contentType":"group","meta":{"name":"Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reports provide all information relevant to a candidate’s requested background check. Reports include the status of the background check process, the list of searches included in the check, and the Package requested."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the Package selected, a report may include any combination of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/ssn-trace"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checkr Screenings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" listed below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reports are provided to candidates through the Candidate Portal, and as a PDF (if requested)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information on the searches listed, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/ssn-trace"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screenings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (below),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/sections/203637147-Screening-Types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screening Types"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/reports","summary":"Create a new Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/createreport","deprecated":false},{"title":"/reports/{id}","summary":"Update an existing Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/updatereport","deprecated":false},{"title":"/reports/{id}","summary":"Retrieve an existing Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/getreport","deprecated":false},{"title":"/reports/{id}/complete","summary":"Complete an existing Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/completereport","deprecated":false},{"title":"/reports/{id}/progressive/status","summary":"Retrieve progressive checkpoint status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/getreportprogressivestatus","deprecated":false},{"title":"/reports/{id}/review_action","summary":"Apply a review action to a Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reports/reviewactionreport","deprecated":false}]}]}]}]}},{"type":"group","label":"Invitations","link":"/apis/openapi/invitations","routeSlug":"/apis/openapi/invitations","items":[{"label":"Create a new Invitation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/invitations/createinvitation","routeSlug":"/apis/openapi/invitations/createinvitation","metadata":{"seo":{"title":"Create a new Invitation","description":"Creates a new Invitation resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInvitation","name":"Create a new Invitation","isWebhook":false,"pointer":"/paths/~1invitations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new Invitation resource.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_102"}},"schemaId":"schema_102","pointer":"/paths/~1invitations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invitations","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_102"}},"responseCodes":["201","400","401","403","404"],"pointer":"/invitations","href":"invitations/createinvitation","openApiOperationId":"createInvitation","summary":"Create a new Invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_102","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_102"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Invitation was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invitation"}},"schemaId":"components/schemas/Invitation"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PackageNotFoundError"}},"schemaId":"components/schemas/PackageNotFoundError"}],"pointer":"/paths/~1invitations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Invitation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invitation"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/PackageNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PackageNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invitations/createinvitation"}],"panels":[]}]},"httpPath":"/invitations"},{"label":"List existing Invitations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/invitations/listofinvitations","routeSlug":"/apis/openapi/invitations/listofinvitations","metadata":{"seo":{"title":"List existing Invitations","description":"Returns a list of existing Invitations with the input status or candidate_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOfInvitations","name":"List existing Invitations","isWebhook":false,"pointer":"/paths/~1invitations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Invitations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of existing Invitations with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no parameters are passed, returns all Invitations."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, returns Invitations that match the input parameter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are passed, return Invitations that match both parameters."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 400 if the (optional) "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call will not return invitations with non-US "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"work_locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/invitations/getinvitation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /invitations/{id}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve candidates outside the US."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"candidate_id","in":"query","schemaId":"schema_90","description":"ID of the candidate to whom the invitation was issued."},{"name":"status","in":"query","schemaId":"schema_103","description":"Status of the Invitation."},{"name":"page","in":"query","schemaId":"schema_93","description":"Specifies the page number to retrieve."},{"name":"per_page","in":"query","schemaId":"schema_93","description":"Indicates how many records each page should contain. The default value is 25 records."}],"pointer":"/paths/~1invitations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invitations","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"candidate_id","in":"query","schemaId":"schema_90"},{"name":"status","in":"query","schemaId":"schema_103"},{"name":"page","in":"query","required":false,"schemaId":"schema_93"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/invitations","href":"invitations/listofinvitations","openApiOperationId":"listOfInvitations","summary":"List existing Invitations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Invitations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104"}},"schemaId":"schema_104"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1invitations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_104","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invitations/listofinvitations"}],"panels":[]}]},"httpPath":"/invitations"},{"label":"Retrieve an existing Invitation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/invitations/getinvitation","routeSlug":"/apis/openapi/invitations/getinvitation","metadata":{"seo":{"title":"Retrieve an existing Invitation","description":"Returns an existing Invitation with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInvitation","name":"Retrieve an existing Invitation","isWebhook":false,"pointer":"/paths/~1invitations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Invitation with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Invitation's ID.","required":true}],"pointer":"/paths/~1invitations~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_deleted","in":"query","schemaId":"schema_105","description":"Retrieve an invitation that has been deleted"}],"pointer":"/paths/~1invitations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invitations/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[{"name":"include_deleted","in":"query","required":false,"schemaId":"schema_105"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/invitations/{id}","href":"invitations/getinvitation","openApiOperationId":"getInvitation","summary":"Retrieve an existing Invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invitation details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invitation"}},"schemaId":"components/schemas/Invitation"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1invitations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Invitation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invitation"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invitations/getinvitation"}],"panels":[]}]},"httpPath":"/invitations/{id}"},{"label":"Cancel an existing Invitation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/invitations/cancelinvitation","routeSlug":"/apis/openapi/invitations/cancelinvitation","metadata":{"seo":{"title":"Cancel an existing Invitation","description":"Cancels an existing Invitation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelInvitation","name":"Cancel an existing Invitation","isWebhook":false,"pointer":"/paths/~1invitations~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an existing Invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels an existing Invitation.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Invitation's ID.","required":true}],"pointer":"/paths/~1invitations~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/invitations/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/invitations/{id}","href":"invitations/cancelinvitation","openApiOperationId":"cancelInvitation","summary":"Cancel an existing Invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Invitation was successfully canceled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invitation"}},"schemaId":"components/schemas/Invitation"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1invitations~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Invitation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invitation"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invitations/cancelinvitation"}],"panels":[]}]},"httpPath":"/invitations/{id}"}],"content":{"contentType":"group","meta":{"name":"Invitations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invitations","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a background check invitation. The candidate will receive an email to submit their information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": By default, the date of expiration is set to 7 days after creation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All invitations expire at 11:59:59pm PDT."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This enables candidates to have a full last day to complete their invitation."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/invitations","summary":"Create a new Invitation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invitations/createinvitation","deprecated":false},{"title":"/invitations","summary":"List existing Invitations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invitations/listofinvitations","deprecated":false},{"title":"/invitations/{id}","summary":"Retrieve an existing Invitation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invitations/getinvitation","deprecated":false},{"title":"/invitations/{id}","summary":"Cancel an existing Invitation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/invitations/cancelinvitation","deprecated":false}]}]}]}]}},{"type":"group","label":"Packages","link":"/apis/openapi/packages","routeSlug":"/apis/openapi/packages","items":[{"label":"List existing Packages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/packages/packageslist","routeSlug":"/apis/openapi/packages/packageslist","metadata":{"seo":{"title":"List existing Packages","description":"Returns a list of all existing Packages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"packagesList","name":"List existing Packages","isWebhook":false,"pointer":"/paths/~1packages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Packages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all existing Packages.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_93","description":"Specifies the page number to retrieve."},{"name":"per_page","in":"query","schemaId":"schema_93","description":"Indicates how many records each page should contain. The default value is 25 records."}],"pointer":"/paths/~1packages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/packages","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_93"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/packages","href":"packages/packageslist","openApiOperationId":"packagesList","summary":"List existing Packages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Packages","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}},"schemaId":"schema_106"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1packages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_106","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_106"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/packageslist"}],"panels":[]}]},"httpPath":"/packages"},{"label":"Retrieve an existing Package","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/packages/getpackage","routeSlug":"/apis/openapi/packages/getpackage","metadata":{"seo":{"title":"Retrieve an existing Package","description":"Returns an existing Package with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPackage","name":"Retrieve an existing Package","isWebhook":false,"pointer":"/paths/~1packages~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Package","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Package with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Package to retrieve.","required":true}],"pointer":"/paths/~1packages~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/packages/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/packages/{id}","href":"packages/getpackage","openApiOperationId":"getPackage","summary":"Retrieve an existing Package"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Package details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Package"}},"schemaId":"components/schemas/Package"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1packages~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Package","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Package"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/getpackage"}],"panels":[]}]},"httpPath":"/packages/{id}"},{"label":"Delete an existing Package","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/packages/deletepackage","routeSlug":"/apis/openapi/packages/deletepackage","metadata":{"seo":{"title":"Delete an existing Package","description":"Deletes an existing Package."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePackage","name":"Delete an existing Package","isWebhook":false,"pointer":"/paths/~1packages~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an existing Package","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an existing Package.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Package to retrieve.","required":true}],"pointer":"/paths/~1packages~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/packages/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/packages/{id}","href":"packages/deletepackage","openApiOperationId":"deletePackage","summary":"Delete an existing Package"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Package was successfully deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Package"}},"schemaId":"components/schemas/Package"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1packages~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Package","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Package"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/deletepackage"}],"panels":[]}]},"httpPath":"/packages/{id}"}],"content":{"contentType":"group","meta":{"name":"Packages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Packages","showPageActions":true},{"nodeType":"markdoc","content":"Packages are a list of screenings to be run for a report.\nWork with your Checkr Customer Success representative to define Packages that will best serve\nyour business needs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/packages","summary":"List existing Packages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/packages/packageslist","deprecated":false},{"title":"/packages/{id}","summary":"Retrieve an existing Package","prefix":{"name":"get","color":"get"},"badges":[],"link":"/packages/getpackage","deprecated":false},{"title":"/packages/{id}","summary":"Delete an existing Package","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/packages/deletepackage","deprecated":false}]}]}]}]}},{"type":"separator","label":"Candidate Profile","content":null},{"type":"group","label":"Documents","link":"/apis/openapi/documents","routeSlug":"/apis/openapi/documents","items":[{"label":"List a Candidate's Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/documents/getcandidatedocuments","routeSlug":"/apis/openapi/documents/getcandidatedocuments","metadata":{"seo":{"title":"List a Candidate's Documents","description":"Returns an array of candidate-provided Documents for the input candidate_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCandidateDocuments","name":"List a Candidate's Documents","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a Candidate's Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an array of candidate-provided Documents for the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"ID of the Candidate for whom documents will be retrieved.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1documents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"types[]","in":"query","schemaId":"schema_107","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of candidate-provided document to return. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"types[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not included in the call, all available Candidate Documents will be returned."},"children":[]}]}]}]}],"pointer":"/paths/~1candidates~1{candidate_id}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/candidates/{candidate_id}/documents","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[{"name":"types[]","in":"query","schemaId":"schema_107"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/candidates/{candidate_id}/documents","href":"documents/getcandidatedocuments","openApiOperationId":"getCandidateDocuments","summary":"List a Candidate's Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Documents","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_108"}},"schemaId":"schema_108"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_108","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_108"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/getcandidatedocuments"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/documents"},{"label":"Upload a new Candidate Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/documents/uploaddocument","routeSlug":"/apis/openapi/documents/uploaddocument","metadata":{"seo":{"title":"Upload a new Candidate Document","description":"Uploads a new Candidate Document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadDocument","name":"Upload a new Candidate Document","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1documents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a new Candidate Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploads a new Candidate Document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a consent PDF, upload with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", save the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the response, and pass it in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consent_document_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/reports/createreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new Report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Uploading the file does not attach it to the report."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload a document for the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1documents/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_109"}},"schemaId":"schema_109","pointer":"/paths/~1candidates~1{candidate_id}~1documents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/candidates/{candidate_id}/documents","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_109"}},"responseCodes":["200","400","401","403"],"pointer":"/candidates/{candidate_id}/documents","href":"documents/uploaddocument","openApiOperationId":"uploadDocument","summary":"Upload a new Candidate Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_109","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_109"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Document was successfully uploaded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Document"}},"schemaId":"components/schemas/Document"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1documents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Document","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Document"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/uploaddocument"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/documents"},{"label":"Retrieve a Document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/documents/getdocument","routeSlug":"/apis/openapi/documents/getdocument","metadata":{"seo":{"title":"Retrieve a Document","description":"Returns an existing Document with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDocument","name":"Retrieve a Document","isWebhook":false,"pointer":"/paths/~1documents~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an existing Document with the input ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report Document IDs can be retrieved from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/reports/getreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an existing Report"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint. Candidate Document IDs can be retrieved using the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/documents/getcandidatedocuments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List a Candidate's Documents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Document to retrieve.","required":true}],"pointer":"/paths/~1documents~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/documents/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/documents/{id}","href":"documents/getdocument","openApiOperationId":"getDocument","summary":"Retrieve a Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Document details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Document"}},"schemaId":"components/schemas/Document"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1documents~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Document","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Document"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/getdocument"}],"panels":[]}]},"httpPath":"/documents/{id}"}],"content":{"contentType":"group","meta":{"name":"Documents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Documents","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a Document, either related to a Report (such as a PDF Report) or related to a Candidate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(such as a Driver License image, or a consent form). Report Document IDs can be retrieved from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/reports/getreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an existing Report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. Candidate Document IDs can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieved using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/documents/getcandidatedocuments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List a Candidate's Documents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/reports/{id}?include=documents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return a Report resource that includes an array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report Documents are of the following types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdlis_report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drug_screen_donor_pass"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drug_alcohol_clearinghouse_query_details_document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf_credit_report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf_health_report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf_individualized_assessment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf_report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf_report_encrypted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf_self_disclosure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf_wisconsin_doj"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"screening_pass"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drug_screening_pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"breath_alcohol_document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"breath_alcohol_result_certificate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chain_of_custody_form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drug_result_certificate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occupational_health_screening_pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occupational_health_screening_document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occupational_health_screening_result_certificate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occupational_health_medical_examiner_certificate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/candidates/{candidate_id}/documents","summary":"List a Candidate's Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/getcandidatedocuments","deprecated":false},{"title":"/candidates/{candidate_id}/documents","summary":"Upload a new Candidate Document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/uploaddocument","deprecated":false},{"title":"/documents/{id}","summary":"Retrieve a Document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/getdocument","deprecated":false}]}]}]}]}},{"type":"group","label":"Driver Licenses","link":"/apis/openapi/driver-licenses","routeSlug":"/apis/openapi/driver-licenses","items":[{"label":"Create a new Driver License","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/driver-licenses/createdriverlicense","routeSlug":"/apis/openapi/driver-licenses/createdriverlicense","metadata":{"seo":{"title":"Create a new Driver License","description":"Creates a new Driver License for a given candidate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDriverLicense","name":"Create a new Driver License","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Driver License","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Driver License for a given candidate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" driver license is created for a candidate with an existing driver license marked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the existing license will be updated to reflect that it is no longer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_driver_license"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exists with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" passed in with the POST request, a new license will not be created. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issued_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values of the existing license will be updated with on the parameters passed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When a new driver license is created, Checkr will attempt to apply the new license information to resolve any existing exceptions for the candidate's most recent MVR screening if the screening has not yet produced reportable results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#driver-license-validation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Driver License validation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Reference section for a list of valid driver license number input by state."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The Candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_110"}},"schemaId":"schema_110","pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/candidates/{candidate_id}/driver_licenses","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_110"}},"responseCodes":["200","400","401","403","404"],"pointer":"/candidates/{candidate_id}/driver_licenses","href":"driver-licenses/createdriverlicense","openApiOperationId":"createDriverLicense","summary":"Create a new Driver License"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_110","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_110"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Driver License was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DriverLicense"}},"schemaId":"components/schemas/DriverLicense"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}},"schemaId":"components/schemas/CandidateNotFoundError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DriverLicense","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DriverLicense"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/CandidateNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/driver-licenses/createdriverlicense"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/driver_licenses"},{"label":"List existing Driver Licenses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/driver-licenses/listofdriverlicenses","routeSlug":"/apis/openapi/driver-licenses/listofdriverlicenses","metadata":{"seo":{"title":"List existing Driver Licenses","description":"Returns a list of existing Driver Licenses for the input Candidate ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOfDriverLicenses","name":"List existing Driver Licenses","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Driver Licenses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of existing Driver Licenses for the input Candidate ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The Candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/candidates/{candidate_id}/driver_licenses","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/candidates/{candidate_id}/driver_licenses","href":"driver-licenses/listofdriverlicenses","openApiOperationId":"listOfDriverLicenses","summary":"List existing Driver Licenses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Driver Licenses","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}},"schemaId":"schema_111"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}},"schemaId":"components/schemas/CandidateNotFoundError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_111","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/CandidateNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/driver-licenses/listofdriverlicenses"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/driver_licenses"},{"label":"Retrieve an existing Driver License","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/driver-licenses/getdriverlicense","routeSlug":"/apis/openapi/driver-licenses/getdriverlicense","metadata":{"seo":{"title":"Retrieve an existing Driver License","description":"Returns a specific driver license for a given candidate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDriverLicense","name":"Retrieve an existing Driver License","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses~1{driver_license_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Driver License","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific driver license for a given candidate.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"driver_license_id","in":"path","schemaId":"schema_90","description":"The Driver License ID.","required":true},{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The Candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses~1{driver_license_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/candidates/{candidate_id}/driver_licenses/{driver_license_id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"driver_license_id","in":"path","required":true,"schemaId":"schema_90"},{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/candidates/{candidate_id}/driver_licenses/{driver_license_id}","href":"driver-licenses/getdriverlicense","openApiOperationId":"getDriverLicense","summary":"Retrieve an existing Driver License"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Driver License details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DriverLicense"}},"schemaId":"components/schemas/DriverLicense"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}},"schemaId":"components/schemas/CandidateNotFoundError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses~1{driver_license_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DriverLicense","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DriverLicense"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/CandidateNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/driver-licenses/getdriverlicense"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/driver_licenses/{driver_license_id}"},{"label":"Update an existing Driver License","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/driver-licenses/updatedriverlicense","routeSlug":"/apis/openapi/driver-licenses/updatedriverlicense","metadata":{"seo":{"title":"Update an existing Driver License","description":"Updates an existing Driver License for a given candidate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDriverLicense","name":"Update an existing Driver License","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses~1{driver_license_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing Driver License","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing Driver License for a given candidate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Updating an existing license to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will set any existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" license to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"driver_license_id","in":"path","schemaId":"schema_90","description":"The Driver License ID.","required":true},{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The Candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses~1{driver_license_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_112"}},"schemaId":"schema_112","pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses~1{driver_license_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/candidates/{candidate_id}/driver_licenses/{driver_license_id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"driver_license_id","in":"path","required":true,"schemaId":"schema_90"},{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_112"}},"responseCodes":["200","400","401","403","404"],"pointer":"/candidates/{candidate_id}/driver_licenses/{driver_license_id}","href":"driver-licenses/updatedriverlicense","openApiOperationId":"updateDriverLicense","summary":"Update an existing Driver License"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_112","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_112"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Driver License was successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DriverLicense"}},"schemaId":"components/schemas/DriverLicense"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}},"schemaId":"components/schemas/CandidateNotFoundError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses~1{driver_license_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DriverLicense","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DriverLicense"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/CandidateNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/driver-licenses/updatedriverlicense"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/driver_licenses/{driver_license_id}"},{"label":"Delete an existing Driver License","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/driver-licenses/deletedriverlicense","routeSlug":"/apis/openapi/driver-licenses/deletedriverlicense","metadata":{"seo":{"title":"Delete an existing Driver License","description":"Deletes a specific driver license for a given candidate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDriverLicense","name":"Delete an existing Driver License","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses~1{driver_license_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an existing Driver License","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific driver license for a given candidate.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"driver_license_id","in":"path","schemaId":"schema_90","description":"The Driver License ID.","required":true},{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The Candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses~1{driver_license_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/candidates/{candidate_id}/driver_licenses/{driver_license_id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"driver_license_id","in":"path","required":true,"schemaId":"schema_90"},{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/candidates/{candidate_id}/driver_licenses/{driver_license_id}","href":"driver-licenses/deletedriverlicense","openApiOperationId":"deleteDriverLicense","summary":"Delete an existing Driver License"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Driver License was successfully deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DriverLicense"}},"schemaId":"components/schemas/DriverLicense"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}},"schemaId":"components/schemas/CandidateNotFoundError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1driver_licenses~1{driver_license_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DriverLicense","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DriverLicense"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/CandidateNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/driver-licenses/deletedriverlicense"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/driver_licenses/{driver_license_id}"}],"content":{"contentType":"group","meta":{"name":"Driver Licenses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Driver Licenses","showPageActions":true},{"nodeType":"markdoc","content":"The driver licenses resource represents a single driver license for a candidate. Candidates may have one current driver license and may have any number of previous driver licenses."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/candidates/{candidate_id}/driver_licenses","summary":"Create a new Driver License","prefix":{"name":"post","color":"post"},"badges":[],"link":"/driver-licenses/createdriverlicense","deprecated":false},{"title":"/candidates/{candidate_id}/driver_licenses","summary":"List existing Driver Licenses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/driver-licenses/listofdriverlicenses","deprecated":false},{"title":"/candidates/{candidate_id}/driver_licenses/{driver_license_id}","summary":"Retrieve an existing Driver License","prefix":{"name":"get","color":"get"},"badges":[],"link":"/driver-licenses/getdriverlicense","deprecated":false},{"title":"/candidates/{candidate_id}/driver_licenses/{driver_license_id}","summary":"Update an existing Driver License","prefix":{"name":"post","color":"post"},"badges":[],"link":"/driver-licenses/updatedriverlicense","deprecated":false},{"title":"/candidates/{candidate_id}/driver_licenses/{driver_license_id}","summary":"Delete an existing Driver License","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/driver-licenses/deletedriverlicense","deprecated":false}]}]}]}]}},{"type":"group","label":"Employers","link":"/apis/openapi/employers","routeSlug":"/apis/openapi/employers","items":[{"label":"Create a new Employer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/employers/createemployer","routeSlug":"/apis/openapi/employers/createemployer","metadata":{"seo":{"title":"Create a new Employer","description":"Creates a new Employer resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEmployer","name":"Create a new Employer","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1employers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Employer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Employer resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the country is not US, the following parameters will be required in addition to those marked as required in the table below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salary"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"country"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"zipcode"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"manager:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is performed to ensure logical dates are provided. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and both dates must be after 1900-01-01."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an employer for the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1employers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_113"}},"schemaId":"schema_113","pointer":"/paths/~1candidates~1{candidate_id}~1employers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/candidates/{candidate_id}/employers","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_113"}},"responseCodes":["200","400","401","403"],"pointer":"/candidates/{candidate_id}/employers","href":"employers/createemployer","openApiOperationId":"createEmployer","summary":"Create a new Employer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_113","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_113"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Employer was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employer"}},"schemaId":"components/schemas/Employer"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1employers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Employer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employer"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employers/createemployer"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/employers"},{"label":"List existing Employers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/employers/employerslistbycandidate","routeSlug":"/apis/openapi/employers/employerslistbycandidate","metadata":{"seo":{"title":"List existing Employers","description":"Returns a list of existing Employers for the input candidate_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"employersListByCandidate","name":"List existing Employers","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1employers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Employers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of existing Employers for the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of employers for the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1employers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_93","description":"Specifies the page number to retrieve."},{"name":"per_page","in":"query","schemaId":"schema_93","description":"Indicates how many records each page should contain. The default value is 25 records."}],"pointer":"/paths/~1candidates~1{candidate_id}~1employers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/candidates/{candidate_id}/employers","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_93"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/candidates/{candidate_id}/employers","href":"employers/employerslistbycandidate","openApiOperationId":"employersListByCandidate","summary":"List existing Employers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Employers","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_114"}},"schemaId":"schema_114"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1employers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_114","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_114"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employers/employerslistbycandidate"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/employers"},{"label":"Delete an existing Employer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/employers/employerdelete","routeSlug":"/apis/openapi/employers/employerdelete","metadata":{"seo":{"title":"Delete an existing Employer","description":"Deletes an existing Employer with the input id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"employerDelete","name":"Delete an existing Employer","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1employers~1{employer_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an existing Employer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an existing Employer with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employer_id","in":"path","schemaId":"schema_90","description":"The Employer's ID.","required":true},{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The Candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1employers~1{employer_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/candidates/{candidate_id}/employers/{employer_id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"employer_id","in":"path","required":true,"schemaId":"schema_90"},{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/candidates/{candidate_id}/employers/{employer_id}","href":"employers/employerdelete","openApiOperationId":"employerDelete","summary":"Delete an existing Employer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Employer was successfully deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employer"}},"schemaId":"components/schemas/Employer"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1employers~1{employer_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Employer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employer"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employers/employerdelete"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/employers/{employer_id}"},{"label":"Retrieve an existing Employer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/employers/getemployer","routeSlug":"/apis/openapi/employers/getemployer","metadata":{"seo":{"title":"Retrieve an existing Employer","description":"Returns an existing Employer with the input candidate_id or employer_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmployer","name":"Retrieve an existing Employer","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1employers~1{employer_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Employer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an existing Employer with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employer_id","in":"path","schemaId":"schema_90","description":"The Employer's ID.","required":true},{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The Candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1employers~1{employer_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/candidates/{candidate_id}/employers/{employer_id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"employer_id","in":"path","required":true,"schemaId":"schema_90"},{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/candidates/{candidate_id}/employers/{employer_id}","href":"employers/getemployer","openApiOperationId":"getEmployer","summary":"Retrieve an existing Employer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Employer details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employer"}},"schemaId":"components/schemas/Employer"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1employers~1{employer_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Employer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employer"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employers/getemployer"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/employers/{employer_id}"}],"content":{"contentType":"group","meta":{"name":"Employers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Employers","showPageActions":true},{"nodeType":"markdoc","content":"The Employers resource includes all relevant employer information for the specified Candidate.\nEmployer resources are tied to the specified candidate, and do not transfer to other employees within the system.\nOnce attached to a candidate, all employers are retained when running subsequent employment verifications. For example, if multiple employment verifications are run for an existing candidate, each report will use all employers attached to that candidate for the verification."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/candidates/{candidate_id}/employers","summary":"Create a new Employer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/employers/createemployer","deprecated":false},{"title":"/candidates/{candidate_id}/employers","summary":"List existing Employers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employers/employerslistbycandidate","deprecated":false},{"title":"/candidates/{candidate_id}/employers/{employer_id}","summary":"Delete an existing Employer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/employers/employerdelete","deprecated":false},{"title":"/candidates/{candidate_id}/employers/{employer_id}","summary":"Retrieve an existing Employer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employers/getemployer","deprecated":false}]}]}]}]}},{"type":"group","label":"Schools","link":"/apis/openapi/schools","routeSlug":"/apis/openapi/schools","items":[{"label":"Create a new School","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/schools/createschoolforcandidate","routeSlug":"/apis/openapi/schools/createschoolforcandidate","metadata":{"seo":{"title":"Create a new School","description":"Creates a new School resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSchoolForCandidate","name":"Create a new School","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1schools/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new School","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new School resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is performed to ensure logical dates are provided. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and both dates must be after 1900-01-01."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the country is not US, the following parameters are required in addition to those marked as required below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"year_awarded"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"minor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"start_date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"end_date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"current"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"city"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"zipcode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"country"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a School for the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1schools/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_115"}},"schemaId":"schema_115","pointer":"/paths/~1candidates~1{candidate_id}~1schools/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/candidates/{candidate_id}/schools","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_115"}},"responseCodes":["200","400","401","403"],"pointer":"/candidates/{candidate_id}/schools","href":"schools/createschoolforcandidate","openApiOperationId":"createSchoolForCandidate","summary":"Create a new School"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_115","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_115"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"School was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/School"}},"schemaId":"components/schemas/School"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1schools/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/School","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/School"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schools/createschoolforcandidate"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/schools"},{"label":"List existing Schools","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/schools/schoolslistbycandidate","routeSlug":"/apis/openapi/schools/schoolslistbycandidate","metadata":{"seo":{"title":"List existing Schools","description":"Returns a list of existing Schools for the input candidate_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"schoolsListByCandidate","name":"List existing Schools","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1schools/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Schools","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of existing Schools for the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of schools for the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1schools/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/candidates/{candidate_id}/schools","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/candidates/{candidate_id}/schools","href":"schools/schoolslistbycandidate","openApiOperationId":"schoolsListByCandidate","summary":"List existing Schools"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Schools","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}},"schemaId":"schema_116"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1schools/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_116","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schools/schoolslistbycandidate"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/schools"},{"label":"Delete an existing School","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/schools/schooldelete","routeSlug":"/apis/openapi/schools/schooldelete","metadata":{"seo":{"title":"Delete an existing School","description":"Deletes an existing School with the input school_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"schoolDelete","name":"Delete an existing School","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1schools~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an existing School","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an existing School with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"school_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The School's ID.","required":true},{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The Candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1schools~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/candidates/{candidate_id}/schools/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"},{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/candidates/{candidate_id}/schools/{id}","href":"schools/schooldelete","openApiOperationId":"schoolDelete","summary":"Delete an existing School"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"School was successfully deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/School"}},"schemaId":"components/schemas/School"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1schools~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/School","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/School"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schools/schooldelete"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/schools/{id}"},{"label":"Retrieve an existing School","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/schools/getschool","routeSlug":"/apis/openapi/schools/getschool","metadata":{"seo":{"title":"Retrieve an existing School","description":"Returns an existing School with the input school_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSchool","name":"Retrieve an existing School","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1schools~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing School","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an existing School with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"school_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The School's ID.","required":true},{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The Candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1schools~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/candidates/{candidate_id}/schools/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"},{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/candidates/{candidate_id}/schools/{id}","href":"schools/getschool","openApiOperationId":"getSchool","summary":"Retrieve an existing School"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"School details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/School"}},"schemaId":"components/schemas/School"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1schools~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/School","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/School"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schools/getschool"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/schools/{id}"}],"content":{"contentType":"group","meta":{"name":"Schools"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schools","showPageActions":true},{"nodeType":"markdoc","content":"The School resource includes all relevant educational information for the specified Candidate.\nSchool resources are tied to the specified candidate, and do not transfer to other alumna within the system."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/candidates/{candidate_id}/schools","summary":"Create a new School","prefix":{"name":"post","color":"post"},"badges":[],"link":"/schools/createschoolforcandidate","deprecated":false},{"title":"/candidates/{candidate_id}/schools","summary":"List existing Schools","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schools/schoolslistbycandidate","deprecated":false},{"title":"/candidates/{candidate_id}/schools/{id}","summary":"Delete an existing School","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/schools/schooldelete","deprecated":false},{"title":"/candidates/{candidate_id}/schools/{id}","summary":"Retrieve an existing School","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schools/getschool","deprecated":false}]}]}]}]}},{"type":"group","label":"Professional Licenses","link":"/apis/openapi/professional-licenses","routeSlug":"/apis/openapi/professional-licenses","items":[{"label":"Create a new Professional License","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/professional-licenses/createprofessionallicense","routeSlug":"/apis/openapi/professional-licenses/createprofessionallicense","metadata":{"seo":{"title":"Create a new Professional License","description":"Creates a new Professional License for a given candidate. A maximum of two licenses may exist for each candidate. When a report is run with Professional License Verification, all candidate licenses existing at the time of report creation will be included for verification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProfessionalLicense","name":"Create a new Professional License","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1professional_licenses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Professional License","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Professional License for a given candidate. A maximum of two licenses may exist for each candidate. When a report is run with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/professional-license-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Professional License Verification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all candidate licenses existing at the time of report creation will be included for verification."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The Candidate's ID","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1professional_licenses/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_117"}},"schemaId":"schema_117","pointer":"/paths/~1candidates~1{candidate_id}~1professional_licenses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/candidates/{candidate_id}/professional_licenses","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_117"}},"responseCodes":["200","400","401","403","404"],"pointer":"/candidates/{candidate_id}/professional_licenses","href":"professional-licenses/createprofessionallicense","openApiOperationId":"createProfessionalLicense","summary":"Create a new Professional License"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_117","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_117"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Professional License was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProfessionalLicense"}},"schemaId":"components/schemas/ProfessionalLicense"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadProfessionalLicenseCreateRequestError"}},"schemaId":"components/schemas/BadProfessionalLicenseCreateRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}},"schemaId":"components/schemas/CandidateNotFoundError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1professional_licenses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProfessionalLicense","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProfessionalLicense"}}},{"code":"400","schemaId":"components/schemas/BadProfessionalLicenseCreateRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadProfessionalLicenseCreateRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/CandidateNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/professional-licenses/createprofessionallicense"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/professional_licenses"},{"label":"List existing Professional Licenses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/professional-licenses/listofprofessionallicenses","routeSlug":"/apis/openapi/professional-licenses/listofprofessionallicenses","metadata":{"seo":{"title":"List existing Professional Licenses","description":"Returns a list of existing Professional Licenses for the given Candidate ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOfProfessionalLicenses","name":"List existing Professional Licenses","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1professional_licenses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Professional Licenses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of existing Professional Licenses for the given Candidate ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The Candidate's ID","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1professional_licenses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/candidates/{candidate_id}/professional_licenses","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/candidates/{candidate_id}/professional_licenses","href":"professional-licenses/listofprofessionallicenses","openApiOperationId":"listOfProfessionalLicenses","summary":"List existing Professional Licenses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of existing Professional Licenses for candidate","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_118"}},"schemaId":"schema_118"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}},"schemaId":"components/schemas/CandidateNotFoundError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1professional_licenses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_118","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_118"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/CandidateNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/professional-licenses/listofprofessionallicenses"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/professional_licenses"},{"label":"Delete an existing Professional License","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/professional-licenses/deleteprofessionallicenses","routeSlug":"/apis/openapi/professional-licenses/deleteprofessionallicenses","metadata":{"seo":{"title":"Delete an existing Professional License","description":"Deletes an existing Professional License"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProfessionalLicenses","name":"Delete an existing Professional License","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1professional_licenses~1{license_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an existing Professional License","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an existing Professional License\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"license_id","in":"path","schemaId":"schema_90","description":"The ID of the license to delete.","required":true},{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The Candidate's ID","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1professional_licenses~1{license_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/candidates/{candidate_id}/professional_licenses/{license_id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"license_id","in":"path","required":true,"schemaId":"schema_90"},{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/candidates/{candidate_id}/professional_licenses/{license_id}","href":"professional-licenses/deleteprofessionallicenses","openApiOperationId":"deleteProfessionalLicenses","summary":"Delete an existing Professional License"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Professional License was successfully deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_119"}},"schemaId":"schema_119"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1professional_licenses~1{license_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_119","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_119"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/professional-licenses/deleteprofessionallicenses"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/professional_licenses/{license_id}"}],"content":{"contentType":"group","meta":{"name":"Professional Licenses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Professional Licenses","showPageActions":true},{"nodeType":"markdoc","content":"The professional license resource represents a single certification or license issued to a candidate for qualification in a professional field. Candidates may have two existing professional license resources at a time."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/candidates/{candidate_id}/professional_licenses","summary":"Create a new Professional License","prefix":{"name":"post","color":"post"},"badges":[],"link":"/professional-licenses/createprofessionallicense","deprecated":false},{"title":"/candidates/{candidate_id}/professional_licenses","summary":"List existing Professional Licenses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/professional-licenses/listofprofessionallicenses","deprecated":false},{"title":"/candidates/{candidate_id}/professional_licenses/{license_id}","summary":"Delete an existing Professional License","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/professional-licenses/deleteprofessionallicenses","deprecated":false}]}]}]}]}},{"type":"group","label":"Candidate Postal Address","link":"/apis/openapi/candidate-postal-address","routeSlug":"/apis/openapi/candidate-postal-address","items":[{"label":"Get the Candidate's Postal Addresses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/candidate-postal-address/getcandidatepostaladdress","routeSlug":"/apis/openapi/candidate-postal-address/getcandidatepostaladdress","metadata":{"seo":{"title":"Get the Candidate's Postal Addresses","description":"Returns the Postal Address of a given candidate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCandidatePostalAddress","name":"Get the Candidate's Postal Addresses","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1postal_address/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the Candidate's Postal Addresses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the Postal Address of a given candidate.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1postal_address/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/candidates/{candidate_id}/postal_address","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/candidates/{candidate_id}/postal_address","href":"candidate-postal-address/getcandidatepostaladdress","openApiOperationId":"getCandidatePostalAddress","summary":"Get the Candidate's Postal Addresses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Candidate postal address","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidatePostalAddress"}},"schemaId":"components/schemas/CandidatePostalAddress"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}},"schemaId":"components/schemas/CandidateNotFoundError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1postal_address/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CandidatePostalAddress","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidatePostalAddress"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/CandidateNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidate-postal-address/getcandidatepostaladdress"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/postal_address"},{"label":"Create a new Postal Address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/candidate-postal-address/createpostaladdress","routeSlug":"/apis/openapi/candidate-postal-address/createpostaladdress","metadata":{"seo":{"title":"Create a new Postal Address","description":"Creates a new Postal Address for a given candidate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPostalAddress","name":"Create a new Postal Address","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1postal_address/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Postal Address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new Postal Address for a given candidate.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1postal_address/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_120"}},"schemaId":"schema_120","pointer":"/paths/~1candidates~1{candidate_id}~1postal_address/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/candidates/{candidate_id}/postal_address","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_120"}},"responseCodes":["200","400","401","403","404"],"pointer":"/candidates/{candidate_id}/postal_address","href":"candidate-postal-address/createpostaladdress","openApiOperationId":"createPostalAddress","summary":"Create a new Postal Address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_120","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_120"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Candidate Postal Address was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidatePostalAddress"}},"schemaId":"components/schemas/CandidatePostalAddress"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_121"}},"schemaId":"schema_121"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}},"schemaId":"components/schemas/CandidateNotFoundError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1postal_address/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CandidatePostalAddress","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidatePostalAddress"}}},{"code":"400","schemaId":"schema_121","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_121"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/CandidateNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidate-postal-address/createpostaladdress"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/postal_address"}],"content":{"contentType":"group","meta":{"name":"Candidate Postal Address"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Candidate Postal Address","showPageActions":true},{"nodeType":"markdoc","content":"The candidate postal address is the address Checkr will use to send postal mail to the candidate. Each candidate can be associated with only one postal address."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/candidates/{candidate_id}/postal_address","summary":"Get the Candidate's Postal Addresses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/candidate-postal-address/getcandidatepostaladdress","deprecated":false},{"title":"/candidates/{candidate_id}/postal_address","summary":"Create a new Postal Address","prefix":{"name":"post","color":"post"},"badges":[],"link":"/candidate-postal-address/createpostaladdress","deprecated":false}]}]}]}]}},{"type":"group","label":"SSN","link":"/apis/openapi/ssn","routeSlug":"/apis/openapi/ssn","items":[{"label":"Get a candidate's encrypted SSN","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/ssn/getcandidatessn","routeSlug":"/apis/openapi/ssn/getcandidatessn","metadata":{"seo":{"title":"Get a candidate's encrypted SSN","description":"Returns an encrypted SSN for the input candidate_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCandidateSsn","name":"Get a candidate's encrypted SSN","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1ssn/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a candidate's encrypted SSN","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an encrypted SSN for the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1ssn/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/candidates/{candidate_id}/ssn","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/candidates/{candidate_id}/ssn","href":"ssn/getcandidatessn","openApiOperationId":"getCandidateSsn","summary":"Get a candidate's encrypted SSN"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Candidate's encrypted SSN","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ssn"}},"schemaId":"components/schemas/Ssn"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Encryption key required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EncryptionKeyError"}},"schemaId":"components/schemas/EncryptionKeyError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1ssn/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ssn","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ssn"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/EncryptionKeyError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EncryptionKeyError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ssn/getcandidatessn"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/ssn"}],"content":{"contentType":"group","meta":{"name":"SSN"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SSN","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SSN resource allows you to retrieve a candidate's encrypted SSN."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Access to this endpoint requires an RSA key-pair for encryption. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/advanced-features#configuring-ssn-encryption"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuring Encryption for Candidate SSN Endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for information on how to generate encryption keys. Work with your Checkr Customer Success Manager to enable this feature for your account."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/candidates/{candidate_id}/ssn","summary":"Get a candidate's encrypted SSN","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ssn/getcandidatessn","deprecated":false}]}]}]}]}},{"type":"separator","label":"Account & Configuration","content":null},{"type":"group","label":"Account","link":"/apis/openapi/account","routeSlug":"/apis/openapi/account","items":[{"label":"Retrieve authenticated account details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/account/account","routeSlug":"/apis/openapi/account/account","metadata":{"seo":{"title":"Retrieve authenticated account details","description":"Returns Account details for the authenticated account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"account","name":"Retrieve authenticated account details","isWebhook":false,"pointer":"/paths/~1account/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve authenticated account details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns Account details for the authenticated account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/account","href":"account/account","openApiOperationId":"account","summary":"Retrieve authenticated account details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account"}},"schemaId":"components/schemas/Account"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1account/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Account","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/account"}],"panels":[]}]},"httpPath":"/account"},{"label":"Create a new Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/account/createaccount","routeSlug":"/apis/openapi/account/createaccount","metadata":{"seo":{"title":"Create a new Account","description":"Creates a customer Account associated with your Partner Application. Only Checkr Partners are authorized to use this endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAccount","name":"Create a new Account","isWebhook":false,"pointer":"/paths/~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a customer Account associated with your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/partners/introduction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner Application"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only Checkr Partners are authorized to use this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The oauth_authorize parameter allows you to determine how your customer authorizes your application to connect to Checkr and order reports."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, this parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which requires your customers to provide explicit authorization to your application to create candidates, invitations, and reports in Checkr on your customer’s behalf."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Checkr returns the authorization code in the account response. You may then use that access code in the oauth/token call to get an authorized token you can use to create reports/candidates in the customer's Checkr account."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_122"}},"schemaId":"schema_122","pointer":"/paths/~1accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accounts","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_122"}},"responseCodes":["201","401","403"],"pointer":"/accounts","href":"account/createaccount","openApiOperationId":"createAccount","summary":"Create a new Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_122","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_122"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Account details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account"}},"schemaId":"components/schemas/Account"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Account","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/createaccount"}],"panels":[]}]},"httpPath":"/accounts"}],"content":{"contentType":"group","meta":{"name":"Account"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Account resource includes account information and settings. Account information can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated from the Dashboard. Some Account settings, like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available_screenings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", can be updated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only by Checkr. Contact our Customer Success team for more information."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account","summary":"Retrieve authenticated account details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/account","deprecated":false},{"title":"/accounts","summary":"Create a new Account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account/createaccount","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/apis/openapi/users","routeSlug":"/apis/openapi/users","items":[{"label":"List existing Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/users/userslist","routeSlug":"/apis/openapi/users/userslist","metadata":{"seo":{"title":"List existing Users","description":"Returns a list of all existing Users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"usersList","name":"List existing Users","isWebhook":false,"pointer":"/paths/~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all existing Users.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_93","description":"Specifies the page number to retrieve."},{"name":"per_page","in":"query","schemaId":"schema_93","description":"Indicates how many records each page should contain. The default value is 25 records."}],"pointer":"/paths/~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_93"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/users","href":"users/userslist","openApiOperationId":"usersList","summary":"List existing Users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Users","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/userslist"}],"panels":[]}]},"httpPath":"/users"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":"The User resource includes user information and role assignments. Users can be invited and assigned roles from the Dashboard."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users","summary":"List existing Users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/userslist","deprecated":false}]}]}]}]}},{"type":"group","label":"Programs","link":"/apis/openapi/programs","routeSlug":"/apis/openapi/programs","items":[{"label":"List existing Programs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/programs/programslist","routeSlug":"/apis/openapi/programs/programslist","metadata":{"seo":{"title":"List existing Programs","description":"Returns a list of existing Programs with the input name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"programsList","name":"List existing Programs","isWebhook":false,"pointer":"/paths/~1programs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Programs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of existing Programs with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns Programs with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_93","description":"Specifies the page number to retrieve."},{"name":"per_page","in":"query","schemaId":"schema_93","description":"Indicates how many records each page should contain. The default value is 25 records."}],"pointer":"/paths/~1programs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/programs","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","schemaId":"schema_90"},{"name":"page","in":"query","required":false,"schemaId":"schema_93"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/programs","href":"programs/programslist","openApiOperationId":"programsList","summary":"List existing Programs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Programs","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_124"}},"schemaId":"schema_124"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1programs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_124","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_124"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/programs/programslist"}],"panels":[]}]},"httpPath":"/programs"},{"label":"Retrieve an existing Program","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/programs/getprogram","routeSlug":"/apis/openapi/programs/getprogram","metadata":{"seo":{"title":"Retrieve an existing Program","description":"Returns an existing Program with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProgram","name":"Retrieve an existing Program","isWebhook":false,"pointer":"/paths/~1programs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Program","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Program with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Program to retrieve.","required":true}],"pointer":"/paths/~1programs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/programs/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/programs/{id}","href":"programs/getprogram","openApiOperationId":"getProgram","summary":"Retrieve an existing Program"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Program details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Program"}},"schemaId":"components/schemas/Program"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1programs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Program","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Program"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/programs/getprogram"}],"panels":[]}]},"httpPath":"/programs/{id}"}],"content":{"contentType":"group","meta":{"name":"Programs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Programs","showPageActions":true},{"nodeType":"markdoc","content":"Represents a division of an Account. Programs are typically used to identify clients,\ncost centers, or departments. A Program may have many Geos and may have many Packages."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/programs","summary":"List existing Programs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/programs/programslist","deprecated":false},{"title":"/programs/{id}","summary":"Retrieve an existing Program","prefix":{"name":"get","color":"get"},"badges":[],"link":"/programs/getprogram","deprecated":false}]}]}]}]}},{"type":"group","label":"Hierarchy (Enabled by request)","link":"/apis/openapi/hierarchy-(enabled-by-request)","routeSlug":"/apis/openapi/hierarchy-(enabled-by-request)","items":[{"label":"Create Hierarchy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/hierarchy-(enabled-by-request)/updateaccounthierarchy","routeSlug":"/apis/openapi/hierarchy-(enabled-by-request)/updateaccounthierarchy","metadata":{"seo":{"title":"Create Hierarchy","description":"Creates a new or replaces an existing Account Hierarchy."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAccountHierarchy","name":"Create Hierarchy","isWebhook":false,"pointer":"/paths/~1hierarchy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Hierarchy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new or replaces an existing Account Hierarchy."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Hierarchy endpoint performs ingestion asynchronously. Check the status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the ingestion by calling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/hierarchy/status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once ingested, use the Checkr Dashboard to assign your nodes to Packages, PAMs, and Users."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_125"}},"schemaId":"schema_125","pointer":"/paths/~1hierarchy/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hierarchy","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_125"}},"responseCodes":["202","400","403","423"],"pointer":"/hierarchy","href":"hierarchy-(enabled-by-request)/updateaccounthierarchy","openApiOperationId":"updateAccountHierarchy","summary":"Create Hierarchy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_125","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_125"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Ingestion successfully initiated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}},"schemaId":"schema_126"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadHierarchyRequestError"}},"schemaId":"components/schemas/BadHierarchyRequestError"},{"code":"403","description":"Hierarchy not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNotEnabledError"}},"schemaId":"components/schemas/HierarchyNotEnabledError"},{"code":"423","description":"Ingestion already in progress","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IngestionInProgressError"}},"schemaId":"components/schemas/IngestionInProgressError"}],"pointer":"/paths/~1hierarchy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_126","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126"}}},{"code":"400","schemaId":"components/schemas/BadHierarchyRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadHierarchyRequestError"}}},{"code":"403","schemaId":"components/schemas/HierarchyNotEnabledError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNotEnabledError"}}},{"code":"423","schemaId":"components/schemas/IngestionInProgressError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IngestionInProgressError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hierarchy-(enabled-by-request)/updateaccounthierarchy"}],"panels":[]}]},"httpPath":"/hierarchy"},{"label":"Retrieve Hierarchy (Deprecated)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/hierarchy-(enabled-by-request)/getaccounthierarchy","routeSlug":"/apis/openapi/hierarchy-(enabled-by-request)/getaccounthierarchy","metadata":{"seo":{"title":"Retrieve Hierarchy (Deprecated)","description":"Note: This endpoint is deprecated and will no longer be supported. Please use the new List existing Nodes endpoint instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountHierarchy","name":"Retrieve Hierarchy (Deprecated)","isWebhook":false,"pointer":"/paths/~1hierarchy/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Hierarchy (Deprecated)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint is "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will no longer be supported. Please use the new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/nodes/nodeslist"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List existing Nodes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the current Hierarchy for the Account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the account hierarchy in its entirety, or from a specific node to its children. The returned JSON object will include the Packages assigned to each node in the dashboard. This is useful for building UIs that truncate the list of Packages displayed to a requester, or display only the nodes that are relevant to the requester."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output is arranged hierarchically, with child nodes accessible through the parent node. Customers without large hierarchy mode enabled who do not specify pagination parameters will be returned the entire hierarchy. Customers with large hierarchy mode enabled and pagination parameters specified in this request will be returned the given page and number of results per page. If pagination parameters are not included, only the first page of the hierarchy will be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Customers with large hierarchy mode enabled will see a different response. Please reach out to clients@checkr.com if you have any questions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"node_custom_ids","in":"query","schemaId":"schema_127","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the nodes to return. Returns the portion(s) of the Account Hierarchy matching the input nodes and their descendants."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_93","description":"Specifies the page to retrieve. The default page is 1."},{"name":"per_page","in":"query","schemaId":"schema_93","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates how many nodes each page should contain. The default per_page value is 20."},"children":[]}]}]}]}],"pointer":"/paths/~1hierarchy/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hierarchy","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"node_custom_ids","in":"query","schemaId":"schema_127"},{"name":"page","in":"query","required":false,"schemaId":"schema_93"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/hierarchy","href":"hierarchy-(enabled-by-request)/getaccounthierarchy","openApiOperationId":"getAccountHierarchy","summary":"Retrieve Hierarchy (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The hierarchy for the account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128"}},"schemaId":"schema_128"},{"code":"403","description":"Hierarchy not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNotEnabledError"}},"schemaId":"components/schemas/HierarchyNotEnabledError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNotFoundError"}},"schemaId":"components/schemas/HierarchyNotFoundError"}],"pointer":"/paths/~1hierarchy/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_128","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128"}}},{"code":"403","schemaId":"components/schemas/HierarchyNotEnabledError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNotEnabledError"}}},{"code":"404","schemaId":"components/schemas/HierarchyNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hierarchy-(enabled-by-request)/getaccounthierarchy"}],"panels":[]}]},"httpPath":"/hierarchy"},{"label":"Add nodes to a hierarchy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/hierarchy-(enabled-by-request)/createaccounthierarchynodes","routeSlug":"/apis/openapi/hierarchy-(enabled-by-request)/createaccounthierarchynodes","metadata":{"seo":{"title":"Add nodes to a hierarchy","description":"Adds new nodes to an existing Account Hierarchy."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAccountHierarchyNodes","name":"Add nodes to a hierarchy","isWebhook":false,"pointer":"/paths/~1hierarchy~1nodes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add nodes to a hierarchy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds new nodes to an existing Account Hierarchy.\n\nThis endpoint creates the nodes synchronously.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_125"}},"schemaId":"schema_125","pointer":"/paths/~1hierarchy~1nodes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hierarchy/nodes","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_125"}},"responseCodes":["201","400","403","423"],"pointer":"/hierarchy/nodes","href":"hierarchy-(enabled-by-request)/createaccounthierarchynodes","openApiOperationId":"createAccountHierarchyNodes","summary":"Add nodes to a hierarchy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_125","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_125"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Nodes were successfully added to the hierarchy","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129"}},"schemaId":"schema_129"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadHierarchyRequestError"}},"schemaId":"components/schemas/BadHierarchyRequestError"},{"code":"403","description":"Hierarchy not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNotEnabledError"}},"schemaId":"components/schemas/HierarchyNotEnabledError"},{"code":"423","description":"Ingestion already in progress","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IngestionInProgressError"}},"schemaId":"components/schemas/IngestionInProgressError"}],"pointer":"/paths/~1hierarchy~1nodes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_129","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_129"}}},{"code":"400","schemaId":"components/schemas/BadHierarchyRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadHierarchyRequestError"}}},{"code":"403","schemaId":"components/schemas/HierarchyNotEnabledError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNotEnabledError"}}},{"code":"423","schemaId":"components/schemas/IngestionInProgressError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IngestionInProgressError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hierarchy-(enabled-by-request)/createaccounthierarchynodes"}],"panels":[]}]},"httpPath":"/hierarchy/nodes"},{"label":"Retrieve Hierarchy update status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/hierarchy-(enabled-by-request)/getaccounthierarchystatus","routeSlug":"/apis/openapi/hierarchy-(enabled-by-request)/getaccounthierarchystatus","metadata":{"seo":{"title":"Retrieve Hierarchy update status","description":"Returns the status of the latest Hierarchy ingestion request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountHierarchyStatus","name":"Retrieve Hierarchy update status","isWebhook":false,"pointer":"/paths/~1hierarchy~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Hierarchy update status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the status of the latest Hierarchy ingestion request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call requires no input, and is provided as a means to determine the progress of an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"asynchronous "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /hierarchy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hierarchy/status","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/hierarchy/status","href":"hierarchy-(enabled-by-request)/getaccounthierarchystatus","openApiOperationId":"getAccountHierarchyStatus","summary":"Retrieve Hierarchy update status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The current status of hierarchy ingestion.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_130"}},"schemaId":"schema_130"},{"code":"403","description":"Hierarchy not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNotEnabledError"}},"schemaId":"components/schemas/HierarchyNotEnabledError"}],"pointer":"/paths/~1hierarchy~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_130","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_130"}}},{"code":"403","schemaId":"components/schemas/HierarchyNotEnabledError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNotEnabledError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hierarchy-(enabled-by-request)/getaccounthierarchystatus"}],"panels":[]}]},"httpPath":"/hierarchy/status"}],"content":{"contentType":"group","meta":{"name":"Hierarchy (Enabled by request)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Hierarchy (Enabled by request)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Hierarchy endpoint to structure your Account as a grouping of individual entities (Nodes) that represent your business with respect to your hiring and background check needs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parent-child relationship of Nodes may then be used to manage the relationship of your Packages and other account settings to Users and Candidates within your Account. Once defined, use the Checkr Dashboard to assign Nodes to Users, Packages, your Positive Adjudication Matrix, and other aspects of your Checkr Account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifying a unique ID (custom_id) for each Node in the hierarchy allows you to edit the structure of your hierarchy without dissociating any Packages, PAMs, or Users assigned directly to the individual nodes. As nodes are moved to different locations within the hierarchy they will inherit Packages or PAMs from their new parent that may differ from the last, but Packages assigned directly to the node will not change."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hierarchy","summary":"Create Hierarchy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/hierarchy-(enabled-by-request)/updateaccounthierarchy","deprecated":false},{"title":"/hierarchy","summary":"Retrieve Hierarchy (Deprecated)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hierarchy-(enabled-by-request)/getaccounthierarchy","deprecated":false},{"title":"/hierarchy/nodes","summary":"Add nodes to a hierarchy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/hierarchy-(enabled-by-request)/createaccounthierarchynodes","deprecated":false},{"title":"/hierarchy/status","summary":"Retrieve Hierarchy update status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hierarchy-(enabled-by-request)/getaccounthierarchystatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Geos","link":"/apis/openapi/geos","routeSlug":"/apis/openapi/geos","items":[{"label":"Create a new Geo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/geos/creategeo","routeSlug":"/apis/openapi/geos/creategeo","metadata":{"seo":{"title":"Create a new Geo","description":"Creates a new Geo resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGeo","name":"Create a new Geo","isWebhook":false,"pointer":"/paths/~1geos/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Geo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Geo resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attempting to create a new Geo with the same name/state combination will result in an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"409 error"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_131"}},"schemaId":"schema_131","pointer":"/paths/~1geos/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/geos","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_131"}},"responseCodes":["201","400","401","403","409"],"pointer":"/geos","href":"geos/creategeo","openApiOperationId":"createGeo","summary":"Create a new Geo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_131","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_131"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Geo was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geo"}},"schemaId":"components/schemas/Geo"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"409","description":"Duplicate geo","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DuplicateGeoError"}},"schemaId":"components/schemas/DuplicateGeoError"}],"pointer":"/paths/~1geos/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Geo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geo"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"409","schemaId":"components/schemas/DuplicateGeoError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DuplicateGeoError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/geos/creategeo"}],"panels":[]}]},"httpPath":"/geos"},{"label":"List existing Geos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/geos/geoslist","routeSlug":"/apis/openapi/geos/geoslist","metadata":{"seo":{"title":"List existing Geos","description":"Returns a list of existing Geos with the input name or state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"geosList","name":"List existing Geos","isWebhook":false,"pointer":"/paths/~1geos/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Geos","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of existing Geos with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all Geos with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"state","in":"query","schemaId":"schema_90","description":"Returns all Geos with the input state."},{"name":"page","in":"query","schemaId":"schema_93","description":"Specifies the page number to retrieve."},{"name":"per_page","in":"query","schemaId":"schema_93","description":"Indicates how many records each page should contain. The default value is 25 records."}],"pointer":"/paths/~1geos/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/geos","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","schemaId":"schema_90"},{"name":"state","in":"query","schemaId":"schema_90"},{"name":"page","in":"query","required":false,"schemaId":"schema_93"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/geos","href":"geos/geoslist","openApiOperationId":"geosList","summary":"List existing Geos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Geos","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}},"schemaId":"schema_132"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1geos/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_132","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/geos/geoslist"}],"panels":[]}]},"httpPath":"/geos"},{"label":"Retrieve an existing Geo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/geos/getgeo","routeSlug":"/apis/openapi/geos/getgeo","metadata":{"seo":{"title":"Retrieve an existing Geo","description":"Returns an existing Geo with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGeo","name":"Retrieve an existing Geo","isWebhook":false,"pointer":"/paths/~1geos~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Geo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Geo with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Geo.","required":true}],"pointer":"/paths/~1geos~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/geos/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/geos/{id}","href":"geos/getgeo","openApiOperationId":"getGeo","summary":"Retrieve an existing Geo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Geo details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geo"}},"schemaId":"components/schemas/Geo"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1geos~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Geo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geo"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/geos/getgeo"}],"panels":[]}]},"httpPath":"/geos/{id}"},{"label":"Delete an existing Geo","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/geos/deletegeo","routeSlug":"/apis/openapi/geos/deletegeo","metadata":{"seo":{"title":"Delete an existing Geo","description":"Deletes an existing Geo."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGeo","name":"Delete an existing Geo","isWebhook":false,"pointer":"/paths/~1geos~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an existing Geo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an existing Geo.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Geo.","required":true}],"pointer":"/paths/~1geos~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/geos/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","400","401","403","409"],"pointer":"/geos/{id}","href":"geos/deletegeo","openApiOperationId":"deleteGeo","summary":"Delete an existing Geo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Geo was successfully deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geo"}},"schemaId":"components/schemas/Geo"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"409","description":"Geo used","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UsedGeoError"}},"schemaId":"components/schemas/UsedGeoError"}],"pointer":"/paths/~1geos~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"components/schemas/Geo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geo"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"409","schemaId":"components/schemas/UsedGeoError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UsedGeoError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/geos/deletegeo"}],"panels":[]}]},"httpPath":"/geos/{id}"},{"label":"Update an existing Geo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/geos/updategeo","routeSlug":"/apis/openapi/geos/updategeo","metadata":{"seo":{"title":"Update an existing Geo","description":"Updates an existing Geo resource with the input city.city can only be added once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGeo","name":"Update an existing Geo","isWebhook":false,"pointer":"/paths/~1geos~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing Geo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing Geo resource with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only be added once."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Geo.","required":true}],"pointer":"/paths/~1geos~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_133"}},"schemaId":"schema_133","pointer":"/paths/~1geos~1{id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/geos/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_133"}},"responseCodes":["200","400","401","403","409"],"pointer":"/geos/{id}","href":"geos/updategeo","openApiOperationId":"updateGeo","summary":"Update an existing Geo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_133","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_133"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Geo was successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geo"}},"schemaId":"components/schemas/Geo"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"409","description":"Geo city updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GeoCityUpdatedError"}},"schemaId":"components/schemas/GeoCityUpdatedError"}],"pointer":"/paths/~1geos~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Geo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geo"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"409","schemaId":"components/schemas/GeoCityUpdatedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GeoCityUpdatedError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/geos/updategeo"}],"panels":[]}]},"httpPath":"/geos/{id}"}],"content":{"contentType":"group","meta":{"name":"Geos"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Geos","showPageActions":true},{"nodeType":"markdoc","content":"Represents a candidate geography."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/geos","summary":"Create a new Geo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/geos/creategeo","deprecated":false},{"title":"/geos","summary":"List existing Geos","prefix":{"name":"get","color":"get"},"badges":[],"link":"/geos/geoslist","deprecated":false},{"title":"/geos/{id}","summary":"Retrieve an existing Geo","prefix":{"name":"get","color":"get"},"badges":[],"link":"/geos/getgeo","deprecated":false},{"title":"/geos/{id}","summary":"Delete an existing Geo","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/geos/deletegeo","deprecated":false},{"title":"/geos/{id}","summary":"Update an existing Geo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/geos/updategeo","deprecated":false}]}]}]}]}},{"type":"group","label":"Nodes","link":"/apis/openapi/nodes","routeSlug":"/apis/openapi/nodes","items":[{"label":"List existing Nodes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/nodes/nodeslist","routeSlug":"/apis/openapi/nodes/nodeslist","metadata":{"seo":{"title":"List existing Nodes","description":"Returns a list of existing Nodes that make up the current Account Hierarchy."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"nodesList","name":"List existing Nodes","isWebhook":false,"pointer":"/paths/~1nodes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Nodes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of existing Nodes that make up the current Account Hierarchy."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=packages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, each Node object in the response will include a \"packages\" field. This will be an array of strings representing the slugs of the account Packages that are assigned (directly or indirectly) to the given Node. This field can be used to build UIs that truncate the list of Packages displayed to a requester, or to display only the nodes that are relevant to the requester."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=packages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not passed, no package information will be included in the response."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint uses pagination; please see the corresponding "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#pagination"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reference page"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_134","description":"Includes a \"packages\" array with each Node object, containing a list of slugs for packages that are assigned to that node or its ancestors.","example":"packages"},{"name":"page","in":"query","schemaId":"schema_93","description":"Specifies the page number to retrieve."},{"name":"per_page","in":"query","schemaId":"schema_93","description":"Indicates how many records each page should contain. The default value is 25 records."},{"name":"order_by","in":"query","schemaId":"schema_135","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns records sorted by custom_id or created_at. If neither is specified, records will be sorted by created_at."},"children":[]}]}]}],"example":"custom_id"},{"name":"order","in":"query","schemaId":"schema_136","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns records arranged in order as specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. If neither is specified, records will be listed in ascending order."},"children":[]}]}]}],"example":"desc"}],"pointer":"/paths/~1nodes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/nodes","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","required":false,"example":"packages","schemaId":"schema_134"},{"name":"page","in":"query","required":false,"schemaId":"schema_93"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_93"},{"name":"order_by","in":"query","required":false,"example":"custom_id","schemaId":"schema_135"},{"name":"order","in":"query","required":false,"example":"desc","schemaId":"schema_136"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/nodes","href":"nodes/nodeslist","openApiOperationId":"nodesList","summary":"List existing Nodes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Nodes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_137"}},"schemaId":"schema_137"},{"code":"403","description":"Hierarchy not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNotEnabledError"}},"schemaId":"components/schemas/HierarchyNotEnabledError"}],"pointer":"/paths/~1nodes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_137","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_137"}}},{"code":"403","schemaId":"components/schemas/HierarchyNotEnabledError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNotEnabledError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/nodes/nodeslist"}],"panels":[]}]},"httpPath":"/nodes"},{"label":"Retrieve an existing node","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/nodes/getnode","routeSlug":"/apis/openapi/nodes/getnode","metadata":{"seo":{"title":"Retrieve an existing node","description":"Returns an existing node by custom_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNode","name":"Retrieve an existing node","isWebhook":false,"pointer":"/paths/~1nodes~1{custom_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an existing node by custom_id."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=packages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed, the response will include a \"packages\" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will be an array of strings representing the slugs of the account"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Packages that are assigned (directly or indirectly) to the given Node. This field can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used to build UIs that truncate the list of Packages displayed to a requester, or to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"display only the nodes that are relevant to the requester."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=packages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not passed, no package information will be included in the response."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom_id","in":"path","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom_id of the Node."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1nodes~1{custom_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_134","description":"Includes a \"packages\" array with each Node object, containing a list of slugs for packages that are assigned to that node or its ancestors.","example":"packages"}],"pointer":"/paths/~1nodes~1{custom_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/nodes/{custom_id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"custom_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[{"name":"include","in":"query","required":false,"example":"packages","schemaId":"schema_134"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/nodes/{custom_id}","href":"nodes/getnode","openApiOperationId":"getNode","summary":"Retrieve an existing node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Node","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNode"}},"schemaId":"components/schemas/HierarchyNode"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1nodes~1{custom_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/HierarchyNode","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNode"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/nodes/getnode"}],"panels":[]}]},"httpPath":"/nodes/{custom_id}"},{"label":"Update an existing node","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/nodes/updatenode","routeSlug":"/apis/openapi/nodes/updatenode","metadata":{"seo":{"title":"Update an existing node","description":"Updates the name and tier on an existing node by custom_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateNode","name":"Update an existing node","isWebhook":false,"pointer":"/paths/~1nodes~1{custom_id}/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the name and tier on an existing node by custom_id."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom_id","in":"path","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom_id of the Node."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1nodes~1{custom_id}/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/nodes/{custom_id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"custom_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/nodes/{custom_id}","href":"nodes/updatenode","openApiOperationId":"updateNode","summary":"Update an existing node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Node","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNode"}},"schemaId":"components/schemas/HierarchyNode"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1nodes~1{custom_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/HierarchyNode","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNode"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/nodes/updatenode"}],"panels":[]}]},"httpPath":"/nodes/{custom_id}"},{"label":"Delete an existing node","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/nodes/deletenode","routeSlug":"/apis/openapi/nodes/deletenode","metadata":{"seo":{"title":"Delete an existing node","description":"Deletes an existing node by custom_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteNode","name":"Delete an existing node","isWebhook":false,"pointer":"/paths/~1nodes~1{custom_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an existing node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an existing node by custom_id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parent nodes and nodes assigned to continuous check subscriptions or legacy"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriptions cannot be deleted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom_id","in":"path","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom_id of the Node."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1nodes~1{custom_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/nodes/{custom_id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"custom_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/nodes/{custom_id}","href":"nodes/deletenode","openApiOperationId":"deleteNode","summary":"Delete an existing node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Node","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNode"}},"schemaId":"components/schemas/HierarchyNode"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1nodes~1{custom_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/HierarchyNode","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HierarchyNode"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/nodes/deletenode"}],"panels":[]}]},"httpPath":"/nodes/{custom_id}"}],"content":{"contentType":"group","meta":{"name":"Nodes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Nodes","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nodes are the individual entities that comprise an Account Hierarchy. If hierarchy is enabled for your Checkr Account, this endpoint may be used to retrieve a list of all Account Nodes. To create Nodes, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/hierarchy-(enabled-by-request)/updateaccounthierarchy"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/nodes","summary":"List existing Nodes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/nodes/nodeslist","deprecated":false},{"title":"/nodes/{custom_id}","summary":"Retrieve an existing node","prefix":{"name":"get","color":"get"},"badges":[],"link":"/nodes/getnode","deprecated":false},{"title":"/nodes/{custom_id}","summary":"Update an existing node","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/nodes/updatenode","deprecated":false},{"title":"/nodes/{custom_id}","summary":"Delete an existing node","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/nodes/deletenode","deprecated":false}]}]}]}]}},{"type":"group","label":"Counties","link":"/apis/openapi/counties","routeSlug":"/apis/openapi/counties","items":[{"label":"Get Counties by State(s)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/counties/getcounties","routeSlug":"/apis/openapi/counties/getcounties","metadata":{"seo":{"title":"Get Counties by State(s)","description":"Returns a list of all counties for the input state(s). If no state is provided with the query, returns a list of all counties in the United States."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCounties","name":"Get Counties by State(s)","isWebhook":false,"pointer":"/paths/~1counties/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Counties by State(s)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all counties for the input state(s). If no state is provided with the query, returns a list of all counties in the United States.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"states","in":"query","schemaId":"schema_90","description":"A comma-separated list of states' Federal Information Processing Series (FIPS) values to query."}],"pointer":"/paths/~1counties/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/counties","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"states","in":"query","required":false,"schemaId":"schema_90"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/counties","href":"counties/getcounties","openApiOperationId":"getCounties","summary":"Get Counties by State(s)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Counties by State","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}},"schemaId":"schema_138"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"}],"pointer":"/paths/~1counties/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_138","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/counties/getcounties"}],"panels":[]}]},"httpPath":"/counties"}],"content":{"contentType":"group","meta":{"name":"Counties"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Counties","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Counties resource provides a list of all counties within the United States."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the returned list to validate the counties submitted by your candidates during the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/reports/createreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Self Disclosure"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" process."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/counties","summary":"Get Counties by State(s)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/counties/getcounties","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/apis/openapi/webhooks","routeSlug":"/apis/openapi/webhooks","items":[{"label":"Create a new Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/webhooks/createwebhook","routeSlug":"/apis/openapi/webhooks/createwebhook","metadata":{"seo":{"title":"Create a new Webhook","description":"Creates a new Webhook resource. An account can have a maximum of 2 webhooks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhook","name":"Create a new Webhook","isWebhook":false,"pointer":"/paths/~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Webhook resource. An account can have a maximum of 2 webhooks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any webhook URL that fails to accept with a 2XX status code at least one request over a period of 60 days will be removed automatically - e.g. webhooks failing for 100% of the requests during 60 or more days."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_139"}},"schemaId":"schema_139","pointer":"/paths/~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhooks","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_139"}},"responseCodes":["201","400","401","403"],"pointer":"/webhooks","href":"webhooks/createwebhook","openApiOperationId":"createWebhook","summary":"Create a new Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_139","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_139"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Webhook details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook"}},"schemaId":"components/schemas/Webhook"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_140"}},"schemaId":"schema_140"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Webhook","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook"}}},{"code":"400","schemaId":"schema_140","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_140"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/createwebhook"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"List existing Webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/webhooks/webhookslist","routeSlug":"/apis/openapi/webhooks/webhookslist","metadata":{"seo":{"title":"List existing Webhooks","description":"Returns a list of existing Webhooks"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhooksList","name":"List existing Webhooks","isWebhook":false,"pointer":"/paths/~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of existing Webhooks\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/webhooks","href":"webhooks/webhookslist","openApiOperationId":"webhooksList","summary":"List existing Webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Webhooks","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_141"}},"schemaId":"schema_141"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_141","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_141"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhookslist"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"Retrieve a Webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/webhooks/getwebhook","routeSlug":"/apis/openapi/webhooks/getwebhook","metadata":{"seo":{"title":"Retrieve a Webhook","description":"Returns the existing Webhook corresponding to the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhook","name":"Retrieve a Webhook","isWebhook":false,"pointer":"/paths/~1webhooks~1${id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the existing Webhook corresponding to the input ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Webhook.","required":true}],"pointer":"/paths/~1webhooks~1${id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks/${id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/webhooks/${id}","href":"webhooks/getwebhook","openApiOperationId":"getWebhook","summary":"Retrieve a Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook"}},"schemaId":"components/schemas/Webhook"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1webhooks~1${id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Webhook","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/getwebhook"}],"panels":[]}]},"httpPath":"/webhooks/${id}"},{"label":"Delete a Webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/webhooks/deletewebhook","routeSlug":"/apis/openapi/webhooks/deletewebhook","metadata":{"seo":{"title":"Delete a Webhook","description":"Deletes the existing Webhook corresponding to the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhook","name":"Delete a Webhook","isWebhook":false,"pointer":"/paths/~1webhooks~1${id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the existing Webhook corresponding to the input ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Webhook.","required":true}],"pointer":"/paths/~1webhooks~1${id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/webhooks/${id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/webhooks/${id}","href":"webhooks/deletewebhook","openApiOperationId":"deleteWebhook","summary":"Delete a Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook was successfully deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookDelete"}},"schemaId":"components/schemas/WebhookDelete"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1webhooks~1${id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookDelete","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookDelete"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/deletewebhook"}],"panels":[]}]},"httpPath":"/webhooks/${id}"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use webhooks to receive updates on objects created with the API and to kick off additional workflows based on these events. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/#section/Webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/webhooks","summary":"Create a new Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/createwebhook","deprecated":false},{"title":"/webhooks","summary":"List existing Webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/webhookslist","deprecated":false},{"title":"/webhooks/${id}","summary":"Retrieve a Webhook","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getwebhook","deprecated":false},{"title":"/webhooks/${id}","summary":"Delete a Webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deletewebhook","deprecated":false}]}]}]}]}},{"type":"group","label":"Report Tags","link":"/apis/openapi/report-tags","routeSlug":"/apis/openapi/report-tags","items":[{"label":"Add a tag to a Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/report-tags/addtagtoreport","routeSlug":"/apis/openapi/report-tags/addtagtoreport","metadata":{"seo":{"title":"Add a tag to a Report","description":"This request is used to add a tag to a Report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addTagToReport","name":"Add a tag to a Report","isWebhook":false,"pointer":"/paths/~1reports~1{id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a tag to a Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This request is used to add a tag to a Report."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Note: "},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"tag"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" value passed to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST /v1/reports/{id}/tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" will match the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"name"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" field in the response."},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Report's ID.","required":true}],"pointer":"/paths/~1reports~1{id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_93","description":"Specifies the page number to retrieve."},{"name":"per_page","in":"query","schemaId":"schema_93","description":"Indicates how many records each page should contain. The default value is 25 records."}],"pointer":"/paths/~1reports~1{id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_142"}},"schemaId":"schema_142","pointer":"/paths/~1reports~1{id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/reports/{id}/tags","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_93"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_142"}},"responseCodes":["200","400","401","403"],"pointer":"/reports/{id}/tags","href":"report-tags/addtagtoreport","openApiOperationId":"addTagToReport","summary":"Add a tag to a Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_142","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_142"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report tag was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}},"schemaId":"schema_143"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1reports~1{id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_143","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_143"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-tags/addtagtoreport"}],"panels":[]}]},"httpPath":"/reports/{id}/tags"},{"label":"Update tags for a Report","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/report-tags/updatetagsforreport","routeSlug":"/apis/openapi/report-tags/updatetagsforreport","metadata":{"seo":{"title":"Update tags for a Report","description":"This request is used to define all tags for a Report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTagsForReport","name":"Update tags for a Report","isWebhook":false,"pointer":"/paths/~1reports~1{id}~1tags/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update tags for a Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This request is used to define all tags for a Report.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Report's ID.","required":true}],"pointer":"/paths/~1reports~1{id}~1tags/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_144"}},"schemaId":"schema_144","pointer":"/paths/~1reports~1{id}~1tags/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/reports/{id}/tags","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_144"}},"responseCodes":["200","400","401","403"],"pointer":"/reports/{id}/tags","href":"report-tags/updatetagsforreport","openApiOperationId":"updateTagsForReport","summary":"Update tags for a Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_144","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_144"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report tags were successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_145"}},"schemaId":"schema_145"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1reports~1{id}~1tags/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_145","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_145"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-tags/updatetagsforreport"}],"panels":[]}]},"httpPath":"/reports/{id}/tags"},{"label":"Retrieve tags for a Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/report-tags/gettagsforreport","routeSlug":"/apis/openapi/report-tags/gettagsforreport","metadata":{"seo":{"title":"Retrieve tags for a Report","description":"Retrieves tags for the input Report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTagsForReport","name":"Retrieve tags for a Report","isWebhook":false,"pointer":"/paths/~1reports~1{id}~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve tags for a Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves tags for the input Report.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Report's ID.","required":true}],"pointer":"/paths/~1reports~1{id}~1tags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{id}/tags","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/reports/{id}/tags","href":"report-tags/gettagsforreport","openApiOperationId":"getTagsForReport","summary":"Retrieve tags for a Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of report tags.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportTags"}},"schemaId":"components/schemas/ReportTags"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1reports~1{id}~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportTags","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportTags"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-tags/gettagsforreport"}],"panels":[]}]},"httpPath":"/reports/{id}/tags"},{"label":"Delete a tag from a Report","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/report-tags/deletetagfromreport","routeSlug":"/apis/openapi/report-tags/deletetagfromreport","metadata":{"seo":{"title":"Delete a tag from a Report","description":"This request is used to delete a tag from a Report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTagFromReport","name":"Delete a tag from a Report","isWebhook":false,"pointer":"/paths/~1reports~1{id}~1tags/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a tag from a Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This request is used to delete a tag from a Report.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Report's ID.","required":true}],"pointer":"/paths/~1reports~1{id}~1tags/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_146"}},"schemaId":"schema_146","pointer":"/paths/~1reports~1{id}~1tags/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/reports/{id}/tags","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_146"}},"responseCodes":["200","400","401","403"],"pointer":"/reports/{id}/tags","href":"report-tags/deletetagfromreport","openApiOperationId":"deleteTagFromReport","summary":"Delete a tag from a Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_146","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_146"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report tags were successfully deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_147"}},"schemaId":"schema_147"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1reports~1{id}~1tags/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_147","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_147"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-tags/deletetagfromreport"}],"panels":[]}]},"httpPath":"/reports/{id}/tags"}],"content":{"contentType":"group","meta":{"name":"Report Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Tags","showPageActions":true},{"nodeType":"markdoc","content":"Report Tags are defined by customers, and may be used to search Reports."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/reports/{id}/tags","summary":"Add a tag to a Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/report-tags/addtagtoreport","deprecated":false},{"title":"/reports/{id}/tags","summary":"Update tags for a Report","prefix":{"name":"put","color":"put"},"badges":[],"link":"/report-tags/updatetagsforreport","deprecated":false},{"title":"/reports/{id}/tags","summary":"Retrieve tags for a Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-tags/gettagsforreport","deprecated":false},{"title":"/reports/{id}/tags","summary":"Delete a tag from a Report","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/report-tags/deletetagfromreport","deprecated":false}]}]}]}]}},{"type":"group","label":"Report Addresses","link":"/apis/openapi/report-addresses","routeSlug":"/apis/openapi/report-addresses","items":[{"label":"List existing Report addresses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/report-addresses/addresseslistbyreport","routeSlug":"/apis/openapi/report-addresses/addresseslistbyreport","metadata":{"seo":{"title":"List existing Report addresses","description":"This request is used to retrieve addresses for a given Report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addressesListByReport","name":"List existing Report addresses","isWebhook":false,"pointer":"/paths/~1reports~1{report_id}~1addresses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Report addresses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This request is used to retrieve addresses for a given Report."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of Report addresses for the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1reports~1{report_id}~1addresses/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_93","description":"Specifies the page number to retrieve."},{"name":"per_page","in":"query","schemaId":"schema_93","description":"Indicates how many records each page should contain. The default value is 25 records."}],"pointer":"/paths/~1reports~1{report_id}~1addresses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{report_id}/addresses","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_93"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/reports/{report_id}/addresses","href":"report-addresses/addresseslistbyreport","openApiOperationId":"addressesListByReport","summary":"List existing Report addresses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Report addresses","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_148"}},"schemaId":"schema_148"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1reports~1{report_id}~1addresses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_148","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_148"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-addresses/addresseslistbyreport"}],"panels":[]}]},"httpPath":"/reports/{report_id}/addresses"}],"content":{"contentType":"group","meta":{"name":"Report Addresses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Addresses","showPageActions":true},{"nodeType":"markdoc","content":"Represents candidate reported addresses on a Report."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/reports/{report_id}/addresses","summary":"List existing Report addresses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-addresses/addresseslistbyreport","deprecated":false}]}]}]}]}},{"type":"group","label":"Report ETA","link":"/apis/openapi/report-eta","routeSlug":"/apis/openapi/report-eta","items":[{"label":"Retrieve a Report's ETA","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/report-eta/requestreporteta","routeSlug":"/apis/openapi/report-eta/requestreporteta","metadata":{"seo":{"title":"Retrieve a Report's ETA","description":"Returns an existing Report ETA for the input Report ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"requestReportETA","name":"Retrieve a Report's ETA","isWebhook":false,"pointer":"/paths/~1reports~1{id}~1eta/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Report's ETA","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Report ETA for the input Report ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Report for which the ETA was generated.","required":true}],"pointer":"/paths/~1reports~1{id}~1eta/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{id}/eta","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/reports/{id}/eta","href":"report-eta/requestreporteta","openApiOperationId":"requestReportETA","summary":"Retrieve a Report's ETA"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report ETA","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportETA"}},"schemaId":"components/schemas/ReportETA"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PredictionUnavailable"}},"schemaId":"components/schemas/PredictionUnavailable"}],"pointer":"/paths/~1reports~1{id}~1eta/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportETA","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportETA"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/PredictionUnavailable","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PredictionUnavailable"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-eta/requestreporteta"}],"panels":[]}]},"httpPath":"/reports/{id}/eta"}],"content":{"contentType":"group","meta":{"name":"Report ETA"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report ETA","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report ETAs predict when screenings will complete for each background check report. This ETA provides a date for the estimated completion of a specific report, helping both you and your candidates plan ahead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While the predictions are highly accurate, they are not a guarantee. Some county-level searches are subject to unpredictable timelines, due to manual search processes and court availability. For more information on these searches, please see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360001686627"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"County Criminal Record Search"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Checkr Help Center."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"90% of reports will complete within one business day of the estimated date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For those reports which do not complete within the initial estimate, Checkr will re-generate the ETA using the current information available for the remaining screenings. A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/webhooks#report-events"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report.updated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook will be issued for both the initial and each subsequent ETA."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360025682094"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checkr ETA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/reports/{id}/eta","summary":"Retrieve a Report's ETA","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-eta/requestreporteta","deprecated":false}]}]}]}]}},{"type":"separator","label":"Adverse Action","content":null},{"type":"group","label":"Adverse Actions","link":"/apis/openapi/adverse-actions","routeSlug":"/apis/openapi/adverse-actions","items":[{"label":"Retrieve an existing Adverse Action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/adverse-actions/getadverseaction","routeSlug":"/apis/openapi/adverse-actions/getadverseaction","metadata":{"seo":{"title":"Retrieve an existing Adverse Action","description":"Returns an existing Adverse Action with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAdverseAction","name":"Retrieve an existing Adverse Action","isWebhook":false,"pointer":"/paths/~1adverse_actions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Adverse Action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Adverse Action with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Adverse Action.","required":true}],"pointer":"/paths/~1adverse_actions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/adverse_actions/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/adverse_actions/{id}","href":"adverse-actions/getadverseaction","openApiOperationId":"getAdverseAction","summary":"Retrieve an existing Adverse Action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Adverse Action details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdverseAction"}},"schemaId":"components/schemas/AdverseAction"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1adverse_actions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AdverseAction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdverseAction"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/adverse-actions/getadverseaction"}],"panels":[]}]},"httpPath":"/adverse_actions/{id}"},{"label":"Cancel an existing Adverse Action","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/adverse-actions/canceladverseaction","routeSlug":"/apis/openapi/adverse-actions/canceladverseaction","metadata":{"seo":{"title":"Cancel an existing Adverse Action","description":"Cancels an existing Adverse Action."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelAdverseAction","name":"Cancel an existing Adverse Action","isWebhook":false,"pointer":"/paths/~1adverse_actions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an existing Adverse Action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels an existing Adverse Action.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Adverse Action.","required":true}],"pointer":"/paths/~1adverse_actions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/adverse_actions/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/adverse_actions/{id}","href":"adverse-actions/canceladverseaction","openApiOperationId":"cancelAdverseAction","summary":"Cancel an existing Adverse Action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Adverse Action was successfully canceled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdverseAction"}},"schemaId":"components/schemas/AdverseAction"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1adverse_actions~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AdverseAction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdverseAction"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/adverse-actions/canceladverseaction"}],"panels":[]}]},"httpPath":"/adverse_actions/{id}"},{"label":"List Adverse Actions for a Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/adverse-actions/listadverseactionsbyreport","routeSlug":"/apis/openapi/adverse-actions/listadverseactionsbyreport","metadata":{"seo":{"title":"List Adverse Actions for a Report","description":"Returns a list of Adverse Actions associated with the specified Report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAdverseActionsByReport","name":"List Adverse Actions for a Report","isWebhook":false,"pointer":"/paths/~1reports~1{report_id}~1adverse_actions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Adverse Actions for a Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of Adverse Actions associated with the specified Report.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_90","description":"The ID of the Report.","required":true}],"pointer":"/paths/~1reports~1{report_id}~1adverse_actions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"context","in":"query","schemaId":"schema_149","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter Adverse Actions with the matching context value: a customizable, semi-unique scoping identifier. If omitted, Adverse Actions with any context (including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") will be included in the results."},"children":[]}]}]}],"example":"context-1"}],"pointer":"/paths/~1reports~1{report_id}~1adverse_actions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{report_id}/adverse_actions","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[{"name":"context","in":"query","required":false,"example":"context-1","schemaId":"schema_149"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/reports/{report_id}/adverse_actions","href":"adverse-actions/listadverseactionsbyreport","openApiOperationId":"listAdverseActionsByReport","summary":"List Adverse Actions for a Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Adverse Actions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_150","exampleIds":["paths/~1reports~1{report_id}~1adverse_actions/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"schema_150","exampleIds":["paths/~1reports~1{report_id}~1adverse_actions/get/responses/200/content/application~1json/examples/default"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1reports~1{report_id}~1adverse_actions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_150","exampleIds":["paths/~1reports~1{report_id}~1adverse_actions/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_150","exampleIds":["paths/~1reports~1{report_id}~1adverse_actions/get/responses/200/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/adverse-actions/listadverseactionsbyreport"}],"panels":[]}]},"httpPath":"/reports/{report_id}/adverse_actions"},{"label":"Create a new Adverse Action","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/adverse-actions/createadverseaction","routeSlug":"/apis/openapi/adverse-actions/createadverseaction","metadata":{"seo":{"title":"Create a new Adverse Action","description":"Creates a new Adverse Action."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAdverseAction","name":"Create a new Adverse Action","isWebhook":false,"pointer":"/paths/~1reports~1{report_id}~1adverse_actions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Adverse Action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Adverse Action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report must be in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status and cannot have any existing Adverse Actions that have not been canceled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_90","description":"The ID of the Report for which the Adverse Action will be created.","required":true}],"pointer":"/paths/~1reports~1{report_id}~1adverse_actions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_151"}},"schemaId":"schema_151","pointer":"/paths/~1reports~1{report_id}~1adverse_actions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/reports/{report_id}/adverse_actions","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_151"}},"responseCodes":["200","400","401","403"],"pointer":"/reports/{report_id}/adverse_actions","href":"adverse-actions/createadverseaction","openApiOperationId":"createAdverseAction","summary":"Create a new Adverse Action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_151","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_151"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Adverse Action was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdverseAction"}},"schemaId":"components/schemas/AdverseAction"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1reports~1{report_id}~1adverse_actions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AdverseAction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AdverseAction"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/adverse-actions/createadverseaction"}],"panels":[]}]},"httpPath":"/reports/{report_id}/adverse_actions"}],"content":{"contentType":"group","meta":{"name":"Adverse Actions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adverse Actions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adverse Actions are initiated by Checkr customers if something is returned on a Candidate’s"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report that requires further investigation. When an Adverse Action is initiated, the candidate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must be informed, and given time to address the issues raised."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"National and local laws control the Adverse Action process and define the sequence and timing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with which it must process. Please work with your legal council to ensure that your process is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"compliant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/216873808"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Adverse Actions Process"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/adverse_actions/{id}","summary":"Retrieve an existing Adverse Action","prefix":{"name":"get","color":"get"},"badges":[],"link":"/adverse-actions/getadverseaction","deprecated":false},{"title":"/adverse_actions/{id}","summary":"Cancel an existing Adverse Action","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/adverse-actions/canceladverseaction","deprecated":false},{"title":"/reports/{report_id}/adverse_actions","summary":"List Adverse Actions for a Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/adverse-actions/listadverseactionsbyreport","deprecated":false},{"title":"/reports/{report_id}/adverse_actions","summary":"Create a new Adverse Action","prefix":{"name":"post","color":"post"},"badges":[],"link":"/adverse-actions/createadverseaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Adverse Items","link":"/apis/openapi/adverse-items","routeSlug":"/apis/openapi/adverse-items","items":[{"label":"List existing Adverse Items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/adverse-items/adverseitemsbyreport","routeSlug":"/apis/openapi/adverse-items/adverseitemsbyreport","metadata":{"seo":{"title":"List existing Adverse Items","description":"Returns a list of existing Adverse Items with the input report_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"adverseItemsByReport","name":"List existing Adverse Items","isWebhook":false,"pointer":"/paths/~1reports~1{report_id}~1adverse_items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Adverse Items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of existing Adverse Items with the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report must be in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status and cannot have any existing Adverse Actions that have not been canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 400 if the Report's status is not Consider or the Report already has an active (non-cancelled) Adverse Action."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_90","description":"The ID of the associated Report.","required":true}],"pointer":"/paths/~1reports~1{report_id}~1adverse_items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{report_id}/adverse_items","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/reports/{report_id}/adverse_items","href":"adverse-items/adverseitemsbyreport","openApiOperationId":"adverseItemsByReport","summary":"List existing Adverse Items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Adverse Items","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_152"}},"schemaId":"schema_152"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1reports~1{report_id}~1adverse_items/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_152","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_152"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/adverse-items/adverseitemsbyreport"}],"panels":[]}]},"httpPath":"/reports/{report_id}/adverse_items"}],"content":{"contentType":"group","meta":{"name":"Adverse Items"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adverse Items","showPageActions":true},{"nodeType":"markdoc","content":"Adverse Items are items selected from a returned report that may be used\nto initiate Adverse Action for a Candidate."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/reports/{report_id}/adverse_items","summary":"List existing Adverse Items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/adverse-items/adverseitemsbyreport","deprecated":false}]}]}]}]}},{"type":"group","label":"Assessments","link":"/apis/openapi/assessments","routeSlug":"/apis/openapi/assessments","items":[{"label":"List existing Assessments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/assessments/assessmentsbyreport","routeSlug":"/apis/openapi/assessments/assessmentsbyreport","metadata":{"seo":{"title":"List existing Assessments","description":"Returns Assessments for an existing Report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"assessmentsByReport","name":"List existing Assessments","isWebhook":false,"pointer":"/paths/~1reports~1{report_id}~1assessments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Assessments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns Assessments for an existing Report.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_90","description":"The ID of the associated Report.","required":true}],"pointer":"/paths/~1reports~1{report_id}~1assessments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{report_id}/assessments","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/reports/{report_id}/assessments","href":"assessments/assessmentsbyreport","openApiOperationId":"assessmentsByReport","summary":"List existing Assessments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Assessments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_153"}},"schemaId":"schema_153"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1reports~1{report_id}~1assessments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_153","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_153"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assessments/assessmentsbyreport"}],"panels":[]}]},"httpPath":"/reports/{report_id}/assessments"}],"content":{"contentType":"group","meta":{"name":"Assessments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assessments","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to return the Assessments for Reports."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Listen to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report.updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook to determine when an Assessment has been applied to a report."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/reports/{report_id}/assessments","summary":"List existing Assessments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assessments/assessmentsbyreport","deprecated":false}]}]}]}]}},{"type":"group","label":"Candidate Stories","link":"/apis/openapi/candidate-stories","routeSlug":"/apis/openapi/candidate-stories","items":[{"label":"Retrieve a Candidate Story","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/candidate-stories/getcandidatestory","routeSlug":"/apis/openapi/candidate-stories/getcandidatestory","metadata":{"seo":{"title":"Retrieve a Candidate Story","description":"Returns the existing Candidate Story corresponding to the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCandidateStory","name":"Retrieve a Candidate Story","isWebhook":false,"pointer":"/paths/~1candidate_stories~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Candidate Story","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the existing Candidate Story corresponding to the input ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Candidate Story.","required":true}],"pointer":"/paths/~1candidate_stories~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/candidate_stories/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/candidate_stories/{id}","href":"candidate-stories/getcandidatestory","openApiOperationId":"getCandidateStory","summary":"Retrieve a Candidate Story"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Candidate Story details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateStory"}},"schemaId":"components/schemas/CandidateStory"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidate_stories~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CandidateStory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateStory"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidate-stories/getcandidatestory"}],"panels":[]}]},"httpPath":"/candidate_stories/{id}"},{"label":"Delete a Candidate Story","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/candidate-stories/deletecandidatestory","routeSlug":"/apis/openapi/candidate-stories/deletecandidatestory","metadata":{"seo":{"title":"Delete a Candidate Story","description":"Deletes the existing Candidate Story corresponding to the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCandidateStory","name":"Delete a Candidate Story","isWebhook":false,"pointer":"/paths/~1candidate_stories~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Candidate Story","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the existing Candidate Story corresponding to the input ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Candidate Story.","required":true}],"pointer":"/paths/~1candidate_stories~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/candidate_stories/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/candidate_stories/{id}","href":"candidate-stories/deletecandidatestory","openApiOperationId":"deleteCandidateStory","summary":"Delete a Candidate Story"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Candidate Story was successfully deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateStory"}},"schemaId":"components/schemas/CandidateStory"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1candidate_stories~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CandidateStory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateStory"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidate-stories/deletecandidatestory"}],"panels":[]}]},"httpPath":"/candidate_stories/{id}"},{"label":"Create a new Candidate Story","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/candidate-stories/createcandidatestory","routeSlug":"/apis/openapi/candidate-stories/createcandidatestory","metadata":{"seo":{"title":"Create a new Candidate Story","description":"Create a new Candidate Story for the input report_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCandidateStory","name":"Create a new Candidate Story","isWebhook":false,"pointer":"/paths/~1reports~1{report_id}~1candidate_stories/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Candidate Story","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new Candidate Story for the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an candidate story for the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1reports~1{report_id}~1candidate_stories/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_154"}},"schemaId":"schema_154","pointer":"/paths/~1reports~1{report_id}~1candidate_stories/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/reports/{report_id}/candidate_stories","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_154"}},"responseCodes":["200","400","401","403"],"pointer":"/reports/{report_id}/candidate_stories","href":"candidate-stories/createcandidatestory","openApiOperationId":"createCandidateStory","summary":"Create a new Candidate Story"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_154","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_154"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Candidate Story was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateStory"}},"schemaId":"components/schemas/CandidateStory"},{"code":"400","description":"Limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_155"}},"schemaId":"schema_155"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1reports~1{report_id}~1candidate_stories/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CandidateStory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateStory"}}},{"code":"400","schemaId":"schema_155","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_155"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/candidate-stories/createcandidatestory"}],"panels":[]}]},"httpPath":"/reports/{report_id}/candidate_stories"}],"content":{"contentType":"group","meta":{"name":"Candidate Stories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Candidate Stories","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate Stories allows candidates with records the opportunity to share additional context"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"about themselves and their background checks. Once submitted, these stories will be available"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to customers in the candidate’s report in the Checkr Dashboard."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360044417414"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate Stories: Improving understanding of the past and present"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/candidate_stories/{id}","summary":"Retrieve a Candidate Story","prefix":{"name":"get","color":"get"},"badges":[],"link":"/candidate-stories/getcandidatestory","deprecated":false},{"title":"/candidate_stories/{id}","summary":"Delete a Candidate Story","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/candidate-stories/deletecandidatestory","deprecated":false},{"title":"/reports/{report_id}/candidate_stories","summary":"Create a new Candidate Story","prefix":{"name":"post","color":"post"},"badges":[],"link":"/candidate-stories/createcandidatestory","deprecated":false}]}]}]}]}},{"type":"separator","label":"Post-Hire Monitoring","content":null},{"type":"group","label":"Subscriptions","link":"/apis/openapi/subscriptions","routeSlug":"/apis/openapi/subscriptions","items":[{"label":"Create a new Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/subscriptions/createsubscription","routeSlug":"/apis/openapi/subscriptions/createsubscription","metadata":{"seo":{"title":"Create a new Subscription","description":"Creates a new Subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSubscription","name":"Create a new Subscription","isWebhook":false,"pointer":"/paths/~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes for International Customers: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions are generally not available for packages which include international screenings"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"since they require specific consent forms before they are run. If your candidate is located outside the US, you may not create"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a Subscription for them. The exceptions are Global MVR screenings, Global MVRs are the only international screening capable of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"handling standalone consent collection."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_156"}},"schemaId":"schema_156","pointer":"/paths/~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_156"}},"responseCodes":["200","400","401","403","404"],"pointer":"/subscriptions","href":"subscriptions/createsubscription","openApiOperationId":"createSubscription","summary":"Create a new Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_156","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_156"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}},"schemaId":"components/schemas/Subscription"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PackageNotFoundError"}},"schemaId":"components/schemas/PackageNotFoundError"}],"pointer":"/paths/~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/PackageNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PackageNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/createsubscription"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"List existing Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/subscriptions/getsubscriptions","routeSlug":"/apis/openapi/subscriptions/getsubscriptions","metadata":{"seo":{"title":"List existing Subscriptions","description":"Lists existing Subscriptions with the input parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscriptions","name":"List existing Subscriptions","isWebhook":false,"pointer":"/paths/~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists existing Subscriptions with the input parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"candidate_id","in":"query","schemaId":"schema_90","description":"ID of the candidate to search for subscriptions."},{"name":"created_after","in":"query","schemaId":"schema_91","description":"Returns subscriptions created after the input date."},{"name":"created_before","in":"query","schemaId":"schema_91","description":"Returns subscriptions created before the input date."},{"name":"status","in":"query","schemaId":"schema_157","description":"Returns subscriptions with the input status."},{"name":"page","in":"query","schemaId":"schema_93","description":"Specifies the page number to retrieve."},{"name":"per_page","in":"query","schemaId":"schema_93","description":"Indicates how many records each page should contain. The default value is 25 records."}],"pointer":"/paths/~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"candidate_id","in":"query","required":false,"schemaId":"schema_90"},{"name":"created_after","in":"query","required":false,"schemaId":"schema_91"},{"name":"created_before","in":"query","required":false,"schemaId":"schema_91"},{"name":"status","in":"query","required":false,"schemaId":"schema_157"},{"name":"page","in":"query","required":false,"schemaId":"schema_93"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_93"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/subscriptions","href":"subscriptions/getsubscriptions","openApiOperationId":"getSubscriptions","summary":"List existing Subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Subscriptions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_158"}},"schemaId":"schema_158"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159"}},"schemaId":"schema_159"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_158","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_158"}}},{"code":"400","schemaId":"schema_159","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/getsubscriptions"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"Retrieve an existing Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/subscriptions/getsubscription","routeSlug":"/apis/openapi/subscriptions/getsubscription","metadata":{"seo":{"title":"Retrieve an existing Subscription","description":"Retrieves an existing Subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscription","name":"Retrieve an existing Subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing Subscription.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Subscription.","required":true}],"pointer":"/paths/~1subscriptions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/subscriptions/{id}","href":"subscriptions/getsubscription","openApiOperationId":"getSubscription","summary":"Retrieve an existing Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}},"schemaId":"components/schemas/Subscription"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1subscriptions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/getsubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}"},{"label":"Update a Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/subscriptions/updatesubscription","routeSlug":"/apis/openapi/subscriptions/updatesubscription","metadata":{"seo":{"title":"Update a Subscription","description":"Updates a Subscription. Specify only those parameters you wish to change."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSubscription","name":"Update a Subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a Subscription. Specify only those parameters you wish to change.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Subscription.","required":true}],"pointer":"/paths/~1subscriptions~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_160"}},"schemaId":"schema_160","pointer":"/paths/~1subscriptions~1{id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_160"}},"responseCodes":["200","400","401","403"],"pointer":"/subscriptions/{id}","href":"subscriptions/updatesubscription","openApiOperationId":"updateSubscription","summary":"Update a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_160","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_160"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}},"schemaId":"components/schemas/Subscription"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1subscriptions~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/updatesubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}"},{"label":"Cancel an existing Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/subscriptions/cancelsubscription","routeSlug":"/apis/openapi/subscriptions/cancelsubscription","metadata":{"seo":{"title":"Cancel an existing Subscription","description":"Cancels an existing Subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelSubscription","name":"Cancel an existing Subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an existing Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels an existing Subscription.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Subscription.","required":true}],"pointer":"/paths/~1subscriptions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscriptions/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/subscriptions/{id}","href":"subscriptions/cancelsubscription","openApiOperationId":"cancelSubscription","summary":"Cancel an existing Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription was successfully canceled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCanceled"}},"schemaId":"components/schemas/SubscriptionCanceled"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1subscriptions~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionCanceled","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCanceled"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/cancelsubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}"}],"content":{"contentType":"group","meta":{"name":"Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","showPageActions":true},{"nodeType":"markdoc","content":"Represents a background check subscription. A background report with\nthe Package specified will run at every interval."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscriptions","summary":"Create a new Subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/createsubscription","deprecated":false},{"title":"/subscriptions","summary":"List existing Subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/getsubscriptions","deprecated":false},{"title":"/subscriptions/{id}","summary":"Retrieve an existing Subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/getsubscription","deprecated":false},{"title":"/subscriptions/{id}","summary":"Update a Subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/updatesubscription","deprecated":false},{"title":"/subscriptions/{id}","summary":"Cancel an existing Subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscriptions/cancelsubscription","deprecated":false}]}]}]}]}},{"type":"group","label":"Continuous Checks","link":"/apis/openapi/continuous-checks","routeSlug":"/apis/openapi/continuous-checks","items":[{"label":"Create a new Continuous Check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/continuous-checks/createcontinuouscheck","routeSlug":"/apis/openapi/continuous-checks/createcontinuouscheck","metadata":{"seo":{"title":"Create a new Continuous Check","description":"Creates a new Continuous Check resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createContinuousCheck","name":"Create a new Continuous Check","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1continuous_checks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Continuous Check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new Continuous Check resource.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The Candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1continuous_checks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_161"}},"schemaId":"schema_161","pointer":"/paths/~1candidates~1{candidate_id}~1continuous_checks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/candidates/{candidate_id}/continuous_checks","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_161"}},"responseCodes":["201","400","401","403","422"],"pointer":"/candidates/{candidate_id}/continuous_checks","href":"continuous-checks/createcontinuouscheck","openApiOperationId":"createContinuousCheck","summary":"Create a new Continuous Check"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_161","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_161"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Continuous Check was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheck"}},"schemaId":"components/schemas/ContinuousCheck"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadContinuousCheckRequestError"}},"schemaId":"components/schemas/BadContinuousCheckRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheckMissingSSNTraceError"}},"schemaId":"components/schemas/ContinuousCheckMissingSSNTraceError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1continuous_checks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ContinuousCheck","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheck"}}},{"code":"400","schemaId":"components/schemas/BadContinuousCheckRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadContinuousCheckRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"422","schemaId":"components/schemas/ContinuousCheckMissingSSNTraceError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheckMissingSSNTraceError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/continuous-checks/createcontinuouscheck"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/continuous_checks"},{"label":"List existing Continuous Checks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/continuous-checks/listofcontinuouschecks","routeSlug":"/apis/openapi/continuous-checks/listofcontinuouschecks","metadata":{"seo":{"title":"List existing Continuous Checks","description":"Returns a list of existing Continuous Checks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOfContinuousChecks","name":"List existing Continuous Checks","isWebhook":false,"pointer":"/paths/~1candidates~1{candidate_id}~1continuous_checks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Continuous Checks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of existing Continuous Checks.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"candidate_id","in":"path","schemaId":"schema_90","description":"The Candidate's ID.","required":true}],"pointer":"/paths/~1candidates~1{candidate_id}~1continuous_checks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/candidates/{candidate_id}/continuous_checks","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"candidate_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/candidates/{candidate_id}/continuous_checks","href":"continuous-checks/listofcontinuouschecks","openApiOperationId":"listOfContinuousChecks","summary":"List existing Continuous Checks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Continuous Checks","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_162"}},"schemaId":"schema_162"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}},"schemaId":"components/schemas/CandidateNotFoundError"}],"pointer":"/paths/~1candidates~1{candidate_id}~1continuous_checks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_162","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_162"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/CandidateNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CandidateNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/continuous-checks/listofcontinuouschecks"}],"panels":[]}]},"httpPath":"/candidates/{candidate_id}/continuous_checks"},{"label":"Retrieve an existing Continuous Check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/continuous-checks/getcontinuouscheck","routeSlug":"/apis/openapi/continuous-checks/getcontinuouscheck","metadata":{"seo":{"title":"Retrieve an existing Continuous Check","description":"Returns an existing Continuous Check with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContinuousCheck","name":"Retrieve an existing Continuous Check","isWebhook":false,"pointer":"/paths/~1continuous_checks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Continuous Check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Continuous Check with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Continuous Check's ID.","required":true}],"pointer":"/paths/~1continuous_checks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/continuous_checks/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/continuous_checks/{id}","href":"continuous-checks/getcontinuouscheck","openApiOperationId":"getContinuousCheck","summary":"Retrieve an existing Continuous Check"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Continuous Check details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheck"}},"schemaId":"components/schemas/ContinuousCheck"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheckNotFoundError"}},"schemaId":"components/schemas/ContinuousCheckNotFoundError"}],"pointer":"/paths/~1continuous_checks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContinuousCheck","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheck"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/ContinuousCheckNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheckNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/continuous-checks/getcontinuouscheck"}],"panels":[]}]},"httpPath":"/continuous_checks/{id}"},{"label":"Update an existing Continuous Check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/continuous-checks/postcontinuouscheck","routeSlug":"/apis/openapi/continuous-checks/postcontinuouscheck","metadata":{"seo":{"title":"Update an existing Continuous Check","description":"Updates the node and/or work locations of an existing Continuous Check."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postContinuousCheck","name":"Update an existing Continuous Check","isWebhook":false,"pointer":"/paths/~1continuous_checks~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing Continuous Check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the node and/or work locations of an existing Continuous Check.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Continuous Check's ID.","required":true}],"pointer":"/paths/~1continuous_checks~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_163"}},"schemaId":"schema_163","pointer":"/paths/~1continuous_checks~1{id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/continuous_checks/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_163"}},"responseCodes":["201","400","401","403","404"],"pointer":"/continuous_checks/{id}","href":"continuous-checks/postcontinuouscheck","openApiOperationId":"postContinuousCheck","summary":"Update an existing Continuous Check"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"schemaId":"schema_163","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_163"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Continuous Check was successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheck"}},"schemaId":"components/schemas/ContinuousCheck"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadContinuousCheckUpdateRequestError"}},"schemaId":"components/schemas/BadContinuousCheckUpdateRequestError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheckNotFoundError"}},"schemaId":"components/schemas/ContinuousCheckNotFoundError"}],"pointer":"/paths/~1continuous_checks~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ContinuousCheck","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheck"}}},{"code":"400","schemaId":"components/schemas/BadContinuousCheckUpdateRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadContinuousCheckUpdateRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/ContinuousCheckNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheckNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/continuous-checks/postcontinuouscheck"}],"panels":[]}]},"httpPath":"/continuous_checks/{id}"},{"label":"Cancel an existing Continuous Check","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/continuous-checks/cancelcontinuouscheck","routeSlug":"/apis/openapi/continuous-checks/cancelcontinuouscheck","metadata":{"seo":{"title":"Cancel an existing Continuous Check","description":"Cancels an existing Continuous Check."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelContinuousCheck","name":"Cancel an existing Continuous Check","isWebhook":false,"pointer":"/paths/~1continuous_checks~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an existing Continuous Check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels an existing Continuous Check.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"The Continuous Check's ID.","required":true}],"pointer":"/paths/~1continuous_checks~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/continuous_checks/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/continuous_checks/{id}","href":"continuous-checks/cancelcontinuouscheck","openApiOperationId":"cancelContinuousCheck","summary":"Cancel an existing Continuous Check"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Continuous Check was successfully canceled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheck"}},"schemaId":"components/schemas/ContinuousCheck"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheckNotFoundError"}},"schemaId":"components/schemas/ContinuousCheckNotFoundError"}],"pointer":"/paths/~1continuous_checks~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContinuousCheck","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheck"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/ContinuousCheckNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContinuousCheckNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/continuous-checks/cancelcontinuouscheck"}],"panels":[]}]},"httpPath":"/continuous_checks/{id}"}],"content":{"contentType":"group","meta":{"name":"Continuous Checks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Continuous Checks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Continuous Check runs a monthly check for pointers to new records, which may result in a Report. Unlike a Subscription, which generates a full Report at a defined cadence, Continuous Check generates a full Report only if new reportable information is found. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360016337054-Continuous-Check-The-new-standard-of-safety"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Continuous Crim: The new standard of safety"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/4410112521111-Continuous-MVR-The-new-standard-in-driver-safety"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Continuous MVR: The new standard in driver safety"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Checkr Help Center."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/webhooks#report-events"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report.complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to watch for new Reports created for candidates enrolled in Continuous Check. These Reports will list one of the following as the Package within the webhook payload:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuous_check"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuous_mvr"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuous_mvr_enrollment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" These Package names are returned through the Checkr APIs, but may not be used as input. Attempting to create Invitations, Reports, or Subscriptions with these Packages will result in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Package not found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is your legal obligation to manage your list of candidates enrolled in Continuous Check. You must obtain the required "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360001906708"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"evergreen consent"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before enrolling them, and you must remove them from the service when they begin an Adverse Action process or are removed from your platform. Work with your legal counsel to ensure that your Continuous Check process remains compliant with all applicable laws and regulations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If your candidate is located outside of the US, they cannot be enrolled in Continuous Check."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/candidates/{candidate_id}/continuous_checks","summary":"Create a new Continuous Check","prefix":{"name":"post","color":"post"},"badges":[],"link":"/continuous-checks/createcontinuouscheck","deprecated":false},{"title":"/candidates/{candidate_id}/continuous_checks","summary":"List existing Continuous Checks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/continuous-checks/listofcontinuouschecks","deprecated":false},{"title":"/continuous_checks/{id}","summary":"Retrieve an existing Continuous Check","prefix":{"name":"get","color":"get"},"badges":[],"link":"/continuous-checks/getcontinuouscheck","deprecated":false},{"title":"/continuous_checks/{id}","summary":"Update an existing Continuous Check","prefix":{"name":"post","color":"post"},"badges":[],"link":"/continuous-checks/postcontinuouscheck","deprecated":false},{"title":"/continuous_checks/{id}","summary":"Cancel an existing Continuous Check","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/continuous-checks/cancelcontinuouscheck","deprecated":false}]}]}]}]}},{"type":"separator","label":"I-9 & Verification","content":null},{"type":"group","label":"Forms I-9","link":"/apis/openapi/forms-i-9","routeSlug":"/apis/openapi/forms-i-9","items":[{"label":"List existing Forms I-9","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/forms-i-9/listformsi9","routeSlug":"/apis/openapi/forms-i-9/listformsi9","metadata":{"seo":{"title":"List existing Forms I-9","description":"Retrieves all Forms I-9 for the authenticated Checkr account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFormsI9","name":"List existing Forms I-9","isWebhook":false,"pointer":"/paths/~1v2~1i9~1forms_i9/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Forms I-9","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all Forms I-9 for the authenticated Checkr account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns only Forms I-9 with the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value(s). Accepts the same values the response's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field returns. Multiple values may be provided, comma-separated."},"children":[]}]}]}],"example":"Section 1 in progress,Section 2 in progress"},{"name":"page","in":"query","schemaId":"schema_164","description":"Specifies the page number to retrieve."},{"name":"per_page","in":"query","schemaId":"schema_165","description":"Indicates how many records each page should contain. The maximum is 100 records."}],"pointer":"/paths/~1v2~1i9~1forms_i9/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/i9/forms_i9","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr.com","description":"Main server"}],"parameters":{"path":[],"query":[{"name":"status","in":"query","required":false,"example":"Section 1 in progress,Section 2 in progress","schemaId":"schema_90"},{"name":"page","in":"query","required":false,"schemaId":"schema_164"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_165"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v2/i9/forms_i9","href":"forms-i-9/listformsi9","openApiOperationId":"listFormsI9","summary":"List existing Forms I-9"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr.com","description":"Main server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Forms I-9","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166"}},"schemaId":"schema_166"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_167"}},"schemaId":"schema_167"}],"pointer":"/paths/~1v2~1i9~1forms_i9/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_166","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_167"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/forms-i-9/listformsi9"}],"panels":[]}]},"httpPath":"/v2/i9/forms_i9"},{"label":"Create a new Form I-9","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/forms-i-9/createformi9","routeSlug":"/apis/openapi/forms-i-9/createformi9","metadata":{"seo":{"title":"Create a new Form I-9","description":"Creates a new Form I-9 resource. This resource allows the creation of a single Form I-9 in each request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFormI9","name":"Create a new Form I-9","isWebhook":false,"pointer":"/paths/~1v2~1i9~1forms_i9/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Form I-9","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new Form I-9 resource. This resource allows the creation of a\nsingle Form I-9 in each request.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_168"}},"schemaId":"schema_168","pointer":"/paths/~1v2~1i9~1forms_i9/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/i9/forms_i9","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr.com","description":"Main server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_168"}},"responseCodes":["201","401","404","409","422"],"pointer":"/v2/i9/forms_i9","href":"forms-i-9/createformi9","openApiOperationId":"createFormI9","summary":"Create a new Form I-9"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr.com","description":"Main server"}],"schemaId":"schema_168","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_168"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Form I-9 details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormI9V2"}},"schemaId":"components/schemas/FormI9V2"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_169"}},"schemaId":"schema_169"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_170"}},"schemaId":"schema_170"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_171"}},"schemaId":"schema_171"}],"pointer":"/paths/~1v2~1i9~1forms_i9/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/FormI9V2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormI9V2"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_167"}}},{"code":"404","schemaId":"schema_169","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_169"}}},{"code":"409","schemaId":"schema_170","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_170"}}},{"code":"422","schemaId":"schema_171","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_171"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/forms-i-9/createformi9"}],"panels":[]}]},"httpPath":"/v2/i9/forms_i9"},{"label":"Retrieve a Form I-9","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/forms-i-9/getformi9","routeSlug":"/apis/openapi/forms-i-9/getformi9","metadata":{"seo":{"title":"Retrieve a Form I-9","description":"Retrieves an existing Form I-9."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFormI9","name":"Retrieve a Form I-9","isWebhook":false,"pointer":"/paths/~1v2~1i9~1forms_i9~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Form I-9","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing Form I-9.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_172","description":"ID of the Form I-9","required":true}],"pointer":"/paths/~1v2~1i9~1forms_i9~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/i9/forms_i9/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr.com","description":"Main server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_172"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v2/i9/forms_i9/{id}","href":"forms-i-9/getformi9","openApiOperationId":"getFormI9","summary":"Retrieve a Form I-9"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr.com","description":"Main server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Form I-9 details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormI9V2"}},"schemaId":"components/schemas/FormI9V2"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1v2~1i9~1forms_i9~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FormI9V2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormI9V2"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_167"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/forms-i-9/getformi9"}],"panels":[]}]},"httpPath":"/v2/i9/forms_i9/{id}"},{"label":"Retrieve Form I-9 PDF file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/forms-i-9/getformi9pdf","routeSlug":"/apis/openapi/forms-i-9/getformi9pdf","metadata":{"seo":{"title":"Retrieve Form I-9 PDF file","description":"Retrieves a link to the completed Form I-9 PDF file associated with theForm I-9 ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFormI9Pdf","name":"Retrieve Form I-9 PDF file","isWebhook":false,"pointer":"/paths/~1v2~1i9~1forms_i9~1{id}~1pdf/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Form I-9 PDF file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a link to the completed Form I-9 PDF file associated with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Form I-9 ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns a pre-signed URL, valid for 15 minutes. The PDF"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"becomes available shortly after the Form I-9 is countersigned; before"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that, this endpoint returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_172","description":"ID of the Form I-9","required":true}],"pointer":"/paths/~1v2~1i9~1forms_i9~1{id}~1pdf/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/i9/forms_i9/{id}/pdf","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr.com","description":"Main server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_172"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v2/i9/forms_i9/{id}/pdf","href":"forms-i-9/getformi9pdf","openApiOperationId":"getFormI9Pdf","summary":"Retrieve Form I-9 PDF file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr.com","description":"Main server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Form I-9 PDF URL","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_173"}},"schemaId":"schema_173"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_174"}},"schemaId":"schema_174"}],"pointer":"/paths/~1v2~1i9~1forms_i9~1{id}~1pdf/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_173","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_173"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_167"}}},{"code":"404","schemaId":"schema_174","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_174"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/forms-i-9/getformi9pdf"}],"panels":[]}]},"httpPath":"/v2/i9/forms_i9/{id}/pdf"}],"content":{"contentType":"group","meta":{"name":"Forms I-9"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Forms I-9","showPageActions":true},{"nodeType":"markdoc","content":"The Forms I-9 resource provides all information about Forms I-9. It also allows the creation of new Forms I-9, retrieves details about ongoing I-9s, and makes the PDF files for completed I-9s available."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/i9/forms_i9","summary":"List existing Forms I-9","prefix":{"name":"get","color":"get"},"badges":[],"link":"/forms-i-9/listformsi9","deprecated":false},{"title":"/v2/i9/forms_i9","summary":"Create a new Form I-9","prefix":{"name":"post","color":"post"},"badges":[],"link":"/forms-i-9/createformi9","deprecated":false},{"title":"/v2/i9/forms_i9/{id}","summary":"Retrieve a Form I-9","prefix":{"name":"get","color":"get"},"badges":[],"link":"/forms-i-9/getformi9","deprecated":false},{"title":"/v2/i9/forms_i9/{id}/pdf","summary":"Retrieve Form I-9 PDF file","prefix":{"name":"get","color":"get"},"badges":[],"link":"/forms-i-9/getformi9pdf","deprecated":false}]}]}]}]}},{"type":"group","label":"Worksites","link":"/apis/openapi/worksites","routeSlug":"/apis/openapi/worksites","items":[{"label":"List existing Worksites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/worksites/worksiteslist","routeSlug":"/apis/openapi/worksites/worksiteslist","metadata":{"seo":{"title":"List existing Worksites","description":"Returns a list with all existing Worksites for the authenticated Checkraccount."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"worksitesList","name":"List existing Worksites","isWebhook":false,"pointer":"/paths/~1v2~1i9~1worksites/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Worksites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list with all existing Worksites for the authenticated Checkr"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Worksites are read-only through the API: create and manage them from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Checkr Dashboard. Use the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"worksite_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/forms-i-9/createformi9"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creating a Form I-9"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_164","description":"Specifies the page number to retrieve."},{"name":"per_page","in":"query","schemaId":"schema_165","description":"Indicates how many records each page should contain. The maximum is 100 records."}],"pointer":"/paths/~1v2~1i9~1worksites/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/i9/worksites","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr.com","description":"Main server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_164"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_165"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v2/i9/worksites","href":"worksites/worksiteslist","openApiOperationId":"worksitesList","summary":"List existing Worksites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr.com","description":"Main server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Worksites","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_175"}},"schemaId":"schema_175"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_167"}},"schemaId":"schema_167"}],"pointer":"/paths/~1v2~1i9~1worksites/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_175","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_175"}}},{"code":"401","schemaId":"schema_167","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_167"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/worksites/worksiteslist"}],"panels":[]}]},"httpPath":"/v2/i9/worksites"}],"content":{"contentType":"group","meta":{"name":"Worksites"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Worksites","showPageActions":true},{"nodeType":"markdoc","content":"The Worksite resource represents the locations where candidates work, used when creating Forms I-9. Worksites are read-only through the API and are managed from the Checkr Dashboard."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/i9/worksites","summary":"List existing Worksites","prefix":{"name":"get","color":"get"},"badges":[],"link":"/worksites/worksiteslist","deprecated":false}]}]}]}]}},{"type":"group","label":"Verifications","link":"/apis/openapi/verifications","routeSlug":"/apis/openapi/verifications","items":[{"label":"List existing Verifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/verifications/verificationslistbyreport","routeSlug":"/apis/openapi/verifications/verificationslistbyreport","metadata":{"seo":{"title":"List existing Verifications","description":"Returns a list of existing Verifications for the input report_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verificationsListByReport","name":"List existing Verifications","isWebhook":false,"pointer":"/paths/~1reports~1{report_id}~1verifications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List existing Verifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of existing Verifications for the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of verifications for the input "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1reports~1{report_id}~1verifications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{report_id}/verifications","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/reports/{report_id}/verifications","href":"verifications/verificationslistbyreport","openApiOperationId":"verificationsListByReport","summary":"List existing Verifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Report Verifications","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_176"}},"schemaId":"schema_176"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1reports~1{report_id}~1verifications/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_176","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_176"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verifications/verificationslistbyreport"}],"panels":[]}]},"httpPath":"/reports/{report_id}/verifications"},{"label":"Retrieve a Verification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/verifications/getverification","routeSlug":"/apis/openapi/verifications/getverification","metadata":{"seo":{"title":"Retrieve a Verification","description":"Returns an existing Verification with the input ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVerification","name":"Retrieve a Verification","isWebhook":false,"pointer":"/paths/~1verifications~1{verification_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Verification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Verification with the input ID\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"verification_id","in":"path","schemaId":"schema_90","required":true}],"pointer":"/paths/~1verifications~1{verification_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/verifications/{verification_id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"verification_id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/verifications/{verification_id}","href":"verifications/getverification","openApiOperationId":"getVerification","summary":"Retrieve a Verification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Verification details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Verification"}},"schemaId":"components/schemas/Verification"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1verifications~1{verification_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Verification","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Verification"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verifications/getverification"}],"panels":[]}]},"httpPath":"/verifications/{verification_id}"}],"content":{"contentType":"group","meta":{"name":"Verifications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verifications","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a link by which candidates may upload a document. If a candidate must upload"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documents to continue processing their report, a set of Verifications will be available."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checkr offers two verification types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"education"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". ID Verifications are used for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identity and license purposes, such as ID card or driver’s license. Education Verifications"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are used for documents related to Education Verification."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/reports/{report_id}/verifications","summary":"List existing Verifications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verifications/verificationslistbyreport","deprecated":false},{"title":"/verifications/{verification_id}","summary":"Retrieve a Verification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verifications/getverification","deprecated":false}]}]}]}]}},{"type":"group","label":"Getting Started","link":"/apis/openapi/getting-started","routeSlug":"/apis/openapi/getting-started","items":[],"content":{"contentType":"group","meta":{"name":"Getting Started"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Getting Started","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before you can start using Checkr's I9 verification endpoints please complete first adding Form I-9 to your account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A step by step guide can be found at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/15483223505303"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checkr Help Center"},"children":[]}]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/getting-started"}],"panels":[]}]}},{"type":"separator","label":"US Screening","content":null},{"type":"group","label":"SSN Trace","link":"/apis/openapi/ssn-trace","routeSlug":"/apis/openapi/ssn-trace","items":[{"label":"Retrieve an existing SSN Trace","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/ssn-trace/getssntrace","routeSlug":"/apis/openapi/ssn-trace/getssntrace","metadata":{"seo":{"title":"Retrieve an existing SSN Trace","description":"Returns an existing SSN Trace with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSsnTrace","name":"Retrieve an existing SSN Trace","isWebhook":false,"pointer":"/paths/~1ssn_traces~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing SSN Trace","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing SSN Trace with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the SSN Trace to retrieve.","required":true}],"pointer":"/paths/~1ssn_traces~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ssn_traces/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/ssn_traces/{id}","href":"ssn-trace/getssntrace","openApiOperationId":"getSsnTrace","summary":"Retrieve an existing SSN Trace"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"SSN Trace details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SsnTrace"}},"schemaId":"components/schemas/SsnTrace"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1ssn_traces~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SsnTrace","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SsnTrace"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ssn-trace/getssntrace"}],"panels":[]}]},"httpPath":"/ssn_traces/{id}"}],"content":{"contentType":"group","meta":{"name":"SSN Trace"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SSN Trace","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSN Trace is typically the first screening run, and is used to verify that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the input SSN exists, determine where and when it was issued, and to compile"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a list of all known aliases associated with the SSN. This Trace is also used to generate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a list of all known addresses recorded by credit agencies for the SSN for the last 7 years."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An SSN Trace may be used to determine which additional jurisdictions should be searched for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the candidate, based on the list of known addresses returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the platform detects an issue with the SSN Trace run (data mismatch, absence of data,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or inclusion of the SSN on the death master file), Checkr may issue an exception and ask"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the candidate to either re-enter their SSN or upload other supporting documentation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information returned by this search is not a part of the consumer report and may not be used for FCRA purposes, including eligibility determinations under the FCRA"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360001967227"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSN Trace"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ssn_traces/{id}","summary":"Retrieve an existing SSN Trace","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ssn-trace/getssntrace","deprecated":false}]}]}]}]}},{"type":"group","label":"Sex Offender Registry Search","link":"/apis/openapi/sex-offender-registry-search","routeSlug":"/apis/openapi/sex-offender-registry-search","items":[{"label":"Retrieve an existing Sex Offender Registry Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/sex-offender-registry-search/getsexoffendersearch","routeSlug":"/apis/openapi/sex-offender-registry-search/getsexoffendersearch","metadata":{"seo":{"title":"Retrieve an existing Sex Offender Registry Search","description":"Returns an existing Sex Offender Registry Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSexOffenderSearch","name":"Retrieve an existing Sex Offender Registry Search","isWebhook":false,"pointer":"/paths/~1sex_offender_searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Sex Offender Registry Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Sex Offender Registry Search with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Sex Offender Search to retrieve.","required":true}],"pointer":"/paths/~1sex_offender_searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sex_offender_searches/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/sex_offender_searches/{id}","href":"sex-offender-registry-search/getsexoffendersearch","openApiOperationId":"getSexOffenderSearch","summary":"Retrieve an existing Sex Offender Registry Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Sex Offender Registry Search details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SexOffenderSearch"}},"schemaId":"components/schemas/SexOffenderSearch"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1sex_offender_searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SexOffenderSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SexOffenderSearch"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sex-offender-registry-search/getsexoffendersearch"}],"panels":[]}]},"httpPath":"/sex_offender_searches/{id}"}],"content":{"contentType":"group","meta":{"name":"Sex Offender Registry Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sex Offender Registry Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents an instant multi-state Sex Offender Registry Search."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A nationwide search of all 50 states' and the District of Columbia’s sex offender registries"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for all levels of registered sex offenders. Search includes type(s) of offense and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identifiers, such as Date of Birth (DOB)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360001863428"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sex Offender Registry Search"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sex_offender_searches/{id}","summary":"Retrieve an existing Sex Offender Registry Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sex-offender-registry-search/getsexoffendersearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Global Watchlist Search","link":"/apis/openapi/global-watchlist-search","routeSlug":"/apis/openapi/global-watchlist-search","items":[{"label":"Retrieve an existing Global Watchlist Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/global-watchlist-search/getglobalwatchlistsearch","routeSlug":"/apis/openapi/global-watchlist-search/getglobalwatchlistsearch","metadata":{"seo":{"title":"Retrieve an existing Global Watchlist Search","description":"Returns an existing Global Watchlist Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGlobalWatchlistSearch","name":"Retrieve an existing Global Watchlist Search","isWebhook":false,"pointer":"/paths/~1global_watchlist_searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Global Watchlist Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Global Watchlist Search with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Global Watchlist Search to retrieve.","required":true}],"pointer":"/paths/~1global_watchlist_searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/global_watchlist_searches/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/global_watchlist_searches/{id}","href":"global-watchlist-search/getglobalwatchlistsearch","openApiOperationId":"getGlobalWatchlistSearch","summary":"Retrieve an existing Global Watchlist Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Global Watchlist Search details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GlobalWatchlistSearch"}},"schemaId":"components/schemas/GlobalWatchlistSearch"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1global_watchlist_searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GlobalWatchlistSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GlobalWatchlistSearch"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/global-watchlist-search/getglobalwatchlistsearch"}],"panels":[]}]},"httpPath":"/global_watchlist_searches/{id}"}],"content":{"contentType":"group","meta":{"name":"Global Watchlist Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Global Watchlist Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Global Watchlist Search searches known domestic and international terrorist watchlists"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as well as the records of the Office of Inspector General (OIG), Excluded Parties List (EPL)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and additional domestic and international agency lists."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360001951208"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Global Watchlist Search"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/global_watchlist_searches/{id}","summary":"Retrieve an existing Global Watchlist Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/global-watchlist-search/getglobalwatchlistsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"National Criminal Search","link":"/apis/openapi/national-criminal-search","routeSlug":"/apis/openapi/national-criminal-search","items":[{"label":"Retrieve an existing National Criminal Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/national-criminal-search/getnationalcriminalsearch","routeSlug":"/apis/openapi/national-criminal-search/getnationalcriminalsearch","metadata":{"seo":{"title":"Retrieve an existing National Criminal Search","description":"Returns an existing National Criminal Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNationalCriminalSearch","name":"Retrieve an existing National Criminal Search","isWebhook":false,"pointer":"/paths/~1national_criminal_searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing National Criminal Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing National Criminal Search with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the National Criminal Search to retrieve.","required":true}],"pointer":"/paths/~1national_criminal_searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/national_criminal_searches/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/national_criminal_searches/{id}","href":"national-criminal-search/getnationalcriminalsearch","openApiOperationId":"getNationalCriminalSearch","summary":"Retrieve an existing National Criminal Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"National Criminal Search details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NationalCriminalSearch"}},"schemaId":"components/schemas/NationalCriminalSearch"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1national_criminal_searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NationalCriminalSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NationalCriminalSearch"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/national-criminal-search/getnationalcriminalsearch"}],"panels":[]}]},"httpPath":"/national_criminal_searches/{id}"}],"content":{"contentType":"group","meta":{"name":"National Criminal Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"National Criminal Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checkr conducts a National Criminal Database Search as a routine part of all criminal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"background checks. The search queries 3,200 counties and over 900 million records across"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the United States, and provides a quick means to evaluate which courts or jurisdictions should"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be searched more thoroughly for any given candidate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The National Criminal Database Search is used only as a \"pointer search\" to determine which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"courts or jurisdictions to search. Records returned from this database do not appear"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the final report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360001686567"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"National Criminal Database Search"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/national_criminal_searches/{id}","summary":"Retrieve an existing National Criminal Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/national-criminal-search/getnationalcriminalsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Federal Criminal Search","link":"/apis/openapi/federal-criminal-search","routeSlug":"/apis/openapi/federal-criminal-search","items":[{"label":"Retrieve an existing Federal Criminal Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/federal-criminal-search/getfederalcriminalsearch","routeSlug":"/apis/openapi/federal-criminal-search/getfederalcriminalsearch","metadata":{"seo":{"title":"Retrieve an existing Federal Criminal Search","description":"Returns an existing Federal Criminal Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFederalCriminalSearch","name":"Retrieve an existing Federal Criminal Search","isWebhook":false,"pointer":"/paths/~1federal_criminal_searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Federal Criminal Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Federal Criminal Search with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Federal Criminal Search to retrieve.","required":true}],"pointer":"/paths/~1federal_criminal_searches~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclude","in":"query","schemaId":"schema_90","description":"Indicates whether to return disctrict screenings in pointer search payload","example":"district"}],"pointer":"/paths/~1federal_criminal_searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/federal_criminal_searches/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[{"name":"exclude","in":"query","required":false,"example":"district","schemaId":"schema_90"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/federal_criminal_searches/{id}","href":"federal-criminal-search/getfederalcriminalsearch","openApiOperationId":"getFederalCriminalSearch","summary":"Retrieve an existing Federal Criminal Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Federal Criminal Search details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FederalCriminalSearch"}},"schemaId":"components/schemas/FederalCriminalSearch"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1federal_criminal_searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FederalCriminalSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FederalCriminalSearch"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/federal-criminal-search/getfederalcriminalsearch"}],"panels":[]}]},"httpPath":"/federal_criminal_searches/{id}"}],"content":{"contentType":"group","meta":{"name":"Federal Criminal Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Federal Criminal Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches the Federal Criminal record database and Federal District courts to return felony and misdemeanor records."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(National, State, and County Criminal Searches do not return federal records.) For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360001882627"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Federal Criminal Search"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/federal_criminal_searches/{id}","summary":"Retrieve an existing Federal Criminal Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/federal-criminal-search/getfederalcriminalsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Federal District Criminal Search","link":"/apis/openapi/federal-district-criminal-search","routeSlug":"/apis/openapi/federal-district-criminal-search","items":[{"label":"Retrieve an existing Federal District  Criminal Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/federal-district-criminal-search/getfederaldistrictcriminalsearch","routeSlug":"/apis/openapi/federal-district-criminal-search/getfederaldistrictcriminalsearch","metadata":{"seo":{"title":"Retrieve an existing Federal District  Criminal Search","description":"Returns an existing Federal District Criminal Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFederalDistrictCriminalSearch","name":"Retrieve an existing Federal District  Criminal Search","isWebhook":false,"pointer":"/paths/~1federal_district_criminal_searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Federal District  Criminal Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Federal District Criminal Search with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Federal District Criminal Search to retrieve.","required":true}],"pointer":"/paths/~1federal_district_criminal_searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/federal_district_criminal_searches/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/federal_district_criminal_searches/{id}","href":"federal-district-criminal-search/getfederaldistrictcriminalsearch","openApiOperationId":"getFederalDistrictCriminalSearch","summary":"Retrieve an existing Federal District  Criminal Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Federal District Criminal Search details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FederalDistrictCriminalSearch"}},"schemaId":"components/schemas/FederalDistrictCriminalSearch"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1federal_district_criminal_searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FederalDistrictCriminalSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FederalDistrictCriminalSearch"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/federal-district-criminal-search/getfederaldistrictcriminalsearch"}],"panels":[]}]},"httpPath":"/federal_district_criminal_searches/{id}"}],"content":{"contentType":"group","meta":{"name":"Federal District Criminal Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Federal District Criminal Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches Federal District Criminal courts to verify felony and misdemeanor records identified by PACER."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360001882627"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Federal District Criminal Search"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/federal_district_criminal_searches/{id}","summary":"Retrieve an existing Federal District  Criminal Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/federal-district-criminal-search/getfederaldistrictcriminalsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Federal Civil Search","link":"/apis/openapi/federal-civil-search","routeSlug":"/apis/openapi/federal-civil-search","items":[{"label":"Retrieve an existing Federal Civil Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/federal-civil-search/getfederalcivilsearch","routeSlug":"/apis/openapi/federal-civil-search/getfederalcivilsearch","metadata":{"seo":{"title":"Retrieve an existing Federal Civil Search","description":"Returns an existing Federal Civil Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFederalCivilSearch","name":"Retrieve an existing Federal Civil Search","isWebhook":false,"pointer":"/paths/~1federal_civil_searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Federal Civil Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Federal Civil Search with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Federal Civil Search to retrieve.","required":true}],"pointer":"/paths/~1federal_civil_searches~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclude","in":"query","schemaId":"schema_90","description":"Indicates whether to return district screenings in pointer search payload","example":"district"}],"pointer":"/paths/~1federal_civil_searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/federal_civil_searches/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[{"name":"exclude","in":"query","required":false,"example":"district","schemaId":"schema_90"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/federal_civil_searches/{id}","href":"federal-civil-search/getfederalcivilsearch","openApiOperationId":"getFederalCivilSearch","summary":"Retrieve an existing Federal Civil Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Federal Civil Search details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FederalCivilSearch"}},"schemaId":"components/schemas/FederalCivilSearch"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1federal_civil_searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FederalCivilSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FederalCivilSearch"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/federal-civil-search/getfederalcivilsearch"}],"panels":[]}]},"httpPath":"/federal_civil_searches/{id}"}],"content":{"contentType":"group","meta":{"name":"Federal Civil Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Federal Civil Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches the PACER database to identify Federal Civil records. Checkr conducts Federal District Searches to verify records identified by this search."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360010443533"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Federal Civil District Search"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/federal_civil_searches/{id}","summary":"Retrieve an existing Federal Civil Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/federal-civil-search/getfederalcivilsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Federal District Civil Search","link":"/apis/openapi/federal-district-civil-search","routeSlug":"/apis/openapi/federal-district-civil-search","items":[{"label":"Retrieve an existing Federal District Civil Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/federal-district-civil-search/getfederaldistrictcivilsearch","routeSlug":"/apis/openapi/federal-district-civil-search/getfederaldistrictcivilsearch","metadata":{"seo":{"title":"Retrieve an existing Federal District Civil Search","description":"Returns an existing Federal District Civil Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFederalDistrictCivilSearch","name":"Retrieve an existing Federal District Civil Search","isWebhook":false,"pointer":"/paths/~1federal_civil_district_searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Federal District Civil Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Federal District Civil Search with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Federal District Civil Search to retrieve.","required":true}],"pointer":"/paths/~1federal_civil_district_searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/federal_civil_district_searches/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/federal_civil_district_searches/{id}","href":"federal-district-civil-search/getfederaldistrictcivilsearch","openApiOperationId":"getFederalDistrictCivilSearch","summary":"Retrieve an existing Federal District Civil Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Federal District Civil Search details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FederalDistrictCivilSearch"}},"schemaId":"components/schemas/FederalDistrictCivilSearch"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1federal_civil_district_searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FederalDistrictCivilSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FederalDistrictCivilSearch"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/federal-district-civil-search/getfederaldistrictcivilsearch"}],"panels":[]}]},"httpPath":"/federal_civil_district_searches/{id}"}],"content":{"contentType":"group","meta":{"name":"Federal District Civil Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Federal District Civil Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches Federal District Civil courts to verify felony and misdemeanor records identified by PACER"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360010443533"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Federal District Civil Search"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/federal_civil_district_searches/{id}","summary":"Retrieve an existing Federal District Civil Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/federal-district-civil-search/getfederaldistrictcivilsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"County Criminal Search","link":"/apis/openapi/county-criminal-search","routeSlug":"/apis/openapi/county-criminal-search","items":[{"label":"Retrieve an existing County Criminal Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/county-criminal-search/getcountycriminalsearch","routeSlug":"/apis/openapi/county-criminal-search/getcountycriminalsearch","metadata":{"seo":{"title":"Retrieve an existing County Criminal Search","description":"Returns an existing County Criminal Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCountyCriminalSearch","name":"Retrieve an existing County Criminal Search","isWebhook":false,"pointer":"/paths/~1county_criminal_searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing County Criminal Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing County Criminal Search with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the County Criminal Search to retrieve.","required":true}],"pointer":"/paths/~1county_criminal_searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/county_criminal_searches/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/county_criminal_searches/{id}","href":"county-criminal-search/getcountycriminalsearch","openApiOperationId":"getCountyCriminalSearch","summary":"Retrieve an existing County Criminal Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"County Criminal Search details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CountyCriminalSearch"}},"schemaId":"components/schemas/CountyCriminalSearch"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1county_criminal_searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CountyCriminalSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CountyCriminalSearch"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/county-criminal-search/getcountycriminalsearch"}],"panels":[]}]},"httpPath":"/county_criminal_searches/{id}"}],"content":{"contentType":"group","meta":{"name":"County Criminal Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"County Criminal Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"County Criminal records make up the majority of criminal records, and are therefore one of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the most complete sources for both felony and misdemeanor records. These records are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not reported to the federal database, and will therefore not be surfaced"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a Federal Criminal Database Search."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The County Criminal Search resource defines the results from a criminal record search"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a specific county."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360001686627"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"County Criminal Search"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/county_criminal_searches/{id}","summary":"Retrieve an existing County Criminal Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/county-criminal-search/getcountycriminalsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"State Criminal Search","link":"/apis/openapi/state-criminal-search","routeSlug":"/apis/openapi/state-criminal-search","items":[{"label":"Retrieve an existing State Criminal Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/state-criminal-search/getstatecriminalsearch","routeSlug":"/apis/openapi/state-criminal-search/getstatecriminalsearch","metadata":{"seo":{"title":"Retrieve an existing State Criminal Search","description":"Returns an existing State Criminal Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStateCriminalSearch","name":"Retrieve an existing State Criminal Search","isWebhook":false,"pointer":"/paths/~1state_criminal_searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing State Criminal Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing State Criminal Search with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the State Criminal Search to retrieve.","required":true}],"pointer":"/paths/~1state_criminal_searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/state_criminal_searches/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/state_criminal_searches/{id}","href":"state-criminal-search/getstatecriminalsearch","openApiOperationId":"getStateCriminalSearch","summary":"Retrieve an existing State Criminal Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"State Criminal Search details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StateCriminalSearch"}},"schemaId":"components/schemas/StateCriminalSearch"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1state_criminal_searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StateCriminalSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StateCriminalSearch"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/state-criminal-search/getstatecriminalsearch"}],"panels":[]}]},"httpPath":"/state_criminal_searches/{id}"}],"content":{"contentType":"group","meta":{"name":"State Criminal Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"State Criminal Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The State Criminal Search returns criminal records from a selected state’s database,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the content of which varies by state. Some states include records reported from all counties;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"some include records only from a few. This search should be used in conjunction with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a County Criminal Search, and not as a replacement for the more complete records returned"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the County Search."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360001668148"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State Criminal Search"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/state_criminal_searches/{id}","summary":"Retrieve an existing State Criminal Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/state-criminal-search/getstatecriminalsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Motor Vehicle Report","link":"/apis/openapi/motor-vehicle-report","routeSlug":"/apis/openapi/motor-vehicle-report","items":[{"label":"Retrieve an existing Motor Vehicle Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/motor-vehicle-report/getmotorvehiclereport","routeSlug":"/apis/openapi/motor-vehicle-report/getmotorvehiclereport","metadata":{"seo":{"title":"Retrieve an existing Motor Vehicle Report","description":"Returns an existing Motor Vehicle Report with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMotorVehicleReport","name":"Retrieve an existing Motor Vehicle Report","isWebhook":false,"pointer":"/paths/~1motor_vehicle_reports~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Motor Vehicle Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an existing Motor Vehicle Report with the input ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response documented here is the multi-MVR format, returned when the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept: application/vnd.checkr.multimvr+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is set (recommended)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without the header the endpoint still works, but returns the legacy format"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"where the license details are flattened onto the top-level object instead of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nested under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"license_reports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Motor Vehicle Report to retrieve.","required":true}],"pointer":"/paths/~1motor_vehicle_reports~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_177","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.checkr.multimvr+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to receive the multi-MVR response format: per-license details (including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"violations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accidents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endorsements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc.) are nested under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"license_reports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array, one entry per license on file, instead of the flattened top-level license fields returned by default."},"children":[]}]}]}]}],"pointer":"/paths/~1motor_vehicle_reports~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/motor_vehicle_reports/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":false,"schemaId":"schema_177"}],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/motor_vehicle_reports/{id}","href":"motor-vehicle-report/getmotorvehiclereport","openApiOperationId":"getMotorVehicleReport","summary":"Retrieve an existing Motor Vehicle Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Motor Vehicle Report details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MotorVehicleReport"}},"schemaId":"components/schemas/MotorVehicleReport"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1motor_vehicle_reports~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MotorVehicleReport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MotorVehicleReport"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/motor-vehicle-report/getmotorvehiclereport"}],"panels":[]}]},"httpPath":"/motor_vehicle_reports/{id}"}],"content":{"contentType":"group","meta":{"name":"Motor Vehicle Report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Motor Vehicle Report","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Motor Vehicle Records originate from a state’s Department of Motor Vehicles, and include"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"information related to a person’s driving history, including driver’s license status and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"restrictions, as well as violations and convictions. Use MVR reports to evaluate a candidate’s"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"driving history and safety record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that some convictions, such as driving under the influence, may appear only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on MVR reports, and not on criminal searches."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360001568167"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Motor Vehicle Records"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/motor_vehicle_reports/{id}","summary":"Retrieve an existing Motor Vehicle Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/motor-vehicle-report/getmotorvehiclereport","deprecated":false}]}]}]}]}},{"type":"group","label":"Drug & Alcohol Clearinghouse Search","link":"/apis/openapi/drug-and-alcohol-clearinghouse-search","routeSlug":"/apis/openapi/drug-and-alcohol-clearinghouse-search","items":[{"label":"Retrieve an existing Drug & Alcohol Clearinghouse Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/drug-and-alcohol-clearinghouse-search/getdrugalcoholclearinghousesearches","routeSlug":"/apis/openapi/drug-and-alcohol-clearinghouse-search/getdrugalcoholclearinghousesearches","metadata":{"seo":{"title":"Retrieve an existing Drug & Alcohol Clearinghouse Search","description":"Returns an existing Drug & Alcohol Clearinghouse Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDrugAlcoholClearinghouseSearches","name":"Retrieve an existing Drug & Alcohol Clearinghouse Search","isWebhook":false,"pointer":"/paths/~1drug_alcohol_clearinghouse_searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Drug & Alcohol Clearinghouse Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an existing Drug & Alcohol Clearinghouse Search with the input ID."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the Drug & Alcohol Clearinghouse Search to retrieve."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1drug_alcohol_clearinghouse_searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/drug_alcohol_clearinghouse_searches/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/drug_alcohol_clearinghouse_searches/{id}","href":"drug-and-alcohol-clearinghouse-search/getdrugalcoholclearinghousesearches","openApiOperationId":"getDrugAlcoholClearinghouseSearches","summary":"Retrieve an existing Drug & Alcohol Clearinghouse Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drug & Alcohol Clearinghouse Search details"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DrugAlcoholClearinghouse"}},"schemaId":"components/schemas/DrugAlcoholClearinghouse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1drug_alcohol_clearinghouse_searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DrugAlcoholClearinghouse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DrugAlcoholClearinghouse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drug-and-alcohol-clearinghouse-search/getdrugalcoholclearinghousesearches"}],"panels":[]}]},"httpPath":"/drug_alcohol_clearinghouse_searches/{id}"}],"content":{"contentType":"group","meta":{"name":"Drug & Alcohol Clearinghouse Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Drug & Alcohol Clearinghouse Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Drug & Alcohol Clearinghouse search provides information about a candidate's drug and alcohol violation history."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The screening includes a query result of Driver Prohibited or Not Prohibited."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Further query details, such as the violations themselves, can be accessed via the Checkr Dashboard."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/20842669601047-DOT-checks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DOT Checks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/drug_alcohol_clearinghouse_searches/{id}","summary":"Retrieve an existing Drug & Alcohol Clearinghouse Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/drug-and-alcohol-clearinghouse-search/getdrugalcoholclearinghousesearches","deprecated":false}]}]}]}]}},{"type":"group","label":"Education Verification","link":"/apis/openapi/education-verification","routeSlug":"/apis/openapi/education-verification","items":[{"label":"Retrieve an existing Education Verification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/education-verification/geteducationverification","routeSlug":"/apis/openapi/education-verification/geteducationverification","metadata":{"seo":{"title":"Retrieve an existing Education Verification","description":"Returns an existing Education Verification with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEducationVerification","name":"Retrieve an existing Education Verification","isWebhook":false,"pointer":"/paths/~1education_verifications~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Education Verification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Education Verification with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Education Verification to retrieve.","required":true}],"pointer":"/paths/~1education_verifications~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/education_verifications/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/education_verifications/{id}","href":"education-verification/geteducationverification","openApiOperationId":"getEducationVerification","summary":"Retrieve an existing Education Verification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Education Verification details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EducationVerification"}},"schemaId":"components/schemas/EducationVerification"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1education_verifications~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EducationVerification","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EducationVerification"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/education-verification/geteducationverification"}],"panels":[]}]},"httpPath":"/education_verifications/{id}"}],"content":{"contentType":"group","meta":{"name":"Education Verification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Education Verification","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use an Education Verification to verify a candidate’s education history, and highest degree"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"achieved."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For this screening, candidates are asked to supply their degree, major, school, and the state"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in which the school is located. Checkr then attempts to verify the information. After three"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed attempts (itemized in the logs), Checkr generates an exception, and asks the candidate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to upload supporting documentation. Once the document is uploaded, the verification process"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will begin again."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360001863468"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Education Verification"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/education_verifications/{id}","summary":"Retrieve an existing Education Verification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/education-verification/geteducationverification","deprecated":false}]}]}]}]}},{"type":"group","label":"Employment Verification","link":"/apis/openapi/employment-verification","routeSlug":"/apis/openapi/employment-verification","items":[{"label":"Retrieve an existing Employment Verification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/employment-verification/getemploymentverification","routeSlug":"/apis/openapi/employment-verification/getemploymentverification","metadata":{"seo":{"title":"Retrieve an existing Employment Verification","description":"Returns an existing Employment Verification with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmploymentVerification","name":"Retrieve an existing Employment Verification","isWebhook":false,"pointer":"/paths/~1employment_verifications~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Employment Verification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Employment Verification with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Employment Verification to retrieve.","required":true}],"pointer":"/paths/~1employment_verifications~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/employment_verifications/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/employment_verifications/{id}","href":"employment-verification/getemploymentverification","openApiOperationId":"getEmploymentVerification","summary":"Retrieve an existing Employment Verification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Employment Verification details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmploymentVerification"}},"schemaId":"components/schemas/EmploymentVerification"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1employment_verifications~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmploymentVerification","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmploymentVerification"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employment-verification/getemploymentverification"}],"panels":[]}]},"httpPath":"/employment_verifications/{id}"}],"content":{"contentType":"group","meta":{"name":"Employment Verification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Employment Verification","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use an Employment Verification to verify a candidate’s employment history for the last three"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"employers, or the last seven years."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For this screening, candidates are asked to supply their employment history. Checkr then"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attempts to verify the information. After three failed attempts (itemized in the logs),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checkr generates an exception, and asks the candidate to upload supporting documentation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once the document is uploaded, the verification process will begin again."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/228391768"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Employment Verification"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/employment_verifications/{id}","summary":"Retrieve an existing Employment Verification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employment-verification/getemploymentverification","deprecated":false}]}]}]}]}},{"type":"group","label":"Personal Reference Verification","link":"/apis/openapi/personal-reference-verification","routeSlug":"/apis/openapi/personal-reference-verification","items":[{"label":"Retrieve an existing Personal Reference Verification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/personal-reference-verification/getpersonalreferenceverification","routeSlug":"/apis/openapi/personal-reference-verification/getpersonalreferenceverification","metadata":{"seo":{"title":"Retrieve an existing Personal Reference Verification","description":"Returns an existing Personal Reference Verification with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPersonalReferenceVerification","name":"Retrieve an existing Personal Reference Verification","isWebhook":false,"pointer":"/paths/~1personal_reference_verifications~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Personal Reference Verification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Personal Reference Verification with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Personal Reference Verification to retrieve.","required":true}],"pointer":"/paths/~1personal_reference_verifications~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/personal_reference_verifications/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/personal_reference_verifications/{id}","href":"personal-reference-verification/getpersonalreferenceverification","openApiOperationId":"getPersonalReferenceVerification","summary":"Retrieve an existing Personal Reference Verification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Personal Reference Verification details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonalReferenceVerification"}},"schemaId":"components/schemas/PersonalReferenceVerification"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1personal_reference_verifications~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PersonalReferenceVerification","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonalReferenceVerification"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/personal-reference-verification/getpersonalreferenceverification"}],"panels":[]}]},"httpPath":"/personal_reference_verifications/{id}"}],"content":{"contentType":"group","meta":{"name":"Personal Reference Verification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Personal Reference Verification","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use a Personal Reference Verification to verify a candidate’s personal credentials."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For this screening, candidates are asked to supply a personal reference. Checkr then contacts the personal reference and asks predefined questions to confirm their credentials."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360000989328-Personal-and-Professional-Reference-Checks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal and Professional Reference Checks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/personal_reference_verifications/{id}","summary":"Retrieve an existing Personal Reference Verification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/personal-reference-verification/getpersonalreferenceverification","deprecated":false}]}]}]}]}},{"type":"group","label":"Professional Reference Verification","link":"/apis/openapi/professional-reference-verification","routeSlug":"/apis/openapi/professional-reference-verification","items":[{"label":"Retrieve an existing Professional Reference Verification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/professional-reference-verification/getprofessionalreferenceverification","routeSlug":"/apis/openapi/professional-reference-verification/getprofessionalreferenceverification","metadata":{"seo":{"title":"Retrieve an existing Professional Reference Verification","description":"Returns an existing Professional Reference Verification with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProfessionalReferenceVerification","name":"Retrieve an existing Professional Reference Verification","isWebhook":false,"pointer":"/paths/~1professional_reference_verifications~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Professional Reference Verification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Professional Reference Verification with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Professional Reference Verification to retrieve.","required":true}],"pointer":"/paths/~1professional_reference_verifications~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/professional_reference_verifications/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/professional_reference_verifications/{id}","href":"professional-reference-verification/getprofessionalreferenceverification","openApiOperationId":"getProfessionalReferenceVerification","summary":"Retrieve an existing Professional Reference Verification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Professional Reference Verification details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProfessionalReferenceVerification"}},"schemaId":"components/schemas/ProfessionalReferenceVerification"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1professional_reference_verifications~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProfessionalReferenceVerification","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProfessionalReferenceVerification"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/professional-reference-verification/getprofessionalreferenceverification"}],"panels":[]}]},"httpPath":"/professional_reference_verifications/{id}"}],"content":{"contentType":"group","meta":{"name":"Professional Reference Verification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Professional Reference Verification","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use a Professional Reference Verification to verify a candidate’s professional credentials."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For this screening, candidates are asked to supply a professional reference. Checkr then contacts the professional reference and asks predefined questions to confirm their credentials."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360000989328-Personal-and-Professional-Reference-Checks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal and Professional Reference Checks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/professional_reference_verifications/{id}","summary":"Retrieve an existing Professional Reference Verification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/professional-reference-verification/getprofessionalreferenceverification","deprecated":false}]}]}]}]}},{"type":"group","label":"Professional License Verification","link":"/apis/openapi/professional-license-verification","routeSlug":"/apis/openapi/professional-license-verification","items":[{"label":"Retrieve an existing Professional License Verification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/professional-license-verification/getprofessionallicenseverification","routeSlug":"/apis/openapi/professional-license-verification/getprofessionallicenseverification","metadata":{"seo":{"title":"Retrieve an existing Professional License Verification","description":"Returns an existing Professional License Verification with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProfessionalLicenseVerification","name":"Retrieve an existing Professional License Verification","isWebhook":false,"pointer":"/paths/~1professional_license_verifications~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Professional License Verification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Professional License Verification with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Professional License Verification to retrieve.","required":true}],"pointer":"/paths/~1professional_license_verifications~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/professional_license_verifications/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/professional_license_verifications/{id}","href":"professional-license-verification/getprofessionallicenseverification","openApiOperationId":"getProfessionalLicenseVerification","summary":"Retrieve an existing Professional License Verification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Professional License Verification details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProfessionalLicenseVerification"}},"schemaId":"components/schemas/ProfessionalLicenseVerification"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1professional_license_verifications~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProfessionalLicenseVerification","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProfessionalLicenseVerification"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/professional-license-verification/getprofessionallicenseverification"}],"panels":[]}]},"httpPath":"/professional_license_verifications/{id}"}],"content":{"contentType":"group","meta":{"name":"Professional License Verification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Professional License Verification","showPageActions":true},{"nodeType":"markdoc","content":"Use a Professional License Verification to verify a candidate's professional credentials."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/professional_license_verifications/{id}","summary":"Retrieve an existing Professional License Verification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/professional-license-verification/getprofessionallicenseverification","deprecated":false}]}]}]}]}},{"type":"group","label":"FACIS Search","link":"/apis/openapi/facis-search","routeSlug":"/apis/openapi/facis-search","items":[{"label":"Retrieve an existing FACIS Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/facis-search/getfacissearch","routeSlug":"/apis/openapi/facis-search/getfacissearch","metadata":{"seo":{"title":"Retrieve an existing FACIS Search","description":"Returns an existing FACIS Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFacisSearch","name":"Retrieve an existing FACIS Search","isWebhook":false,"pointer":"/paths/~1facis_searches~1${id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing FACIS Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing FACIS Search with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Facis Search to retrieve.","required":true}],"pointer":"/paths/~1facis_searches~1${id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/facis_searches/${id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/facis_searches/${id}","href":"facis-search/getfacissearch","openApiOperationId":"getFacisSearch","summary":"Retrieve an existing FACIS Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"FACIS Search details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FacisSearch"}},"schemaId":"components/schemas/FacisSearch"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1facis_searches~1${id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FacisSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FacisSearch"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/facis-search/getfacissearch"}],"panels":[]}]},"httpPath":"/facis_searches/${id}"}],"content":{"contentType":"group","meta":{"name":"FACIS Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FACIS Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches databases for records of adverse actions against individuals and entities in the healthcare field. For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360001576947-FACIS-Fraud-Abuse-Control-Information-System-search"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FACIS"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/facis_searches/${id}","summary":"Retrieve an existing FACIS Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/facis-search/getfacissearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Social Media Screening","link":"/apis/openapi/social-media-screening","routeSlug":"/apis/openapi/social-media-screening","items":[{"label":"Retrieve an existing Social Media Screening","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/social-media-screening/getsocialmediascreening","routeSlug":"/apis/openapi/social-media-screening/getsocialmediascreening","metadata":{"seo":{"title":"Retrieve an existing Social Media Screening","description":"Returns an existing Social Media Screening with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSocialMediaScreening","name":"Retrieve an existing Social Media Screening","isWebhook":false,"pointer":"/paths/~1social_media_screenings~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing Social Media Screening","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing Social Media Screening with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the Social Media Screening to retrieve.","required":true}],"pointer":"/paths/~1social_media_screenings~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/social_media_screenings/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/social_media_screenings/{id}","href":"social-media-screening/getsocialmediascreening","openApiOperationId":"getSocialMediaScreening","summary":"Retrieve an existing Social Media Screening"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Social Media Screening details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SocialMediaScreening"}},"schemaId":"components/schemas/SocialMediaScreening"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1social_media_screenings~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SocialMediaScreening","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SocialMediaScreening"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/social-media-screening/getsocialmediascreening"}],"panels":[]}]},"httpPath":"/social_media_screenings/{id}"}],"content":{"contentType":"group","meta":{"name":"Social Media Screening"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Social Media Screening","showPageActions":true},{"nodeType":"markdoc","content":"A Social Media Screening searches publicly available social media content for material that may be relevant to a candidate's background check. The result includes any flagged behavior categories and a PDF document of the findings."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/social_media_screenings/{id}","summary":"Retrieve an existing Social Media Screening","prefix":{"name":"get","color":"get"},"badges":[],"link":"/social-media-screening/getsocialmediascreening","deprecated":false}]}]}]}]}},{"type":"group","label":"FMCSA Pre-Employment Screening Program Search","link":"/apis/openapi/fmcsa-pre-employment-screening-program-search","routeSlug":"/apis/openapi/fmcsa-pre-employment-screening-program-search","items":[{"label":"Retrieve an existing FMCSA Pre-Employment Screening Program Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/fmcsa-pre-employment-screening-program-search/getfmcsapreemploymentscreeningprogramsearches","routeSlug":"/apis/openapi/fmcsa-pre-employment-screening-program-search/getfmcsapreemploymentscreeningprogramsearches","metadata":{"seo":{"title":"Retrieve an existing FMCSA Pre-Employment Screening Program Search","description":"Returns an existing FMCSA Pre-Employment Screening Program Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFmcsaPreEmploymentScreeningProgramSearches","name":"Retrieve an existing FMCSA Pre-Employment Screening Program Search","isWebhook":false,"pointer":"/paths/~1fmcsa_pre_employment_screening_program_searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing FMCSA Pre-Employment Screening Program Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing FMCSA Pre-Employment Screening Program Search with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the FMCSA Pre-Employment Screening Program Search to retrieve.","required":true}],"pointer":"/paths/~1fmcsa_pre_employment_screening_program_searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fmcsa_pre_employment_screening_program_searches/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/fmcsa_pre_employment_screening_program_searches/{id}","href":"fmcsa-pre-employment-screening-program-search/getfmcsapreemploymentscreeningprogramsearches","openApiOperationId":"getFmcsaPreEmploymentScreeningProgramSearches","summary":"Retrieve an existing FMCSA Pre-Employment Screening Program Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"FMCSA Pre-Employment Screening Program Search details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FmcsaPreEmploymentScreeningProgram"}},"schemaId":"components/schemas/FmcsaPreEmploymentScreeningProgram"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1fmcsa_pre_employment_screening_program_searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FmcsaPreEmploymentScreeningProgram","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FmcsaPreEmploymentScreeningProgram"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fmcsa-pre-employment-screening-program-search/getfmcsapreemploymentscreeningprogramsearches"}],"panels":[]}]},"httpPath":"/fmcsa_pre_employment_screening_program_searches/{id}"}],"content":{"contentType":"group","meta":{"name":"FMCSA Pre-Employment Screening Program Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FMCSA Pre-Employment Screening Program Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An FMCSA Pre-Employment Screening Program (PSP) search provides a candidate's DOT safety performance history, including crash and inspection records from the FMCSA."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The screening includes a record result of FOUND or NOT_FOUND, and a presigned URL to download the PSP report PDF when available."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/20842669601047-DOT-checks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DOT Checks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Checkr Help Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fmcsa_pre_employment_screening_program_searches/{id}","summary":"Retrieve an existing FMCSA Pre-Employment Screening Program Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fmcsa-pre-employment-screening-program-search/getfmcsapreemploymentscreeningprogramsearches","deprecated":false}]}]}]}]}},{"type":"group","label":"Identity Data Evaluation","link":"/apis/openapi/identity-data-evaluation","routeSlug":"/apis/openapi/identity-data-evaluation","items":[{"label":"Retrieve an existing identity data evaluation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/identity-data-evaluation/getidentitydataevaluation","routeSlug":"/apis/openapi/identity-data-evaluation/getidentitydataevaluation","metadata":{"seo":{"title":"Retrieve an existing identity data evaluation","description":"Returns an existing identity data evaluation with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIdentityDataEvaluation","name":"Retrieve an existing identity data evaluation","isWebhook":false,"pointer":"/paths/~1identity_data_evaluations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing identity data evaluation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing identity data evaluation with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the identity data evaluation to retrieve.","required":true}],"pointer":"/paths/~1identity_data_evaluations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/identity_data_evaluations/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/identity_data_evaluations/{id}","href":"identity-data-evaluation/getidentitydataevaluation","openApiOperationId":"getIdentityDataEvaluation","summary":"Retrieve an existing identity data evaluation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"identity data evaluation details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentityDataEvaluation"}},"schemaId":"components/schemas/IdentityDataEvaluation"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1identity_data_evaluations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdentityDataEvaluation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentityDataEvaluation"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identity-data-evaluation/getidentitydataevaluation"}],"panels":[]}]},"httpPath":"/identity_data_evaluations/{id}"}],"content":{"contentType":"group","meta":{"name":"Identity Data Evaluation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Identity Data Evaluation","showPageActions":true},{"nodeType":"markdoc","content":"Analyzes SSN usage patterns to identify potential identity data inconsistencies. Returns risk signals such as the number of distinct names, dates of birth, and employers associated with the SSN."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/identity_data_evaluations/{id}","summary":"Retrieve an existing identity data evaluation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identity-data-evaluation/getidentitydataevaluation","deprecated":false}]}]}]}]}},{"type":"separator","label":"International Screening","content":null},{"type":"group","label":"International Adverse Media Search","link":"/apis/openapi/international-adverse-media-search","routeSlug":"/apis/openapi/international-adverse-media-search","items":[{"label":"Retrieve an existing International Adverse Media Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/international-adverse-media-search/getinternationaladversemediasearch","routeSlug":"/apis/openapi/international-adverse-media-search/getinternationaladversemediasearch","metadata":{"seo":{"title":"Retrieve an existing International Adverse Media Search","description":"Returns an existing International Adverse Media Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInternationalAdverseMediaSearch","name":"Retrieve an existing International Adverse Media Search","isWebhook":false,"pointer":"/paths/~1international_adverse_media_searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing International Adverse Media Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing International Adverse Media Search with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the International Adverse Media Search to retrieve.","required":true}],"pointer":"/paths/~1international_adverse_media_searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/international_adverse_media_searches/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/international_adverse_media_searches/{id}","href":"international-adverse-media-search/getinternationaladversemediasearch","openApiOperationId":"getInternationalAdverseMediaSearch","summary":"Retrieve an existing International Adverse Media Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"International Adverse Media Search details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalAdverseMediaSearch"}},"schemaId":"components/schemas/InternationalAdverseMediaSearch"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1international_adverse_media_searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InternationalAdverseMediaSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalAdverseMediaSearch"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/international-adverse-media-search/getinternationaladversemediasearch"}],"panels":[]}]},"httpPath":"/international_adverse_media_searches/{id}"}],"content":{"contentType":"group","meta":{"name":"International Adverse Media Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"International Adverse Media Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In countries where third party access to criminal record information is restricted, Adverse Media Checks may be performed to access private databases, public sanctions lists, media sources, and other public and private record repositories."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360056108714-International-Screenings#:~:text=is%204%20days.-,Adverse%20Media%20Check,-%3A%20In%20countries"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Screenings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/international_adverse_media_searches/{id}","summary":"Retrieve an existing International Adverse Media Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/international-adverse-media-search/getinternationaladversemediasearch","deprecated":false}]}]}]}]}},{"type":"group","label":"International Criminal Search","link":"/apis/openapi/international-criminal-search","routeSlug":"/apis/openapi/international-criminal-search","items":[{"label":"Retrieve an existing International Criminal Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/international-criminal-search/getinternationalcriminalsearch","routeSlug":"/apis/openapi/international-criminal-search/getinternationalcriminalsearch","metadata":{"seo":{"title":"Retrieve an existing International Criminal Search","description":"Returns an existing International Criminal Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInternationalCriminalSearch","name":"Retrieve an existing International Criminal Search","isWebhook":false,"pointer":"/paths/~1international_criminal_searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing International Criminal Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing International Criminal Search with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the International Criminal Search to retrieve.","required":true}],"pointer":"/paths/~1international_criminal_searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/international_criminal_searches/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/international_criminal_searches/{id}","href":"international-criminal-search/getinternationalcriminalsearch","openApiOperationId":"getInternationalCriminalSearch","summary":"Retrieve an existing International Criminal Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"International Criminal Search details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalCriminalSearch"}},"schemaId":"components/schemas/InternationalCriminalSearch"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1international_criminal_searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InternationalCriminalSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalCriminalSearch"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/international-criminal-search/getinternationalcriminalsearch"}],"panels":[]}]},"httpPath":"/international_criminal_searches/{id}"}],"content":{"contentType":"group","meta":{"name":"International Criminal Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"International Criminal Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criminal records check in supported countries. Criminal data is accessed from the appropriate database or agency."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360056108714-International-Screenings#:~:text=International%20Criminal%20Check"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Screenings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/international_criminal_searches/{id}","summary":"Retrieve an existing International Criminal Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/international-criminal-search/getinternationalcriminalsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"International Education Verification","link":"/apis/openapi/international-education-verification","routeSlug":"/apis/openapi/international-education-verification","items":[{"label":"Retrieve an existing International Education Verificaiton","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/international-education-verification/getinternationaleducationverificaiton","routeSlug":"/apis/openapi/international-education-verification/getinternationaleducationverificaiton","metadata":{"seo":{"title":"Retrieve an existing International Education Verificaiton","description":"Returns an existing International Education Verificaiton with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInternationalEducationVerificaiton","name":"Retrieve an existing International Education Verificaiton","isWebhook":false,"pointer":"/paths/~1international_education_verifications~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing International Education Verificaiton","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing International Education Verificaiton with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the International Education Verificaiton to retrieve.","required":true}],"pointer":"/paths/~1international_education_verifications~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/international_education_verifications/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/international_education_verifications/{id}","href":"international-education-verification/getinternationaleducationverificaiton","openApiOperationId":"getInternationalEducationVerificaiton","summary":"Retrieve an existing International Education Verificaiton"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"International Education Verification details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalEducationVerification"}},"schemaId":"components/schemas/InternationalEducationVerification"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1international_education_verifications~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InternationalEducationVerification","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalEducationVerification"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/international-education-verification/getinternationaleducationverificaiton"}],"panels":[]}]},"httpPath":"/international_education_verifications/{id}"}],"content":{"contentType":"group","meta":{"name":"International Education Verification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"International Education Verification","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The verification of academic status of any educational level such as high school, college and post-grad may include institution name, dates of attendance, graduation/conferred date, degree obtained, major, minor, honors and relevant awards. Reasonable attempts will be made to search available industry databases and international educational institutions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360056108714-International-Screenings#:~:text=International%20Education%20Verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Screenings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/international_education_verifications/{id}","summary":"Retrieve an existing International Education Verificaiton","prefix":{"name":"get","color":"get"},"badges":[],"link":"/international-education-verification/getinternationaleducationverificaiton","deprecated":false}]}]}]}]}},{"type":"group","label":"International Employment Verification","link":"/apis/openapi/international-employment-verification","routeSlug":"/apis/openapi/international-employment-verification","items":[{"label":"Retrieve an existing International Employment Verification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/international-employment-verification/getinternationalemploymentverification","routeSlug":"/apis/openapi/international-employment-verification/getinternationalemploymentverification","metadata":{"seo":{"title":"Retrieve an existing International Employment Verification","description":"Returns an existing International Employment Verification with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInternationalEmploymentVerification","name":"Retrieve an existing International Employment Verification","isWebhook":false,"pointer":"/paths/~1international_employment_verifications{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing International Employment Verification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing International Employment Verification with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the International Employment Verification to retrieve.","required":true}],"pointer":"/paths/~1international_employment_verifications{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/international_employment_verifications{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/international_employment_verifications{id}","href":"international-employment-verification/getinternationalemploymentverification","openApiOperationId":"getInternationalEmploymentVerification","summary":"Retrieve an existing International Employment Verification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"International Employment Verification details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalEmploymentVerification"}},"schemaId":"components/schemas/InternationalEmploymentVerification"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1international_employment_verifications{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InternationalEmploymentVerification","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalEmploymentVerification"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/international-employment-verification/getinternationalemploymentverification"}],"panels":[]}]},"httpPath":"/international_employment_verifications{id}"}],"content":{"contentType":"group","meta":{"name":"International Employment Verification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"International Employment Verification","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verification of previous employment history may include employer’s name, dates of employment, position/title, reason for leaving, eligibility for rehire, and comments. Reasonable attempts will be made to verify available government agencies and employment databases. Email verification, and phone verification may be used in countries where the records of former employers are not available in searchable form, and where contacting the supervisor or manager is common practice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360056108714-International-Screenings#:~:text=International%20Employment%20Verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Screenings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/international_employment_verifications{id}","summary":"Retrieve an existing International Employment Verification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/international-employment-verification/getinternationalemploymentverification","deprecated":false}]}]}]}]}},{"type":"group","label":"International Global Watchlist Search","link":"/apis/openapi/international-global-watchlist-search","routeSlug":"/apis/openapi/international-global-watchlist-search","items":[{"label":"Retrieve an existing International Global Watchlist Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/international-global-watchlist-search/getinternationalglobalwatchlistsearch","routeSlug":"/apis/openapi/international-global-watchlist-search/getinternationalglobalwatchlistsearch","metadata":{"seo":{"title":"Retrieve an existing International Global Watchlist Search","description":"Returns an existing International Global Watchlist Search with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInternationalGlobalWatchlistSearch","name":"Retrieve an existing International Global Watchlist Search","isWebhook":false,"pointer":"/paths/~1international_global_watchlist_searches~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing International Global Watchlist Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing International Global Watchlist Search with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the International Global Watchlist Search to retrieve.","required":true}],"pointer":"/paths/~1international_global_watchlist_searches~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/international_global_watchlist_searches/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/international_global_watchlist_searches/{id}","href":"international-global-watchlist-search/getinternationalglobalwatchlistsearch","openApiOperationId":"getInternationalGlobalWatchlistSearch","summary":"Retrieve an existing International Global Watchlist Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"International Global Watchlist Search details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalGlobalWatchlistSearch"}},"schemaId":"components/schemas/InternationalGlobalWatchlistSearch"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1international_global_watchlist_searches~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InternationalGlobalWatchlistSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalGlobalWatchlistSearch"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/international-global-watchlist-search/getinternationalglobalwatchlistsearch"}],"panels":[]}]},"httpPath":"/international_global_watchlist_searches/{id}"}],"content":{"contentType":"group","meta":{"name":"International Global Watchlist Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"International Global Watchlist Search","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A comprehensive search of multiple U.S. and International government watchlists which include the FBI’s Most Wanted list, Interpol's Most Wanted lists, Office of Foreign Asset Control Sanction lists, Denied Persons lists, Department of State Sanction lists, and the Specially Designated Nationals List."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360056108714-International-Screenings#:~:text=Global%20Watchlist%20Check"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Screenings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/international_global_watchlist_searches/{id}","summary":"Retrieve an existing International Global Watchlist Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/international-global-watchlist-search/getinternationalglobalwatchlistsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"International Identity Document Validation","link":"/apis/openapi/international-identity-document-validation","routeSlug":"/apis/openapi/international-identity-document-validation","items":[{"label":"Retrieve an existing International Identity Document Validation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/international-identity-document-validation/getinternationalidentitydocumentvalidation","routeSlug":"/apis/openapi/international-identity-document-validation/getinternationalidentitydocumentvalidation","metadata":{"seo":{"title":"Retrieve an existing International Identity Document Validation","description":"Returns an existing International Identity Document Validation with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInternationalIdentityDocumentValidation","name":"Retrieve an existing International Identity Document Validation","isWebhook":false,"pointer":"/paths/~1international_identity_document_validation~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing International Identity Document Validation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing International Identity Document Validation with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the International Identity Document Validation to retrieve.","required":true}],"pointer":"/paths/~1international_identity_document_validation~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/international_identity_document_validation/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/international_identity_document_validation/{id}","href":"international-identity-document-validation/getinternationalidentitydocumentvalidation","openApiOperationId":"getInternationalIdentityDocumentValidation","summary":"Retrieve an existing International Identity Document Validation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"International Identity Document Validation details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalIdentityDocumentValidation"}},"schemaId":"components/schemas/InternationalIdentityDocumentValidation"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1international_identity_document_validation~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InternationalIdentityDocumentValidation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalIdentityDocumentValidation"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/international-identity-document-validation/getinternationalidentitydocumentvalidation"}],"panels":[]}]},"httpPath":"/international_identity_document_validation/{id}"}],"content":{"contentType":"group","meta":{"name":"International Identity Document Validation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"International Identity Document Validation","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies that the candidate’s passport, national ID or driver’s license is authentic and validly in circulation. This check provides a multi-level validation process by inspecting document data and positioning for authenticity, scanning the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Machine-readable_passport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine Readable Zone"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (if available), and cross-checking the information provided against government databases to discover if the document is stolen, lost, expired or invalid."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360056108714-International-Screenings#:~:text=to%20international%20candidates%3A-,Identity%20Document%20Validation,-%3A%20Verifies%20that"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Screenings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/international_identity_document_validation/{id}","summary":"Retrieve an existing International Identity Document Validation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/international-identity-document-validation/getinternationalidentitydocumentvalidation","deprecated":false}]}]}]}]}},{"type":"group","label":"International Motor Vehicle Report","link":"/apis/openapi/international-motor-vehicle-report","routeSlug":"/apis/openapi/international-motor-vehicle-report","items":[{"label":"Retrieve an existing International Motor Vehicle Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/openapi/international-motor-vehicle-report/getinternationalmotorvehiclereport","routeSlug":"/apis/openapi/international-motor-vehicle-report/getinternationalmotorvehiclereport","metadata":{"seo":{"title":"Retrieve an existing International Motor Vehicle Report","description":"Returns an existing International Motor Vehicle Report with the input ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInternationalMotorVehicleReport","name":"Retrieve an existing International Motor Vehicle Report","isWebhook":false,"pointer":"/paths/~1international_motor_vehicle_reports~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an existing International Motor Vehicle Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an existing International Motor Vehicle Report with the input ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basic_auth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_90","description":"ID of the International Motor Vehicle Report to retrieve.","required":true}],"pointer":"/paths/~1international_motor_vehicle_reports~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/international_motor_vehicle_reports/{id}","servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_90"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basic_auth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/international_motor_vehicle_reports/{id}","href":"international-motor-vehicle-report/getinternationalmotorvehiclereport","openApiOperationId":"getInternationalMotorVehicleReport","summary":"Retrieve an existing International Motor Vehicle Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"International Motor Vehicle Report details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalMotorVehicleReport"}},"schemaId":"components/schemas/InternationalMotorVehicleReport"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"}],"pointer":"/paths/~1international_motor_vehicle_reports~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InternationalMotorVehicleReport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalMotorVehicleReport"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/international-motor-vehicle-report/getinternationalmotorvehiclereport"}],"panels":[]}]},"httpPath":"/international_motor_vehicle_reports/{id}"}],"content":{"contentType":"group","meta":{"name":"International Motor Vehicle Report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"International Motor Vehicle Report","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checks the validity of a driver license and where available, may include a detailed history of the candidate’s driving violations or license conditions. Canada only at this time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.checkr.com/hc/en-us/articles/360056108714-International-Screenings#:~:text=International%20motor%20vehicle,hours%20to%20weeks."},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International Screenings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/international_motor_vehicle_reports/{id}","summary":"Retrieve an existing International Motor Vehicle Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/international-motor-vehicle-report/getinternationalmotorvehiclereport","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ResourceURI":{"id":"components/schemas/ResourceURI","kind":"json-schema","title":"ResourceURI","data":{"type":"string","description":"URI of the resource.","readOnly":true}},"components/schemas/Account":{"id":"components/schemas/Account","kind":"json-schema","title":"Account","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The returned Account ID is dependent on the API token used to make the call."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an account-level API token is used, the ID of the account associated with the Live API Token will be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a partner OAuth token is used, the ID of the account (or customer's account) connected to the OAuth application will be returned."},"children":[]}]}]}]}]},"object":{"type":"string","enum":["account"]},"account_deauthorization":{"type":"object","description":"Account deauthorization details if account has been deauthorized.\n","properties":{"reason":{"type":"string","description":"Reason for account deauthorization.","example":"nonpayment"}}},"adverse_action_email":{"type":"string","description":"Email used to send pre- and post- Adverse Action notices on behalf of the Account to candidates.\nThis address will also receive undeliverable notices if an Adverse Action notice isn't deliverable to a candidate.\n","format":"email","example":"john.doe@example.com"},"api_authorized":{"type":"boolean","description":"Determines whether Account is authorized to use the API to order background checks.\n","default":false,"example":true},"authorized":{"type":"boolean","description":"Determines whether Account is credentialed to order background checks.\n","default":false,"example":true},"available_screenings":{"type":"array","description":"List of screening types available for the Account.\n","items":{"type":"string","pattern":"[a-z_]+"},"example":["county_civil_search","county_criminal_search","municipal_criminal_search","education_verification","employment_verification","federal_civil_search","federal_criminal_search","motor_vehicle_report","national_criminal_search","sex_offender_search","ssn_trace","state_criminal_search","international_adverse_media_search","international_education_verification"]},"billing_email":{"type":"string","description":"Email that is used for Checkr to contact you about invoices and other billing communication.\n","format":"email","example":"john.doe@example.com"},"company":{"type":"object","description":"Company details","properties":{"name":{"type":"string","description":"Registered company name.","example":"Acme Corporation"},"dba_name":{"type":"string","description":"Doing-Business-As name of Company displayed in Checkr emails and branded web pages.\n","example":"ACME"},"street":{"type":"string","description":"Street address where company is headquartered.","example":"123 Main St"},"city":{"type":"string","description":"City where company is headquartered.","example":"Wilmington"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State where company is headquartered. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-2:US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"DE"},"zipcode":{"type":"string","description":"Zipcode where company is headquartered.","example":"19801"},"phone":{"type":"string","description":"Company phone number.","example":"206-555-0100"},"website":{"type":"string","description":"Company's official corporate website.","example":"https://example.com"},"industry":{"type":"string","description":"Industry that company operates in, as NAICS code (see https://www.naics.com)","pattern":"[0-9-]+","example":"52-59"},"incorporation_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incorporation state. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-2:US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"DE"},"incorporation_type":{"type":"string","description":"Type of incorporation.","example":"llc","enum":["association","co-ownership","corporation","joint-venture","limited-partnership","llc","llp","non-profit","partnership","s-corporation","sp","trusteeship"]},"tax_id":{"type":"string","description":"Company Tax ID number.","example":"123456789","writeOnly":true}}},"compliance_contact_email":{"type":"string","description":"Email for the main point of contact on your side to communicate with Checkr about\ncompliance issues or updates. This is also where we'll send you the results of candidate\ndisputes (for example, if we changed the information on a report).\n","format":"email","example":"compliance.team@example.com"},"created_at":{"type":"string","description":"Time at which the Account was created.","format":"date-time","example":"2020-01-07T00:26:49Z"},"default_compliance_city":{"type":"string","description":"Fallback compliance city if candidate location is not provided.\n","nullable":true,"example":"San Francisco"},"default_compliance_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fallback compliance state if candidate location is not provided. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-2:US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"CA","nullable":true},"geos_required":{"type":"boolean","description":"Determines whether a Geo must be provided to order a Report.","default":false},"name":{"type":"string","description":"Name of Account displayed in the Dashboard.","example":"Acme Corp"},"purpose":{"type":"string","description":"Permissible purpose to run background checks.\nDetermines which background checks the Account is credentialed for.\n","default":"employment","enum":["employment","business","insurance","tenant"]},"segmentation_enabled":{"type":"boolean","description":"Determines whether Hierarchy/Nodes is enabled on the Account.","default":true},"support_email":{"type":"string","description":"Email address used for candidates to contact you if they need to supply evidence\nof rehabilitation or other context during the Adverse Action process.\n","format":"email","example":"support@example.com","nullable":true},"support_phone":{"type":"string","description":"Phone number used for candidates to contact you if they need to supply evidence of\nrehabilitation or other context during the Adverse Action process.\n","nullable":true,"example":"206-555-0188"},"technical_contact_email":{"type":"string","description":"The main point of contact on your side to communicate with Checkr about technical issues or\nupdates.\n","format":"email","example":"jane.smith@example.com"},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/accounts/e44aa283528e6fde7d542194"},"uri_name":{"type":"string","example":"acme-corp","pattern":"[a-z0-9-_]+","description":"Unique slug referencing the Account. This appears in some Account-specific URL paths.\n"}}}},"components/schemas/UnauthorizedError":{"id":"components/schemas/UnauthorizedError","kind":"json-schema","title":"UnauthorizedError","data":{"type":"object","properties":{"error":{"type":"string","example":"Bad authentication error"}}}},"components/schemas/ForbiddenError":{"id":"components/schemas/ForbiddenError","kind":"json-schema","title":"ForbiddenError","data":{"type":"object","properties":{"error":{"type":"string","example":"You do not have permission to access the requested resource"}}}},"components/schemas/ResourceId":{"id":"components/schemas/ResourceId","kind":"json-schema","title":"ResourceId","data":{"type":"string","example":"e44aa283528e6fde7d542194","readOnly":true,"description":"ID of the resource."}},"components/schemas/AssessmentValue":{"id":"components/schemas/AssessmentValue","kind":"json-schema","title":"AssessmentValue","data":{"type":"string","example":"eligible","enum":["eligible","review","escalated"]}},"components/schemas/Rule":{"id":"components/schemas/Rule","kind":"json-schema","title":"Rule","data":{"type":"object","description":"Description of the applied Rule, as defined for your account.\n","properties":{"name":{"type":"string","description":"The name of the Rule, as defined for your account.","example":"Allow dismissed charges rule"},"type":{"type":"string","description":"The type of the Rule.","enum":["count","custom","default","lookback_period","fairness_and_compliance","undefined"],"example":"lookback_period"}}}},"components/schemas/AdverseItemAssessment":{"id":"components/schemas/AdverseItemAssessment","kind":"json-schema","title":"AdverseItemAssessment","data":{"type":"object","description":"Information about the Assessment of the Adverse Item.\n\nIncluded only if Assess is enabled for the account.\n","properties":{"value":{"$ref":"#/components/schemas/AssessmentValue"},"rule":{"$ref":"#/components/schemas/Rule"}}}},"components/schemas/AdverseItem":{"id":"components/schemas/AdverseItem","kind":"json-schema","title":"AdverseItem","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","description":"Defines the object type.","enum":["adverse_item"],"readOnly":true},"text":{"type":"string","description":"Human-readable description of the Adverse Item.","example":"License status: Suspended"},"assessment":{"$ref":"#/components/schemas/AdverseItemAssessment"}}}},"components/schemas/AdverseAction":{"id":"components/schemas/AdverseAction","kind":"json-schema","title":"AdverseAction","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["adverse_action"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/adverse_actions/57ed51e57619e8002a6683f2"},"created_at":{"type":"string","description":"Time at which the Adverse Action was created.","format":"date-time","example":"2016-09-29T17:39:49Z"},"delivery":{"type":"object","description":"Details about the delivery state of the Adverse Action.","properties":{"state":{"type":"string","description":"Status of delivery for the Adverse Action.","enum":["none","queued","sent","delivered","error","unknown","unopened"],"example":"delivered"},"reason":{"type":"string","nullable":true,"description":"Reason for the current state. Typically, this an error message, e.g. the raw response from an email provider.","example":"The email account that you tried to reach does not exist. Please double-check the recipient's email address for typos or unnecessary spaces."},"updated_at":{"type":"string","description":"Time at which the delivery state was updated.","format":"date-time","example":"2016-09-29T17:39:49Z"}}},"status":{"type":"string","description":"Status of the Adverse Action.","enum":["pending","complete","dispute","canceled"],"example":"pending"},"report_id":{"type":"string","description":"ID of the Report causing this adverse action.","example":"b861a56db1b1b89692dd6118"},"post_notice_scheduled_at":{"type":"string","nullable":true,"description":"Timestamp at which the post Adverse Action notification will be sent. This time is\ndependent on the time at which the Pre-Adverse Action was created, and related settings\nwithin your Checkr system.\n","format":"date-time","example":"2016-10-07T12:34:00Z"},"post_notice_ready_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp after which the post notice can be sent. (Often 7 days after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]}],"format":"date-time","example":"2016-10-06T17:39:48Z"},"canceled_at":{"type":"string","description":"Time at which the Adverse Action was canceled.","format":"date-time","nullable":true,"example":null},"adverse_items":{"type":"array","items":{"$ref":"#/components/schemas/AdverseItem"},"description":"Array of Adverse Items on which the Action is based."},"individualized_assessment_engaged":{"type":"boolean","default":false},"context":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A customizable. semi-unique scoping identifier. Adverse Actions with a context have some special behaviors that do not affect the report adjudication and are not affected by most report adjudication actions. Multiple Adverse Actions can exist for a report as long as the context is unique for the report."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":null},"events":{"type":"array","description":"A list of important lifecycle events.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the event.","example":"507f1f77bcf86cd799439011"},"type":{"type":"string","description":"The type of event.","enum":["created","completed"],"example":"created"},"time":{"type":"string","format":"date-time","description":"Timestamp when the event occurred.","example":"2016-09-29T17:39:49Z"},"trigger":{"type":"string","nullable":true,"description":"The trigger that caused this event, if applicable.","example":null},"user":{"type":"string","nullable":true,"description":"The user who triggered the event, if applicable.","example":"user@example.com"}}}}}}},"components/schemas/BadRequestError":{"id":"components/schemas/BadRequestError","kind":"json-schema","title":"BadRequestError","data":{"type":"object","properties":{"error":{"type":"string","example":"Dl number 'F211165' does not match the license number format in CA"}}}},"components/schemas/CandidateStoryDocument":{"id":"components/schemas/CandidateStoryDocument","kind":"json-schema","title":"CandidateStoryDocument","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["document"],"readOnly":true},"type":{"type":"string","description":"The type of Document.","enum":["candidate_story_document"],"example":"candidate_story_document"},"created_at":{"type":"string","description":"Time at which the Document was created.","format":"date-time","example":"2020-04-17T07:48:01Z"},"download_uri":{"type":"string","description":"JSON encoded URL of the document. This URL is valid for 15 minutes.","example":"https://checkr-documents.checkr.com/download_path"},"filesize":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File’s size in bytes."},"children":[]}]}]}],"example":8576},"filename":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File’s name."},"children":[]}]}]}],"example":"proof_of_rehabilitation.pdf"},"content_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File’s content type."},"children":[]}]}]}],"example":"image/pdf"}}}},"components/schemas/CandidateStory":{"id":"components/schemas/CandidateStory","kind":"json-schema","title":"CandidateStory","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["candidate_story"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/candidate_stories/e44aa283528e6fde7d542194"},"report_id":{"type":"string","description":"ID of the Report to which the Candidate Story is linked.","example":"af3393b7d751206c7c67b6e5"},"record":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simplified representation of linked record."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Candidate Story is considered general information about the Candidate."},"children":[]}]}]}],"nullable":true,"properties":{"id":{"type":"string","description":"Record ID","example":"4e2a551f79e0095b35d4d3ca"},"case_number":{"type":"string","description":"Case number, if existing","example":"NMND78D","nullable":true},"charge":{"type":"string","description":"Charge description, if existing","example":"LIGHT OFFENSE","nullable":true},"offense_date":{"type":"string","format":"date","description":"Offense date, if existing","example":"2020-01-20","nullable":true},"location":{"type":"string","description":"Location of the Record, can be a State, or a City and a State, if existing","example":"San Mateo, CA","nullable":true}}},"content":{"type":"string","description":"Additional information provided by Candidate.","example":"Since my case, I have received the following certifications (see attachments)"},"created_at":{"type":"string","description":"Time at which the Candidate Story was created.","format":"date-time","example":"2020-04-17T07:48:34Z"},"documents":{"description":"Attached documents provided by Candidate.","type":"array","items":{"$ref":"#/components/schemas/CandidateStoryDocument"}}}}},"components/schemas/FormI9V2":{"id":"components/schemas/FormI9V2","kind":"json-schema","title":"FormI9V2","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the resource","example":"9adab19c-c8a8-44f1-a2fc-a8bd614d5c93"},"candidate_id":{"type":"string","description":"ID of the Checkr candidate the Form I-9 belongs to.","example":"3de7e278beb24d14a3785e2dd02cca49"},"full_name":{"type":"string","description":"Full name of the candidate.","example":"John Doe"},"email":{"type":"string","description":"Candidate email address.","example":"john.doe@example.com"},"status":{"type":"string","description":"Current status of the Form I-9 / E-Verify process.\n","enum":["Section 1 in progress","Section 2 in progress","E-Verify in progress","Action required","Authorized","Unauthorized"],"example":"Section 1 in progress"},"start_date":{"type":"string","format":"date","description":"Candidate start date (ISO 8601).","example":"2026-04-29"},"worksite_id":{"type":"string","format":"uuid","description":"Worksite resource Id.","example":"25a06fdc-c2f0-4bb2-b455-1666c1608c6e"},"worksite_name":{"type":"string","description":"Name of the Worksite associated with the Form I-9.","example":"Headquarters"},"workflow_type":{"type":"string","description":"Type of workflow.","enum":["remote_section_1_only","employee_appointment"],"example":"remote_section_1_only"},"apply_url":{"type":"string","format":"uri","description":"Link the candidate uses to complete Section 1. Share this link with the candidate if they did not receive the invitation email.\n","example":"https://apply.checkr.com/apply/context/9adab19c-c8a8-44f1-a2fc-a8bd614d5c93?welcome=false"},"created_at":{"type":"string","format":"date-time","description":"Form I-9 date of creation.","example":"2026-04-29T16:21:11Z"}}}},"components/schemas/I9Worksite":{"id":"components/schemas/I9Worksite","kind":"json-schema","title":"I9Worksite","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Worksite resource Id. Use this value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"worksite_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a Form I-9."},"children":[]}]}]}],"example":"25a06fdc-c2f0-4bb2-b455-1666c1608c6e"},"name":{"type":"string","description":"Name of the Worksite.","example":"Headquarters"},"street_line1":{"type":"string","description":"Street address of the Worksite.","example":"1 Montgomery St"},"street_line2":{"type":"string","description":"Additional address information (suite, floor, etc.).","example":"Suite 2400"},"city":{"type":"string","description":"City of the Worksite.","example":"San Francisco"},"state":{"type":"string","description":"Two-letter state code of the Worksite.","example":"CA"},"zip_code":{"type":"string","description":"ZIP code of the Worksite.","example":"94104"},"everify_enabled":{"type":"boolean","description":"Whether E-Verify is enabled for Forms I-9 created for this Worksite.","example":true}}}},"components/schemas/Metadata":{"id":"components/schemas/Metadata","kind":"json-schema","title":"Metadata","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 50 customer-defined key-value pairs. Use this parameter to store additional information on your candidate. For example: Use the key to map candidates to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job_req_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"branch_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Keys must be 40 characters or less. Values must be 500 characters or less."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: { \"job_req_id\": \"12345\" }"},"children":[]}]}]}]}},"components/schemas/Candidate":{"id":"components/schemas/Candidate","kind":"json-schema","title":"Candidate","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["candidate"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/candidates/e44aa283528e6fde7d542194"},"first_name":{"type":"string","pattern":"^(?=.*[a-zA-ZªµºÀ-ÖØ-öø-ÿ])[a-zA-Z0-9ªµºÀ-ÖØ-öø-ÿ\\-'., ]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s first name."},"children":[]}]}]}],"example":"John","minLength":1},"middle_name":{"type":"string","pattern":"[a-zA-Z0-9ªµºÀ-ÖØ-öø-ÿ\\-'., ]*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s middle name. This field is required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_middle_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Alfred"},"no_middle_name":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"middle_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the candidate has no middle name."},"children":[]}]}]}],"default":false},"last_name":{"type":"string","pattern":"[a-zA-Z0-9ªµºÀ-ÖØ-öø-ÿ\\-'., ]{2,}","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s last name."},"children":[]}]}]}],"example":"Smith","minLength":1},"mother_maiden_name":{"type":"string","pattern":"[a-zA-Z0-9ªµºÀ-ÖØ-öø-ÿ\\-'., ]*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s mother’s maiden name."},"children":[]}]}]}],"example":"Jones"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s email address."},"children":[]}]}]}],"format":"email","example":"john.smith@gmail.com"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s phone number."},"children":[]}]}]}],"example":5555555555,"nullable":true},"zipcode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s 5-digit zip code."},"children":[]}]}]}],"example":90401},"dob":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s date of birth."},"children":[]}]}]}],"format":"date","example":"1970-01-22"},"ssn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s Social Security Number. This value will be redacted in all return calls, except for the last four digits."},"children":[]}]}]}],"example":"XXX-XX-4645"},"driver_license_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s driver license number."},"children":[]}]}]}],"example":"F2111655"},"driver_license_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s driver license state of issue."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-2:US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"CA"},"previous_driver_license_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s previous driver license number."},"children":[]}]}]}],"example":"F1501739"},"previous_driver_license_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State that issued the candidate’s previous driver license."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-2:US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"MD"},"copy_requested":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the candidate has asked to receive a copy of their report."},"children":[]}]}]}],"default":false},"custom_id":{"type":"string","description":"Client-assigned unique ID for the Candidate. Can be used to map Checkr Candidate IDs to your internal tracking system, and to search for Candidates through both the Dashboard and the API."},"report_ids":{"type":"array","description":"Array of Report IDs.","readOnly":true,"items":{"type":"string","example":"532e71cfe88a1d4e8d00000d"}},"geo_ids":{"type":"array","description":"Array of Geo IDs.","items":{"type":"string","example":"79f943e212cce7de21c054a8"}},"adjudication":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The adjudication for the Candidate’s most recently created Report."},"children":[]}]}]}],"enum":["engaged","pre_adverse_action","post_adverse_action"]},"postal_address":{"type":"object","description":"Candidate's postal address.","example":{"name":"John Alfred Smith","street":"123 Main Street","street2":"APT A","city":"San Francisco","state":"CA","zipcode":"94108"}},"metadata":{"$ref":"#/components/schemas/Metadata"}}}},"components/schemas/WorkLocation":{"id":"components/schemas/WorkLocation","kind":"json-schema","title":"WorkLocation","data":{"type":"object","required":["state"],"properties":{"country":{"type":"string","description":"The country in ISO-3166 alpha-2 format.","example":"US","minLength":2,"maxLength":2},"state":{"type":"string","description":"The two letter state code.","example":"CA"},"city":{"type":"string","description":"Name of the city","example":"San Francisco","maxLength":255}}}},"components/schemas/Document":{"id":"components/schemas/Document","kind":"json-schema","title":"Document","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["document"],"readOnly":true},"type":{"type":"string","description":"The type of Document.","enum":["cdlis_report","consent","credit_report_consent_form","degree","diploma","driver_abstract","driver_license","driver_license_back","driver_license_history","drug_alcohol_clearinghouse_query_details_document","drug_screen_donor_pass","education_certificate","education_proof","employment_proof","government_id","government_id_back","health_screening_occupational_health_document","health_screening_result_certificate","international_consent_form","mvr_report","order_summary_pdf","passport","paystub","pdf_credit_report","pdf_health_report","pdf_individualized_assessment","pdf_professional_license_verification_report","pdf_report","pdf_self_disclosure","pdf_wisconsin_doj","previous_driver_license","professional_license_certification_image","screening_pass","selfie","social_media_screening_pdf","ssn_card","state_id_card","state_id_card_back","tax_form1099","tax_form_schedule_c","tax_form_w2","transcript"],"example":"driver_license"},"created_at":{"type":"string","description":"Time at which the Document was created.","format":"date-time","example":"2015-02-11T20:01:50Z"},"download_uri":{"type":"string","description":"JSON encoded URL of the document. This URL is valid for 15 minutes.","example":"https://checkr-documents.checkr.com/download_path"},"filesize":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File’s size in bytes."},"children":[]}]}]}],"example":8576},"filename":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File’s name."},"children":[]}]}]}],"example":"1423684910_candidate_driver_license.jpg"},"content_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File’s content type."},"children":[]}]}]}],"example":"image/jpeg"},"locale":{"type":"string","description":"Locale of the Document.","example":"en"}}}},"components/schemas/DriverLicense":{"id":"components/schemas/DriverLicense","kind":"json-schema","title":"DriverLicense","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["candidate_driver_license"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/candidates/551564b7865af96a28b13f36/driver_licenses/e44aa283528e6fde7d542194"},"candidate_id":{"type":"string","description":"ID of the candidate.","example":"551564b7865af96a28b13f36"},"number":{"type":"string","description":"The driver license number.","example":"F2222222"},"state":{"type":"string","description":"The state that issued the driver license.","example":"CA"},"issued_dates":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The issued date."},"source":{"type":"string","description":"Indicates where this issued date information came from. Issued dates added through the API will have a source of \"client\"."}}},"description":"An array of issued date objects","example":[{"value":"2010-01-30","source":"client"}]},"current":{"type":"boolean","description":"Defines whether the driver license is the candidate's current license.","example":true},"source":{"type":"string","description":"Where/how Checkr learned about the license.","default":"Other","example":"Self-Disclosure"}}}},"components/schemas/CandidateNotFoundError":{"id":"components/schemas/CandidateNotFoundError","kind":"json-schema","title":"CandidateNotFoundError","data":{"type":"object","properties":{"error":{"type":"string","example":"Candidate not found"}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","properties":{"street":{"type":"string","pattern":"[a-zA-Z0-9 -'.,]*","description":"Street address.","example":"123 Main St."},"unit":{"type":"string","pattern":"[a-zA-Z0-9 -'.,]*","description":"House, building or apartment number.","example":2000},"city":{"type":"string","pattern":"[a-zA-Z0-9 -'.,]*","description":"City.","example":"San Francisco"},"state":{"type":"string","description":"State.","example":"CA"},"zipcode":{"type":"string","description":"5-digit zip code.","example":"90401"},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2"},"children":[]}]}]}],"example":"US"}}}},"components/schemas/Employer":{"id":"components/schemas/Employer","kind":"json-schema","title":"Employer","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["employer"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/candidates/e44aa283528e6fde7d542194/employers/ca27df84be5b50dfa7ee1cda"},"candidate_id":{"type":"string","description":"ID of the Candidate being screened.","pattern":"[a-zA-Z0-9 -'.,]*","example":"xxx","minLength":1},"name":{"type":"string","pattern":"[a-zA-Z0-9 -'.,]*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s employer’s name."},"children":[]}]}]}],"example":"Checkr","minLength":1},"position":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s position or title."},"children":[]}]}]}],"example":"Software Engineer"},"salary":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s gross salary in dollars annually."},"children":[]}]}]}],"example":10000},"contract_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s contract type."},"children":[]}]}]}],"enum":["full_time","part_time","contract","internship"],"example":"full_time"},"do_not_contact":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the employer will not be contacted about the Candidate."},"children":[]}]}]}],"example":false},"start_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s start date with the employer."},"children":[]}]}]}],"format":"date","example":"2016-06-01"},"end_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s end date with the employer."},"children":[]}]}]}],"format":"date","example":"2017-05-01"},"employer_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Employer’s website."},"children":[]}]}]}],"example":"www.employer.com"},"address":{"$ref":"#/components/schemas/Address"},"manager":{"type":"object","properties":{"name":{"type":"string","description":"Candidate's manager's name.","example":"Joe Smith"},"title":{"type":"string","description":"Candidate's manager's title.","example":"Engineering Manager"},"email":{"type":"string","description":"Candidate's manager's email address.","example":"joesmith@checkr.co"},"phone":{"type":"string","description":"Candidate's manager's phone number.","example":"212-555-1234"}}}}}},"components/schemas/School":{"id":"components/schemas/School","kind":"json-schema","title":"School","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["school"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/schools/e44aa283528e6fde7d542194"},"candidate_id":{"type":"string","pattern":"[a-zA-Z0-9 -'.,]*","description":"Candidate linked to this School resource.","example":"83ebeagdec0948690863766f792ead24d61fe3f9","minLength":1},"name":{"type":"string","pattern":"[a-zA-Z0-9 -'.,]*","description":"Name of the School.","example":"College University","minLength":1},"degree":{"type":"string","description":"Degree awarded to the Candidate.","example":"BA"},"year_awarded":{"type":"integer","description":"Year in which the degree was awarded.","example":2017,"minLength":1},"major":{"type":"string","pattern":"[a-zA-Z0-9 -'.,]*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s major."},"children":[]}]}]}],"example":"Russian Literature"},"phone":{"type":"string","description":"School's phone number.","example":"415-111-1111","nullable":true},"minor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s minor."},"children":[]}]}]}],"example":"Background Checks"},"start_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s start date with the School."},"children":[]}]}]}],"format":"date","example":"2012-09-22"},"end_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s end date with the School."},"children":[]}]}]}],"format":"date","example":"2017-05-10"},"current":{"type":"boolean","description":"Defines whether the Candidate is currently enrolled.","default":false},"school_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"School’s website."},"children":[]}]}]}],"example":"www.collegeuniversity.com"},"address":{"$ref":"#/components/schemas/Address"}}}},"components/schemas/ProfessionalLicense":{"id":"components/schemas/ProfessionalLicense","kind":"json-schema","title":"ProfessionalLicense","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"expiration_date":{"type":"string","format":"date","description":"Expiration date of the professional license","example":"2033-01-30"},"issuer_name":{"type":"string","description":"Name of the organization that issued the professional license","example":"Medical Board of California"},"issuer_region":{"type":"string","description":"2-letter abbreviation of US state where license was issued. For licenses not issued for a specific state, use \"United States\".","example":"CA"},"license_type":{"type":"string","description":"Category or industry of professional license","example":"Physician"},"license_number":{"type":"string","description":"Unique identifier assigned to license by issuer. Format may vary","example":"A 12345"}}}},"components/schemas/BadProfessionalLicenseCreateRequestError":{"id":"components/schemas/BadProfessionalLicenseCreateRequestError","kind":"json-schema","title":"BadProfessionalLicenseCreateRequestError","data":{"type":"object","properties":{"error":{"type":"string","example":"license_type is missing"}}}},"components/schemas/ResourceNotFoundError":{"id":"components/schemas/ResourceNotFoundError","kind":"json-schema","title":"ResourceNotFoundError","data":{"type":"object","properties":{"error":{"type":"string","example":"Resource not found"}}}},"components/schemas/Ssn":{"id":"components/schemas/Ssn","kind":"json-schema","title":"Ssn","data":{"type":"object","properties":{"encrypted_ssn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The candidate's SSN: encrypted, then encoded using Base64. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no SSN exists for the candidate."},"children":[]}]}]}],"example":"hyYMhDje9dVUEPKU9myy7OFJ7R27pj0pmlegFlka99I="}}}},"components/schemas/EncryptionKeyError":{"id":"components/schemas/EncryptionKeyError","kind":"json-schema","title":"EncryptionKeyError","data":{"type":"object","properties":{"error":{"type":"string","example":"Encryption key required."}}}},"components/schemas/CandidatePostalAddress":{"id":"components/schemas/CandidatePostalAddress","kind":"json-schema","title":"CandidatePostalAddress","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["candidate_postal_address"],"readOnly":true},"candidate_id":{"$ref":"#/components/schemas/ResourceId"},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/candidate/e44aa283528e6fde7d542194/postal_address"},"name":{"type":"string","description":"Name of the Candidate.\n","example":"John Alfred Smith"},"street":{"type":"string","description":"Street address of the Candidate.\n","example":"123 Main St"},"street2":{"type":"string","description":"Additional street address of the Candidate.\n","example":"Apt A","nullable":true},"city":{"type":"string","description":"City of the Candidate.\n","example":"Santa Monica"},"state":{"type":"string","description":"State of the Candidate.\n","example":"CA"},"zipcode":{"type":"string","description":"5-digit zip code of the Candidate.\n","example":"90401"}}}},"components/schemas/BadPiiRequestError":{"id":"components/schemas/BadPiiRequestError","kind":"json-schema","title":"BadPiiRequestError","data":{"type":"object","properties":{"error":{"type":"string","example":"Candidate has already had PII removed"}}}},"components/schemas/County":{"id":"components/schemas/County","kind":"json-schema","title":"County","data":{"type":"object","properties":{"name":{"type":"string","example":"BOULDER","description":"The county's common name."},"fips_code":{"type":"string","example":"23456","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 2+3 digit FIPS code for the county (2-digit state + 3-digit county FIPS code)."},"children":[]}]}]}]}}}},"components/schemas/AssessmentAttribute":{"id":"components/schemas/AssessmentAttribute","kind":"json-schema","title":"AssessmentAttribute","data":{"type":"string","description":"The assessment for this screening. This field will be non-null only for Assess-enabled accounts. For accounts with Assess enabled, it will be null for reports completed before Assess was enabled, and null for a short time after report completion while the account's Assess rules are applied.\n","nullable":true,"enum":["eligible","review","escalated"],"example":"eligible"}},"components/schemas/ScreeningsGenericPayload":{"id":"components/schemas/ScreeningsGenericPayload","kind":"json-schema","title":"ScreeningsGenericPayload","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string"},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}]},"status":{"type":"string","description":"Status of the screening.\n","enum":["pending","complete","canceled","suspended"],"example":"complete"},"result":{"type":"string","description":"Result of the screening.","enum":["clear","consider"],"nullable":true,"example":"clear"},"assessment":{"allOf":[{"$ref":"#/components/schemas/AssessmentAttribute"}]},"created_at":{"type":"string","description":"Time at which the screening was created.","format":"date-time","example":"2014-01-18T12:34:00Z"},"completed_at":{"type":"string","description":"Time at which the screening was completed.","format":"date-time","example":"2014-01-18T12:35:30Z"},"turnaround_time":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of seconds the screening took to complete, calculated from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#cancellation-reasons"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancellation reasons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for possible values."},"children":[]}]}]}],"nullable":true,"example":"complete_now_customer_requested"},"cancellation_reason_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#cancellation-reasons"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancellation reasons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for possible values."},"children":[]}]}]}],"nullable":true,"example":"Customer requested Complete Now prior to screening completion"}}}},"components/schemas/ScreeningStatus":{"id":"components/schemas/ScreeningStatus","kind":"json-schema","title":"ScreeningStatus","data":{"type":"string","description":"Status of the screening.","enum":["pending","complete"]}},"components/schemas/ScreeningResult":{"id":"components/schemas/ScreeningResult","kind":"json-schema","title":"ScreeningResult","data":{"type":"string","description":"Outcome of the screening.","enum":["clear","consider"],"nullable":true}},"components/schemas/Record":{"id":"components/schemas/Record","kind":"json-schema","title":"Record","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"case_number":{"type":"string","example":"24323-DA"},"file_date":{"type":"string","format":"date","nullable":true,"example":null},"arresting_agency":{"type":"string","example":"DEA Boston Division"},"court_jurisdiction":{"type":"string","nullable":true,"example":null},"court_of_record":{"type":"string","nullable":true,"example":null},"full_name":{"type":"string","example":"John Alfred Smith"},"dob":{"type":"string","example":"1970-01-22"},"yob":{"type":"integer","example":1970},"county":{"type":"string","example":"SUFFOLK"},"state":{"type":"string","example":"MA"},"address":{"$ref":"#/components/schemas/Address"}}}},"components/schemas/Charge":{"id":"components/schemas/Charge","kind":"json-schema","title":"Charge","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"charge":{"type":"string","example":"Fraud"},"category":{"type":"string","description":"The Checkr Assess category assigned to this criminal charge. This field will be included only if Checkr Assess is enabled for your account.\n","enum":["criminal_intent","drugs_and_alcohol","fraud_and_deception","homicide","security","sexual","statutory","theft_and_property","unclassified","vehicles_and_traffic","violence"],"example":"fraud_and_deception"},"charge_type":{"type":"string","nullable":true,"example":null},"charge_id":{"type":"string","nullable":true,"example":null},"classification":{"type":"string","example":"Felony"},"deposition":{"type":"string","nullable":true,"example":null},"defendant":{"type":"string","nullable":true,"example":null},"plaintiff":{"type":"string","nullable":true,"example":null},"sentence":{"type":"string","example":"Active Punishment Minimum: 10Y"},"disposition":{"type":"string","example":"Guilty"},"probation_status":{"type":"string","nullable":true,"example":null},"offense_date":{"type":"string","format":"date","example":"2011-04-22"},"deposition_date":{"type":"string","format":"date","example":"2014-05-27"},"arrest_date":{"type":"string","format":"date","nullable":true,"example":null},"charge_date":{"type":"string","format":"date","nullable":true,"example":null},"sentence_date":{"type":"string","format":"date","nullable":true,"example":null},"disposition_date":{"type":"string","format":"date","example":"2011-06-02"},"conviction_date":{"type":"string","format":"date","nullable":true,"example":"2011-06-02"},"release_date":{"type":"string","format":"date","nullable":true,"example":"2011-06-02"},"next_court_date":{"type":"string","format":"date","nullable":true,"example":"2011-06-02"},"court":{"type":"string","example":"Circuit & District Court"},"plea":{"type":"string","example":null},"assessment":{"type":"string","example":null},"prison_time":{"type":"string","description":"Sentenced to prison time.","example":"4 Year(s)"},"jail_time":{"type":"string","description":"Sentenced to jail time.","example":"15 Day(s)"},"probation_time":{"type":"string","description":"Sentenced to probation time.","example":null},"restitution":{"type":"string","description":"Sentenced to restitution.","example":"220.00"}}}},"components/schemas/ScreeningPointer":{"id":"components/schemas/ScreeningPointer","kind":"json-schema","title":"ScreeningPointer","data":{"type":"string","description":"Pointer description associated with the screening.","enum":["Arrest Search","Candidate Zip Code","Candidate Address","<county>, <state> County Search","National Search","<state> State Search","Account Policy","<education address> Education History","<employment address> Employment History","Report Geo","MVR Address","Package Policy","Candidate Self Disclosure","SSN Trace Address History","Checkr Initiated"]}},"components/schemas/CountyCriminalSearch":{"id":"components/schemas/CountyCriminalSearch","kind":"json-schema","title":"CountyCriminalSearch","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"object":{"enum":["county_criminal_search"]},"uri":{"example":"/v1/county_criminal_searches/539fdcf335644a0ef4000001"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"complete"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"consider"}]},"turnaround_time":{"example":100800},"estimated_completion_time":{"type":"string","format":"date-time","description":"Estimated time of completion for the Search. This estimate will be based on the maximum turnaround time across all counties searched.","example":"2019-03-13T16:31:07Z"},"estimated_completion_date":{"type":"string","format":"date","description":"Estimated date of completion for the Search.","example":"2019-03-13"},"county":{"type":"string","description":"County in which the record was recorded.","example":"SAN FRANCISCO"},"state":{"type":"string","description":"State in which the record was recorded.","example":"CA"},"records":{"type":"array","description":"Array of CriminalRecord objects.","items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"charges":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Charge"},{"type":"object","properties":{"charge":{"example":"Sell Cocaine"},"defendant":{"description":"Defendant's name on the record.","example":"John Alfred Smith"},"arrest_date":{"description":"Recorded arrest date.","example":"2011-04-22"},"sentence_date":{"description":"Recorded sentence date.","example":"2011-06-02"}}}]}}}}]}},"filtered_by_positive_adjudication_records":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalRecord objects filtered out by your account’s Positive Adjudication Matrix or by your account’s Assess configuration."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"filtered_by_positive_adjudication_charges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalCharge objects filtered out by your account’s Positive Adjudication Matrix."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Charge"}]}}}}]}},"screening_pointers":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"screening_pointers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the screening."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/ScreeningPointer"},{"type":"string","example":["Denver, CO County Search","Kentucky State Search","Widgets-R-Us Employment Address","Harvard University Education Address"]}]}}}}]}},"components/schemas/DrugAlcoholClearinghouse":{"id":"components/schemas/DrugAlcoholClearinghouse","kind":"json-schema","title":"DrugAlcoholClearinghouse","data":{"type":"object","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"report_id":{"type":"string","description":"The ID of the Report.","example":"539fd88c101897f7cd000007"},"query_result":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The result of the Drug & Alcohol Clearinghouse query."},"children":[]}]}]}],"enum":["Driver Not Prohibited","Driver Prohibited"],"example":"Driver Not Prohibited"},"query_type":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of Drug & Alcohol Clearinghouse query conducted. Screenings created before this field was introduced return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pre_hire"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["pre_hire","post_hire"],"example":"pre_hire"},"status":{"type":"string","description":"The status of the screening.","example":"complete","enum":["pending","complete","canceled"]},"cancellation_reason":{"type":"string","nullable":true,"description":"The reason the screening was canceled.","enum":["candidate_missing_consent","request_withdrawn"],"example":"candidate_missing_consent"},"cancellation_reason_description":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancellation_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the screening."},"children":[]}]}]}],"enum":["Candidate consent not provided","Request withdrawn"],"example":"Candidate consent not provided"}}}},"components/schemas/FmcsaPreEmploymentScreeningProgram":{"id":"components/schemas/FmcsaPreEmploymentScreeningProgram","kind":"json-schema","title":"FmcsaPreEmploymentScreeningProgram","data":{"type":"object","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"report_id":{"type":"string","description":"The ID of the Report.","example":"539fd88c101897f7cd000007"},"record_result":{"type":"string","nullable":true,"description":"The result of the FMCSA Pre-Employment Screening Program query.","enum":["FOUND","NOT_FOUND"],"example":"FOUND"},"pdf_url":{"type":"string","nullable":true,"description":"A presigned URL to download the PSP report PDF. Expires after one hour.","example":"https://s3.amazonaws.com/checkr-screenings/psp/e44aa283528e6fde7d542194/report.pdf?X-Amz-Expires=3600"},"status":{"type":"string","description":"The status of the screening.","example":"complete","enum":["pending","complete","canceled"]},"cancellation_reason":{"type":"string","nullable":true,"description":"The reason the screening was canceled.","enum":["candidate_missing_consent","request_withdrawn"],"example":"candidate_missing_consent"},"cancellation_reason_description":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancellation_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the screening."},"children":[]}]}]}],"enum":["Candidate consent not provided","Request withdrawn"],"example":"Candidate consent not provided"}}}},"components/schemas/IncludesCanceledBoolean":{"id":"components/schemas/IncludesCanceledBoolean","kind":"json-schema","title":"IncludesCanceledBoolean","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If account has opted in to report lifecycle phase two, indicates the presence of canceled histories. Otherwise, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":[true,false],"nullable":true}},"components/schemas/EducationVerification":{"id":"components/schemas/EducationVerification","kind":"json-schema","title":"EducationVerification","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"object":{"enum":["education_verification"]},"uri":{"example":"/v1/education_verifications/595511af261066005170f47"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"consider"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"consider"}]},"turnaround_time":{"example":603216},"includes_canceled":{"allOf":[{"$ref":"#/components/schemas/IncludesCanceledBoolean"},{"example":true}]},"records":{"type":"array","description":"Array of CandidateEducationHistory records.","items":{"type":"object","properties":{"id":{"type":"string","example":"592311d2113adf7e9c9f66b8"},"result":{"type":"object","properties":{"verified":{"type":"boolean","example":false},"degrees":{"type":"array","description":"Array of degrees verified by vendors","items":{"type":"object","properties":{"title":{"type":"string"},"majors":{"type":"string"},"major_concentrations":{"type":"string"},"minors":{"type":"string"},"year_awarded":{"type":"string"}}}}}},"school":{"$ref":"#/components/schemas/School"},"events":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","example":"started"},"created_at":{"type":"string","example":"2017-06-29T14:42:47Z"},"type":{"type":"string","example":"verification_start"}}}},"status":{"type":"string","enum":["pending","clear","consider"],"example":"consider"},"cancellation_reason":{"type":"string","description":"The reason the screening was canceled.","enum":["complete_now_customer_requested","no_history_required_information","international_entry_not_supported"],"nullable":true,"example":"customer_requested_complete_now"},"cancellation_reason_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancellation_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the screening."},"children":[]}]}]}],"enum":["Customer requested Complete Now prior to screening completion","Candidate declared no history","Screening does not support international entries"],"nullable":true,"example":"Customer requested Complete Now prior to screening completion"}}}}}}]}},"components/schemas/ResultPayload":{"id":"components/schemas/ResultPayload","kind":"json-schema","title":"ResultPayload","data":{"type":"object","properties":{"verified":{"type":"boolean","example":true},"comments":{"type":"string"},"ignored":{"type":"string","nullable":true,"example":null}}}},"components/schemas/EmploymentVerification":{"id":"components/schemas/EmploymentVerification","kind":"json-schema","title":"EmploymentVerification","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"object":{"enum":["employment_verification"]},"uri":{"example":"/v1/employment_verifications/595511af261066005170f471"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"consider"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"consider"}]},"turnaround_time":{"example":603216},"includes_canceled":{"allOf":[{"$ref":"#/components/schemas/IncludesCanceledBoolean"},{"example":true}]},"records":{"type":"array","description":"Array of CandidateEmploymentHistory objects.","items":{"type":"object","properties":{"id":{"type":"string","example":"592311d2113adf7e9c9f66b8"},"result":{"type":"object","properties":{"start_date":{"allOf":[{"$ref":"#/components/schemas/ResultPayload"},{"type":"object","properties":{"comments":{"example":"2016-06-01"}}}]},"end_date":{"allOf":[{"$ref":"#/components/schemas/ResultPayload"},{"type":"object","properties":{"comments":{"example":"2017-05-01"}}}]},"position":{"allOf":[{"$ref":"#/components/schemas/ResultPayload"},{"type":"object","properties":{"verified":{"example":true},"comments":{"example":"Software Development Engineer"},"ignored":{"example":"manual"}}}]},"contract_type":{"allOf":[{"$ref":"#/components/schemas/ResultPayload"},{"type":"object","properties":{"comments":{"example":"Full Time"},"ignored":{"example":"package"}}}]},"salary":{"allOf":[{"$ref":"#/components/schemas/ResultPayload"},{"type":"object","properties":{"verified":{"example":true},"comments":{"example":"100000"}}}]},"questions":{"type":"array","description":"List of questions for the candidate's employer.","items":{"type":"object","properties":{"sort_number":{"description":"The position of the question within the list.","type":"integer","example":1},"text":{"description":"The question that was asked.","type":"string","example":"What is the documented reason for the employee's departure?"},"response":{"description":"The answer received in response to the question.","type":"string","example":"They resigned."}}}}}},"employer":{"$ref":"#/components/schemas/Employer"},"events":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","example":"started"},"created_at":{"type":"string","example":"2017-06-29T14:42:44Z"},"type":{"type":"string","example":"verification_start"}}}},"status":{"type":"string","enum":["pending","clear","consider"],"example":"consider"},"cancellation_reason":{"type":"string","description":"The reason the screening was canceled.","enum":["complete_now_customer_requested","no_history_required_information","international_entry_not_supported"],"nullable":true,"example":"customer_requested_complete_now"},"cancellation_reason_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancellation_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the screening."},"children":[]}]}]}],"enum":["Customer requested Complete Now prior to screening completion","Candidate declared no history","Screening does not support international entries"],"nullable":true,"example":"Customer requested Complete Now prior to screening completion"}}}}}}]}},"components/schemas/PersonalReferenceVerification":{"id":"components/schemas/PersonalReferenceVerification","kind":"json-schema","title":"PersonalReferenceVerification","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"id":{"example":"642f279b0ea616002e474daa"},"object":{"enum":["personal_reference_verifications"]},"uri":{"example":"/v1/personal_reference_verifications/642f279b0ea616002e474daa"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"consider"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"consider"}]},"turnaround_time":{"example":42},"name":{"type":"string","description":"Personal Reference's full name.","example":"John Smith"},"email":{"type":"string","description":"Personal Reference's email address.","format":"email","example":"john.smith@gmail.com"},"phone":{"type":"string","description":"Personal Reference's phone number.","example":5555555555},"relationship":{"type":"string","description":"Relationship between Candidate and Personal Reference.","example":"Friend"},"questions":{"type":"array","description":"Array of questions and answers received from Personal Reference.","items":{"type":"object","properties":{"question":{"type":"string","description":"A question that was asked to a Personal Reference.","example":"How long have you known the applicant?"},"answer":{"type":"string","description":"Answer that Personal Reference gave as a response.","example":"We have known each other for about ten years."}}}}}}]}},"components/schemas/ProfessionalReferenceVerification":{"id":"components/schemas/ProfessionalReferenceVerification","kind":"json-schema","title":"ProfessionalReferenceVerification","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"id":{"example":"642f279b0ea616002e474daa"},"object":{"enum":["professional_reference_verifications"]},"uri":{"example":"/v1/professional_reference_verifications/642f279b0ea616002e474daa"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"consider"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"consider"}]},"turnaround_time":{"example":42},"name":{"type":"string","description":"Professional Reference's full name.","example":"John Smith"},"email":{"type":"string","description":"Professional Reference's email address.","format":"email","example":"john.smith@gmail.com"},"phone":{"type":"string","description":"Professional Reference's phone number.","example":5555555555},"relationship":{"type":"string","description":"Relationship between Candidate and Professional Reference.","example":"Manager"},"questions":{"type":"array","description":"Array of questions and answers received from Professional Reference.","items":{"type":"object","properties":{"question":{"type":"string","description":"A question that was asked to a Professional Reference.","example":"How long have you known the applicant?"},"answer":{"type":"string","description":"Answer that Professional Reference gave as a response.","example":"We have known each other for about ten years."}}}}}}]}},"components/schemas/ScreeningsWithNullResult":{"id":"components/schemas/ScreeningsWithNullResult","kind":"json-schema","title":"ScreeningsWithNullResult","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string"},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}]},"status":{"type":"string","description":"Status of the screening.\n","enum":["pending","complete","canceled","suspended"],"example":"complete"},"result":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result of the screening."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"red"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter will always return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value because this is a non-reportable screening."},"children":[]}]}]}],"enum":["clear","consider"],"nullable":true,"example":"clear"},"created_at":{"type":"string","description":"Time at which the screening was created.","format":"date-time","example":"2014-01-18T12:34:00Z"},"completed_at":{"type":"string","description":"Time at which the screening was completed.","format":"date-time","example":"2014-01-18T12:35:30Z"},"turnaround_time":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of seconds the screening took to complete, calculated from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#cancellation-reasons"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancellation reasons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for possible values."},"children":[]}]}]}],"example":null},"cancellation_reason_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#cancellation-reasons"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancellation reasons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for possible values."},"children":[]}]}]}],"example":null}}}},"components/schemas/FederalCriminalSearch":{"id":"components/schemas/FederalCriminalSearch","kind":"json-schema","title":"FederalCriminalSearch","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsWithNullResult"},{"type":"object","properties":{"object":{"enum":["federal_criminal_search"]},"uri":{"example":"/v1/federal_criminal_searches/539fd88c101897f7cd000006"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"complete"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"clear"}]},"assessment":{"allOf":[{"$ref":"#/components/schemas/AssessmentAttribute"}]},"turnaround_time":{"example":90},"records":{"type":"array","description":"Array of CriminalRecord objects.","items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"arresting_agency":{"example":null},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}}}}]}},"filtered_by_positive_adjudication_records":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalRecord objects filtered out by your account’s Positive Adjudication Matrix or by your account’s Assess configuration."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"filtered_by_positive_adjudication_charges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalCharge objects filtered out by your account’s Positive Adjudication Matrix."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Charge"}]}}}}]}}}}]}},"components/schemas/FederalDistrictCriminalSearch":{"id":"components/schemas/FederalDistrictCriminalSearch","kind":"json-schema","title":"FederalDistrictCriminalSearch","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"object":{"enum":["federal_district_criminal_search"]},"uri":{"example":"/v1/federal_district_criminal_searches/625487abdc27f729a9997f50"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"complete"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"clear"}]},"turnaround_time":{"example":90},"records":{"type":"array","description":"Array of CriminalRecord objects.","items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"arresting_agency":{"example":null},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}}}}]}},"records_hidden_by_assess":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalRecord objects filtered out by your account’s Assess configuration."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"charges_hidden_by_assess":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalCharge objects filtered out by your account’s Assess configuration."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Charge"}]}}}}]}},"filtered_by_positive_adjudication_records":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalRecord objects filtered out by your account’s Positive Adjudication Matrix."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"filtered_by_positive_adjudication_charges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalCharge objects filtered out by your account’s Positive Adjudication Matrix."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Charge"}]}}}}]}}}}]}},"components/schemas/FederalCivilSearch":{"id":"components/schemas/FederalCivilSearch","kind":"json-schema","title":"FederalCivilSearch","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsWithNullResult"},{"type":"object","properties":{"object":{"enum":["federal_civil_search"]},"uri":{"example":"/v1/federal_civil_searches/625487abdc27f729a9997f50"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"complete"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"clear"}]},"turnaround_time":{"example":90},"records":{"type":"array","description":"Array of CriminalRecord objects.","items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"arresting_agency":{"example":null},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}}}}]}},"records_hidden_by_assess":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalRecord objects filtered out by your account’s Assess configuration."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"charges_hidden_by_assess":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalCharge objects filtered out by your account’s Assess configuration."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Charge"}]}}}}]}},"filtered_by_positive_adjudication_records":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalRecord objects filtered out by your account’s Positive Adjudication Matrix."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"filtered_by_positive_adjudication_charges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalCharge objects filtered out by your account’s Positive Adjudication Matrix."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Charge"}]}}}}]}}}}]}},"components/schemas/FederalDistrictCivilSearch":{"id":"components/schemas/FederalDistrictCivilSearch","kind":"json-schema","title":"FederalDistrictCivilSearch","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"object":{"enum":["federal_district_civil_search"]},"uri":{"example":"/v1/federal_district_civil_searches/625487abdc27f729a9997f50"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"complete"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"clear"}]},"turnaround_time":{"example":90},"records":{"type":"array","description":"Array of CriminalRecord objects.","items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"arresting_agency":{"example":null},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}}}}]}},"records_hidden_by_assess":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalRecord objects filtered out by your account’s Assess configuration."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"charges_hidden_by_assess":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalCharge objects filtered out by your account’s Assess configuration."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Charge"}]}}}}]}},"filtered_by_positive_adjudication_records":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalRecord objects filtered out by your account’s Positive Adjudication Matrix."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"filtered_by_positive_adjudication_charges":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalCharge objects filtered out by your account’s Positive Adjudication Matrix."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Charge"}]}}}}]}}}}]}},"components/schemas/Geo":{"id":"components/schemas/Geo","kind":"json-schema","title":"Geo","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["geo"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/geos/e44aa283528e6fde7d542194"},"created_at":{"type":"string","description":"Time at which the Geo was created.","format":"date-time","example":"2015-01-18T12:34:00Z"},"name":{"type":"string","description":"Human-readable name of the Geo.","example":"SF CA"},"city":{"type":"string","description":"City for the Geo.","example":"San Francisco"},"state":{"type":"string","description":"State for the Geo.","example":"CA"},"deleted_at":{"type":"string","description":"Time at which the Geo was deleted.","nullable":true,"format":"date-time","example":null}}}},"components/schemas/DuplicateGeoError":{"id":"components/schemas/DuplicateGeoError","kind":"json-schema","title":"DuplicateGeoError","data":{"type":"object","properties":{"error":{"type":"string","example":"Duplicate geo, name: Napa, state: CA already exists"}}}},"components/schemas/GeoCityUpdatedError":{"id":"components/schemas/GeoCityUpdatedError","kind":"json-schema","title":"GeoCityUpdatedError","data":{"type":"object","properties":{"error":{"type":"string","example":"Geo city can not be updated if city already exists"}}}},"components/schemas/UsedGeoError":{"id":"components/schemas/UsedGeoError","kind":"json-schema","title":"UsedGeoError","data":{"type":"object","properties":{"error":{"type":"string","example":"Geo can not be deleted as it is used by Candidates"}}}},"components/schemas/GlobalWatchlistSearch":{"id":"components/schemas/GlobalWatchlistSearch","kind":"json-schema","title":"GlobalWatchlistSearch","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"object":{"enum":["global_watchlist_search"]},"uri":{"example":"/v1/global_watchlist_searches/539fd88c101897f7cd000008"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"complete"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"consider"}]},"turnaround_time":{"example":90},"records":{"type":"array","description":"Array of CriminalRecord objects.","items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"charges":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Charge"},{"type":"object","properties":{"charge":{"description":"Recorded charge.","example":"RICO murder"}}}]}}}}]}}}}]}},"components/schemas/HierarchyTree":{"id":"components/schemas/HierarchyTree","kind":"json-schema","title":"HierarchyTree","data":{"type":"object","required":["name","custom_id"],"properties":{"name":{"type":"string","description":"The name for the node. This name will be displayed in the Checkr Dashboard.","example":"Acme Staffing"},"custom_id":{"type":"string","description":"Customer-defined unique ID for the node. Must be unique within your account.","example":"zpy8orej4r614ize"},"tier":{"type":"string","description":"Customer-defined label for this level of the hierarchy. (For example \"Department\" or \"Division\")","example":"department"},"children":{"type":"array","items":{"$ref":"#/components/schemas/HierarchyTree"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of child hierarchy trees with name, custom_id, tier and their children"},"children":[]}]}]}]}}}},"components/schemas/HierarchyNotEnabledError":{"id":"components/schemas/HierarchyNotEnabledError","kind":"json-schema","title":"HierarchyNotEnabledError","data":{"type":"object","properties":{"error":{"type":"string","example":"Sorry, your account is not enabled for Hierarchy"}}}},"components/schemas/HierarchyNotFoundError":{"id":"components/schemas/HierarchyNotFoundError","kind":"json-schema","title":"HierarchyNotFoundError","data":{"type":"object","properties":{"error":{"type":"string","example":"No hierarchy exists on account, or hierarchy ingestion is in progress"}}}},"components/schemas/HierarchyNode":{"id":"components/schemas/HierarchyNode","kind":"json-schema","title":"HierarchyNode","data":{"type":"object","required":["name","custom_id"],"properties":{"name":{"type":"string","description":"The name for the node. This name will be displayed in the Checkr Dashboard.","example":"Acme Staffing","minLength":1,"maxLength":255},"custom_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined unique ID for the node. Must be unique within your account. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom IDs may contain only letters, numbers, spaces, hyphens, colons, ampersands, and/or underscores."},"children":[]}]}]}],"example":"zpy8orej4r614ize","minLength":1,"maxLength":255},"tier":{"type":"string","description":"Customer-defined label for this level of the hierarchy. (For example \"Department\" or \"Division\".)","example":"department","maxLength":255},"parent_custom_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the parent of this node. If not provided, this node will be placed at the top level of the hierarchy. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If provided, this node must be a valid and previously loaded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and may contain only letters, numbers, spaces, hyphens, colons, ampersands, and/or underscores."},"children":[]}]}]}],"example":"parent custom id","maxLength":255},"packages":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of slugs for packages that are visible to this node (through either direct assignment to the node, or assignment to one of the node's ancestors). Only provided if \"include=packages\" is included in the query."},"children":[]}]}]}],"items":{"type":"string"},"example":["driver_pro","tasker_pro"]}}}},"components/schemas/BadHierarchyRequestError":{"id":"components/schemas/BadHierarchyRequestError","kind":"json-schema","title":"BadHierarchyRequestError","data":{"type":"object","properties":{"error":{"type":"string","example":"nodes cannot be empty"}}}},"components/schemas/IngestionInProgressError":{"id":"components/schemas/IngestionInProgressError","kind":"json-schema","title":"IngestionInProgressError","data":{"type":"object","properties":{"error":{"type":"string","example":"Ingestion is already in progress"}}}},"components/schemas/Invitation":{"id":"components/schemas/Invitation","kind":"json-schema","title":"Invitation","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["invitation"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/invitations/e44aa283528e6fde7d542194"},"invitation_url":{"type":"string","description":"URL for the Invitation.","example":"https://apply.checkr.com/invite/try-checkr/290f9d6d6e46/test"},"status":{"type":"string","description":"Status of the Invitation.","enum":["pending","completed","expired"],"example":"pending"},"created_at":{"type":"string","description":"Time at which the Invitation was created.","format":"date-time","example":"2015-05-14T17:45:34Z"},"expires_at":{"type":"string","description":"Time at which the Invitation will expire.","format":"date-time","example":"2015-05-21T17:45:34Z"},"completed_at":{"type":"string","description":"Time at which the Invitation was completed by the candidate.","nullable":true,"format":"date-time","example":null},"deleted_at":{"type":"string","description":"Time at which the Invitation was deleted.","nullable":true,"example":null},"package":{"type":"string","description":"Package associated with the Invitation.","example":"driver_pro"},"candidate_id":{"type":"string","description":"ID of the Candidate to whom the Invitation was sent.","example":"551564b7865af96a28b13f36"},"report_id":{"type":"string","description":"ID of the Report created by the completion of this Invitation. Will be null if the Invitation has not yet been completed.","nullable":true,"example":null},"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the invitation is archived."},"children":[]}]}]}],"example":false},"archived_info":{"type":"object","description":"Information relating to an archived report or invitation","properties":{"time":{"type":"string","description":"Time the report or invitation was archived","format":"date-time","example":"2023-08-29T23:15:34Z"},"user":{"type":"object","description":"User information about the archiver","properties":{"email":{"type":"string","description":"User's email address\n","format":"email","nullable":true,"example":"john.smith@gmail.com"},"id":{"type":"string","description":"User's ID\n","nullable":true,"example":"1234abcd5678"}}}}}}}},"components/schemas/PackageNotFoundError":{"id":"components/schemas/PackageNotFoundError","kind":"json-schema","title":"PackageNotFoundError","data":{"type":"object","properties":{"error":{"type":"string","example":"Package not found"}}}},"components/schemas/ScreeningsGenericPayloadInternational":{"id":"components/schemas/ScreeningsGenericPayloadInternational","kind":"json-schema","title":"ScreeningsGenericPayloadInternational","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId","example":"41007cffefb435cf7d701f75d8b86f"},"object":{"type":"string"},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}]},"status":{"type":"string","description":"Status of the screening.\n","enum":["pending","complete","canceled","suspended"],"example":"complete"},"result":{"type":"string","description":"Result of the screening.","enum":["clear","consider"],"nullable":true,"example":"clear"},"created_at":{"type":"string","description":"Time at which the screening was created.","format":"date-time","example":"2014-01-18T12:34:00Z"},"completed_at":{"type":"string","description":"Time at which the screening was completed.","format":"date-time","example":"2014-01-18T12:35:30Z"},"turnaround_time":{"type":"integer","example":90,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of seconds the screening took to complete, calculated from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#cancellation-reasons"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancellation reasons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for possible values."},"children":[]}]}]}],"example":"complete_now_customer_requested"},"cancellation_reason_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#cancellation-reasons"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancellation reasons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for possible values."},"children":[]}]}]}],"example":"Customer requested Complete Now prior to screening completion"}}}},"components/schemas/InternationalAdverseMediaSearch":{"id":"components/schemas/InternationalAdverseMediaSearch","kind":"json-schema","title":"InternationalAdverseMediaSearch","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayloadInternational"},{"type":"object","properties":{"id":{"example":"41007cffefb435cf7d701f75d8b86c"},"object":{"enum":["international_adverse_media_search"]},"uri":{"example":"/v1/international_adverse_media_searches/41007cffefb435cf7d701f75d8b86c"},"country":{"type":"string","description":"ISO country code of the jurisdiction where the search was run","example":"FR"},"pdf_url":{"type":"string","description":"URL to PDF document containing screening result details","example":"https://eu-west-1-checkr-staging.s3.eu-west-1.amazonaws.com/document.pdf"}}}]}},"components/schemas/InternationalAddress":{"id":"components/schemas/InternationalAddress","kind":"json-schema","title":"InternationalAddress","data":{"type":"object","properties":{"street":{"type":"string","pattern":"[a-zA-Z0-9 -'.,]*","description":"Street address","example":"123 Champs-Élysées"},"unit":{"type":"string","pattern":"[a-zA-Z0-9 -'.,]*","description":"House, building or apartment number.","example":2000},"city":{"type":"string","pattern":"[a-zA-Z0-9 -'.,]*","description":"City","example":"Paris"},"state":{"type":"string","description":"State or Province abbreviation","example":"IDF"},"zipcode":{"type":"string","description":"Postal code","example":"75008"},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2"},"children":[]}]}]}],"example":"FR"}}}},"components/schemas/InternationalCriminalSearch":{"id":"components/schemas/InternationalCriminalSearch","kind":"json-schema","title":"InternationalCriminalSearch","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayloadInternational"},{"type":"object","properties":{"id":{"example":"41007cffefb435cf7d701f75d8b86d"},"object":{"enum":["international_criminal_search"]},"uri":{"example":"/v1/international_criminal_searches/41007cffefb435cf7d701f75d8b86d"},"records":{"type":"array","description":"Array of CriminalRecord objects.","items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"arresting_agency":{"example":null},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}},"address":{"$ref":"#/components/schemas/InternationalAddress"}}}]}},"country":{"type":"string","description":"ISO country code of the jurisdiction where the search was run","example":"FR"},"pdf_url":{"type":"string","description":"URL to PDF document containing screening result details","example":"https://eu-west-1-checkr-staging.s3.eu-west-1.amazonaws.com/document.pdf"}}}]}},"components/schemas/InternationalEducationVerification":{"id":"components/schemas/InternationalEducationVerification","kind":"json-schema","title":"InternationalEducationVerification","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayloadInternational"},{"type":"object","properties":{"id":{"example":"41007cffefb435cf7d701f75d8b86c"},"object":{"enum":["international_education_verification"]},"uri":{"example":"/v1/international_education_verifications/41007cffefb435cf7d701f75d8b86c"},"turnaround_time":{"example":603216},"records":{"type":"array","description":"Array of CandidateEducationHistory records.","items":{"type":"object","properties":{"id":{"type":"string","example":"592311d2113adf7e9c9f66b8"},"result":{"type":"object","properties":{"verified":{"type":"boolean","example":false}}},"school":{"allOf":[{"$ref":"#/components/schemas/School"},{"properties":{"address":{"$ref":"#/components/schemas/InternationalAddress"}}}]},"events":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","example":"started"},"created_at":{"type":"string","example":"2017-06-29T14:42:47Z"},"type":{"type":"string","example":"verification_start"}}}},"status":{"type":"string","enum":["pending","clear","consider"],"example":"consider"},"country":{"type":"string","description":"ISO country code of the jurisdiction where the search was run","example":"FR"},"pdf_url":{"type":"string","description":"URL to PDF document containing screening result details","example":"https://eu-west-1-checkr-staging.s3.eu-west-1.amazonaws.com/document.pdf"}}}}}}]}},"components/schemas/InternationalEmploymentVerification":{"id":"components/schemas/InternationalEmploymentVerification","kind":"json-schema","title":"InternationalEmploymentVerification","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayloadInternational"},{"type":"object","properties":{"id":{"example":"41007cffefb435cf7d701f75d8b86f"},"object":{"enum":["international_employment_verification"]},"uri":{"example":"/v1/international_employment_verifications/41007cffefb435cf7d701f75d8b86f"},"turnaround_time":{"example":603216},"records":{"type":"array","description":"Array of CandidateEmploymentHistory objects.","items":{"type":"object","properties":{"id":{"type":"string","example":"592311d2113adf7e9c9f66b8"},"result":{"type":"object","properties":{"start_date":{"allOf":[{"$ref":"#/components/schemas/ResultPayload"},{"type":"object","properties":{"comments":{"example":"2016-06-01"}}}]},"end_date":{"allOf":[{"$ref":"#/components/schemas/ResultPayload"},{"type":"object","properties":{"comments":{"example":"2017-05-01"}}}]},"position":{"allOf":[{"$ref":"#/components/schemas/ResultPayload"},{"type":"object","properties":{"verified":{"example":true},"comments":{"example":"Software Development Engineer"},"ignored":{"example":"manual"}}}]},"contract_type":{"allOf":[{"$ref":"#/components/schemas/ResultPayload"},{"type":"object","properties":{"comments":{"example":"Full Time"},"ignored":{"example":"package"}}}]},"salary":{"allOf":[{"$ref":"#/components/schemas/ResultPayload"},{"type":"object","properties":{"verified":{"example":true},"comments":{"example":"100000"}}}]},"questions":{"type":"array","description":"List of questions for the candidate's employer.","items":{"type":"object","properties":{"sort_number":{"description":"The position of the question within the list.","type":"integer","example":1},"text":{"description":"The question that was asked.","type":"string","example":"What is the documented reason for the employee's departure?"},"response":{"description":"The answer received in response to the question.","type":"string","example":"They resigned."}}}}}},"employer":{"allOf":[{"$ref":"#/components/schemas/Employer"},{"properties":{"address":{"$ref":"#/components/schemas/InternationalAddress"}}}]},"events":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","example":"started"},"created_at":{"type":"string","example":"2017-06-29T14:42:44Z"},"type":{"type":"string","example":"verification_start"}}}},"status":{"type":"string","enum":["pending","clear","consider"],"example":"consider"},"country":{"type":"string","description":"ISO country code of the jurisdiction where the search was run","example":"FR"},"pdf_url":{"type":"string","description":"URL to PDF document containing screening result details","example":"https://eu-west-1-checkr-staging.s3.eu-west-1.amazonaws.com/document.pdf"}}}}}}]}},"components/schemas/InternationalGlobalWatchlistSearch":{"id":"components/schemas/InternationalGlobalWatchlistSearch","kind":"json-schema","title":"InternationalGlobalWatchlistSearch","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayloadInternational"},{"type":"object","properties":{"id":{"example":"41007cffefb435cf7d701f75d8b87a"},"object":{"enum":["international_global_watchlist_search"]},"uri":{"example":"/v1/international_global_watchlist_searches/41007cffefb435cf7d701f75d8b87a"},"country":{"type":"string","description":"ISO country code of the jurisdiction where the search was run","example":"FR"},"pdf_url":{"type":"string","description":"URL to PDF document containing screening result details","example":"https://eu-west-1-checkr-staging.s3.eu-west-1.amazonaws.com/document.pdf"}}}]}},"components/schemas/InternationalIdentityDocumentValidation":{"id":"components/schemas/InternationalIdentityDocumentValidation","kind":"json-schema","title":"InternationalIdentityDocumentValidation","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayloadInternational"},{"type":"object","properties":{"id":{"example":"41007cffefb435cf7d701f75d8b87b"},"object":{"enum":["international_identity_document_validation"]},"uri":{"example":"/v1/international_identity_document_validations/41007cffefb435cf7d701f75d8b87b"},"pdf_url":{"type":"string","description":"URL to PDF document containing screening result details","example":"https://eu-west-1-checkr-staging.s3.eu-west-1.amazonaws.com/document.pdf"}}}]}},"components/schemas/IdentityDataEvaluation":{"id":"components/schemas/IdentityDataEvaluation","kind":"json-schema","title":"IdentityDataEvaluation","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"object":{"type":"string","enum":["identity_data_evaluation"],"example":"identity_data_evaluation"},"uri":{"type":"string","description":"URI of the identity data evaluation.","example":"/v1/identity_data_evaluations/9f82ebb23267477a606e0a9c"},"ssn_risk":{"type":"object","description":"SSN risk data associated with the evaluation.","nullable":true,"properties":{"id":{"type":"string","description":"ID of the SSN risk record.","example":"6dbba87999aac2b5deaf539f"},"risk_flag":{"type":"string","description":"Indicates the level of identity data risk associated with the SSN.","enum":["inconsistent","consistent","limited"],"example":"inconsistent"},"distinct_dobs":{"type":"integer","description":"Number of distinct dates of birth associated with this SSN.","example":2},"distinct_employers":{"type":"integer","description":"Number of distinct employers associated with this SSN.","example":4},"distinct_full_names":{"type":"integer","description":"Number of distinct full names associated with this SSN.","example":3},"total_usages_completed":{"type":"integer","description":"Total number of completed usages associated with this SSN.","example":8},"internal_account_usages":{"type":"array","description":"Identity data observed on background checks within your account that share this SSN.\nUse these records to identify conflicting identity data or potential fraud by reviewing the names, dates of birth, and emails associated with reports in your account.\n","items":{"type":"object","properties":{"name":{"type":"string","description":"Full name used on a background check in your account.","example":"Jordan Riley"},"dob":{"type":"string","format":"date","description":"Date of birth used on a background check in your account.","example":"1988-03-14"},"email":{"type":"string","format":"email","description":"Email address used on a background check in your account.","example":"jordan.riley@example.com"},"candidate_resource_id":{"type":"string","description":"ID of the candidate resource in your account associated with this usage.","example":"7c2e91a4f3d05b6c812ade42"}}}},"external_account_usages":{"type":"array","description":"Identity data observed on background checks from other Checkr accounts that share this SSN.\nUse these records to identify conflicting identity data or potential fraud. Personally identifiable information from other accounts is limited to name and date of birth.\n","items":{"type":"object","properties":{"name":{"type":"string","description":"Full name used on a background check from another Checkr account.","example":"Morgan Avery Quinn"},"dob":{"type":"string","format":"date","description":"Date of birth used on a background check from another Checkr account.","example":"1972-09-26"}}}}}}}}]}},"components/schemas/LicenseInfo":{"id":"components/schemas/LicenseInfo","kind":"json-schema","title":"LicenseInfo","data":{"type":"object","properties":{"license_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s driver license number; Format varies by subdivision (i.e. province)"},"children":[]}]}]}],"example":"ABC12345"},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s driver license country of issue. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO 3166-2 2 letter alpha2 country code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CA"},"children":[]}]}]}],"example":"CA"},"subdivision":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate's driver license subdivision of issue country. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO 3166-2 subdivision code. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CA-AB"},"children":[]}]}]}],"example":"CA-AB"},"license_class":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s driver license class"},"children":[]}]}]}],"example":"G1"},"expiration_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s driver license expiration date. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \"YYYY-MM-DD”"},"children":[]}]}]}],"format":"date","example":"2030-01-01"},"is_current":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean that represents if it is the candidate’s current driver license"},"children":[]}]}]}],"example":true}}}},"components/schemas/Violation":{"id":"components/schemas/Violation","kind":"json-schema","title":"Violation","data":{"type":"object","properties":{"issued_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Violation issuance date. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \"YYYY-MM-DD”"},"children":[]}]}]}],"format":"date","example":"2050-01-01"},"description":{"type":"string","description":"Description of the violation","example":"HIT AND RUN"}}}},"components/schemas/LicenseReport":{"id":"components/schemas/LicenseReport","kind":"json-schema","title":"LicenseReport","data":{"type":"object","properties":{"license_status":{"type":"string","description":"Final result of the search","example":"VALID"},"actual_license_class":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual, verified license class this driver is eligible for. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" G, G1, G2"},"children":[]}]}]}],"example":1},"is_valid_license_class":{"type":"boolean","description":"Boolean check to confirm if the License Classes match","example":true},"license_infos":{"type":"array","description":"Array of LicenseInfo objects","items":{"$ref":"#/components/schemas/LicenseInfo"}},"violations":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of Violation objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The violations, if any, will show up only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_driver_history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, it will return an empty violation array."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/Violation"}}}}},"components/schemas/InternationalMotorVehicleReport":{"id":"components/schemas/InternationalMotorVehicleReport","kind":"json-schema","title":"InternationalMotorVehicleReport","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayloadInternational"},{"type":"object","properties":{"id":{"example":"41007cffefb435cf7d701f75d8b86d"},"object":{"enum":["international_motor_vehicle_report"]},"uri":{"example":"/v1/international_motor_vehicle_reports/41007cffefb435cf7d701f75d8b86d"},"country":{"type":"string","description":"ISO 3166-2 country code of the jurisdiction where the search was run","example":"CA"},"pdf_url":{"type":"string","description":"URL to PDF document containing screening result details","example":"https://eu-west-1-checkr-staging.s3.eu-west-1.amazonaws.com/document.pdf"},"license_reports":{"type":"array","description":"Array of LicenseReport objects","items":{"allOf":[{"$ref":"#/components/schemas/LicenseReport"}]}}}}]}},"components/schemas/MotorVehicleReport":{"id":"components/schemas/MotorVehicleReport","kind":"json-schema","title":"MotorVehicleReport","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"object":{"enum":["motor_vehicle_report"]},"license_reports":{"type":"array","description":"Array of license reports","items":{"type":"object","properties":{"number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s driver’s license number."},"children":[]}]}]}],"example":"F2111132"},"dob":{"type":"string","format":"date","description":"Date of Birth of the individual the license was issued to as returned by the DMV.","example":"1980-01-01"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s driver’s license state of issue."},"children":[]}]}]}],"example":"NC"},"status":{"type":"string","description":"Status of the license as returned by the DMV if found, or status indicating the license is not found or not available.","example":"valid, expired, not_found"},"type":{"type":"string","description":"Type of the license as returned by the DMV.","example":"personal, commercial, or non-commercial"},"class":{"type":"string","description":"Class of the license as returned by the DMV.","example":"C"},"expiration_date":{"type":"string","format":"date","description":"Date on which the license expires.","example":"2025-09-16"},"expiration_extension_record":{"type":"object","description":"Record of the extension policy applied to extend the license expiration date.","properties":{"name":{"type":"string","description":"Name of the extension policy.","example":"NC Senate Bill 391"},"description":{"type":"string","description":"Description of the extension policy.","example":"NC Senate Bill 391 extends the expiration for passenger licenses for in-state driving."},"extended_expiration_date":{"type":"string","format":"date","description":"Date on which license expires after extension is applied.","example":"2027-09-16"}}},"issued_date":{"type":"string","format":"date","description":"Date on which the license was issued.","example":"2023-09-16"},"first_issued_date":{"type":"string","format":"date","description":"Date on which the license was first issued. Used to determine if the candidate meets minimum experience requirements.","example":"2015-09-16"},"restrictions":{"type":"array","description":"Array of restrictions, as returned by the individual states' DMV.","items":{"type":"string"}},"current_license":{"type":"boolean","description":"True when this is the current license in use"},"privilege_to_drive":{"type":"string","enum":["valid","invalid"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the validity of the license, as determined by the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"license_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"license_class"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiration_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If one or more of these three fields indicates that the license is not valid, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"privilege_to_drive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"valid"},"violations":{"type":"array","description":"Array of Violation objects.","items":{"type":"object","properties":{"type":{"type":"string","example":"conviction"},"issued_date":{"type":"string","example":"2011-11-14"},"conviction_date":{"type":"string","example":"2010-04-11"},"description":{"type":"string","example":"speeding 15-19 mph"},"points":{"type":"integer","example":0},"city":{"type":"string","nullable":true,"example":null},"county":{"type":"string","example":"SANTA CLARA"},"state":{"type":"string","example":"California"},"ticket_number":{"type":"string","example":"2D55555"},"disposition":{"type":"string","nullable":true,"example":null},"category":{"type":"string","nullable":true,"example":null},"court_name":{"type":"string","nullable":true,"example":null},"acd_code":{"type":"string","nullable":true,"example":null},"state_code":{"type":"string","nullable":true,"example":null},"docket":{"type":"string","nullable":true,"example":null},"additional_info":{"type":"string","nullable":true,"example":"Docket Number: S319499, Date Updated: 2021-12-17, Statute Code: VC"}}}},"accidents":{"type":"array","description":"Array of Accident objects.","items":{"type":"object","properties":{"accident_date":{"type":"string","example":"2009-04-12"},"description":{"type":"string","example":"property damage"},"city":{"type":"string","nullable":true,"example":null},"county":{"type":"string","example":"SAN FRANCISCO"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-2:US"},"children":[]}]}]}],"nullable":true,"example":null},"order_number":{"type":"string","example":"33-435932"},"points":{"nullable":true,"example":null},"vehicle_speed":{"type":"number","nullable":true,"example":null},"reinstatement_date":{"type":"string","format":"date","nullable":true,"example":null},"action_taken":{"type":"string","example":"police report filed"},"ticket_number":{"type":"string","nullable":true,"example":null},"enforcing_agency":{"type":"string","example":"San Francisco PD"},"jurisdiction":{"type":"string","nullable":true,"example":null},"severity":{"type":"string","nullable":true,"example":null},"violation_number":{"type":"string","nullable":true,"example":null},"license_plate":{"type":"string","example":"6UM6938"},"fine_amount":{"type":"number","nullable":true,"example":null},"state_code":{"type":"string","nullable":true,"example":null},"acd_code":{"type":"string","nullable":true,"example":null},"injury_accident":{"type":"boolean","default":false},"fatality_accident":{"type":"boolean","default":false},"fatality_count":{"type":"integer","example":0},"injury_count":{"type":"integer","example":0},"vehicles_involved_count":{"type":"integer","example":3},"report_number":{"type":"string","nullable":true,"example":null},"policy_number":{"type":"string","nullable":true,"example":null},"group":{"type":"string","nullable":true,"enum":["unspecified","property damage","personal injury","fatality"],"description":"Displays category type for an accident.","example":"property damage"},"note":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A note that is added if an accident appears on a candidate’s MVR."},"children":[]}]}]}],"example":"Unless fault is indicated, only the fact of an accident is being reported."}}}},"suspensions":{"type":"array","description":"Array of Suspension objects.","items":{"type":"object","properties":{"description":{"type":"string","example":"ACCUMULATION OF CONVICTIONS OR POINTS"},"start_date":{"type":"string","example":"2011-11-14"},"end_date":{"type":"string","example":"2012-03-21"},"state":{"type":"string","example":"CA"}}}},"miscellaneous_incidents":{"type":"array","description":"Array of Miscellaneous objects.","items":{"type":"object","properties":{"description":{"type":"string","example":"RIGHT OF WAY REMINDER LETTER"},"date":{"type":"string","example":"2011-11-14"},"additional_info":{"type":"string","example":"Additional information about the miscellaneous item."}}}},"endorsements":{"type":"array","description":"Array of Endorsements","items":{"type":"string"}},"medical_certificates":{"type":"array","description":"Array of Medical Certificate objects. Only available for commercial MVR.","items":{"type":"object","properties":{"status":{"type":"string","example":"CERTIFIED"},"issued_date":{"type":"string","example":"2011-11-14"},"expiration_date":{"type":"string","example":"2012-03-21"},"self_certification":{"type":"string","example":"NON-EXCEPTED INTERSTATE"},"examiner":{"type":"object","properties":{"full_name":{"type":"string","example":"Amy Welch Taylor Jr."},"specialty":{"type":"string","example":"PA - Physician Assistant"},"license_number":{"type":"string","example":"981736076"},"license_state":{"type":"string","example":"CT"},"registration_number":{"type":"string","example":"11111111111"}}}}}}}}},"uri":{"example":"/v1/motor_vehicle_reports/539fd88c101897f7cd000007"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"complete"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"consider"}]},"turnaround_time":{"example":90},"full_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s full name, as listed with the DMV."},"children":[]}]}]}],"example":"John Alfred Smith"},"license_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s driver’s license number."},"children":[]}]}]}],"example":"F2111132"},"license_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s driver’s license state of issue."},"children":[]}]}]}],"example":"CA"},"previous_license_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s previous driver’s license number."},"children":[]}]}]}],"example":"F2111132"},"previous_license_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s previous driver’s license state of issue."},"children":[]}]}]}],"example":"CA"},"license_status":{"type":"string","description":"Status of the license as returned by the DMV if found, or status indicating the license is not found or not available.","example":"valid, expired, not_found"},"license_type":{"type":"string","description":"Type of the license as returned by the DMV.","example":"personal, commercial, or non-commercial"},"license_class":{"type":"string","description":"Class of the license as returned by the DMV.","example":"C"},"dob":{"type":"string","format":"date","description":"Date of Birth of the individual the license was issued to as returned by the DMV.","example":"1980-01-01"},"expiration_date":{"type":"string","format":"date","description":"Date on which the license expires.","example":"2016-07-24"},"covid_extension":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the MVR report has been automatically adjusted for DMV license expiration date extension. This field will be returned in the response data for impacted reports only."},"children":[]}]}]}]},"issued_date":{"type":"string","format":"date","description":"Date on which the license was issued.","example":"2006-12-03"},"first_issued_date":{"type":"string","format":"date","description":"Date on which the license was first issued. Used to determine if the candidate meets minimum experience requirements.","example":"2000-01-14"},"inferred_issued_date":{"type":"string","format":"date","description":"Checkr-inferred license issued date based on data returned by the DMV.","nullable":true,"example":null},"restrictions":{"type":"array","description":"Array of restrictions, as returned by the individual states' DMV.","items":{"type":"string"}},"custom_rules":{"type":"object","description":"Object with custom rules applied to generate this MVR.","properties":{"rule_key_1":{"type":"object","properties":{"description":{"type":"string","example":"rule description 1"},"satisfied":{"type":"boolean","example":true}}},"rule_key_2":{"type":"object","properties":{"description":{"type":"string","example":"rule description 2"},"satisfied":{"type":"boolean","example":false}}}}},"not_found":{"type":"boolean","description":"No license found by the DMV matching the candidate's license number/state and PII.","default":false},"experience_failed":{"type":"boolean","description":"If true, the MVR has an unsatisfied StrictExperience rule.","default":false},"type":{"type":"string","description":"MVR type.","example":"standard"},"privilege_to_drive":{"type":"string","enum":["valid","invalid"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the validity of the license, as determined by the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"license_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"license_class"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiration_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If one or more of these three fields indicates that the license is not valid, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"privilege_to_drive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"valid"},"accidents":{"type":"array","description":"Array of Accident objects.","items":{"type":"object","properties":{"accident_date":{"type":"string","example":"2009-04-12"},"description":{"type":"string","example":"property damage"},"city":{"type":"string","nullable":true,"example":null},"county":{"type":"string","example":"SAN FRANCISCO"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-2:US"},"children":[]}]}]}],"nullable":true,"example":null},"order_number":{"type":"string","example":"33-435932"},"points":{"nullable":true,"example":null},"vehicle_speed":{"type":"number","nullable":true,"example":null},"reinstatement_date":{"type":"string","format":"date","nullable":true,"example":null},"action_taken":{"type":"string","example":"police report filed"},"ticket_number":{"type":"string","nullable":true,"example":null},"enforcing_agency":{"type":"string","example":"San Francisco PD"},"jurisdiction":{"type":"string","nullable":true,"example":null},"severity":{"type":"string","nullable":true,"example":null},"violation_number":{"type":"string","nullable":true,"example":null},"license_plate":{"type":"string","example":"6UM6938"},"fine_amount":{"type":"number","nullable":true,"example":null},"state_code":{"type":"string","nullable":true,"example":null},"acd_code":{"type":"string","nullable":true,"example":null},"injury_accident":{"type":"boolean","default":false},"fatality_accident":{"type":"boolean","default":false},"fatality_count":{"type":"integer","example":0},"injury_count":{"type":"integer","example":0},"vehicles_involved_count":{"type":"integer","example":3},"report_number":{"type":"string","nullable":true,"example":null},"policy_number":{"type":"string","nullable":true,"example":null},"group":{"type":"string","nullable":true,"enum":["unspecified","property damage","personal injury","fatality"],"description":"Displays category type for an accident.","example":"property damage"},"note":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A note that is added if an accident appears on a candidate’s MVR."},"children":[]}]}]}],"example":"Unless fault is indicated, only the fact of an accident is being reported."}}}},"violations":{"type":"array","description":"Array of Violation objects.","items":{"type":"object","properties":{"type":{"type":"string","example":"conviction"},"issued_date":{"type":"string","example":"2011-11-14"},"conviction_date":{"type":"string","example":"2010-04-11"},"description":{"type":"string","example":"speeding 15-19 mph"},"points":{"type":"integer","example":0},"city":{"type":"string","nullable":true,"example":null},"county":{"type":"string","example":"SANTA CLARA"},"state":{"type":"string","example":"California"},"ticket_number":{"type":"string","example":"2D55555"},"disposition":{"type":"string","nullable":true,"example":null},"category":{"type":"string","nullable":true,"example":null},"court_name":{"type":"string","nullable":true,"example":null},"acd_code":{"type":"string","nullable":true,"example":null},"state_code":{"type":"string","nullable":true,"example":null},"docket":{"type":"string","nullable":true,"example":null},"additional_info":{"type":"string","nullable":true,"example":"Docket Number: S319499, Date Updated: 2021-12-17, Statute Code: VC"}}}},"suspensions":{"type":"array","description":"Array of Suspension objects.","items":{"type":"object","properties":{"description":{"type":"string","example":"ACCUMULATION OF CONVICTIONS OR POINTS"},"start_date":{"type":"string","example":"2011-11-14"},"end_date":{"type":"string","example":"2012-03-21"},"state":{"type":"string","example":"CA"}}}}}}]}},"components/schemas/ScreeningStatusNonReportable":{"id":"components/schemas/ScreeningStatusNonReportable","kind":"json-schema","title":"ScreeningStatusNonReportable","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the screening.  Screenings completed before April 2021 may return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"clear\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"consider\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["pending","complete"]}},"components/schemas/NationalCriminalSearch":{"id":"components/schemas/NationalCriminalSearch","kind":"json-schema","title":"NationalCriminalSearch","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsWithNullResult"},{"type":"object","properties":{"object":{"enum":["national_criminal_search"]},"uri":{"example":"/v1/national_criminal_searches/539fd88c101897f7cd000006"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatusNonReportable"},{"example":"complete"}]},"result":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outcome of the screening.  Screenings completed before April 2021 may return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"clear\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"consider\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"example":null},"turnaround_time":{"example":90},"records":{"type":"array","description":"Array of CriminalRecord objects.","items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"arresting_agency":{"example":null},"charges":{"type":"array","items":{"$ref":"#/components/schemas/Charge"}}}}]}}}}]}},"components/schemas/Node":{"id":"components/schemas/Node","kind":"json-schema","title":"Node","data":{"type":"object","required":["name","custom_id"],"properties":{"name":{"type":"string","description":"The name for the node. This name will be displayed in the Checkr Dashboard.","example":"Acme Staffing","minLength":1,"maxLength":255},"custom_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined unique ID for the node. Must be unique within your account. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom IDs will contain only letters, numbers, spaces, hyphens, colons, ampersands, and/or underscores."},"children":[]}]}]}],"example":"zpy8orej4r614ize","minLength":1,"maxLength":255},"tier":{"type":"string","description":"Customer-defined label for this level of the hierarchy. (For example \"Department\" or \"Division\".)","example":"department","maxLength":255},"parent_custom_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the parent of this node. If not provided, this node will be placed at the top level of the hierarchy."},"children":[]}]}]}],"example":"2tpiycfpbw5o3xat","maxLength":255},"packages":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of slugs for packages that are visible to this node (through either direct assignment to the node, or assignment to one of the node's ancestors). Only provided if \"include=packages\" is included in the query."},"children":[]}]}]}],"items":{"type":"string"},"example":["driver_pro","tasker_pro"]}}}},"components/schemas/Package":{"id":"components/schemas/Package","kind":"json-schema","title":"Package","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["package"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/packages/e44aa283528e6fde7d542194"},"apply_url":{"type":"string","description":"URL at which candidates may apply for a background check with this Package.","example":"https://apply.checkr.com/apply/customer-services-inc/532c20ea819b"},"created_at":{"type":"string","description":"Time at which the Package was created.","format":"date-time","example":"2014-01-18T12:34:00Z"},"deleted_at":{"type":"string","description":"Time at which the Package was deleted.","format":"date-time","example":"2014-01-18T12:34:00Z"},"name":{"type":"string","description":"Human-readable name of the Package.","example":"Criminal Pro"},"slug":{"type":"string","description":"Unique key identifier of the Package.","example":"criminal_pro"},"price":{"type":"integer","description":"Package price in USD cents.","example":6500},"screenings":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ssn_trace","social_media_screenings","sex_offender_search","global_watchlist_search","national_criminal_search","municipal_criminal_search","county_criminal_search","state_criminal_search","federal_criminal_search","county_civil_search","federal_civil_search","personal_reference_verification","professional_license_verification","professional_reference_verification","education_verification","employment_verification","drug_screening","international_criminal_search","motor_vehicle_report","eviction_search","credit_report","facis_search"],"example":"ssn_trace"},"subtype":{"type":"string","nullable":true,"example":null}}}}}}},"components/schemas/ProfessionalLicenseVerification":{"id":"components/schemas/ProfessionalLicenseVerification","kind":"json-schema","title":"ProfessionalLicenseVerification","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"object":{"enum":["professional_license_verification"]},"uri":{"example":"/v1/professional_license_verifications/5ee1b0c080c74df951ce6a59"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clear"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a valid active license was found matching the candidate's PII."},"children":[]}]}]}],"enum":["pending","clear","consider"],"example":"consider"},"result":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clear"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a valid active license was found matching the candidate's PII."},"children":[]}]}]}],"enum":["clear","consider"],"nullable":true,"example":"consider"},"turnaround_time":{"example":603216},"documents":{"type":"array","description":"An array of documents captured for the Professional License Verification.","items":{"$ref":"#/components/schemas/Document"}},"certifications":{"type":"array","description":"An array of candidate input objects and license verification results objects.","items":{"allOf":[{"type":"object","properties":{"result":{"type":"object","description":"Certification result.","properties":{"certification_issued_to":{"type":"string","description":"Certification Holder.","example":"Jersey John Smith"},"certification_issuer":{"type":"string","description":"Certifying organization that issued the license. For example: \"California: General\".","example":"California: Care Providers"},"certification_issuer_region":{"type":"string","description":"Certifying organization's region or state.","example":"CA"},"certification_expiration":{"type":"string","format":"date","description":"Certification's expiration date in YYYY-MM-DD format. Present only if certification is found.","example":"2019-01-10"},"verified_by":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entity that verified the license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Verified by one of Checkr's Professional License partners (most common)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Candidate's license was manually entered, and has not been verified."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"enum":["partner","none"]},"sub_results":{"type":"array","description":"An array of objects describing the results of verification data.","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"Certifying organization's name for the data returned."},"value":{"type":"string","description":"Certifying organization specific data value."}}}]},"example":[{"name":"license_number","value":"B1234567"}]},"sub_checks":{"type":"array","description":"An array of objects describing the results of specific verification criteria.","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Certification active."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_consistency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Certification matches candidate PII."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_good_standing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Certification not revoked."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Certification found given license identifier."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"enum":["not_expired","data_consistency","in_good_standing","found"]},"status":{"type":"string","enum":["clear","consider"]}}}]},"example":[{"name":"not_expired","status":"consider"},{"name":"data_consistency","status":"clear"},{"name":"in_good_standing","status":"clear"},{"name":"found","status":"clear"}]}}},"input":{"type":"object","description":"Candidate input for license verification.","properties":{"certification_issued_to":{"type":"string","description":"Candidate name used in application for professional license verification.","example":"Jersey John Smith"},"certification_issuer":{"type":"string","description":"Certifying organization that issued the license. For example: \"California: General\".","example":"California: Care Providers"},"license_number":{"type":"string","description":"Professional License Number.","example":"B1234567"},"license_type":{"type":"string","description":"Professional License type, as provided by the certification's issuer.","example":"Nurse"},"certification_issuer_website":{"type":"string","description":"Certifying organization's website.","example":"https://www.bpelsg.ca.gov/"},"additional_text":{"type":"string","description":"Additional information provided by the candidate for their manually entered license.","example":"License expires on 01-01-2050"}}},"candidate_documents":{"type":"array","description":"An array of documents uploaded by the candidate","items":{"$ref":"#/components/schemas/Document"}}}}]}}}}]}},"components/schemas/Program":{"id":"components/schemas/Program","kind":"json-schema","title":"Program","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["program"],"readOnly":true},"name":{"type":"string","description":"Human-readable name of the Program.","example":"Program A"},"created_at":{"type":"string","description":"Time at which the resource was created.","format":"date-time","example":"2017-08-07T16:51:09Z"},"deleted_at":{"type":"string","description":"Time at which the resource was deleted.","format":"date-time","nullable":true,"example":null},"package_ids":{"type":"array","items":{"type":"string","example":"a57a0cd15965a585ff7d5d35"},"description":"Array of associated Package IDs."},"geo_ids":{"type":"array","items":{"type":"string","example":"cbc37748bc6a45b41af5c3f5"},"description":"Array of associated Geo IDs."}}}},"components/schemas/SelfDisclosure":{"id":"components/schemas/SelfDisclosure","kind":"json-schema","title":"SelfDisclosure","data":{"type":"object","required":["description","date","location"],"properties":{"description":{"type":"string","description":"Candidate-provided description of their criminal history.","example":"I made a mistake and grew from this experience."},"offense_level":{"type":"string","description":"The level of the offense.","example":"Misdemeanor"},"offense_category":{"type":"string","description":"The criminal charge","example":"Insurance Fraud"},"sentence":{"type":"string","description":"The sentence imposed.","example":"24 months probation"},"time_served":{"type":"string","description":"The time served.","example":"20 months probation"},"date":{"type":"string","description":"Date of the conviction.","format":"date","example":"2019-11-01"},"location":{"type":"object","description":"The location of the incident.","required":["state","county"],"properties":{"county":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the county in which the conviction occurred. (Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/counties"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/counties"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource to obtain a list of counties in each state.)"},"children":[]}]}]}],"example":"BOULDER"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State where the county is located. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-2:US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"CO"},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 letter country code. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default.)"},"children":[]}]}]}],"example":"US"}}}}}},"components/schemas/IdentityVerification":{"id":"components/schemas/IdentityVerification","kind":"json-schema","title":"IdentityVerification","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"object":{"type":"string","enum":["identity_verification"],"example":"identity_verification"},"uri":{"type":"string","description":"URI of the Identity Verification.","example":"/v1/identity_verifications/9f82ebb23267477a606e0a9c"},"evaluations":{"type":"array","description":"Evaluations performed during the Identity Verification. A completed\nIdentity Verification may include one or more evaluations.\n","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the evaluation.","example":"6dbba87999aac2b5deaf539f"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of evaluation performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"biometric"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Document and selfie verification."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"enum":["biometric"],"example":"biometric"},"variant":{"type":"string","description":"Variant of the evaluation performed.","example":"selfie_id"},"outcome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outcome of the evaluation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The evaluation passed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unverified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The evaluation did not pass."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"enum":["verified","unverified"],"example":"verified"},"risk_signals":{"type":"array","description":"An array of risk signals surfaced during the evaluation.","items":{"type":"object","properties":{"description":{"type":"string","description":"Human-readable description of the risk signal.","example":"The document has expired and is no longer valid"}}}},"documents":{"type":"array","description":"An array of documents captured for the evaluation.","items":{"$ref":"#/components/schemas/Document"}}}}}}}]}},"components/schemas/Report":{"id":"components/schemas/Report","kind":"json-schema","title":"Report","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the object type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["report"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/reports/4722c07dd9a10c3985ae432a"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if and only if all screenings, including SSN Trace, within the report were canceled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if at least one screening was completed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the report is awaiting a Review Action decision to continue or skip."},"children":[]}]}]}],"enum":["pending","complete","suspended","paused","dispute","canceled"],"example":"complete"},"result":{"type":"string","description":"Outcome of the report.\n","enum":["clear","consider"],"nullable":true,"example":"clear"},"includes_canceled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the report includes a canceled screening."},"children":[]}]}]}],"example":false},"created_at":{"type":"string","description":"Time at which the report was created.\n","format":"date-time","example":"2014-01-18T12:34:00Z"},"completed_at":{"type":"string","description":"Time at which the report was completed.\n","format":"date-time","example":"2014-01-18T12:35:30Z"},"revised_at":{"type":"string","description":"Time at which the report was revised.\n","format":"date-time","nullable":true,"example":null},"upgraded_at":{"type":"string","description":"Time at which the report was upgraded.\n","format":"date-time","nullable":true,"example":null},"turnaround_time":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of seconds the report took to complete, calculated from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":90},"package":{"type":"string","description":"Human-readable name of the Package.\n","example":"driver_pro"},"adjudication":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The adjudication for the candidate. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no adjudication has been made."},"children":[]}]}]}],"nullable":true,"enum":["engaged","pre_adverse_action","post_adverse_action"],"example":"engaged"},"assessment":{"type":"string","description":"The assessment for the report. This field will be non-null only for Assess-enabled accounts. For accounts with Assess enabled, it will be null for reports completed before Assess was enabled, and null for a short time after report completion while the account's Assess rules are applied.\n","nullable":true,"enum":["eligible","review","escalated"],"example":"eligible"},"source":{"type":"string","enum":["api","continuous_check","form","manual_order","recurrence","web"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method used to create the report. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created from the Checkr API. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuous_check"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created automatically from a Continuous Check return. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created from the Checkr Hosted Invite/Apply flow. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual_order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created from a manual order (customer enters candidate's PII) originating in the Checkr Dashboard. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurrence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created from a Subscription. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"web"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created from "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidates > Order new Report "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Checkr Dashboard."},"children":[]}]}]}],"example":"api"},"segment_stamps":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tier and name of the node the report was ordered with and tier|name information for all its parent nodes."},"children":[]}]}]}],"items":{"type":"string","example":["unit|Anvil Charlotte","company|Acme Corporation","division|Anvil Sales","region|Anvil South East"]}},"work_locations":{"type":"array","description":"Array of work locations set while ordering this report.\n","items":{"$ref":"#/components/schemas/WorkLocation"}},"estimated_completion_time":{"type":"string","description":"Date at which the report is predicted to be finished. Despite the date-time format, we only estimate to the date. The time is not relevant.\n","format":"date-time","example":"2019-07-31T00:00:00Z"},"candidate_story_ids":{"type":"array","description":"Array of Candidate Story IDs linked to the Report.","items":{"type":"string","example":"989b4c2d83dd8a81547f2dae"}},"candidate_id":{"type":"string","description":"ID of the candidate being screened.","example":"e44aa283528e6fde7d542194"},"drug_screening":{"type":"object","description":"Embedded Drug Screening object","properties":{"id":{"type":"string","description":"ID of the Drug Screening linked to the Report.","example":"539fd88c101897f7cd000001"},"status":{"type":"string","description":"Status of the Drug Screening.\n","enum":["pending","clear","consider","suspended","canceled","complete"],"example":"clear"},"result":{"type":"string","description":"Outcome of the Drug Screening.\n","enum":["clear","consider"],"example":"clear"},"disposition":{"type":"string","description":"Medical evaluation for entire screening","enum":["negative","positive","canceled"],"example":"negative"},"mro_notes":{"type":"string","description":"Notes from Medical Review Officer","example":"Diluted Sample"},"analytes":{"type":"array","description":"Array of result analytes from the Drug Screening Panel","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of drug that was tested","example":"Marijuana"},"disposition":{"type":"string","description":"Medical evaluation for specific drug","enum":["negative","positive"],"example":"negative"},"specimen_type":{"type":"string","description":"Type of specimen that was tested","enum":["urine","breath","saliva"],"example":"urine"}}}},"events":{"type":"array","description":"Array of drug screening events","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of event","enum":["completed","screening_invitation_sent","screening_scheduled","status_update","screening_pass_extended","screening_notice"],"example":"status_update"},"text":{"type":"string","description":"Additional note for event type","example":"Specimen Sent to Lab"},"created_at":{"type":"string","description":"Time the event was created","format":"date-time","example":"2014-01-19T11:28:31Z"}}}},"screening_pass_expires_at":{"type":"string","description":"Time the Candidate has to complete the drug screening","format":"date-time","example":"2014-01-19T11:28:31Z"},"appointment_id":{"type":"string","description":"ID of the Appointment linked to the Drug Screening.","example":"539fd88c101897f7cd000001"}}},"ssn_trace_id":{"type":"string","description":"ID of the SSN Trace linked to the Report.","example":"539fd88c101897f7cd000001"},"arrest_search_id":{"type":"string","description":"ID of the Arrest Search linked to the report.","example":"539fd88c101897f7cd000001"},"drug_alcohol_clearinghouse_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the Drug & Alcohol Clearinghouse Search linked to the Report."},"children":[]}]}]}],"example":"539fd88c101897f7cd000001"},"drug_screening_id":{"type":"string","description":"ID of the Drug Screening linked to the report.","example":"539fd88c101897f7cd000001"},"facis_search_id":{"type":"string","description":"ID of the FACIS Search linked to the Report.","example":"539fd88c101897f7cd000001"},"federal_criminal_search_id":{"type":"string","description":"ID of the Federal Criminal Search linked to the Report.","example":"539fd88c101897f7cd000001"},"federal_district_criminal_search_id":{"type":"string","description":"ID of the Federal District Criminal Search linked to the Report.","example":"539fd88c101897f7cd000001"},"federal_civil_search_id":{"type":"string","description":"ID of the Federal Civil Search linked to the Report.","example":"539fd88c101897f7cd000001"},"federal_district_civil_search_id":{"type":"string","description":"ID of the Federal District Civil Search linked to the Report.","example":"539fd88c101897f7cd000001"},"global_watchlist_search_id":{"type":"string","description":"ID of the Global Watchlist Search linked to the Report.","example":"539fd88c101897f7cd000001"},"social_media_screenings_id":{"type":"string","description":"ID of the Social Media Screening linked to the Report.","example":"539fd88c101897f7cd000001"},"sex_offender_search_id":{"type":"string","description":"ID of the Sex Offender Registry Search linked to the Report.","example":"539fd88c101897f7cd000008"},"national_criminal_search_id":{"type":"string","description":"ID of the National Criminal Search linked to the Report.","example":"539fd88c101897f7cd000006"},"county_criminal_search_ids":{"type":"array","description":"Array of County Criminal Search IDs linked to the Report.","items":{"type":"string","example":"539fdcf335644a0ef4000003"}},"occupational_health_screening_id":{"type":"string","description":"ID of the Health Screening linked to the report.","example":"539fdcf335644a0ef4000003"},"personal_reference_verification_ids":{"type":"array","description":"Array of Personal Reference Verification IDs linked to the Report.","items":{"type":"string","example":"539fdcf335644a0ef4000003"}},"professional_reference_verification_ids":{"type":"array","description":"Array of Professional Reference Verification IDs linked to the Report.","items":{"type":"string","example":"539fdcf335644a0ef4000003"}},"motor_vehicle_report_id":{"type":"string","description":"ID of the Motor Vehicle Record Search linked to the Report.","example":"539fd88c101897f7cd000007"},"professional_license_verification_ids":{"type":"array","description":"Array of Professional License Verification IDs linked to the Report.","items":{"type":"string","example":"5ee1b0c080c74df951ce6a59"}},"state_criminal_searches":{"type":"array","description":"Array of State Criminal Search IDs linked to the Report.","items":{"type":"string","example":"539fdcf335644a0ef4000003"}},"international_criminal_searches_v2_ids":{"type":"array","description":"Array of International Criminal Search IDs linked to the Report. If no searches exist, this field is omitted.","items":{"type":"string","example":"41007c751c9a15c892c0981a0400d1"}},"international_adverse_media_search_ids":{"type":"array","description":"Array of International Adverse Media Search IDs linked to the Report. If no searches exists, this field is omitted.","items":{"type":"string","example":"41007c751c9a15c892c0981a0400e2"}},"international_global_watchlist_search_id":{"type":"string","description":"ID of an International Global Watchlist Search linked to the Report. If no search exists, this field is omitted.","example":"41007c751c9a15c892c0981a0400f3"},"international_education_verification_id":{"type":"string","description":"ID of an International Education Verification linked to the Report. If no verification exists, this field is omitted.","example":"41007c751c9a15c892c0981a040004"},"international_employment_verification_id":{"type":"string","description":"ID of an International Employment Verification linked to the Report. If no verification exists, this field is omitted.","example":"41007c751c9a15c892c0981a040015"},"international_identity_document_validation_id":{"type":"string","description":"ID of an International Identity Document Validation linked to the Report. If no validation exists, this field is omitted.","example":"41007c751c9a15c892c0981a040026"},"identity_data_evaluation_id":{"type":"string","description":"ID of the identity data evaluation linked to the report. If no evaluation exists, this field is omitted.","example":"9f82ebb23267477a606e0a9c"},"identity_verification_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the Identity Verification linked to the Report. If no Identity Verification exists, this field is omitted. Returned by default; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include=identity_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to embed the full Identity Verification object instead."},"children":[]}]}]}],"example":"9f82ebb23267477a606e0a9c"},"identity_verification":{"allOf":[{"$ref":"#/components/schemas/IdentityVerification"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded Identity Verification object. Only returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include=identity_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed; otherwise the Report returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity_verification_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"document_ids":{"type":"array","description":"Array of Document IDs.","items":{"example":"539fdcf335496a0ef4000003","type":"string"}},"geo_ids":{"type":"array","description":"Array of Geo IDs.","items":{"type":"string","example":"87f5bb4983eade22c55f4731"}},"program_id":{"type":"string","description":"ID of the Program linked to the Report.\n","example":"00166f9ff39ec7b453adfaec"},"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the invitation is archived."},"children":[]}]}]}],"example":false}}}},"components/schemas/PreExistingAdverseActionError":{"id":"components/schemas/PreExistingAdverseActionError","kind":"json-schema","title":"PreExistingAdverseActionError","data":{"type":"object","properties":{"error":{"type":"string","example":"Report has a pre-existing adverse action. See https://docs.checkr.com/#operation/updateReport"}}}},"components/schemas/ReportETA":{"id":"components/schemas/ReportETA","kind":"json-schema","title":"ReportETA","data":{"type":"object","properties":{"estimate_generated_at":{"type":"string","description":"Time at which the prediction was created.\n","format":"date-time","example":"2014-01-18T12:34:00Z"},"estimated_completion_time":{"type":"string","description":"Date at which the report is predicted to be finished. Despite the date-time format, we only estimate to the date. The time is not relevant.\n","format":"date-time","example":"2019-07-31T00:00:00Z"}}}},"components/schemas/PredictionUnavailable":{"id":"components/schemas/PredictionUnavailable","kind":"json-schema","title":"PredictionUnavailable","data":{"type":"object","properties":{"error":{"type":"string","example":"Report ETA prediction unavailable"}}}},"components/schemas/ReportTags":{"id":"components/schemas/ReportTags","kind":"json-schema","title":"ReportTags","data":{"type":"object","properties":{"count":{"type":"number","format":"integer","example":2},"object":{"type":"string","example":"list","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}},"example":[{"name":"EIN-234234234"},{"name":"api-generated"}]}}}},"components/schemas/ReportAddresses":{"id":"components/schemas/ReportAddresses","kind":"json-schema","title":"ReportAddresses","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of location.","example":"UCSF"},"city":{"type":"string","example":"San Francisco"},"state":{"type":"string","example":"CA"},"start_date":{"type":"string","format":"date-time","example":"2018-07-22T17:41:20Z"},"end_date":{"type":"string","format":"date-time","example":"2018-01-24T17:41:20Z"}}}},"components/schemas/RulesetVersion":{"id":"components/schemas/RulesetVersion","kind":"json-schema","title":"RulesetVersion","data":{"type":"object","description":"Information about a RulesetVersion. RulesetVersions are complete, distinct \nversions of Rulesets. New RulesetVersions are generated each time a Ruleset \nis published. The most recent 'live' RulesetVersion is used (by default) when \nassessing new Reports.\n\nRulesetVersions also include metadata about the creator and publisher of the \nversion, and timestamps for these events.\n","properties":{"number":{"type":"integer","description":"The version number","example":5}}}},"components/schemas/Ruleset":{"id":"components/schemas/Ruleset","kind":"json-schema","title":"Ruleset","data":{"type":"object","description":"Information about a Ruleset.\n","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"name":{"type":"string","description":"The name of the Ruleset","example":"Ruleset for employees in Arizona"},"version":{"$ref":"#/components/schemas/RulesetVersion"}}}},"components/schemas/AssessedObject":{"id":"components/schemas/AssessedObject","kind":"json-schema","title":"AssessedObject","data":{"type":"object","description":"TODO\n","properties":{"object_id":{"$ref":"#/components/schemas/ResourceId"},"object_type":{"type":"string","enum":["child_abuse_search","criminal_charge","drug_screening","drug_screening_v2","employment_verification","education_verification","global_watchlist_charge","motor_vehicle_report","occupational_health_screening","sex_offender_search"],"example":"criminal_charge"}}}},"components/schemas/AssessmentResult":{"id":"components/schemas/AssessmentResult","kind":"json-schema","title":"AssessmentResult","data":{"type":"object","description":"The result of assessing one or more items on the report.\n","properties":{"value":{"$ref":"#/components/schemas/AssessmentValue"},"assessed_objects":{"type":"array","items":{"$ref":"#/components/schemas/AssessedObject"}},"rule":{"$ref":"#/components/schemas/Rule"}}}},"components/schemas/Assessment":{"id":"components/schemas/Assessment","kind":"json-schema","title":"Assessment","data":{"type":"object","description":"Information about an Assessment of the Report.\n","properties":{"value":{"$ref":"#/components/schemas/AssessmentValue"},"created_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time at which the Assessment was created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This timestame is accurate to the millisecond."},"children":[]}]}]}],"format":"date-time","example":"2014-01-18T12:34:015Z"},"ruleset":{"$ref":"#/components/schemas/Ruleset"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentResult"}}}}},"components/schemas/CandidateStoriesLimitError":{"id":"components/schemas/CandidateStoriesLimitError","kind":"json-schema","title":"CandidateStoriesLimitError","data":{"type":"object","properties":{"error":{"type":"string","example":"Candidate stories limit exceeded"}}}},"components/schemas/CandidateStoryDocumentsLimitError":{"id":"components/schemas/CandidateStoryDocumentsLimitError","kind":"json-schema","title":"CandidateStoryDocumentsLimitError","data":{"type":"object","properties":{"error":{"type":"string","example":"Candidate story documents limit exceeded"}}}},"components/schemas/Verification":{"id":"components/schemas/Verification","kind":"json-schema","title":"Verification","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["verification"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/verifications/db313e73383710d4fa2f18fd"},"created_at":{"type":"string","format":"date-time","example":"2014-01-18T12:34:00Z"},"completed_at":{"type":"string","format":"date-time","description":"Value will be null if the candidate has not uploaded the required documents, otherwise will contain the date and time that the documents were provided.","nullable":true,"example":null},"processed_at":{"type":"string","format":"date-time","description":"Value will be null if the candidate has not uploaded the required documents, otherwise will contain the date and time that the documents were processed.","nullable":true,"example":null},"verification_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of possible verification types can be found "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#verification-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"id"},"verification_url":{"type":"string","description":"URL to direct the candidate to upload documents.","example":"http://verifications.checkr.com/db313e73383710d4fa2f18fd"},"report_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value include the report_id"},"children":[]}]}]}],"example":"4722c07dd9a10c3985ae432a"}}}},"components/schemas/SexOffenderSearch":{"id":"components/schemas/SexOffenderSearch","kind":"json-schema","title":"SexOffenderSearch","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"object":{"example":"sex_offender_search"},"uri":{"example":"/v1/sex_offender_searches/539fd88c101897f7cd000008"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"complete"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"consider"}]},"turnaround_time":{"example":90},"records":{"type":"array","description":"Array of SexRecord objects.","items":{"type":"object","properties":{"registry":{"type":"string","description":"State in which the record was registered.","example":"California"},"full_name":{"type":"string","description":"Name listed on the record.","example":"John Alfred Smith"},"age":{"type":"integer","description":"Age listed on the record.","example":44},"dob":{"type":"string","format":"date","description":"Date of birth listed on the record.","example":"1975-02-01"},"registration_start":{"type":"string","format":"date","description":"Start date for the registration.","example":"2011-02-12"},"registration_end":{"type":"string","format":"date","description":"End date for the registration.","example":"2012-02-12"},"state":{"type":"string","description":"State listed for the record.","example":"CA"}}}}}}]}},"components/schemas/SocialMediaScreening":{"id":"components/schemas/SocialMediaScreening","kind":"json-schema","title":"SocialMediaScreening","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"object":{"enum":["social_media_screenings"]},"uri":{"example":"/v1/social_media_screenings/272bc1dc1ee7c355e76b8a3e"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"complete"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"consider"}]},"turnaround_time":{"example":86400},"document":{"type":"object","description":"PDF document containing the social media screening results. Returned once the screening status is complete.","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"type":{"type":"string","description":"The type of Document.","example":"social_media_screening_pdf"},"created_at":{"type":"string","description":"Time at which the Document was created.","format":"date-time","example":"2026-06-08T19:25:23Z"},"download_uri":{"type":"string","description":"JSON encoded URL of the document. This URL is valid for 15 minutes.","example":"https://checkr-documents.checkr.com/download_path"},"filesize":{"type":"integer","description":"File's size in bytes.","example":132327},"filename":{"type":"string","description":"File's name.","example":"social_media_data_search.pdf"},"content_type":{"type":"string","description":"File's content type.","example":"application/pdf"},"locale":{"type":"string","description":"Locale of the document.","example":"en"},"object":{"type":"string","enum":["document"],"readOnly":true}}},"flagged_behaviors":{"type":"array","description":"List of behavior categories flagged during the screening.","items":{"type":"string"},"example":["Disparaging","Drugs/Alcohol"]}}}]}},"components/schemas/SsnTrace":{"id":"components/schemas/SsnTrace","kind":"json-schema","title":"SsnTrace","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsWithNullResult"},{"type":"object","properties":{"object":{"enum":["ssn_trace"]},"uri":{"example":"/v1/ssn_traces/539fd88c101897f7cd000001"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatusNonReportable"},{"example":"complete"}]},"result":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outcome of the screening.  Screenings completed before April 2021 may return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"clear\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"consider\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"example":null},"turnaround_time":{"example":90},"ssn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s social security number. This value will be redacted in all return calls, except for the last four digits."},"children":[]}]}]}],"example":"XXX-XX-4645"},"no_data":{"type":"boolean","description":"No data was returned for the input Candidate PII.","default":false},"dob_mismatch":{"type":"boolean","description":"If true, the name on the SSN Trace matches the candidate's provided information, but the DOB does not.","default":false},"name_mismatch":{"type":"boolean","description":"If true, the DOB associated with the addresses returned from the SSN Trace matches the candidate's input DOB, but the name does not.","default":false},"data_mismatch":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, information returned from the SSN Trace does not match any of the candidate’s provided information."},"children":[]}]}]}],"default":false},"thin_file":{"type":"boolean","description":"No information found.","default":false},"invalid_issuance_year":{"type":"boolean","description":"If true, the input SSN has a year of issuance that precedes the candidate's reported year of birth.","default":false},"death_index":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, the input SSN is listed on the Social Security Administration's “Death Master File”."},"children":[]}]}]}],"default":false},"ssn_already_taken":{"type":"boolean","description":"If true, another Candidate with same SSN already exists in our system.","default":false},"issued_year":{"type":"integer","description":"The year the ID was issued.","example":1993},"issued_state":{"type":"string","description":"The US state where the ID was issued.","example":"CA"},"addresses":{"type":"array","description":"This field has been deprecated and will return an empty array."},"aliases":{"type":"array","description":"This field has been deprecated and will return an empty array."}}}]}},"components/schemas/StateCriminalSearch":{"id":"components/schemas/StateCriminalSearch","kind":"json-schema","title":"StateCriminalSearch","data":{"allOf":[{"$ref":"#/components/schemas/ScreeningsGenericPayload"},{"type":"object","properties":{"object":{"enum":["state_criminal_search"]},"uri":{"example":"/v1/state_criminal_searches/539fdcf335644a0ef4000001"},"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"complete"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"consider"}]},"created_at":{"type":"string","format":"date-time","example":"2014-01-18T12:34:00Z"},"completed_at":{"type":"string","format":"date-time","example":"2014-01-18T12:35:30Z"},"turnaround_time":{"example":100800},"estimated_completion_time":{"type":"string","format":"date-time","description":"Estimated time of completion for the Screening. This estimate will be based on the maximum turnaround time across all states searched.","example":"2014-01-18T12:34:00Z"},"state":{"type":"string","description":"State searched for these records.","example":"CA"},"records":{"type":"array","description":"Array of CriminalRecord objects.","items":{"allOf":[{"$ref":"#/components/schemas/Record"},{"type":"object","properties":{"file_date":{"example":"2010-02-18"},"arresting_agency":{"example":"San Francisco Police Department"},"court_jurisdiction":{"example":"San Francisco"},"charges":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Charge"},{"type":"object","properties":{"charge":{"example":"Sell Cocaine"},"defendant":{"example":"John Alfred Smith"},"arrest_date":{"example":"2011-04-22"},"sentence_date":{"example":"2011-06-02"}}}]}}}}]}},"filtered_by_positive_adjudication_records":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of CriminalRecord objects filtered out by your account’s Positive Adjudication Matrix or by your account’s Assess configuration."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/Record"}]}},"screening_pointers":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"screening_pointers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the screening."},"children":[]}]}]}],"items":{"allOf":[{"$ref":"#/components/schemas/ScreeningPointer"},{"type":"string","example":["Denver, CO County Search","Kentucky State Search","Widgets-R-Us Employment Address","Harvard University Education Address"]}]}}}}]}},"components/schemas/Subscription":{"id":"components/schemas/Subscription","kind":"json-schema","title":"Subscription","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["subscription"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"description":"URI of the Subscription.","example":"/v1/subscriptions/e44aa283528e6fde7d542194"},"status":{"type":"string","description":"Status of the Subscription.","enum":["active","inactive"],"example":"active"},"created_at":{"type":"string","description":"Time at which the Subscription was created.","format":"date-time","example":"2014-01-18T12:34:00Z"},"canceled_at":{"type":"string","description":"Time at which the Subscription was canceled.","format":"date-time","nullable":true,"example":null},"package":{"type":"string","description":"Package to run for the Subscription.","example":"driver_pro"},"interval_count":{"type":"integer","description":"The number of intervals between each recurrent background check.","example":1},"interval_unit":{"type":"string","description":"Interval at which the Subscription will repeat.","enum":["day","week","month","year"],"example":"month"},"start_date":{"type":"string","description":"Start date for the Subscription. This is the date on which the Subscription will begin, and the first time the report will be run.","format":"date","example":"2014-06-10"},"next_occurrence_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The next date on which the Subscription will be run. This date is determined based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval_unit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the last date the subscription was run."},"children":[]}]}]}],"format":"date","example":"2014-07-10"},"candidate_id":{"type":"string","description":"ID of the candidate screened.","example":"4722c07dd9a10c3985ae432a"},"node":{"type":"string","description":"Node to be used when generating a report for this Subscription.","example":"zpy8orej4r614ize"},"work_locations":{"type":"array","description":"Array of work locations to be used when generating a report for this Subscription.","items":{"$ref":"#/components/schemas/WorkLocation"}}}}},"components/schemas/SubscriptionCanceled":{"id":"components/schemas/SubscriptionCanceled","kind":"json-schema","title":"SubscriptionCanceled","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["subscription"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"description":"URI of the Subscription.","example":"/v1/subscriptions/4722c07dd9a10c3985ae432a"},"status":{"type":"string","description":"Status of the Subscription.","enum":["active","inactive"],"example":"active"},"created_at":{"type":"string","description":"Time at which the Subscription was created.","format":"date-time","example":"2014-01-18T12:34:00Z"},"canceled_at":{"type":"string","description":"Time at which the Subscription was canceled.","format":"date-time","nullable":true,"example":"2014-01-30T12:34:00Z"},"package":{"type":"string","description":"Package to run for the Subscription.","example":"driver_pro"},"interval_count":{"type":"integer","description":"The number of intervals between each recurrent background check.","example":1},"interval_unit":{"type":"string","description":"Interval at which the Subscription will repeat.","enum":["day","week","month","year"],"example":"month"},"start_date":{"type":"string","description":"Start date for the Subscription. This is the date on which the Subscription will begin, and the first time the report will be run.","format":"date","example":"2014-06-10"},"candidate_id":{"type":"string","description":"ID of the candidate screened.","example":"e44aa283528e6fde7d542194"}}}},"components/schemas/ContinuousCheck":{"id":"components/schemas/ContinuousCheck","kind":"json-schema","title":"ContinuousCheck","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["continuous_check"],"readOnly":true},"type":{"type":"string","description":"Type of Continuous Check.","enum":["criminal","mvr"],"example":"criminal"},"created_at":{"type":"string","description":"Time at which the Continuous Check was created.","format":"date-time","example":"2015-05-14T17:45:34Z"},"candidate_id":{"type":"string","description":"ID of the Candidate enrolled in Continuous Check.","example":"551564b7865af96a28b13f36"},"node":{"type":"string","description":"Custom ID of the Node associated with the Continuous Check.","example":"zpy8orej4r614ize"},"work_locations":{"type":"array","description":"Array of work locations associated with the Continuous Check.","items":{"$ref":"#/components/schemas/WorkLocation"}}}}},"components/schemas/BadContinuousCheckRequestError":{"id":"components/schemas/BadContinuousCheckRequestError","kind":"json-schema","title":"BadContinuousCheckRequestError","data":{"type":"object","properties":{"error":{"type":"string","example":"type does not have a valid value"}}}},"components/schemas/ContinuousCheckMissingSSNTraceError":{"id":"components/schemas/ContinuousCheckMissingSSNTraceError","kind":"json-schema","title":"ContinuousCheckMissingSSNTraceError","data":{"type":"object","properties":{"error":{"type":"string","example":"Candidate must have a completed SSN trace"}}}},"components/schemas/ContinuousCheckNotFoundError":{"id":"components/schemas/ContinuousCheckNotFoundError","kind":"json-schema","title":"ContinuousCheckNotFoundError","data":{"type":"object","properties":{"error":{"type":"string","example":"Continuous Check not found"}}}},"components/schemas/BadContinuousCheckUpdateRequestError":{"id":"components/schemas/BadContinuousCheckUpdateRequestError","kind":"json-schema","title":"BadContinuousCheckUpdateRequestError","data":{"type":"object","properties":{"error":{"type":"string","example":"Node cannot be found on your account"}}}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"email":{"type":"string","description":"User's email address.","format":"email","example":"john.smith@example.com"},"full_name":{"type":"string","description":"User's full name.","example":"John Smith"},"created_at":{"type":"string","description":"Time at which the User was created.","format":"date-time","example":"2014-01-18T12:34:00Z"},"roles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"admin"}}}}}}},"components/schemas/Webhook":{"id":"components/schemas/Webhook","kind":"json-schema","title":"Webhook","data":{"type":"object","required":["webhook_url"],"properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["webhook"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/webhooks/e44aa283528e6fde7d542194"},"account_id":{"type":"string","example":"8e122cc56b8fa82d33c6118a","readOnly":true,"description":"The account associated with the webhook."},"application_id":{"type":"string","example":null,"readOnly":true,"description":"The application associated with the webhook."},"include_object":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the webhook event payload will include the related object."},"children":[]}]}]}]},"webhook_url":{"type":"string","description":"The URL which receives the webhook event payload. This must be an HTTPS or an AWS SNS URL.","example":"https://example.com"},"created_at":{"type":"string","description":"Time at which the webhook was created.","format":"date-time","example":"1939-09-01T12:21:00Z","readOnly":true},"deleted_at":{"type":"string","description":"Time at which the webhook was deleted.","format":"date-time","nullable":true,"example":null,"readOnly":true}}}},"components/schemas/WebhookDelete":{"id":"components/schemas/WebhookDelete","kind":"json-schema","title":"WebhookDelete","data":{"type":"object","required":["webhook_url"],"properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["webhook"],"readOnly":true},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/webhooks/e44aa283528e6fde7d542194"},"account_id":{"type":"string","example":"8e122cc56b8fa82d33c6118a","readOnly":true,"description":"The account associated with the webhook."},"application_id":{"type":"string","example":null,"readOnly":true,"description":"The application associated with the webhook."},"include_object":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the webhook event payload will include the related object."},"children":[]}]}]}]},"webhook_url":{"type":"string","description":"The URL which receives the webhook event payload. This must be an HTTPS or an AWS SNS URL.","example":"https://example.com"},"created_at":{"type":"string","description":"Time at which the webhook was created.","format":"date-time","example":"1939-09-01T12:21:00Z","readOnly":true},"deleted_at":{"type":"string","description":"Time at which the webhook was deleted.","format":"date-time","nullable":true,"example":"1945-09-02T04:40:00Z","readOnly":true}}}},"components/schemas/FacisSanction":{"id":"components/schemas/FacisSanction","kind":"json-schema","title":"FacisSanction","data":{"type":"object","properties":{"saction":{"type":"string","description":"Text describing sanction","example":"Suspended and Ineligible"},"entry_date":{"type":"string","format":"date","example":"2019-07-11"},"acquisition_date":{"type":"string","format":"date","example":"2019-06-28"},"publication_date":{"type":"string","format":"date-time","example":"2019-01-18"},"case_number":{"type":"string","example":"19-0278"}}}},"components/schemas/FacisRecord":{"id":"components/schemas/FacisRecord","kind":"json-schema","title":"FacisRecord","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"dob":{"type":"string","example":"1970-01-22"},"authority":{"type":"string","example":"California Department of Health Care Services"},"database_registry":{"type":"string","example":"California Department of Health Care Services, Medi-Cal - Suspended and Ineligible Provider List"},"sactions":{"type":"array","description":"Array of FacisSanction objects","items":{"allOf":[{"$ref":"#/components/schemas/FacisSanction"}]}},"full_name":{"type":"string","example":"John Alfred Smith"}}}},"components/schemas/FacisSearch":{"id":"components/schemas/FacisSearch","kind":"json-schema","title":"FacisSearch","data":{"allOf":[{"type":"object","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ScreeningStatus"},{"example":"complete"}]},"result":{"allOf":[{"$ref":"#/components/schemas/ScreeningResult"},{"example":"clear"}]},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#cancellation-reasons"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancellation reasons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for possible values."},"children":[]}]}]}],"example":"complete_now_customer_requested"},"cancellation_reason_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#cancellation-reasons"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancellation reasons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for possible values."},"children":[]}]}]}],"example":"Customer requested Complete Now prior to screening completion"},"id":{"$ref":"#/components/schemas/ResourceId"},"created_at":{"type":"string","description":"Time at which the screening was created.","format":"date-time","example":"2014-01-18T12:34:00Z"},"completed_at":{"type":"string","description":"Time at which the screening was completed.","format":"date-time","example":"2014-01-18T12:35:30Z"},"turnaround_time":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of seconds the screening took to complete, calculated from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":345600},"object":{"type":"string","enum":["facis_search"]},"subtype":{"type":"string","description":"Level number representing the breadth of data sources searched","enum":["1","3"]},"records":{"type":"array","description":"Array of FacisRecord objects.","items":{"allOf":[{"$ref":"#/components/schemas/FacisRecord"}]}}}}]}},"components/schemas/ProgressiveUserReview":{"id":"components/schemas/ProgressiveUserReview","kind":"json-schema","title":"ProgressiveUserReview","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User review for this checkpoint. Always present."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenarios"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Waiting on a review action: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set. Apply a review action to continue or skip remaining"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"screenings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer applied a review action: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a custom label)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-progress or auto-skip: Checkr resolved the gate without pausing. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"checkpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is not the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skipped"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No user-review task on this checkpoint (for example a final, non-gating"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"checkpoint): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skipped"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["status","expired"],"properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How this checkpoint's user review was resolved, or whether it is still"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the report is paused, waiting on a review action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the gate resolved. A set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a customer applied"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a review action. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checkr auto-progressed or auto-skipped without pausing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skipped"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": this checkpoint has no user-review task."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"defined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_requested"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a user-review task exists"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but this checkpoint has not reached the gate yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the user-review task itself was canceled or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed."},"children":[]}]}]}],"enum":["defined","prepared","start_requested","in_progress","completed","skipped","canceled","failed"],"example":"in_progress"},"decision":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The review action the customer applied ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a custom"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"label). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while waiting, when Checkr auto-progressed or auto-skipped,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or when this checkpoint has no user-review task."},"children":[]}]}]}],"example":"continue"},"expired":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the user-review window closed and Checkr applied the default"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiration decision. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise, including auto-progress."},"children":[]}]}]}],"example":false},"paused_at":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this checkpoint's user review is the active in-progress gate, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"time the report was paused for review. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the report was not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paused for this checkpoint (auto-progress, auto-skip, or no user-review"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"task)."},"children":[]}]}]}],"example":"2026-08-12T14:00:00Z"}}}},"components/schemas/ProgressiveCheckpoint":{"id":"components/schemas/ProgressiveCheckpoint","kind":"json-schema","title":"ProgressiveCheckpoint","data":{"type":"object","required":["position","status","products","user_review"],"properties":{"position":{"type":"integer","minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1-based checkpoint ordinal in this response. The first checkpoint is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},"name":{"type":"string","description":"Optional checkpoint name from the execution strategy configuration.\nOmitted when no name is configured.\n","example":"identity_gate"},"status":{"type":"string","description":"Checkpoint execution status. Values are the same fulfillment-task\nstatuses used internally for progressive reports (not remapped).\n","enum":["defined","prepared","start_requested","in_progress","completed","skipped","canceled","failed"],"example":"completed"},"products":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The products this checkpoint runs, identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to see where each product sits in the progression."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Screening statuses and results are not included here; retrieve those from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Report and its screening resources."},"children":[]}]}]}],"items":{"type":"object","required":["product_key"],"properties":{"product_key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Canonical product key (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssn_trace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"ssn_trace"}}}},"user_review":{"$ref":"#/components/schemas/ProgressiveUserReview"}}}},"components/schemas/ProgressiveStatus":{"id":"components/schemas/ProgressiveStatus","kind":"json-schema","title":"ProgressiveStatus","data":{"type":"object","required":["report","progressive_continuation_status","checkpoints"],"properties":{"report":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nested Report identity and public status. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uri"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" match"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getReport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an existing Report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including account-level"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspended"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" translation when that setting is enabled."},"children":[]}]}]}],"required":["id","uri","status"],"properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"uri":{"allOf":[{"$ref":"#/components/schemas/ResourceURI"}],"example":"/v1/reports/abc123"},"status":{"type":"string","description":"Public Report status.\n","enum":["pending","complete","suspended","paused","dispute","canceled"],"example":"paused"}}},"progressive_continuation_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether this report can still be advanced."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eligible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a review action can be applied now, or screenings skipped"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"earlier can still be run. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the deadline in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"passed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ineligible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the report cannot be advanced, for example because"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it is disputed, in adverse action, or canceled."},"children":[]}]}]}],"enum":["eligible","ineligible","expired"],"example":"eligible"},"expires_at":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deadline for advancing this report. Until this time you may apply a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"review action to run the report's remaining screenings. After it passes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"those screenings can no longer be run and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"progressive_continuation_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the report completes for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the first time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is not cleared once the deadline passes, so a timestamp in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"past tells you when the window closed."},"children":[]}]}]}],"example":"2026-09-11T15:54:00Z"},"checkpoints":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ordered progressive checkpoints for this report. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 1-based"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(the first checkpoint is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ProgressiveCheckpoint"}}},"example":{"report":{"id":"abc123","uri":"/v1/reports/abc123","status":"paused"},"progressive_continuation_status":"eligible","expires_at":"2026-09-11T15:54:00Z","checkpoints":[{"position":1,"name":"identity_gate","status":"completed","products":[{"product_key":"ssn_trace"},{"product_key":"identity_verification"}],"user_review":{"status":"completed","decision":"continue","expired":false,"paused_at":null}},{"position":2,"status":"in_progress","products":[{"product_key":"county_criminal_search"}],"user_review":{"status":"in_progress","decision":null,"expired":false,"paused_at":"2026-08-12T14:00:00Z"}}]}}},"schema_89":{"kind":"json-schema","data":{"type":"object","required":["email"],"properties":{"object":{"type":"string","enum":["candidate"],"readOnly":true},"first_name":{"type":"string","pattern":"^(?=.*[a-zA-ZªµºÀ-ÖØ-öø-ÿ])[a-zA-Z0-9ªµºÀ-ÖØ-öø-ÿ\\-'., ]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s first name."},"children":[]}]}]}],"example":"John"},"middle_name":{"type":"string","pattern":"[a-zA-Z0-9ªµºÀ-ÖØ-öø-ÿ\\-'., ]*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s middle name. This field is required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_middle_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Alfred"},"no_middle_name":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"middle_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the candidate has no middle name."},"children":[]}]}]}],"default":false},"last_name":{"type":"string","pattern":"[a-zA-Z0-9ªµºÀ-ÖØ-öø-ÿ\\-'., ]{2,}","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s last name."},"children":[]}]}]}],"example":"Smith"},"mother_maiden_name":{"type":"string","pattern":"[a-zA-Z0-9ªµºÀ-ÖØ-öø-ÿ\\-'., ]*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s mother’s maiden name."},"children":[]}]}]}],"example":"Jones"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s email address."},"children":[]}]}]}],"format":"email","example":"john.smith@gmail.com"},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s phone number."},"children":[]}]}]}],"example":5555555555,"nullable":true},"zipcode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s 5-digit zip code."},"children":[]}]}]}],"example":90401},"dob":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s date of birth."},"children":[]}]}]}],"format":"date","example":"1970-01-22"},"ssn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s Social Security Number. This value will be redacted in all return calls, except for the last four digits."},"children":[]}]}]}],"example":"XXX-XX-4645"},"driver_license_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s driver license number."},"children":[]}]}]}],"example":"F2111655"},"driver_license_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s driver license state of issue."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-2:US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"CA"},"previous_driver_license_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s previous driver license number."},"children":[]}]}]}],"example":"F1501739"},"previous_driver_license_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State that issued the candidate’s previous driver license."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-2:US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"MD"},"copy_requested":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the candidate has asked to receive a copy of their report."},"children":[]}]}]}],"default":false},"postal_address":{"type":"object","description":"The candidate postal address is the address Checkr will use to send postal mail to the candidate. Each candidate can be associated with only one postal address.","example":{"name":"John Alfred Smith","street":"123 Main Street","street2":"APT A","city":"San Francisco","state":"CA","zipcode":"94108"}},"custom_id":{"type":"string","description":"Client-assigned unique ID for the Candidate. Can be used to map Checkr Candidate IDs to your internal tracking system, and to search for Candidates through both the Dashboard and the API.","example":"HRIS-27"},"report_ids":{"type":"array","description":"Array of Report IDs.","readOnly":true,"items":{"type":"string","example":"532e71cfe88a1d4e8d00000d"}},"geo_ids":{"type":"array","description":"Array of Geo IDs.","items":{"type":"string","example":"79f943e212cce7de21c054a8"}},"metadata":{"$ref":"#/components/schemas/Metadata"},"work_locations":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"red"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for non-US candidates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of locations described using country, state, and city. When country is not specified defaults to US. State is required for US candidates. Country is required for non-US candidates."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/WorkLocation"}}}},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"type":"string"},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"type":"object"},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"type":"number","nullable":true},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"type":"object","properties":{"object":{"type":"string","description":"A list","enum":["list"]},"next_href":{"type":"string","format":"uri"},"previous_href":{"type":"string","format":"uri"},"count":{"type":"integer","example":2},"data":{"type":"array","items":{"$ref":"#/components/schemas/Candidate"}}}},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"type":"string","enum":["reports","geos"]},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"type":"object","required":["deletion_contact_email_address"],"properties":{"deletion_contact_email_address":{"type":"string","description":"Email address of person requesting candidate's PII removal.","example":"john.smith@gmail.com"},"deletion_contact_first_name":{"type":"string","description":"First name of person requesting candidate's PII removal.","example":"John"},"deletion_contact_last_name":{"type":"string","description":"Last name of person requesting candidate's PII removal.","example":"Smith"}}},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"allOf":[{"type":"object","properties":{"candidate_id":{"type":"string","description":"ID of the Candidate screened.","example":"e44aa283528e6fde7d542194"},"package":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slug"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the associated package."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"driver_pro"},"children":[]}]}]}]},"node":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"red"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for hierarchy-enabled accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the associated node."},"children":[]}]}]}]},"self_disclosures":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of SelfDisclosures"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Self Disclosures may not be added, updated, or deleted after a Report has been created. The information provided in a Self Disclosure will not be included in the completed Report, and may be retrieved using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/reports/getreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/reports/{id}?include=documents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/documents"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removing the requirement for the description, date, and location parameters greatly reduces the value of Self Disclosures. If your system mandates that these parameters be optional, work with your Checkr Customer Success Manager to disable the requirement."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/SelfDisclosure"}},"work_locations":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"red"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for hierarchy-enabled accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of locations described using country, state, and city. When country is not specified defaults to US. State is required for US candidates. Country is required for non-US candidates."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/WorkLocation"}},"tags":{"type":"array","description":"Array of tags for the Report.","items":{"type":"string"}},"consent_document_ids":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDs of consent documents previously created with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/documents/uploaddocument"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload a Candidate Document"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each id must reference a document with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that belongs to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"candidate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on this request and is a PDF."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A missing, empty, or invalid value returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". One invalid id rejects the request, and no report is created."},"children":[]}]}]}],"items":{"type":"string"},"example":["b73f89e14b393979857806f9"]}}},{"required":["package","candidate_id","consent_document_ids"]}]},"id":"schema_97"},"schema_98":{"kind":"json-schema","data":{"type":"object","properties":{"package":{"type":"string","description":"Slug of the Package.\n","example":"driver_pro"},"adjudication":{"type":"string","enum":["engaged"],"example":"engaged"}}},"id":"schema_98"},"schema_99":{"kind":"json-schema","data":{"type":"string","enum":["arrest_search","candidate","candidate_stories","county_civil_searches","county_criminal_searches","credit_report","dispute_comments","documents","drug_alcohol_clearinghouse","drug_screening","education_verification","employment_verification","eviction_search","facis_search","federal_civil_search","federal_criminal_search","geos","global_watchlist_search","identity_data_evaluation","identity_verification","international_adverse_media_searches","international_criminal_searches","international_criminal_searches_v2","international_education_verification","international_employment_verification","international_global_watchlist_search","international_identity_document_validation","motor_vehicle_report","municipal_criminal_searches","national_criminal_search","occupational_health_screening","personal_reference_verifications","photo_verification","pointer_state_criminal_searches","professional_reference_verifications","professional_license_verifications","program","public_comments","self_disclosures","sex_offender_search","social_media_screenings","ssn_trace","state_criminal_searches","terrorist_watchlist_search"]},"id":"schema_99"},"schema_100":{"kind":"json-schema","data":{"type":"object","required":["decision"],"properties":{"decision":{"type":"string","enum":["skip_remaining","continue"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The review action decision to apply. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to proceed with the remaining screenings, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip_remaining"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to skip them and complete the report."},"children":[]}]}]}]}}},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"User review decision applied"}}},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"type":"object","required":["package","candidate_id"],"properties":{"package":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slug"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the associated package."},"children":[]}]}]}],"example":"driver_pro"},"candidate_id":{"type":"string","description":"ID of the Candidate for whom the Invitation is created.","example":"551564b7865af96a28b13f36"},"node":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"red"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for hierarchy-enabled accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the associated node."},"children":[]}]}]}]},"work_locations":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"red"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for hierarchy-enabled accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of locations described using country, state, and city. When country is not specified defaults to US. State is required for US candidates. Country is required for non-US candidates."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/WorkLocation"}},"tags":{"type":"array","description":"Array of tags for the Report.","items":{"type":"string"}}}},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"type":"string","enum":["pending","completed","expired"]},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"object","properties":{"object":{"type":"string","description":"A list","enum":["list"]},"next_href":{"type":"string","format":"uri"},"previous_href":{"type":"string","format":"uri"},"count":{"type":"integer","example":2},"data":{"type":"array","items":{"$ref":"#/components/schemas/Invitation"}}}},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{"properties":{"object":{"type":"string","description":"A list","enum":["list"]},"next_href":{"type":"string","format":"uri"},"previous_href":{"type":"string","format":"uri"},"count":{"type":"integer","example":2},"data":{"type":"array","items":{"$ref":"#/components/schemas/Package"}}}},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["alien_id","citizenship_certificate","consent","credit_report_consent_form","degree","diploma","driver_abstract","driver_license","driver_license_back","driver_license_history","education_certificate","education_proof","electronic_consent_form","employment_proof","government_id","international_consent_form","military_id","national_id","national_id_back","passport","passport_signature_page","paystub","previous_driver_license","professional_license_certification_image","selfie","ssn_card","state_id_card","state_id_card_back","student_id","tax_form1099","tax_form_schedule_c","tax_form_w2","taxpayer_id","transcript"]}},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"object":{"type":"string","description":"A list","enum":["list"]},"count":{"type":"integer","example":1}}},"id":"schema_108"},"schema_109":{"kind":"json-schema","data":{"type":"object","required":["file","type"],"properties":{"type":{"type":"string","enum":["alien_id","citizenship_certificate","consent","credit_report_consent_form","degree","diploma","driver_abstract","driver_license","driver_license_back","driver_license_history","education_certificate","education_proof","electronic_consent_form","employment_proof","government_id","international_consent_form","military_id","national_id","national_id_back","passport","passport_signature_page","paystub","previous_driver_license","professional_license_certification_image","selfie","ssn_card","state_id_card","state_id_card_back","student_id","tax_form1099","tax_form_schedule_c","tax_form_w2","taxpayer_id","transcript"]},"file":{"type":"string","format":"binary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path to the document on your local file system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid MIME types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/gif"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/bmp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/tiff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/heic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_109"},"schema_110":{"kind":"json-schema","data":{"type":"object","required":["number","state","current"],"properties":{"number":{"type":"string","description":"The driver license number.","example":"F2222222"},"state":{"type":"string","description":"The state that issued the driver license.","example":"CA"},"issued_date":{"type":"string","format":"date","description":"The issued date of the driver license.","example":"2010-01-30"},"current":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines whether the driver license is the candidate's current license. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the license is the candidate's current license, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"children":[]}]}]}]}}},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DriverLicense"}},"object":{"type":"string","description":"A list","enum":["list"]},"count":{"type":"integer","example":1}}},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"type":"object","properties":{"number":{"type":"string","description":"The updated number of the driver license.","example":"F1111111"},"state":{"type":"string","description":"The updated state that issued the driver license.","example":"CA"},"issued_date":{"type":"string","format":"date","description":"The updated issued date of the driver license.","example":"2010-01-30"},"current":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The updated current status of the driver license. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the license is the candidate's current license, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"children":[]}]}]}]}}},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"type":"object","required":["name","position","contract_type","start_date","address"],"properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["employer"],"readOnly":true},"candidate_id":{"type":"string","description":"ID of the Candidate being screened.","pattern":"[a-zA-Z0-9 -'.,]*","example":"xxx","minLength":1},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of employment history to be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If type is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gap"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required, and only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be recorded."},"children":[]}]}]}],"enum":["employer","gap"],"default":"employer"},"name":{"type":"string","pattern":"[a-zA-Z0-9 -'.,]*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s employer’s name."},"children":[]}]}]}],"example":"Checkr","minLength":1},"position":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s position or title."},"children":[]}]}]}],"example":"Software Engineer"},"salary":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s gross salary in dollars annually."},"children":[]}]}]}],"example":10000},"contract_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s contract type."},"children":[]}]}]}],"enum":["full_time","part_time","contract","internship"],"example":"full_time"},"do_not_contact":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the employer will not be contacted about the Candidate."},"children":[]}]}]}],"example":false},"start_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s start date with the employer."},"children":[]}]}]}],"format":"date","example":"2016-06-01"},"end_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s end date with the employer."},"children":[]}]}]}],"format":"date","example":"2017-05-01"},"employer_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Employer’s website."},"children":[]}]}]}],"example":"www.employer.com"},"address":{"$ref":"#/components/schemas/Address"},"manager":{"type":"object","properties":{"name":{"type":"string","description":"Candidate's manager's name.","example":"Joe Smith"},"title":{"type":"string","description":"Candidate's manager's title.","example":"Engineering Manager"},"email":{"type":"string","description":"Candidate's manager's email address.","example":"joesmith@checkr.co"},"phone":{"type":"string","description":"Candidate's manager's phone number.","example":"212-555-1234"}}},"note":{"type":"string","description":"A text note used to add context for an employment gap.","example":"Took time off to travel abroad.","maxLength":65535}}},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Employer"}},"object":{"type":"string","description":"A list","enum":["list"]},"count":{"type":"integer","example":2}}},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"type":"object","required":["name","degree","major","address"],"properties":{"id":{"$ref":"#/components/schemas/ResourceId"},"object":{"type":"string","enum":["school"],"readOnly":true},"candidate_id":{"type":"string","pattern":"[a-zA-Z0-9 -'.,]*","description":"Candidate linked to this School resource.","example":"83ebeagdec0948690863766f792ead24d61fe3f9","minLength":1},"name":{"type":"string","pattern":"[a-zA-Z0-9 -'.,]*","description":"Name of the School.","example":"College University","minLength":1},"degree":{"type":"string","description":"Degree awarded to the Candidate.","example":"BA"},"year_awarded":{"type":"integer","description":"Year in which the degree was awarded.","example":2017,"minLength":1},"major":{"type":"string","pattern":"[a-zA-Z0-9 -'.,]*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s major."},"children":[]}]}]}],"example":"Russian Literature"},"phone":{"type":"string","description":"School's phone number.","example":"415-111-1111","nullable":true},"minor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s minor."},"children":[]}]}]}],"example":"Background Checks"},"start_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s start date with the School."},"children":[]}]}]}],"format":"date","example":"2012-09-22"},"end_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Candidate’s end date with the School."},"children":[]}]}]}],"format":"date","example":"2017-05-10"},"current":{"type":"boolean","description":"Defines whether the Candidate is currently enrolled.","default":false},"school_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"School’s website."},"children":[]}]}]}],"example":"www.collegeuniversity.com"},"address":{"$ref":"#/components/schemas/Address"}}},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/School"}},"object":{"type":"string","description":"A list","enum":["list"]},"next_href":{"type":"string","format":"uri"}}},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ProfessionalLicense"},{"type":"object","required":["issuer_name","issuer_region","license_type","certification_document_id"],"properties":{"certification_document_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of document previously created with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/#operation/uploadDocument"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uploadDocument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. Document must be of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"professional_license_certification_image"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and should contain an image proof of professional license to be verified."},"children":[]}]}]}]}}}]},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"properties":{"object":{"type":"string","enum":["list"]},"count":{"type":"integer","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProfessionalLicense"}}}},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ProfessionalLicense"},{"properties":{"deleted_at":{"type":"string","format":"datetime","description":"Timestamp of record deletion","example":"2023-10-10T01:16:27Z"}}}]},"id":"schema_119"},"schema_120":{"kind":"json-schema","data":{"type":"object","required":["name","street","city","state","zipcode"],"properties":{"object":{"type":"string","enum":["postal_address"],"readOnly":true},"name":{"type":"string","description":"Name of the Candidate.\n","example":"John Smith"},"street":{"type":"string","description":"Street address of the Candidate.\n","example":"123 Main St"},"street2":{"type":"string","description":"Additional street address of the Candidate.\n","example":"Apt A","nullable":true},"city":{"type":"string","description":"City of the Candidate.\n","example":"Santa Monica"},"state":{"type":"string","description":"State of the Candidate.\n","example":"CA"},"zipcode":{"type":"string","description":"5-digit zip code of the Candidate.\n","example":"90401"}}},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"<field> is missing."}}},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"type":"object","required":["client_id","name","purpose","user","company"],"properties":{"client_id":{"type":"string","description":"Client credentials provided as part of your Partner Application.","example":"56269e3411a549fd07ed8d92"},"oauth_authorize":{"type":"boolean","description":"Allows skipping of the /oauth/authorize call","default":false},"name":{"type":"string","description":"Name of Account displayed in the Dashboard.","example":"Acme Corporation"},"default_compliance_city":{"type":"string","description":"Fallback compliance city if candidate location is not provided.\n","example":"San Francisco","nullable":true},"default_compliance_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fallback compliance state if candidate location is not provided. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-2:US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"CA","nullable":true},"purpose":{"type":"string","description":"Permissible purpose to run background checks. Determines which background checks the Account is credentialed for.\n","enum":["employment","business","insurance","tenant"],"example":"employment"},"user":{"type":"object","properties":{"full_name":{"type":"string","description":"Full name of the initial Admin user for the Account.","example":"Jeanette Hughes"},"email":{"type":"string","description":"Email of the initial Admin user for the Account.","example":"user@example.com"}}},"company":{"type":"object","properties":{"city":{"type":"string","description":"City where company is headquartered.","example":"San Francisco"},"dba_name":{"type":"string","nullable":true,"description":"Name of Company displayed in Checkr emails and branded web pages.","example":"Acme"},"industry":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Industry that company operates in. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAICS 2017 Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"72"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State where company is headquartered. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-2:US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"CA"},"street":{"type":"string","description":"Street address where company is headquartered.","example":"123 Main Street"},"tax_id":{"type":"string","description":"Company Tax ID number.","example":"123456789"},"zipcode":{"type":"string","description":"Zipcode where company is headquartered.","example":"94107"},"incorporation_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State where company is incorporated. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ISO 3166-2:US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"CA","nullable":true},"incorporation_type":{"type":"string","description":"Type of incorporation.","enum":["association","co-ownership","corporation","joint-venture","limited-partnership","llc","llp","non-profit","partnership","s-corporation","sp","trusteeship"]},"phone":{"type":"string","description":"Company phone number.","example":"206-555-0100","nullable":true},"website":{"type":"string","description":"Company website.","example":"https://www.example.com","nullable":true}}}}},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"properties":{"object":{"type":"string","description":"A list","enum":["list"]},"next_href":{"type":"string","format":"uri"},"previous_href":{"type":"string","format":"uri"},"count":{"type":"integer","example":2},"data":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"object","properties":{"object":{"type":"string","description":"A list","enum":["list"]},"next_href":{"type":"string","format":"uri"},"previous_href":{"type":"string","format":"uri"},"count":{"type":"integer","example":2},"data":{"type":"array","items":{"$ref":"#/components/schemas/Program"}}}},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"type":"object","required":["nodes"],"properties":{"nodes":{"type":"array","items":{"$ref":"#/components/schemas/HierarchyNode"}}}},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"type":"object","properties":{"sync_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uri_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Account, plus a randomly generated hexadecimal ID, linked with a hyphen."},"children":[]}]}]}],"example":"account-da78fa2cd1e6ebee4b5975aa"},"time":{"type":"string","format":"date-time","description":"The date and time at which the ingestion job began.","example":"2020-02-11T00:27:14Z"}}},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"type":"object","properties":{"sync_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uri_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Account, plus a randomly generated hexadecimal ID, linked with a hyphen."},"children":[]}]}]}],"example":"account-da78fa2cd1e6ebee4b5975aa"},"time":{"type":"string","format":"date-time","description":"The date and time at which the ingestion job began.","example":"2020-01-01T08:00:00Z"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/HierarchyTree"}}}},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"type":"string","example":null},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"object","properties":{"hierarchy_present":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a valid hierarchy exists for the account."},"children":[]}]}]}],"example":true},"hierarchy_pending":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a hierarchy ingestion request is currently processing."},"children":[]}]}]}],"example":false},"latest_ingestion":{"type":"object","properties":{"sync_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the last fully-processed ingestion request. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no requests have processed."},"children":[]}]}]}],"example":"account-da78fa2cd1e6ebee4b5975aa"},"time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of the start of the last fully-processed ingestion request. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no requests have processed."},"children":[]}]}]}],"example":"2020-01-01T08:00:00Z"},"successful":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the last hierarchy ingestion request contained no errors."},"children":[]}]}]}],"example":false},"errors":{"type":"array","items":{"type":"string"},"description":"All error messages produced by the last hierarchy ingestion request.","example":["Row 1: Validation failed: Name required"]}}}}},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"type":"object","required":["name","state"],"properties":{"name":{"type":"string","description":"Human-readable name of the Geo.","example":"San Francisco"},"state":{"type":"string","description":"US state for the Geo.","example":"CA"},"city":{"type":"string","description":"A major city within the input state.","example":"San Francisco"}}},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"type":"object","properties":{"object":{"type":"string","description":"A list","enum":["list"]},"next_href":{"type":"string","format":"uri"},"previous_href":{"type":"string","format":"uri"},"count":{"type":"integer","example":2},"data":{"type":"array","items":{"$ref":"#/components/schemas/Geo"}}}},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"type":"object","properties":{"city":{"type":"string","description":"Updates the Geo with the input city.","example":"San Francisco","nullable":true}}},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"type":"string","enum":["packages"]},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{"type":"string","nullable":true,"enum":["custom_id","created_at"]},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"type":"string","nullable":true,"enum":["asc","desc"]},"id":"schema_136"},"schema_137":{"kind":"json-schema","data":{"properties":{"object":{"type":"string","description":"A list","enum":["list"]},"next_href":{"type":"string","format":"uri"},"previous_href":{"type":"string","format":"uri"},"count":{"type":"integer","example":2},"data":{"type":"array","items":{"$ref":"#/components/schemas/Node"}}}},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"x-additionalPropertiesName":"state_abbreviation","type":"object","description":"An array of counties","properties":{"counties":{"type":"array","items":{"$ref":"#/components/schemas/County"}}}},"example":{"HI":{"counties":[{"name":"HAWAII","fips_code":"15001"},{"name":"HONOLULU","fips_code":"15003"},{"name":"KALAWAO","fips_code":"15005"},{"name":"KAUAI","fips_code":"15007"},{"name":"MAUI","fips_code":"15009"}]}}},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"object","required":["webhook_url"],"properties":{"include_object":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the webhook event payload will include the related object."},"children":[]}]}]}]},"webhook_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL which receives the webhook event payload. This must be an HTTPS or an AWS SNS URL. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/webhooks#supported-webhook-url-formats"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Webhook URLs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}],"example":"https://example.com"},"live":{"type":"boolean","description":"When 'true', the webhook is for the live environment.","example":true}}},"id":"schema_139"},"schema_140":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" • webhook_url is missing. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" • Url has already been taken. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" • Allowed webhook API limit exceeded. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" • Url is not valid. Please use a publicly available host and the HTTPS or SNS protocol. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}}},"id":"schema_140"},"schema_141":{"kind":"json-schema","data":{"type":"object","properties":{"object":{"type":"string","description":"A list","enum":["list"]},"next_href":{"type":"string","format":"uri"},"previous_href":{"type":"string","format":"uri"},"count":{"type":"integer","example":2},"data":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}}}},"id":"schema_141"},"schema_142":{"kind":"json-schema","data":{"type":"object","required":["tag"],"properties":{"tag":{"type":"string","example":"To Review"}}},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"number","format":"integer","example":3},"object":{"type":"string","example":"list","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}},"example":[{"name":"EIN-234234234"},{"name":"api-generated"},{"name":"In Progress"}]}}},"id":"schema_143"},"schema_144":{"kind":"json-schema","data":{"type":"object","required":["tags"],"properties":{"tags":{"type":"array","items":{"type":"string","example":"To Review"}}}},"id":"schema_144"},"schema_145":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"number","format":"integer","example":2},"object":{"type":"string","example":"list","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}},"example":[{"name":"West Coast"},{"name":"To Review"}]}}},"id":"schema_145"},"schema_146":{"kind":"json-schema","data":{"type":"object","required":["tag"],"properties":{"tag":{"type":"string","example":"West Coast"}}},"id":"schema_146"},"schema_147":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"number","format":"integer","example":1},"object":{"type":"string","example":"list","enum":["list"]},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}},"example":[{"name":"To Review"}]}}},"id":"schema_147"},"schema_148":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ReportAddresses"}},"object":{"type":"string","description":"A list","enum":["list"]},"count":{"type":"integer","example":1}}},"id":"schema_148"},"schema_149":{"kind":"json-schema","data":{"type":"string","nullable":true},"id":"schema_149"},"schema_150":{"kind":"json-schema","data":{"type":"object","properties":{"object":{"type":"string","description":"A list","enum":["list"]},"next_href":{"type":"string","format":"uri","nullable":true},"previous_href":{"type":"string","format":"uri","nullable":true},"count":{"type":"integer","example":1},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdverseAction"}}}},"id":"schema_150"},"schema_151":{"kind":"json-schema","data":{"type":"object","required":["adverse_item_ids"],"properties":{"post_notice_scheduled_at":{"type":"string","format":"date-time","description":"Time at which the Post-Adverse Action notification will be sent. Default is 7 days after creation.","example":"2016-10-07T12:34:00Z"},"adverse_item_ids":{"type":"array","items":{"type":"string"},"description":"IDs of Adverse Items selected for the Adverse Action."},"context":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A customizable, semi-unique scoping identifier. Adverse Actions with a context have some special behaviors that do not affect the report adjudication and are not affected by most report adjudication actions. Multiple Adverse Actions can exist for a report as long as the context is unique for the report. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"context-1"},"medium":{"type":"object","description":"The medium through which the Adverse Action notification should be sent.\n","properties":{"email":{"type":"object","description":"The email medium is used to send an adverse action via email to the candidate.\n","properties":{"priority":{"type":"number","description":"The priority setting dictates whether the adverse action should be sent through this medium. A priority of 1 means the adverse action will be sent, while a priority of 0 means it will not be sent through this medium.","example":1},"required":{"type":"boolean","description":"The \"required\" setting specifies whether an adverse action must be sent. If set to true, it means the adverse action must be sent through this medium. If set to false, sending the adverse action through this medium is optional.","example":true}}},"postal":{"type":"object","description":"The postal medium is used to send an adverse action via physical mail to the candidate.\n","properties":{"priority":{"type":"number","description":"The priority setting dictates whether the adverse action should be sent through this medium. A priority of 1 means the adverse action will be sent, while a priority of 0 means it will not be sent through this medium.","example":0},"required":{"type":"boolean","description":"The \"required\" setting specifies whether an adverse action must be sent. If set to true, it means the adverse action must be sent through this medium. If set to false, sending the adverse action through this medium is optional.","example":false}}}}}}},"id":"schema_151"},"schema_152":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AdverseItem"}},"object":{"type":"string","description":"A list","enum":["list"]},"count":{"type":"integer","example":1}}},"id":"schema_152"},"schema_153":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Assessment"}},"object":{"type":"string","enum":["list"]},"count":{"type":"integer","description":"The total number of assessments for the specified Report.\n","example":1}}},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"type":"object","required":["content","documents"],"properties":{"content":{"type":"string","description":"Additional information provided by Candidate.","example":"Since my case, I have received the following certifications (see attachments)"},"record_id":{"type":"string","description":"ID of the Record existing on a Screening to which the Candidate Story is linked.\nWhen no record ID is provided, the Candidate Story is considered General Information.\n","example":"af3393b7d751206c7c67b6e5"},"documents":{"type":"array","description":"An array of documents to attach to the Candidate Story. Can be empty.","items":{"type":"object","properties":{"filename":{"type":"string","description":"File name","example":"evidence_of_rehab.pdf"},"tempfile":{"type":"string","description":"Accessible resource from which the document will be copied.","example":"https://tempfilebucket.aws.example.com/abYwtudnakfnafl"},"type":{"type":"string","description":"Document MIME type","enum":["application/pdf","image/bmp","image/gif","image/heic","image/jpeg","image/jpg","image/png","image/tiff"],"example":"application/pdf"}}}}}},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/CandidateStoriesLimitError"},{"$ref":"#/components/schemas/CandidateStoryDocumentsLimitError"}]},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"type":"object","required":["package","candidate_id","start_date"],"properties":{"package":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slug"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the associated package."},"children":[]}]}]}]},"candidate_id":{"type":"string","description":"ID of the candidate being screened."},"start_date":{"type":"string","format":"date","description":"Start date for the subscription. This is the date on which the subscription will begin, and the first time the report will be run."},"interval_count":{"type":"integer","description":"The number of intervals between each recurrent background check."},"interval_unit":{"type":"string","description":"Interval at which the subscription will repeat.","enum":["day","week","month","year"]},"node":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"red"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for hierarchy-enabled accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the associated node."},"children":[]}]}]}]},"work_locations":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"red"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for hierarchy-enabled accounts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of locations described using country, state, and city. When country is not specified defaults to US. State is required for US candidates. Country is required for non-US candidates."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/WorkLocation"}}}},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"type":"string","enum":["active","inactive"]},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"type":"object","properties":{"object":{"type":"string","description":"A list","enum":["list"]},"next_href":{"type":"string","format":"uri"},"previous_href":{"type":"string","format":"uri"},"count":{"type":"integer","example":2},"data":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}}}},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"status does not have a valid value"}}},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"type":"object","properties":{"package":{"type":"string","description":"Package to run for the Report."},"candidate_id":{"type":"string","description":"ID of the candidate being screened."},"start_date":{"type":"string","format":"date","description":"Start date for the subscription. This is the date on which the subscription will begin, and the first time the report will be run."},"interval_count":{"type":"integer","description":"The number of intervals between each recurrent background check."},"interval_unit":{"type":"string","description":"Interval at which the subscription will repeat.","enum":["day","week","month","year"]},"node":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the associated node."},"children":[]}]}]}]},"work_locations":{"type":"array","description":"Array of locations described using country, state, and city. When country is not specified defaults to US. State is required for US candidates. Country is required for non-US candidates.\n","items":{"$ref":"#/components/schemas/WorkLocation"}}}},"id":"schema_160"},"schema_161":{"kind":"json-schema","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Defines the screening type(s) for this Continuous Check.","example":"criminal","enum":["criminal","mvr"]},"node":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"red"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for hierarchy-enabled accounts with Nodes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the associated node."},"children":[]}]}]}]},"work_locations":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"font","attrs":{"color":"red"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for hierarchy-enabled accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of locations described using country, state, and city. When country is not specified defaults to US. State is required for US candidates. Country is required for non-US candidates."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/WorkLocation"}},"mvr_enrollment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mvr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the Continuous MVR enrollment type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commercial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for commercial driver's license (CDL) holders. When omitted, Checkr derives the enrollment type from the candidate's most recent completed MVR, or defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["commercial","standard"],"example":"commercial"}}},"id":"schema_161"},"schema_162":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContinuousCheck"}},"object":{"type":"string","description":"A list","enum":["list"]},"count":{"type":"integer","example":1}}},"id":"schema_162"},"schema_163":{"kind":"json-schema","data":{"type":"object","required":["type"],"properties":{"node":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the associated node."},"children":[]}]}]}]},"work_locations":{"type":"array","description":"Array of locations described using country, state, and city. When country is not specified defaults to US. State is required for US candidates. Country is required for non-US candidates.\n","items":{"$ref":"#/components/schemas/WorkLocation"}}}},"id":"schema_163"},"schema_164":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_164"},"schema_165":{"kind":"json-schema","data":{"type":"integer","default":20,"maximum":100},"id":"schema_165"},"schema_166":{"kind":"json-schema","data":{"properties":{"object":{"type":"string","description":"A list","enum":["list"]},"count":{"type":"integer","description":"Total number of records across all pages.","example":2},"next_href":{"type":"string","format":"uri","description":"URL of the next page of results, or null on the last page.","nullable":true,"example":"/v2/i9/forms_i9?page=2"},"previous_href":{"type":"string","format":"uri","description":"URL of the previous page of results, or null on the first page.","nullable":true,"example":null},"data":{"type":"array","description":"Array of objects (Form I-9)","items":{"$ref":"#/components/schemas/FormI9V2"}}}},"id":"schema_166"},"schema_167":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Unauthorized"}}},"id":"schema_167"},"schema_168":{"kind":"json-schema","data":{"type":"object","required":["candidate_id","start_date","worksite_id","workflow_type"],"properties":{"candidate_id":{"type":"string","description":"Candidate resource Id.\n","example":"3de7e278beb24d14a3785e2dd02cca49"},"start_date":{"type":"string","format":"date","description":"Candidate start date.","example":"2026-04-29"},"worksite_id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Worksite resource Id. Retrieve valid Ids from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/openapi/worksites/worksiteslist"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List existing Worksites"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"25a06fdc-c2f0-4bb2-b455-1666c1608c6e"},"workflow_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For additional insights into workflow types, please consider reviewing the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/reference#form-i-9-definitions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Form I-9 definitions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["remote_section_1_only","employee_appointment"],"example":"remote_section_1_only"}}},"id":"schema_168"},"schema_169":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","description":"Returned when the Worksite or the Checkr candidate does not exist.\n","example":"Worksite not found"}}},"id":"schema_169"},"schema_170":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","description":"Returned when the candidate already has an active Form I-9, or when an active Form I-9 already exists for the candidate's email address.\n","example":"Candidate already has an active Form I-9"}}},"id":"schema_170"},"schema_171":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","description":"List of validation error messages.","items":{"type":"string"},"example":["worksite_id is required","workflow_type must be one of: remote_section_1_only, employee_appointment"]}}},"id":"schema_171"},"schema_172":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_172"},"schema_173":{"kind":"json-schema","data":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Pre-signed URL to download the completed Form I-9 PDF. The URL is valid for 15 minutes; request a fresh URL for each download rather than storing this value.\n","example":"https://checkr-i9-pdf-archive.s3.amazonaws.com/forms/9adab19c-c8a8-44f1-a2fc-a8bd614d5c93.pdf?X-Amz-Credential=xyz&X-Amz-Expires=900&X-Amz-Signature=00fa239977fddb97a5e66f899ac41c34726bb9fb34167c60aa97762a1360eda7"}}},"id":"schema_173"},"schema_174":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","description":"Returned when the Form I-9 does not exist, or when its PDF is not yet available.\n","example":"The Form I-9 PDF is not yet available"}}},"id":"schema_174"},"schema_175":{"kind":"json-schema","data":{"properties":{"object":{"type":"string","description":"A list","enum":["list"]},"count":{"type":"integer","description":"Total number of records across all pages.","example":1},"next_href":{"type":"string","format":"uri","description":"URL of the next page of results, or null on the last page.","nullable":true,"example":null},"previous_href":{"type":"string","format":"uri","description":"URL of the previous page of results, or null on the first page.","nullable":true,"example":null},"data":{"type":"array","description":"Array of objects (Worksite)","items":{"$ref":"#/components/schemas/I9Worksite"}}}},"id":"schema_175"},"schema_176":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Verification"}},"object":{"type":"string","description":"A list","enum":["list"]},"count":{"type":"integer","example":2}}},"id":"schema_176"},"schema_177":{"kind":"json-schema","data":{"type":"string","enum":["application/vnd.checkr.multimvr+json"]},"id":"schema_177"}},"exampleStore":{"paths/~1reports~1{report_id}~1adverse_actions/get/responses/200/content/application~1json/examples/default":{"value":{"object":"list","next_href":null,"previous_href":null,"count":1,"data":[{"id":"57ed51e57619e8002a6683f2","object":"adverse_action","uri":"/v1/adverse_actions/57ed51e57619e8002a6683f2","created_at":"2016-09-29T17:39:49Z","status":"complete","report_id":"b861a56db1b1b89692dd6118","post_notice_scheduled_at":"2016-10-07T12:34:00Z","post_notice_ready_at":"2016-10-06T17:39:48Z","canceled_at":null,"individualized_assessment_engaged":false,"context":null,"delivery":{"state":"delivered","updated_at":"2016-09-29T17:45:00Z"},"adverse_items":[{"id":"57ed4ce3057e0b002adc6d90","object":"adverse_item","text":"FAILURE TO WEAR SEAT BELT"}],"events":[{"id":"507f1f77bcf86cd799439011","type":"created","time":"2016-09-29T17:39:49Z","trigger":null,"user":null},{"id":"507f1f77bcf86cd799439012","type":"completed","time":"2016-10-07T12:34:00Z","trigger":null,"user":"admin@example.com"}]}]},"key":"default","summary":"Response with data (no filter)","id":"paths/~1reports~1{report_id}~1adverse_actions/get/responses/200/content/application~1json/examples/default"}},"securitySchemeStore":{"basic_auth":{"id":"basic_auth","type":"http","scheme":"basic"}},"servers":[{"url":"/_mock/apis/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://api.checkr-staging.com/v1","description":"Staging"}]},"options":{"feedback":{"settings":{"label":"Was this page helpful?"}},"hideSidebar":true,"mockServer":{"url":"/_mock/apis/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/openapi.json?download"},{"url":"/_bundle/apis/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"API Reference","description":"Checkr is a RESTful API-driven background screening service. For guides and reference (Introduction, Getting Started, Webhooks, and more), use the sidebar navigation."}},"baseSlug":"/apis/openapi","routesMapping":{}}