\r\n
\r\n
\r\n The API is secured by authentication. Partners requiring interaction between their applications and the API must first enroll their applications with Centriq\r\n to obtain a unique set of credentials.\r\n
\r\n
\r\n
\r\n \r\n
\r\n Please send an email to your Client Manager or Claims Team requesting that your application be registered\r\n to use the API. Your request must contain the following information:\r\n
\r\n - Partner Name: Your organization's name, e.g. Plumtree (PTY) Ltd.
\r\n - Contact Name: The application administrator's name and surname, e.g. Adam Plumtree
\r\n - Contact Email: The application administrator's email address, e.g. adam@plumtree.co.za.
\r\n - Contact Number: The application administrator's contact telephone number. 092 123 4567
\r\n - Application Name: The name of the client application being enrolled to use the API, e.g. Claims Manager Api.
\r\n - Application DNS: The client application domain, e.g. plumtree.co.za.
\r\n
\r\n \r\n
\r\n Once your request is received and approved, you will be contacted by our IT Support Team who will issue you\r\n with the following application credentials:\r\n
\r\n Client ID a unique key identifying your organization.Client Secret a unique passcode that must be kept private.User Key an application administrator key.
\r\n These credentials only need to be applied for once, are specific to your Partner client application, and must be kept private at all times.\r\n Please refer to the Authorization section on how to use these credentials in your application to make requests to the API.\r\n \r\n
\r\n
\r\n
\r\n
\r\n The API uses the OAuth2 client credentials grant flow to authenticate and authorize Partner client applications. Please ensure that you\r\n have obtained a valid Client ID and Client Secret (refer to Application Registration) before continuing to the next section.\r\n
\r\n
\r\n
\r\n \r\n
\r\n The client application must request an access token from the Gateway Authentication Service Provider before any endpoints can be called. The following\r\n section explains how to set up, request and receive an access token.\r\n
\r\n \r\n
\r\n Accept application/jsonContent Type application/x-www-form-urlencoded
\r\n \r\n
\r\n grant_type client_credentialsscope defaultclient_id your Client IDclient_secret your Client Secret
\r\n \r\n
\r\n POST the request to the /token endpoint to receive an access token. On success, \r\n you will receive an access token (access_token) with a predefined token lifetime (expires_in) expressed \r\n in seconds. You will need to request a new token when the token has expired.\r\n
\r\n
\r\n \r\n
\r\n \r\nPOST /token\r\nAccept: application/json\r\nContent-Type: application/x-www-form-urlencoded\r\ngrant_type=client_credentials&client_id=YourClientID&client_secret=YourClientSecret&scope=default\r\n
\r\n \r\n \r\n
\r\n \r\n{\r\n \"access_token\": \"abcAccessTokenXyz\",\r\n \"token_type\": \"Bearer\",\r\n \"expires_in\": 86399\r\n}\r\n\r\n \r\n
\r\n \r\n
\r\n 401 Unauthorized authentication failed400 Bad Request request is malformed200 OK authenticated
\r\n
\r\n
\r\n \r\n
\r\n In addition to an access token, the API requires a valid user key to make authorized calls to API resources. \r\n This key identifies which user is performing the requests and grants the necessary permissions to complete the requests, for example, \r\n an application administrator user or a complaint handler. A default application administrator user key would have been issued to you \r\n when your application was initially enrolled with Centriq and can be used to maintain your organization's list of users.\r\n
\r\n \r\n
\r\n Authorization Bearer access tokenCen-Authorization user keyAccept application/json
\r\n \r\n
\r\n Make a call to the required endpoint.\r\n
\r\n
\r\n \r\n
\r\n \r\nGET /complaints\r\nAuthorization: Bearer abcAccessTokenXyz\r\nCen-Authorization: abcUserKeyXyz\r\nAccept: application/json\r\n
\r\n \r\n
\r\n \r\n
\r\n 401 Unauthorized authorization failed200 OK authorized
\r\n
\r\n
\r\n
\r\n
\r\n Access to resources must be done using the appropriate HTTP method.\r\n HTTP methods are used to indicate the action an API client would like to perform on a given resource.\r\n Each HTTP method maps to a specific operation, such as creating, reading, updating, or deleting a resource,\r\n and an HTTP method must be included with every request to a REST API.\r\n
\r\n
\r\n
\r\n \r\n
\r\n The API currently supports the following HTTP methods:\r\n
\r\n
\r\n GET Retrieve a resource. The request does not require a body.\r\n
\r\n \r\n
\r\n\r\nGET /complaints\r\nAuthorization: Bearer {access-token}\r\nCen-Authorization: {user-key}\r\nAccept: application/json\r\n\r\n \r\n
POST Create a new resource. The request must contain a body that is the resource to be created.\r\n
\r\n \r\n
\r\n\r\nPOST /complaints\r\nAuthorization: Bearer {access-token}\r\nCen-Authorization: {user-key}\r\nAccept: application/json\r\nContent-Type: application/json\r\n{\r\n ...\r\n}\r\n\r\n \r\n
- \r\n
PUT Replace a requested resource with an updated version.\r\n The request must contain a body of the entire resource being updated.\r\n \r\n \r\n
\r\n \r\n
\r\n\r\nPUT /complaints/1234\r\nAuthorization: Bearer {access-token}\r\nCen-Authorization: {user-key}\r\nAccept: application/json\r\nContent-Type: application/json\r\n{\r\n ...\r\n}\r\n\r\n \r\n
DELETE Remove a resource. The request does not require a body.\r\n
\r\n \r\n
\r\n\r\nDELETE /complaints/1234\r\nAuthorization: Bearer {access-token}\r\nCen-Authorization: {user-key}\r\nAccept: application/json\r\n\r\n \r\n
\r\n
\r\n
\r\n
\r\n
\r\n Rate limiting is a technique used to control the rate at which requests are made to a network, server, or other resource and\r\n is used to prevent excessive or abusive use of a resource and to ensure that the resource is available to all users. \r\n
\r\n
\r\n The C3 API therefore applies rate limiting to ensure that maximum stability and uptime is maintained for all users to execute and receive\r\n responses from the API.\r\n
\r\n
\r\n \r\n
\r\n Rate limits are expressed as the number of requests per hour, minute or second. The current rate limit for all requests made to the API is \r\n 1000 requests per minute.\r\n
\r\n
\r\n
\r\n
\r\n The API supports multiple media types to provide flexibility in how responses are formatted.\r\n The default media type is application/json. Additionally, Centriq-specific types using\r\n Hypermedia As The Engine of Application State (HATEOAS) are also supported.\r\n
\r\n
\r\n
\r\n \r\n
\r\n The Content-Type header is used to indicate the original media type of the resource prior to any content\r\n encoding applied before transmission. In responses, the Content-Type header informs the client about the media type\r\n of the returned data. In requests such as POST or PUT, the client uses the Content-Type header to specify the type of\r\n content being sent to the server.\r\n
\r\n
\r\n The client must specify the desired request/response format using the Content-Type header in the API request.\r\n If the Content-Type header is not provided or contains an invalid content type, the API will\r\n return a 415 Unsupported Media Type error. The following Media types are supported:\r\n
\r\n
\r\n application/json Default JSON request/response.application/vnd.centriq.hateoas+json Include HATEOAS information in the JSON response.multipart/form-data Applicable to document upload requests (POST /documents) only.application/x-www-form-urlencoded Applicable to an access token request (GET /token) only.
\r\n
\r\n
\r\n \r\n
\r\n The Accept header indicates which content types, expressed as media types, the client is able to understand.\r\n The server uses content negotiation to select one of the proposals and informs the client of the choice with the\r\n Content-Type response header.\r\n
\r\n
\r\n The client must specify the desired response format using the Accept header in the API request.\r\n If the Accept header is not provided or contains an invalid media type, the API will\r\n return a 406 Not Acceptable error. The following media types are supported:\r\n
\r\n
\r\n application/json Default JSON response.application/vnd.centriq.hateoas+json Include HATEOAS information in the JSON response.application/octet-stream Applicable to document download requests (GET /documents/{documentId}) only.
\r\n
\r\n \r\n
\r\n \r\nGET /lookups/PolicyTypes/1\r\nAuthorization: Bearer {access-token}\r\nCen-Authorization: {user-key}\r\nAccept: application/json\r\n\r\n \r\n \r\n
\r\n \r\n{\r\n \"id\": 1,\r\n \"name\": \"Short Term\",\r\n \"disabled\": false\r\n}\r\n\r\n \r\n
\r\n
\r\n
\r\n \r\n
\r\n Hypermedia As The Engine of Application State (HATEOAS) is a mechanism whereby an API describes how it can be used by providing\r\n URLs to other allowed actions in its responses. To return HATEOAS links in responses, use \r\n the application/vnd.centriq.hateoas+json request media type.\r\n
\r\n
\r\n \r\n
\r\n \r\nGET /lookups/PolicyTypes/1\r\nAuthorization: Bearer {access-token}\r\nCen-Authorization: {user-key}\r\nAccept: application/vnd.centriq.hateoas+json\r\n\r\n \r\n \r\n
\r\n \r\n{\r\n \"id\": 1,\r\n \"name\": \"Short Term\",\r\n \"disabled\": false,\r\n \"links\": [\r\n {\r\n \"href\": \"https://sample.com/api/v1/lookups/policytypes/1\",\r\n \"method\": \"GET\",\r\n \"rel\": \"self\"\r\n },\r\n {\r\n \"href\": \"https://sample.com/api/v1/lookups/policytypes/1/businesstypes\",\r\n \"method\": \"GET\",\r\n \"rel\": \"getpolicytypebusinesstypes\"\r\n }\r\n ]\r\n}\r\n\r\n \r\n
\r\n
\r\n
\r\n
\r\n
\r\n Data shaping is a feature that allows clients to reduce the amount of data transferred from the API to the client by selecting only the\r\n fields (columns) they need.\r\n
\r\n
\r\n
\r\n fields Allows the client to shape the data by specifying a comma delimited list of fields to be returned on the collection of objects.
\r\n \r\n
\r\n
\r\n \r\n
\r\n To shape the data, include the fields parameter in the query string of your request. Only the specified fields will be \r\n returned in the response.\r\n
\r\n
\r\n \r\n
\r\n \r\nGET /repudiations?fields=repudiationId,repudiationNumber\r\nAccept: application/json\r\n
\r\n \r\n
\r\n
\r\n \r\n
\r\n \r\n{\r\n \"repudiationId\": 123456,\r\n \"repudiationNumber\": \"PLU001-1234\",\r\n \"policyType\": {\r\n \"id\": 1,\r\n \"name\": \"Short Term\",\r\n \"disabled\": false\r\n }\r\n}\r\n\r\n \r\n
\r\n
\r\n
\r\n \r\n
\r\n If the client attempts to shape on fields that are not available on the main resource object, a 400 Bad Request error\r\n will be returned indicating which fields are invalid.\r\n
\r\n
\r\n Data shaping is only supported for top-level fields. If an object contains a sub object, such as policyType in the\r\n following example, specifying these sub-fields like policyType.Id will not work and a 400 Bad Request error\r\n will be returned.\r\n
\r\n
\r\n \r\n
\r\n \r\nGET /repudiations?fields=repudiationId,repudiationNumber,policyType.Id\r\nAccept: application/json\r\n
\r\n \r\n
\r\n
\r\n \r\n
\r\n \r\nHTTP/1.1 400 Bad Request\r\nContent-Type: application/json\r\n{\r\n \"type\": \"https://tools.ietf.org/html/rfc9110#section-15.5.1\",\r\n \"title\": \"Invalid filter parameters request.\",\r\n \"status\": 400,\r\n \"detail\": \"Invalid request information for ordering, filtering and/or field selection.\",\r\n \"instance\": \"/repudiations\",\r\n \"errors\": [\r\n \"Field 'policyType.id' from the provided fields (repudiationId,repudiationNumber,policyType.Id) is not part of the requested object's fields\"\r\n ]\r\n}\r\n\r\n \r\n
\r\n
\r\n
\r\n
\r\n
\r\n Filtering, ordering and paging (or fopping) is a feature that allows clients to manipulate the data transferred from the API to the client by\r\n reducing, sorting or returning the data (rows) in manageable chunks. This is done through various query string parameters.\r\n
\r\n
\r\n
\r\n \r\n
\r\n To filter the data, include the filter parameter followed by the fields and logical operators in the query string of your\r\n request. Only the items matching the specified filter rules will be returned in the response.\r\n
\r\n
\r\n
\r\n filter Allows the client to use rules to search and/or filter the items in the collection.
\r\n \r\n \r\n
\r\n
\r\n == Equal!= Not Equal> Greater Than>= Greater Or Equal Than< Less Than<= Less Or Equal Than~= Contains!~= Not Contains_= Starts With!_= Not Starts With|= Ends With!|= Not Ends With
\r\n \r\n \r\n
\r\n
\r\n ;and AND (if not specified, then AND is implied);or OR
\r\n \r\n \r\n
\r\n
\r\n ; Multiple fields\r\n \r\n
\r\n \r\nFilter: filter=complaintNumber~=PLU001;claimNumber_=test;or\r\nEquivalent: (complaintNumber LIKE '%PLU001%' OR claimNumber LIKE 'test%')\r\n
\r\n \r\n
$ Multiple filters (always defaults to OR)\r\n \r\n
\r\n \r\nFilter: filter=complaintNumber~=PLU001;claimNumber_=test$capturedBy>=2024-08-10\r\nEquivalent: (complaintNumber LIKE '%PLU001%' AND claimNumber LIKE 'test%') OR (capturedBy >= '20240810')\r\n
\r\n \r\n
\r\n \r\n
\r\n \r\n
\r\n To order the data, include the order parameter followed by the field and order operator in the query string of your request.\r\n The items will be ordered by the field and returned in the response.\r\n
\r\n
\r\n
\r\n order Allows the client to order the collection by specifying the ordering permutations.
\r\n \r\n \r\n
\r\n The default sort order is ascending. To sort in descending order, use ;desc after the field.\r\n Currently, only a single order field is supported.\r\n
\r\n
\r\n \r\n
\r\n \r\nFilter: filter=complaintNumber~=PLU001;claimNumber_=test;and$capturedBy>=2024-08-10&order=capturedBy;desc\r\nEquivalent: (complaintNumber LIKE '%PLU001%' AND claimNumber LIKE 'test%') OR (capturedBy >= '20240810') ORDER BY capturedBy DESC\r\n\r\nFilter: filter=complaintNumber~=PLU001;claimNumber_=test;and$capturedBy>=2024-08-10&order=capturedBy\r\nEquivalent: (complaintNumber LIKE '%PLU001%' AND claimNumber LIKE 'test%') OR (capturedBy >= '20240810') ORDER BY capturedBy ASC\r\n
\r\n \r\n
\r\n
\r\n
\r\n \r\n
\r\n To return the data in manageable chunks, include the pageNumber and pageSize parameters in the query string\r\n of your request. Tip: use the HATEOAS media type to include paging information in the x-pagination header\r\n and navigation links in the data responses.\r\n
\r\n
\r\n
\r\n pageNumber The page number to request. The default is 1.pageSize The page size to retrieve. The minimum page size is 5 and the maximum is 20.
\r\n \r\n
\r\n \r\n
\r\n \r\nGET /complaints?pagenumber=5&pagesize=15&fields=complaintId,complaintNumber\r\nAuthorization: Bearer {access-token}\r\nCen-Authorization: {user-key}\r\nAccept: application/vnd.centriq.hateoas+json\r\n\r\n \r\n
\r\n
\r\n \r\n
\r\n \r\napi-supported-versions: 1.0\r\ncontent-length: 64806\r\ncontent-type: application/vnd.centriq.hateoas+json; charset=utf-8\r\ndate: Wed,28 Aug 2024 06:56:44 GMT\r\nx-pagination: {\"totalCount\":120,\"pageSize\":15,\"currentPage\":5,\"totalPages\":12,\"hasNext\":true,\"hasPrevious\":true} \r\n\r\n \r\n
\r\n
\r\n
\r\n \r\n
\r\n \r\n{\r\n\t\"value\": [\r\n ...\r\n\t],\r\n\t\"links\": [\r\n\t\t{\r\n\t\t\t\"href\": \"https://sample.com/api/v1/complaints?pageNumber=5&pageSize=15&fields=complaintId,complaintNumber\",\r\n\t\t\t\"method\": \"GET\",\r\n\t\t\t\"rel\": \"self\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"href\": \"https://sample.com/api/v1/complaints?pageNumber=4&pageSize=15&fields=complaintId,complaintNumber\",\r\n\t\t\t\"method\": \"GET\",\r\n\t\t\t\"rel\": \"previousPage\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"href\": \"https://sample.com/api/v1/complaints?pageNumber=6&pageSize=15&fields=complaintId,complaintNumber\",\r\n\t\t\t\"method\": \"GET\",\r\n\t\t\t\"rel\": \"nextPage\"\r\n\t\t}\r\n\t]\r\n}\r\n\r\n \r\n
\r\n
\r\n
\r\n \r\n
\r\n If the client attempts to fop on fields that are not available on the main resource object, a 400 Bad Request error\r\n will be returned indicating which fields are invalid.\r\n
\r\n
\r\n Fopping is only supported for top-level fields. If an object contains a sub object, such as policyType in the\r\n following example, specifying these sub-fields like policyType.Id will not work and a 400 Bad Request error\r\n will be returned.\r\n
\r\n
\r\n \r\n
\r\n \r\nGET /repudiations?fields=repudiationId,repudiationNumber,policyType.Id\r\nAccept: application/json\r\n
\r\n \r\n
\r\n
\r\n \r\n
\r\n \r\nHTTP/1.1 400 Bad Request\r\nContent-Type: application/json\r\n{\r\n \"type\": \"https://tools.ietf.org/html/rfc9110#section-15.5.1\",\r\n \"title\": \"Invalid filter parameters request.\",\r\n \"status\": 400,\r\n \"detail\": \"Invalid request information for ordering, filtering and/or field selection.\",\r\n \"instance\": \"/repudiations\",\r\n \"errors\": [\r\n \"Field 'policyType.id' from the provided fields (repudiationId,repudiationNumber,policyType.Id) is not part of the requested object's fields\"\r\n ]\r\n}\r\n\r\n \r\n
\r\n
\r\n
\r\n
\r\n
\r\n The API supports uploading and downloading of documents for repudiations and complaints.\r\n
\r\n
\r\n
\r\n \r\n
\r\n Supporting documents can only be uploaded and linked once a repudiation or complaint has been created.\r\n File uploading is performed asynchronously and must be uploaded using the multipart/form-data content-type header.\r\n Any files larger than 50MB will be rejected during the upload process. Multiple files must be uploaded one request at a time.\r\n Use the following pattern to upload a file and set its metadata properties:\r\n
\r\n
\r\n \r\n
\r\n \r\nPOST /complaints/1234/documents\r\nContent-Type: multipart/form-data; boundary=--------------------------335103822890214364100610\r\nAccept: application/json\r\nAuthorization: Bearer {access-token}\r\nCen-Authorization: {user-key}\r\nContent-Length: 15357\r\n----------------------------335103822890214364100610\r\nContent-Disposition: form-data; name=\"File\"; filename=\"photo.jpg\"\r\n<photo.jpg>\r\n----------------------------335103822890214364100610\r\nContent-Disposition: form-data; name=\"FileCategoryId\"\r\n16\r\n----------------------------335103822890214364100610--\r\n\r\n \r\n \r\n
\r\n \r\n{\r\n \"complaintId\": 1234,\r\n \"fileType\": {\r\n \"disabled\": false,\r\n \"id\": 16,\r\n \"name\": \"Other\"\r\n },\r\n \"name\": \"photo.jpg\",\r\n \"size\": \"15035\",\r\n \"extension\": \".jpg\",\r\n \"downloadLink\": \"https://sample.com/api/v1/complaints/1234/documents/12345\",\r\n \"id\": 12345,\r\n \"createdBy\": \"adam@plumtree.co.za\",\r\n \"createdDate\": \"2024-08-27 11:21:20\",\r\n \"modifiedBy\": \"adam@plumtree.co.za\",\r\n \"modifiedDate\": \"2024-08-27 11:21:20\"\r\n}\r\n\r\n \r\n
\r\n
\r\n
\r\n \r\n
\r\n The C3-Suite system currently supports the files formats listed below. Any other file formats not approved by Centriq will be rejected\r\n during upload. Should you need to submit a file format that is not in this list please contact\r\n IT Support for assistance.\r\n
\r\n
\r\n
\r\n \r\n - \r\n GIF Image:\r\n
\r\n - Extension(s): .gif
\r\n - Description: GIF image files are commonly used on the web to display graphics and logos. They also support basic animation, which means they’re a popular file format for memes on social media sites. Learn more about the key features of a GIF file, how to create one, and the advantages and disadvantages of the GIF format.
\r\n
\r\n \r\n - \r\n Joint Photographic Experts Group:\r\n
\r\n - Extension(s): .jpeg, .jpg, .jfif
\r\n - Description: JPEG stands for Joint Photographic Experts Group, an international organization that standardized the format during the late 1980s and early 1990s. It’s the go-to file format for digital images — and it has been ever since photographers began snapping and storing images on digital cameras and other reprographic devices.
\r\n
\r\n \r\n - \r\n Portable Network Graphics:\r\n
\r\n - Extension(s): .png
\r\n - Description: The PNG file format is widely used on websites to display high-quality digital images. Created to exceed the performance of GIF files, PNGs offer not just lossless compression, but also a much broader and brighter color palette. Read on to discover the pros and cons of PNGs, their main uses, and how to create a PNG image.
\r\n
\r\n \r\n - \r\n High Efficiency Image Container:\r\n
\r\n - Extension(s): .heic
\r\n - Description: HEIC stands for High Efficiency Image File, Apple’s new image container format that compresses photos in order to save space. HEIC image files are available on iPhone 7 and later models running iOS 11 or later operating systems.
\r\n
\r\n \r\n - \r\n ZIP:\r\n
\r\n - Extension(s): .zip
\r\n - Description: A file format that can contain multiple files combined and compressed into one file. Files that are zipped have a file extension of .zip. Since it's a type of compressed file, a zip file can be smaller in size than the files it contains. This makes the zip file easier and faster to download.
\r\n
\r\n \r\n - \r\n Moving Picture Experts Group (MPEG):\r\n
\r\n - Extension(s): .mpeg
\r\n - Description: Moving Picture Experts Group (MPEG) is a digital video standard for compression of full-motion images. The compression ratios achieved with MPEG encoding make it an ideal standard for the delivery of digital video data.
\r\n
\r\n \r\n - \r\n Tagged Image File Format:\r\n
\r\n - Extension(s): .tif, .tiff
\r\n - Description: Tag Image File Format or Tagged Image File Format, commonly known by the abbreviations TIFF or TIF, is an image file format for storing raster graphics images, popular among graphic artists, the publishing industry, and photographers.
\r\n
\r\n \r\n - \r\n MP3 File Format:\r\n
\r\n - Extension(s): .mp3
\r\n - Description: MP3, a data compression format for encoding digital audio, most commonly music. MP3 files offered substantial fidelity to compact disc (CD) sources at vastly reduced file sizes.
\r\n
\r\n \r\n - \r\n MP4 video format:\r\n
\r\n - Extension(s): .mp4
\r\n - Description: An MP4 is a common “container format” for video files that allows you to store a lot of video and audio information in a smaller file size. If you edit or even play videos on your computer, chances are you’ve come across .MP4 video files.
\r\n
\r\n \r\n - \r\n M4V file format:\r\n
\r\n - Extension(s): .m4v
\r\n - Description: The M4V file format is a video container format developed by Apple and is very similar to the MP4 format. The primary difference is that M4V files may optionally be protected by DRM copy protection.
\r\n
\r\n \r\n - \r\n Portable Document Format:\r\n
\r\n - Extension(s): .pdf
\r\n - Description: PDF stands for \"portable document format\". Essentially, the format is used when you need to save files that cannot be modified but still need to be easily shared and printed. Today most devices have a version of Adobe Reader or can open a PDF in an Internet Browser.
\r\n
\r\n \r\n - \r\n Comma-separated values (CSV):\r\n
\r\n - Extension(s): .csv
\r\n - Description: A CSV (comma-separated values) file is a text file that has a specific format which allows data to be saved in a table structured format.
\r\n
\r\n \r\n - \r\n WMA (Windows Media Audio) File Format:\r\n
\r\n - Extension(s): .wma
\r\n - Description: A file with the WMA file extension is a Windows Media Audio file. Microsoft created this lossy format to compete with MP3, so it's often used for streaming online music.
\r\n
\r\n \r\n - \r\n Audio Video Interleave (AVI):\r\n
\r\n - Extension(s): .avi
\r\n - Description: AVI stands for Audio Video Interleave. It's a video file format developed by Microsoft in 1992 to store video and audio data in a single file. AVI files can be played back synchronously with audio and video.
\r\n
\r\n \r\n - \r\n Text File (TXT):\r\n
\r\n - Extension(s): .txt
\r\n - Description: Files that contain plain text without any formatting or styling. The .TXT file extension is commonly used in Microsoft Windows such as Notepad.
\r\n
\r\n \r\n - \r\n Ogg Vorbis (OGG):\r\n
\r\n - Extension(s): .ogg, .oga, .ogv
\r\n - Description: OGG is an Ogg Vorbis Compressed Audio File that is saved with the .ogg extension. OGG files are used for storing audio data and can include artist and track information and metadata as well. OGG is a free and open container format that is maintained by Xiph.Org Foundation.
\r\n
\r\n \r\n - \r\n BMP format:\r\n
\r\n - Extension(s): .bmp, .dib
\r\n - Description: The BMP format is an uncompressed raster file designed to display high-quality images on Windows and store printable photos.
\r\n
\r\n \r\n - \r\n EML File Format (EML):\r\n
\r\n - Extension(s): .eml
\r\n - Description: In the simplest terms, an email saved in plain text. Plain text means no special formatting of the text, graphics, or images. However, EML format will contain the email content, subject line, and sender information along with certain other details.
\r\n
\r\n \r\n - \r\n ICO - Image File Format (ICO):\r\n
\r\n - Extension(s): .ico
\r\n - Description: The ICO file format is an image file format for computer icons in Microsoft Windows. ICO files contain one or more small images at multiple sizes and color depths, such that they may be scaled appropriately.
\r\n
\r\n \r\n - \r\n M3U file Format:\r\n
\r\n - Extension(s): .m3u, .m3u8
\r\n - Description: An M3U file is a plain text file that specifies the locations of one or more media files. The file is saved with the \"m3u\" filename extension if the text is encoded in the local system's default non-Unicode encoding (e.g., a Windows codepage), or with the \"m3u8\" extension if the text is UTF-8 encoded.
\r\n
\r\n \r\n
\r\n \r\n
\r\n
\r\n \r\n
\r\n Repudiation or complaint documents will be downloaded in the format originally uploaded in. Use the application/octet-stream\r\n accept header to download the file. Multiple files must be downloaded one request at a time. Use the following pattern\r\n to download a file:\r\n
\r\n
\r\n \r\n
\r\n \r\nGET /complaints/1234/documents/12345\r\nAuthorization: Bearer {access-token}\r\nCen-Authorization: {user-key}\r\nAccept: application/octet-stream\r\n\r\n \r\n \r\n
\r\n \r\n api-supported-versions: 1.0 \r\n content-disposition: attachment; filename=\"photo.jpg\"; filename*=UTF-8''photo.jpg \r\n content-length: 15035 \r\n content-type: image/jpeg \r\n date: Tue,27 Aug 2024 08:26:21 GMT \r\n
\r\n \r\n
\r\n
\r\n
\r\n
\r\n In a case where a claim is disputed or repudiated by a partner, the claim should be referred to Centriq for further evaluation. The picture below\r\n shows the established evaluation process that is followed by Centriq's claim team to thoroughly review the claim according to predefined\r\n criteria before a final decision is made.\r\n ![\"Repudiation](\"../images/repudiationprocess.png\")
\r\n
\r\n
\r\n To submit a repudiation for evaluation, the client application must use the Submit a repudiation endpoint.\r\n The client must ensure that all the required information and documents are\r\n provided before submission so that the evaluation process can run seamlessly.\r\n
\r\n
\r\n \r\n
\r\n The client will be required to complete various tasks to facilitate the repudiation process to\r\n completion. Tasks will be assigned to the client user who captured the repudiation. Below is a list of tasks at which user intervention\r\n will be required from client users during the repudiation evaluation process.\r\n
\r\n
\r\n
\r\n - \r\n More Information Required.\r\n
\r\n \r\n | Task Description | \r\n Available Action(s) | \r\n \r\n
\r\n \r\n | \r\n The More information tasks is assigned to the client user when Centriq's claim department requires additional\r\n information or documentation in order to correctly evaluate the repudiation. The evaluation process will stop up\r\n until the client user has provided the required information.\r\n | \r\n \r\n \r\n - Route back to Claims -
This action will route back the workflow to the Centriq claims team to evaluate the repudiation with the additional information that was request from the client.\r\n \r\n | \r\n
\r\n
\r\n \r\n - \r\n Repudiation Approved.\r\n
\r\n \r\n | Task Description | \r\n Available Action(s) | \r\n
\r\n \r\n | \r\n The repudiation approved tasks is assigned to the client user to confirm if the repudiation letter was sent to the policyholder, the process will not complete if confirmation is not provided.\r\n | \r\n \r\n \r\n - Repudiation Letter Sent -
This action will complete the repudiation evaluation process and set the matter to closed.\r\n \r\n | \r\n
\r\n
\r\n \r\n - \r\n Repudiation Overturned.\r\n
\r\n \r\n | Task Description | \r\n Available Action(s) | \r\n
\r\n \r\n | \r\n The repudiation overturned task is assigned to the client if the Centriq's claim team has rejected or overturned the repudiation.\r\n The client has the option of agreeing or disagreeing with the decision and send the repudiation back to Centriq for evaluation with supporting information and or documents.\r\n | \r\n \r\n \r\n - Accept -
This action requires the client to confirm if the claim has been paid to the policyholder and provide the settlement amount thereof, completing the task with this action will complete the process and close the matter.\r\n - Disagree -
This action will route back the workflow to the Centriq claims team to re-evaluate the repudiation with the additional information or documentation to support the client's disagreement with the decision taken.\r\n \r\n | \r\n
\r\n
\r\n \r\n
\r\n \r\n
\r\n
\r\n
\r\n User tasks are actionable items assigned through various processes or workflows exposed by the Api that require the partner user to take\r\n certain decisions as part of the respective process. The repudiation evaluation process is an example\r\n of a process that involves user tasks to aid in the successful completion of the evaluation process.\r\n
\r\n
\r\n \r\n
\r\n When working with user tasks, the client application must first retrieve a list of tasks for a specific user using the\r\n \"Get a list of user tasks\" endpoint as shown in the example below.\r\n
\r\n
\r\n \r\n
\r\n \r\nGET /users/1234/tasks\r\nAuthorization: Bearer {access-token}\r\nCen-Authorization: {user-key}\r\nAccept: application/json\r\n\r\n \r\n \r\n
\r\n \r\n {\r\n \"value\": [\r\n {\r\n \"taskId\": \"12340987\",\r\n \"name\": \"More Information Required\",\r\n \"description\": \"Additional information has been requested by the Claims Department to process a repudiation for Claim number CLM12345, Party John Doe.\",\r\n \"taskType\": \"RepudiationMoreInformation\",\r\n \"startDate\": \"2024-09-10 11:39:55\",\r\n \"actions\": [\r\n \"Route back to Claims\"\r\n ],\r\n \"processId\": 1234,\r\n \"user\": {\r\n \"displayName\": \"John Doe\",\r\n \"email\": \"john.doe@clientcompany.com\",\r\n \"id\": 1234\r\n }\r\n }\r\n ]\r\n}\r\n \r\n \r\n
\r\n
\r\n
\r\n \r\n
\r\n The user must open the task to view the instructions using the \"Open a user task\" endpoint as\r\n shown in the example below.\r\n
\r\n
\r\n \r\n
\r\n \r\nGET /users/1234/tasks/12340987\r\nAuthorization: Bearer {access-token}\r\nCen-Authorization: {user-key}\r\nAccept: application/json\r\n\r\n \r\n \r\n
\r\n \r\n{\r\n \"actions\": [\r\n \"Route back to Claims\"\r\n ],\r\n \"details\": \"Please attach the policy schedule and repudiation letter.\",\r\n \"taskId\": \"12340987\",\r\n \"taskType\": \"RepudiationMoreInformation\"\r\n}\r\n\r\n \r\n
\r\n
\r\n
\r\n \r\n
\r\n Once the user has completed the instructions assigned, the task can then be completed by providing any comments as well as the action to be performed.\r\n Use the \"Complete a user task\" endpoint as shown in the example below.\r\n
\r\n
\r\n \r\n
\r\n \r\nPOST /users/1234/tasks/12340987\r\nAuthorization: Bearer {access-token}\r\nCen-Authorization: {user-key}\r\nAccept: application/json\r\nContent-Type: application/json\r\n{\r\n \"completionDetails\": {\r\n \"comments\": \"Please see attached policy schedule and repudiation letter.\",\r\n \"selectedAction\": \"Route back to Claims\"\r\n },\r\n \"details\": \"Please attach the policy schedule and repudiation letter.\",\r\n \"taskId\": \"12340987\",\r\n \"taskType\": \"RepudiationMoreInformation\"\r\n}\r\n\r\n \r\n \r\n
\r\n \r\nHTTP/1.1 204 No Content\r\nContent-Type: application/json\r\n{\r\n}\r\n\r\n \r\n
\r\n
\r\n
\r\n \r\n \r\n
\r\n Sometimes, a user may not be available or the appropriate person to action a task. In such cases, the user can reassign the task to another user\r\n to action. Use the \"Reassign a task from one user to another\" endpoint as shown in the example below.\r\n
\r\n
\r\n \r\n
\r\n \r\nPUT /users/1234/tasks/12340987?reassignUserId=5678\r\nAuthorization: Bearer {access-token}\r\nCen-Authorization: {user-key}\r\nAccept: application/json\r\n\r\n \r\n \r\n
\r\n \r\nHTTP/1.1 204 No Content\r\nContent-Type: application/json\r\n{\r\n}\r\n\r\n \r\n
\r\n
\r\n