BACKGROUND_CHECK
Updates the Human Resources system with the status of the background check and provides a link to the report.
More information: https://it.byu.edu
Contact Info: api@byu.edu
Base URL: /domains/erp/hr/background_check
Version: v1
Default request content-types: application/json
Default response content-types: application/json
Schemes: https
Summary
| Path | Operation | Description |
|---|---|---|
| /* | POST |
Paths
POST /*
Uses default content-types: application/json
Background Check Information
Uses default content-types: application/json
- 200 OK
-
The default response type is JSON. Add an Accept header with value=application/xml to return an XML response.
Example for application/json{
"status": {
"bi_response_acknowledgement": {
"success": {
}
}
}
}
Schema definitions
- request_id: string (up to 15 chars)
-
Background check request ID number
- status_code: string , x ∈ { FAIL , PASS , PEND , REVW , SBMT , SKIP }
-
Status Code
- description: string (up to 30 chars)
-
Description
- redirect_link: string (up to 254 chars)
-
URL to the background check report
- report_id: string (up to 15 chars)
-
ID number of the background check report
- bi_acknowledgement: bi_acknowledgement
-
Service Path:
/domains/erp/hr/background_check
Domain or University API:
/domains/erp/hr/background_check
