Get Bgv
/unified/hris/bgv/{id}
Path Parameters
The ID of the resource.
23423523Query Parameters
Refer Specifying query parameters in Truto APIs
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount).debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
The unique identifier for the background verification case
2 supported
The person whose background verification is being run. Providers may call this person a candidate, applicant, or employee.
2 supported
The candidate address used for the background verification case
6 properties
The city of the address
The country of the address
The postal code of the address
The state or province of the address
The first line of the address
The second line of the address
The candidate date of birth
The candidate email addresses
3 properties
The email address
Whether the email address is primary
The type of email address
The provider or customer employee number associated with the candidate, when available. This is not a Truto employees.id reference.
The candidate first name
The candidate gender. If no clear mapping is available, the raw provider value is returned.
The provider identifier for the candidate or applicant
The candidate last name
The candidate middle name
The candidate full name
The candidate phone numbers
3 properties
The extension of the phone number
The phone number
The type of phone number
A URL for the candidate portal, when available
1 supported
Individual checks that compose this background verification case.
2 supported
Additional provider details for the check
The unique identifier for the check
The check name
The check result
The check lifecycle status
The check type
The date when the background verification was completed
2 supported
A URL for candidate consent, when available
1 supported
The date when the background verification case was created
2 supported
Documents associated with this background verification case.
2 supported
The unique identifier for the document
The document name
The document type
The date when the document was uploaded
A provider URL for the document, when available
The HRIS employee associated with this background verification case when a real Truto employee identifier is known. Provider-specific employee numbers are returned on candidate.employee_number instead.
The unique identifier for employees
This represents the name of the employee
The unique identifier for the specific version of the resource
The date when the background verification expires
A URL for the candidate invitation, when available
1 supported
The verification package, program, or screening bundle used for this case.
2 supported
The unique identifier for the BGV package
The name of the BGV package
Raw data returned from the remote API call.
The final background verification report when available.
2 supported
The date when the report URL expires
The report MIME type
A URL for the report, when available
The date when the background verification was requested
2 supported
The normalized verification outcome. This is not a hiring recommendation. If no clear mapping is available, the raw provider value is returned.
clearconsiderdiscrepantverifiedunable_to_verifynot_applicableunknown
2 supported
The normalized lifecycle status of the background verification case. If no clear mapping is available, the raw provider value is returned.
draftinvitedpending_candidatein_progressinsufficientcompletedcanceledexpiredfailedunknown
2 supported
The date when the candidate submitted required information
1 supported
The date when the background verification case was updated
2 supported
truto unified hris bgv '<resource_id>' \
-m get \
-a '<integrated_account_id>' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.get(
'hris',
'bgv',
'<resource_id>',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
result = await truto_api.unified_api.get(
"hris",
"bgv",
"<resource_id>",
{"integrated_account_id": "<integrated_account_id>"}
)
print(result)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/hris/bgv/{id}?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/hris/bgv/{id}?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/hris/bgv/{id}"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())