Start a conversation

API Integration

  • Client & Case Creation

    A simple payload for creating a Client and Case in Case Manager. Payload { operations: [ { type: ClientCreate, ref: client, data: { firstName: John, lastName: Jeffries, dateOfBirth: 1957-04-14, types:...

  • Submitting Your First Request

    Below are the details to connect and post to a Case Manager TEST system against which you can test your integrations. ➡ Note: That this is a test system and is intended for test data only. Important B...

  • Example Payload

    Here is an example payload for creating a client, case and case action with file attachment in a single request. ➡ Note: That references to configuration elements like client types, case and case acti...

  • Operations

    The various types of operations available are documented below. Client Create Create a client record. Operation type identifier: ClientCreate Data Structure Property Data type Required Description typ...

  • Data Types

    As well as the standard JSON data types, we will refer to the following additional types. Date: a string formatted as yyyy-MM-dd Date-time: a string formatted as yyyy-MM-dd’T’HH:mm:ss Reference: a ref...

  • API Specification

    This document applies to Case Manager Web Service v2.x. The web service is accessible over HTTPS. All request and response payloads are transmitted as JSON using the UTF-8 character set. Request Speci...

  • Authentication & Security

    Access to the web services interface is limited to the HTTPS protocol only.  The minimum supported TLS version is 1.2 Web service clients are authenticated using OAUTH2 with the OpenID Connect extensi...