Trust Center Request

This document describes the API for reading and updating Trust Center Requests.
Note: In order to access this API, you need to have paid features enabled for Trust.

List Trust Center Requests

Returns a list of Trust Center Requests

Search parameters

Filter Description
id The ID of the Trust Center Request
created_at The date when this Trust Center Request was created
email The email of the requester for this Trust Center Request
requester_name The name of the requester for the Trust Center Request
reviewed True if this Trust Center Request has been reviewed, false otherwise
Securityheader_authorization
Request
query Parameters
include
boolean

Set to true along with relationships to return the entire relationship data in the included key within the response.

page
integer

Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive.

per_page
integer

Used for pagination of response data (default: 1000 items per response). Specifies the number of results for a given page.

q
string

Search and filter the Trust Center Request data using Lucene syntax.

relationships
boolean

Set to true to return the associated relationships data within the response. (default: false)

Responses
400

Bad Request

401

Unauthorized

403

Forbidden

default
get/trust_center_requests
Request samples
Response samples
application/json
[
  • {
    }
]

Get a Trust Center Request

Returns a single Trust Center Request by ID

Securityheader_authorization
Request
path Parameters
id
required
string

Scope response to id

Responses
400

Bad Request

401

Unauthorized

403

Forbidden

404

Resource not found

default
get/trust_center_requests/{id}
Request samples
Response samples
application/json
{
  • "data": {
    },
  • "includes": { }
}

Update a Trust Center Request

Update a TrustCenterRequest by ID

Securityheader_authorization
Request
path Parameters
id
required
string

Scope response to id

query Parameters
approve_all_resources
boolean

Approve all resources for this trust center request.

approved_trust_center_resource_request_ids
Array of strings <uuid>

The IDs of the trust center resource requests for approval. Empty array will reject the request

custom_response
string

Send custom message in email response

do_not_send_notification
boolean

Set this to true prevent email notifications from being sent

document_security
string

The document security level for this trust center request.

Enum: "clickwrap" "external" "waived"
rejected_trust_center_resource_request_ids
Array of strings <uuid>

The IDs of the trust center resource requests for rejection.

rejection_reasons
object

Send custom rejection messages per resource

Request Body schema: multipart/form-data
optional
file
string <binary>

The signed trust center nda agreement pdf file.

Responses
400

Bad Request

401

Unauthorized

403

Forbidden

404

Resource not found

default
put/trust_center_requests/{id}
Request samples
Response samples
application/json
{
  • "data": {
    },
  • "includes": { }
}