Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Get Background Checks

Retrieves results of all background checks for a talent.

get/v1/talent/{talentId}/background-check

Path parameters

talentIdstring required

The identifier for the talent whose background check results are being retrieved.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

A list of background check results.

talentIdinteger

The identifier for the talent.

orderDatestring date-time

The date and time when the background check order was placed. The field follows the YYYY-MM-DDTHH:mm:ss.sss+00:00 datetimeoffset format. For example, 2024-12-01T14:30:00.546+00:00.

packageIdstring

The identifier for the background check package.

packageNamestring

The name of the background check package.

partnerOrderStatusstring

The status name for the partner order.

scorestring

The partner score status for the background check.

orderStatusstring

The status of the background check order.

adverseActionstring

The pre-adverse action status for the background check.

officeIdinteger

The identifier for the office branch.

completedDatestring date-time

The date and time when the background check order was completed. The field follows the YYYY-MM-DDTHH:mm:ss.sss+00:00 datetimeoffset format. For example, 2024-12-01T14:30:00.546+00:00.

reviewStatusstring

The review status of the order.

reviewedDatestring date-time

The review date and time of the order. The field follows the YYYY-MM-DDTHH:mm:ss.sss+00:00 datetimeoffset format. For example, 2024-12-01T14:30:00.546+00:00.

expiringDatestring date-time

The date and time when the background check is set to expire. The field follows the YYYY-MM-DDTHH:mm:ss.sss+00:00 datetimeoffset format. For example, 2024-12-01T14:30:00.546+00:00.

deletedDatestring date-time

The date and time when the background check order was deleted. The field follows the YYYY-MM-DDTHH:mm:ss.sss+00:00 datetimeoffset format. For example, 2024-12-01T14:30:00.546+00:00.

providerNamestring

The name of the background check provider.

backgroundCheckIdinteger

The unique identifier for the background check record.

Example response

[
  {
    "talentId": 17482,
    "orderDate": "2024-12-01T14:30:00.546Z",
    "packageId": "275d01e5-420c-46a0-8083-70926009df5b",
    "packageName": "Basic Package",
    "partnerOrderStatus": "Completed",
    "score": "Passed",
    "orderStatus": "1",
    "adverseAction": "Initiated",
    "officeId": 4785,
    "completedDate": "2024-12-01T14:30:00.546Z",
    "reviewStatus": "1",
    "reviewedDate": "2024-12-01T14:30:00.546Z",
    "expiringDate": "2024-12-01T14:30:00.546Z",
    "deletedDate": "2024-12-01T14:30:00.546Z",
    "providerName": "Asurint",
    "backgroundCheckId": 18345
  }
]