Create Bgv
/unified/hris/bgv
Partial response — use the "get" endpoint for the full object.
Query 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]=barRequest Body
Refer Writing data using Unified APIs
The BGV's candidate
2 supported2 required
The candidate's email addresses
3 properties
The email address
Whether the email address is primary
The type of email address
The candidate's full name
The candidate's address
6 properties
The city
The country
The postal code
The state
The first line of the street address
The second line of the street address
The candidate's date of birth
The candidate's employee number
The candidate's first name
The candidate's gender
malefemalenon_binarynot_specifiedprefer_not_to_sayother
The candidate's unique identifier
Whether to invite the candidate
The candidate's last name
The candidate's middle name
The candidate's phone numbers
3 properties
The extension of the phone number
The phone number
The type of phone number
1 supported
The BGV's documents. A document with type 'resume' and a URL is required.
2 supported1 required
The document's URL
The document's unique identifier
The document's name
The document's type
The date and time of the document's upload
The BGV's package
2 supported1 required
The BGV package's unique identifier
The package's package group
2 properties
The package group's unique identifier
The package group's name
The BGV package's name
Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.
Whether to invite the candidate. Overridden by candidate.invite if both are provided.
1 supported
1 supported
Response Body
The BGV's unique identifier
2 supported
The BGV's candidate
2 supported
The candidate's address
6 properties
The city
The country
The postal code
The state
The first line of the street address
The second line of the street address
The candidate's date of birth
The candidate's email addresses
3 properties
The email address
Whether the email address is primary
The type of email address
The candidate's employee number
The candidate's first name
The candidate's gender
malefemalenon_binarynot_specifiedprefer_not_to_sayother
The candidate's unique identifier
The candidate's last name
The candidate's middle name
The candidate's full name
The candidate's phone numbers
3 properties
The extension of the phone number
The phone number
The type of phone number
The BGV's checks
2 supported
The check's details
The check's unique identifier
The check's name
The check's result
The check's status
The check's type
The date and time of the BGV's completion
2 supported
The date and time of the BGV's creation
2 supported
The BGV's documents
2 supported
The document's unique identifier
The document's name
The document's type
The date and time of the document's upload
The document's URL
The employee associated with the background verification
The employee's unique identifier
The employee's name
The unique identifier for the specific version of the resource
The date and time of the BGV's expiry
The BGV's package
2 supported
The package's unique identifier
The package's name
The package's package group
2 properties
The package group's unique identifier
The package group's name
Raw data returned from the remote API call.
The BGV's report
2 supported
The date and time of the report's expiry
The report's MIME type
The date and time of the BGV's request
2 supported
The BGV's result
clearconsiderdiscrepantverifiedunable_to_verifynot_applicableunknown
2 supported
The BGV's status
draftinvitedpending_candidatein_progressinsufficientcompletedcanceledexpiredfailedunknown
2 supported
The date and time of the candidate's submission
1 supported
The date and time of the BGV's last update
2 supported
The BGV's URLs
2 supported
The URL type
invitationconsentcandidate_portalreport
The URL
truto unified hris bgv \
-m create \
-a '<integrated_account_id>' \
-b '{
"candidate": {},
"package": {},
"documents": [],
"send_invite": true,
"consent_url": "your_consent_url",
"verifications": {},
"remote_data": {}
}' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.create(
'hris',
'bgv',
{
"candidate": {},
"package": {},
"documents": [],
"send_invite": true,
"consent_url": "your_consent_url",
"verifications": {},
"remote_data": {}
},
{ 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.create(
"hris",
"bgv",
{
"candidate": {},
"package": {},
"documents": [],
"send_invite": True,
"consent_url": "your_consent_url",
"verifications": {},
"remote_data": {}
},
{"integrated_account_id": "<integrated_account_id>"}
)
print(result)
asyncio.run(main())curl -X POST 'https://api.truto.one/unified/hris/bgv?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json' \
-d '{
"candidate": {},
"package": {},
"documents": [],
"send_invite": true,
"consent_url": "your_consent_url",
"verifications": {},
"remote_data": {}
}'const integratedAccountId = '<integrated_account_id>';
const body = {
"candidate": {},
"package": {},
"documents": [],
"send_invite": true,
"consent_url": "your_consent_url",
"verifications": {},
"remote_data": {}
};
const response = await fetch(`https://api.truto.one/unified/hris/bgv?integrated_account_id=${integratedAccountId}`, {
method: 'POST',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
body: JSON.stringify(body),
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/hris/bgv"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
payload = {
"candidate": {},
"package": {},
"documents": [],
"send_invite": True,
"consent_url": "your_consent_url",
"verifications": {},
"remote_data": {}
}
response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())