TenantReportX offers two separate APIs that will integrate our platform into yours.

XML request gateway

The XML gateway (API) provides access via the Internet and XML messaging to a variety of background screening data products. The API consists of an XML schema for formatting screening data product requests and a gateway to which formatted requests are submitted and from which formatted responses are retrieved. As a security measure, all requests and responses are transmitted over HTTPS using 128-bit encryption perfect for minimal information collection and a need for raw data.

The client sends, via an HTTP post, an XML request for a screening product to the gateway. The product is a named configuration of available searches, such as credit, criminal, driving records, and references. The request contains authentication credentials, information indicating which product and searches are being requested, and the necessary applicant data to process the request. The gateway validates the request for correctness and completeness. Errors will be reported in an XML response with an “Error” status and no order ID. If there are no errors, the gateway returns an XML response with a non-error status, an order ID, and a URL to view the report. The gateway will proactively notify the client, via XML, of status changes in the background screening report, or the client can query the gateway for status information.

JSON

This is a restful API and offers many customizable features.

We offer a number of webhooks to help integrators know when key system events occur. We actually have a few more webhooks than documented.

All webhooks are sent via HTTPS to a URL you provide. They are sent as a POST with a JSON message as the body. If we have an issue delivering the webhook the system will automatically try to resend the webhook later. It will retry periodically for a minimum of 24 hours before giving up.

Please contact us for more information regarding your specific needs.

Document Integrations