Appearance

Create Bgv ​

Endpoint ​

http
POST /unified/hris/bgv
Integrations supported
  • SpringVerify India
  • SpringVerify US
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • SpringVerify India
  • SpringVerify US

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns 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.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

candidate
object

The BGV's candidate

Required in
  • SpringVerify India
  • SpringVerify US
id
string

The candidate's unique identifier

first_name
string

The candidate's first name

middle_name
string

The candidate's middle name

last_name
string

The candidate's last name

name
string
REQUIRED · 

The candidate's full name

emails
object[]
REQUIRED · 

The candidate's email addresses

email
string
REQUIRED · 

The email address

type
string

The type of email address

is_primary
boolean

Whether the email address is primary

phones
object[]

The candidate's phone numbers

number
string

The phone number

extension
string

The extension of the phone number

type
string

The type of phone number

gender
string

The candidate's gender

All possible enum values:
  • male
  • female
  • non_binary
  • not_specified
  • prefer_not_to_say
  • other
date_of_birth
string

The candidate's date of birth

address
object

The candidate's address

street_1
string

The first line of the street address

street_2
string

The second line of the street address

city
string

The city

state
string

The state

postal_code
string

The postal code

country
string

The country

employee_number
string

The candidate's employee number

invite
boolean

Whether to invite the candidate

ssn
string
package
object

The BGV's package

References: BgvPackages → id
Required in
  • SpringVerify India
Supported in
  • SpringVerify US
id
string
REQUIRED · 

The BGV package's unique identifier

name
string

The BGV package's name

package_group
object
REQUIRED · 

The package's package group

id
string
REQUIRED · 

The package group's unique identifier

name
string

The package group's name

checks
object
documents
object[]

The BGV's documents. A document with type 'resume' and a URL is required.

Required in
  • SpringVerify India
id
string

The document's unique identifier

type
string

The document's type

name
string

The document's name

url
string
REQUIRED · 

The document's URL

uploaded_at
string · date-time

The date and time of the document's upload

send_invite
boolean

Whether to invite the candidate. Overridden by candidate.invite if both are provided.

Supported in
  • SpringVerify India
consent_url
string
Supported in
  • SpringVerify US
verifications
object
Supported in
  • SpringVerify US
remote_data
object

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.

Response Body ​

id
string
REQUIRED · 

The BGV's unique identifier

Supported in
  • SpringVerify India
  • SpringVerify US
candidate
object

The BGV's candidate

Supported in
  • SpringVerify India
  • SpringVerify US
id
string

The candidate's unique identifier

first_name
string

The candidate's first name

middle_name
string

The candidate's middle name

last_name
string

The candidate's last name

name
string

The candidate's full name

emails
object[]

The candidate's email addresses

email
string

The email address

type
string

The type of email address

is_primary
boolean

Whether the email address is primary

phones
object[]

The candidate's phone numbers

number
string

The phone number

extension
string

The extension of the phone number

type
string

The type of phone number

gender
string

The candidate's gender

All possible enum values:
  • male
  • female
  • non_binary
  • not_specified
  • prefer_not_to_say
  • other
date_of_birth
string

The candidate's date of birth

address
object

The candidate's address

street_1
string

The first line of the street address

street_2
string

The second line of the street address

city
string

The city

state
string

The state

postal_code
string

The postal code

country
string

The country

employee_number
string

The candidate's employee number

employee
object

The employee associated with the background verification

References: Employees → id
id
string

The employee's unique identifier

name
string

The employee's name

package
object

The BGV's package

References: BgvPackages → id
Supported in
  • SpringVerify India
  • SpringVerify US
id
string

The package's unique identifier

name
string

The package's name

package_group
object

The package's package group

id
string

The package group's unique identifier

name
string

The package group's name

status
string

The BGV's status

All possible enum values:
  • draft
  • invited
  • pending_candidate
  • in_progress
  • insufficient
  • completed
  • canceled
  • expired
  • failed
  • unknown
Supported in
  • SpringVerify India
  • SpringVerify US
result
string

The BGV's result

All possible enum values:
  • clear
  • consider
  • discrepant
  • verified
  • unable_to_verify
  • not_applicable
  • unknown
Supported in
  • SpringVerify India
  • SpringVerify US
checks
object[]

The BGV's checks

Supported in
  • SpringVerify India
  • SpringVerify US
id
string

The check's unique identifier

name
string

The check's name

type
string

The check's type

status
string

The check's status

result
string

The check's result

details
string

The check's details

documents
object[]

The BGV's documents

Supported in
  • SpringVerify India
  • SpringVerify US
id
string

The document's unique identifier

type
string

The document's type

name
string

The document's name

url
string

The document's URL

uploaded_at
string · date-time

The date and time of the document's upload

report
object

The BGV's report

Supported in
  • SpringVerify India
  • SpringVerify US
expires_at
string · date-time

The date and time of the report's expiry

mime_type
string

The report's MIME type

urls
object[]

The BGV's URLs

Supported in
  • SpringVerify India
  • SpringVerify US
url
string

The URL

type
string

The URL type

All possible enum values:
  • invitation
  • consent
  • candidate_portal
  • report
requested_at
string · date-time

The date and time of the BGV's request

Supported in
  • SpringVerify India
  • SpringVerify US
submitted_at
string · date-time

The date and time of the candidate's submission

Supported in
  • SpringVerify US
completed_at
string · date-time

The date and time of the BGV's completion

Supported in
  • SpringVerify India
  • SpringVerify US
expires_at
string · date-time

The date and time of the BGV's expiry

created_at
string · date-time

The date and time of the BGV's creation

Supported in
  • SpringVerify India
  • SpringVerify US
updated_at
string · date-time

The date and time of the BGV's last update

Supported in
  • SpringVerify India
  • SpringVerify US
etag
string

The unique identifier for the specific version of the resource

remote_data
object

Raw data returned from the remote API call.