Rest Integration

Endpoints

• Authentication

• Connectivity Check

• Create Case

• Update Case Details

• Update Process Step

• Send Message

• Send Document

• Send Questionnaire

• Request Payment

• Request Third Party ID Check

• List Case Events

• Retrieve Case Event

• Retrieve Case Event File

• List Completed ID Checks

• Retrieve Completed ID Check

• Set ID Check Received

• List Updated Questionnaires

• List Questionnaires by Case

• Retrieve Questionnaire

Environments

We currently have two endpoints for you to use, you will need to be configured for each endpoint and provided with authentication credentials. The environments are:

• Development

• Production

Media Types

Our REST interface allows you to send and receive data in either JSON or XML. The default is JSON and the rest of this documentation will focus on JSON, but the XML is very similar.

To set the media type that you are sending, you must set the Content-Type header to either application/json or application/xml.

To set the media type that you would like to receive, you can use a number of methods:

• Set the Accept header to either application/json or application/xml

• Add a mediaType parameter to the query string with a value of either xml or json, e.g. ?mediaType=xml