{"_id":"5bd21fab5ce6a9003ef3163e","project":"54ee19c23749bf0d00c76515","version":{"_id":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","__v":2,"createdAt":"2018-01-18T19:32:29.915Z","releaseDate":"2018-01-18T19:32:29.915Z","categories":["5a60f64d792a330012d72141","5a60f64d792a330012d72142","5a60f64d792a330012d72143","5a60f64d792a330012d72144","5a60f64d792a330012d72145","5a60f64d792a330012d72146","5a60f64d792a330012d72147","5a660cc7dc0f1c001c2b5568"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"5a60f64d792a330012d72146","version":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-02-25T20:55:14.360Z","from_sync":false,"order":6,"slug":"candidate-endpoints","title":"Candidate Endpoints"},"user":"575f003663430e0e008a8704","__v":1,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-10-25T19:55:23.702Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n\tBackground Check Object\n}","name":""},{"status":400,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}","name":"Missing Access Token"},{"code":"{\n    \"error\": {\n        \"type\": \"invalidAccessToken\",\n        \"message\": \"access token is invalid\"\n    }\n}","language":"json","status":401},{"code":"{\n    \"error\": {\n        \"type\": \"getCandidateAssessmentsErrror\",\n        \"message\": \"there was an unknown error getting candidate background checks\"\n    }\n}","language":"json","status":500}]},"settings":"","examples":{"codes":[{"code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" https://breezy.hr/public/api/v3/company/000000000000/position/000000000000/candidate/000000000000/background-checks","language":"curl"}]},"auth":"required","params":[{"_id":"57a8afcd1ec0f519003e6127","ref":"","in":"path","required":true,"desc":"company id","default":"","type":"string","name":"company_id"},{"_id":"57a8afcd1ec0f519003e6126","ref":"","in":"path","required":true,"desc":"position id","default":"","type":"string","name":"position_id"},{"_id":"57a8afcd1ec0f519003e6125","ref":"","in":"path","required":true,"desc":"candidate id","default":"","type":"string","name":"candidate_id"}],"url":"/v:version/company/:company_id/position/:position_id/candidate/:candidate_id/background-checks"},"isReference":true,"order":3,"body":"","excerpt":"Retrieve all 3rd party background checks for candidate","slug":"company-position-candidate-background-checks","type":"endpoint","title":"./candidate/:id/background-checks"}

get./candidate/:id/background-checks

Retrieve all 3rd party background checks for candidate

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

company_id:
required
string
company id
position_id:
required
string
position id
candidate_id:
required
string
candidate id

Examples


Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}