Information Request

Information request status changed

Fires when an information request’s approval status changes. This is a status-change event.

Ready-to-review signal: a newStatus of READY_FOR_AUDIT means the customer has submitted the information request and it is ready for the auditor to review.

When it fires: once per information request, each time its status changes between the values below. Not every status transition emits an event.

Status values:

NEEDS_EVIDENCE — the request still needs work from the customer; it is not yet ready for the auditor.
READY_FOR_AUDIT — the customer has submitted the request and it is ready for the auditor to review.
AUDITOR_APPROVED — the auditor reviewed the request and approved it.
AUDITOR_FLAGGED — the auditor flagged the request for the customer to address.

A typical lifecycle is NEEDS_EVIDENCE → READY_FOR_AUDIT → AUDITOR_APPROVED (or → AUDITOR_FLAGGED). A request can also move from READY_FOR_AUDIT back to NEEDS_EVIDENCE when the customer takes it back to continue working on it.

POST

v1.information-request.status-changed

Information request status changed

curl --request POST \
  --url https://your-endpoint.example.com/v1.information-request.status-changed \
  --header 'Content-Type: application/json' \
  --data '
{
  "informationRequest": {
    "id": "507f1f77bcf86cd799439011",
    "auditId": "5f8d0f3b9d3f2a1b4c5d6e7f",
    "oldStatus": "NEEDS_EVIDENCE",
    "newStatus": "READY_FOR_AUDIT"
  }
}
'

import requests

url = "https://your-endpoint.example.com/v1.information-request.status-changed"

payload = { "informationRequest": {
        "id": "507f1f77bcf86cd799439011",
        "auditId": "5f8d0f3b9d3f2a1b4c5d6e7f",
        "oldStatus": "NEEDS_EVIDENCE",
        "newStatus": "READY_FOR_AUDIT"
    } }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    informationRequest: {
      id: '507f1f77bcf86cd799439011',
      auditId: '5f8d0f3b9d3f2a1b4c5d6e7f',
      oldStatus: 'NEEDS_EVIDENCE',
      newStatus: 'READY_FOR_AUDIT'
    }
  })
};

fetch('https://your-endpoint.example.com/v1.information-request.status-changed', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your-endpoint.example.com/v1.information-request.status-changed",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'informationRequest' => [
        'id' => '507f1f77bcf86cd799439011',
        'auditId' => '5f8d0f3b9d3f2a1b4c5d6e7f',
        'oldStatus' => 'NEEDS_EVIDENCE',
        'newStatus' => 'READY_FOR_AUDIT'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-endpoint.example.com/v1.information-request.status-changed"

	payload := strings.NewReader("{\n  \"informationRequest\": {\n    \"id\": \"507f1f77bcf86cd799439011\",\n    \"auditId\": \"5f8d0f3b9d3f2a1b4c5d6e7f\",\n    \"oldStatus\": \"NEEDS_EVIDENCE\",\n    \"newStatus\": \"READY_FOR_AUDIT\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://your-endpoint.example.com/v1.information-request.status-changed")
  .header("Content-Type", "application/json")
  .body("{\n  \"informationRequest\": {\n    \"id\": \"507f1f77bcf86cd799439011\",\n    \"auditId\": \"5f8d0f3b9d3f2a1b4c5d6e7f\",\n    \"oldStatus\": \"NEEDS_EVIDENCE\",\n    \"newStatus\": \"READY_FOR_AUDIT\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-endpoint.example.com/v1.information-request.status-changed")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"informationRequest\": {\n    \"id\": \"507f1f77bcf86cd799439011\",\n    \"auditId\": \"5f8d0f3b9d3f2a1b4c5d6e7f\",\n    \"oldStatus\": \"NEEDS_EVIDENCE\",\n    \"newStatus\": \"READY_FOR_AUDIT\"\n  }\n}"

response = http.request(request)
puts response.read_body

Body

application/json

informationRequest

object

required

Show child attributes

Response

200

Return any 2xx status within 15 seconds to acknowledge receipt.

Information request comment createdFires when a comment is created on an information request. Fires once per comment. The payload contains only identifiers; fetch the comment body from the information request comments endpoint (`GET /v1/audits/{auditId}/information-requests/{requestId}/comments`).

⌘I

Information request status changed

curl --request POST \
  --url https://your-endpoint.example.com/v1.information-request.status-changed \
  --header 'Content-Type: application/json' \
  --data '
{
  "informationRequest": {
    "id": "507f1f77bcf86cd799439011",
    "auditId": "5f8d0f3b9d3f2a1b4c5d6e7f",
    "oldStatus": "NEEDS_EVIDENCE",
    "newStatus": "READY_FOR_AUDIT"
  }
}
'

import requests

url = "https://your-endpoint.example.com/v1.information-request.status-changed"

payload = { "informationRequest": {
        "id": "507f1f77bcf86cd799439011",
        "auditId": "5f8d0f3b9d3f2a1b4c5d6e7f",
        "oldStatus": "NEEDS_EVIDENCE",
        "newStatus": "READY_FOR_AUDIT"
    } }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    informationRequest: {
      id: '507f1f77bcf86cd799439011',
      auditId: '5f8d0f3b9d3f2a1b4c5d6e7f',
      oldStatus: 'NEEDS_EVIDENCE',
      newStatus: 'READY_FOR_AUDIT'
    }
  })
};

fetch('https://your-endpoint.example.com/v1.information-request.status-changed', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your-endpoint.example.com/v1.information-request.status-changed",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'informationRequest' => [
        'id' => '507f1f77bcf86cd799439011',
        'auditId' => '5f8d0f3b9d3f2a1b4c5d6e7f',
        'oldStatus' => 'NEEDS_EVIDENCE',
        'newStatus' => 'READY_FOR_AUDIT'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-endpoint.example.com/v1.information-request.status-changed"

	payload := strings.NewReader("{\n  \"informationRequest\": {\n    \"id\": \"507f1f77bcf86cd799439011\",\n    \"auditId\": \"5f8d0f3b9d3f2a1b4c5d6e7f\",\n    \"oldStatus\": \"NEEDS_EVIDENCE\",\n    \"newStatus\": \"READY_FOR_AUDIT\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://your-endpoint.example.com/v1.information-request.status-changed")
  .header("Content-Type", "application/json")
  .body("{\n  \"informationRequest\": {\n    \"id\": \"507f1f77bcf86cd799439011\",\n    \"auditId\": \"5f8d0f3b9d3f2a1b4c5d6e7f\",\n    \"oldStatus\": \"NEEDS_EVIDENCE\",\n    \"newStatus\": \"READY_FOR_AUDIT\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-endpoint.example.com/v1.information-request.status-changed")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"informationRequest\": {\n    \"id\": \"507f1f77bcf86cd799439011\",\n    \"auditId\": \"5f8d0f3b9d3f2a1b4c5d6e7f\",\n    \"oldStatus\": \"NEEDS_EVIDENCE\",\n    \"newStatus\": \"READY_FOR_AUDIT\"\n  }\n}"

response = http.request(request)
puts response.read_body

API Basics

Manage API

Integrations API

Audit API

Webhooks

Information request status changed

Body

Response