Integration Center allows you to takes elements from the response payload and response headers and map these to Paradox System Attributes or authentication attributes.

Response payload in JSON

You need to use dot notation to access the JSON values you want from the payload. Dot notation is a way to access a property of an object. To use dot notation, write the name of the object, followed by a dot (.), followed by the name of the property.

JSON Response Payload example:

{
  "reportId": 23111994,
  "reportUrl": "vero75.screening.services",
  "status": "pending",
  "decision": "amet dolor quis ut velit",
  "orderDate": "amet",
  "completeDate": "consectetur",
  "isIntegratedReport": false,
  "refId": "laboris adipisicing non commodo",
  "billingRefId": "id nulla esse magna",
  "applicantRefId": "mollit laborum ad laboris",
  "applicationRefId": "et commodo elit qui",
  "userRefId": "minim",
  "primaryWebhookUrl": "non commodo anim",
  "secondaryWebhookUrl": "ut",
  "screenings": [
    {
      "screeningId": 1649222,
      "status": "elit culpa",
      "flagged": false,
      "type": "id"
    },
    {
      "screeningId": 97213354,
      "status": "do irure nisi exercitation dolore",
      "flagged": false,
      "type": "dolore ut proident minim adipisicing"
    },
    {
      "screeningId": 47801233,
      "status": "ut",
      "flagged": true,
      "type": "incididunt elit ad cupidatat nisi"
    }
  ]
}

Examples:

• Format: $.{object}.{property}

To get the reportId from the payload, you would first choose a Paradox system attribute to map to, then populate the response value using dot notation:

$.reportId

To get data from an array in the response, in this case the screenings array, you would need to indicate which position in the array. Arrays always start with 0 as the first position.

$.screenings[0].screeningId

Response header

Within Integration Center, unfortunately, it is not possible at this time to view the response headers of an API request. It is necessary to perform the call first in Postman to see the available headers that are returned. CSRF Token protection or specific ATS specifications are two scenarios where it may be necessary to obtain a response header value.

CSRF token protection

Cross-site request forgery (also known as CSRF) is a web security vulnerability that allows an attacker to induce users to perform actions that they do not intend to perform. A CSRF token is a unique, secret, and unpredictable value that is generated by the server-side application and shared with the client. When attempting to perform a sensitive action, such as submitting a form, the client must include the correct CSRF token in the request. This makes it very difficult for an attacker to construct a valid request on behalf of the victim. A CSRF token request may return the token in the response header, therefore it is necessary to be able to map this header value to an attribute.

Integrated ATS specifications

Certain ATS specifications might require you to obtain a value from a response header. For example, in order to send a resume to Kronos WorkforceReady, you must first do a POST call to Kronos to pass the Kronos ID and create the the document metadata. This call returns a link in the HEADER that needs to be used to upload the file content of the document.

Response header from postman

In order to see available headers that are returned, you must send the request in Postman first. Response headers are not visible in Integration Center at this time.

Example:

• Format: $header.{key}

$headers.x-csrf-token

$headers.set-cookie