v1

latestOpenAPI 3.0.32026-07-14265579.8 KB

Order

Create Subject Notification

Creates a subject notification search in the order indicated so a candidate will receive a copy of their background check report.

post/order/{id}/subjectNotification

Path parameters

idstring required

Order ID

Query parameters

electronicNotificationtrue | false required

Accepts true or false and determines which type of subject notification will be added to order. True = add electronic copy of subject notification. False = add physical copy of subject notification

Response

Success Response

resourcestring

orderIDstring

supportReferenceIdstring

productIdinteger

productTypestring

productStatusstring

createdDatestring date-time

Example response

{
  "resource": "ORDER",
  "orderID": "602ad1744b9ccf1bbb4fa292",
  "supportReferenceId": "Y8426379",
  "productId": 51116984,
  "productType": "SBJ",
  "productStatus": "PENDING"
}