Post Background Check Results

post https://api.avionte.com/front-office-partner/v1/background-check/results

Updates results of the background check for a talent

Body Params

partner

The background check partner.

partnerOrderID

string

The identifier for the partner order.

orderStatus

The status of the background check order.

partnerScore

string

The partner score representing the result of the order.

reportUrl

string

The link to the report.

preAdverseActionStatus

string

The Pre-Adverse action status.

globalReferenceKey

string

required

length ≥ 1

The global reference key value which is used to find the background check order records.

reviewedByUser

string

The email of the user who reviewed the background check results.

reviewedDate

date-time

The date and time the background check results were reviewed.

customAttributes

array of objects

A list of custom attributes. This is not an open custom section, and these attributes are used for partner-specific custom data that needs to be included in the background check results for that partner.

customAttributes

Headers

FrontOfficeTenantId

string

Front office ID that indicates the tenant for which the request is being made. Either Tenant or FrontOfficeTenantId is required.

RequestId

string

Allows client-specified request correlation. Provided value must be a valid GUID.

Tenant

string

A short code that indicates the tenant for which the request is being made. Either Tenant or FrontOfficeTenantId is required.

Authorization

string

required

Contains the caller's access token, in the form "Bearer {token}", without quotes.

Responses

400

Bad Request

401

Unauthorized

403

Access Denied

406

Unsupported format(s) indicated by Accept header

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

The request could not be completed because an error occurred in an upstream service

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.avionte.com/front-office-partner/v1/background-check/results \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 response