Right to Access API
U-Assist, being a data processor, can enable its client's customer (end user) to obtain a copy of their personal data along with supplementary information that is stored and processed in the application. This helps the end user to understand whether their personal information is handled lawfully by their service provider.
This API returns the customer PII data for the specific customer id provided by the Client. It fetches the data that is processed in a specific timeframe.
The number of records that can be fetched from each collection in the first request of the API can be configured in environment file.
Endpoint
Method: GET
URL: /api/v2/data/customer
Request
curl -H "Authorization: Bearer 911999706310ffbcb32981863e23ce72d5e60d7b" -XGET "https://api.<region>.cloud.uniphore.com/api/v2/data/customer"
Header Parameter
Header Parameter | Description |
|---|---|
| Bearer <Token> is used to authorize this API. The access token should be sent with all client requests. The access token helps the server to validate the request source. |
Query Parameters
Query Parameters | Description | Data Type | Required / Optional |
|---|---|---|---|
| requestId is provided by the user to track multiple requests initiated for the same customer. If the user does not provide a request Id then the system automatically generates and assigns it to the request. | String | Optional |
| Id of the user who initiates the request. | String | Optional |
| Id of the customer whose PII needs to be fetched from the mongo database collection. The customer id can be extracted from the audio logger/connector. The procedure to collect the customer id is defined in the U-Assist Administrator guide under the section “Extract Customer id from Audio Logger/Connector”. | String | Required |
| Start Time of the time duration for which the customer wants to fetch their data. Start time should be entered in Time Stamp format. | Integer | Required |
| End Time of the time duration for which the customer wants to fetch their data. End time should be entered in Time Stamp format. | Integer | Required |
| Offset is used to implement pagination in the response and sets the record count which needs to be fetched in each batch. If offset value is not given, then 10 is stored as the default value and each query fetches 10 records. | Number | Optional |
Example Request
{
"requestId": "22221123121231",
"userId": "1231231",
"customerId": "111222",
"startTime": "1615841783329",
"endTime": 1615841849344",
"offset": 10
}
Example Response
{
"data": {
"customerId": "12122",
"callData": [
{
"conversationId": "1615841484740tamdeho78",
"transcripts": [
"good afternoon hannah my name is john and i see you're calling about your pending claim eight six seven five three one nine we can take care of it right away ",
"but yeah this is the fourth time am contacting you and it's been weeks now and i still haven't received any money what's going on ",
"i understand your frustration i see your claim is ready to be paid but we need your approval of the settlement terms which we can take care of right now ",
"one anybody tell me this i never saw your request came through for approval ",
"i'm sorry about that let's take care of this right now i'll also re send you a copy but for now i just need your verbal agreement that by accepting the settlement you agree we can close out this matter and there will be no further action do you agree okay ron now that you accepted the terms you'll see a check within 5 business days ",
"yes one more thing i noticed there was a rate increase on my latest bill i don't think that's fair after just a single incident ",
"you're right i see they did go up however because you're a valued customer i can reverse surcharges effective immediately you okay with that ",
"okay yes that works for me thank you ",
"no thank you for your patience and understanding we value and appreciate your business thank you for calling a out of insurance goodbye "
],
"alerts": null,
"entities": [
"8675319",
"john",
"my name,my name is",
" afternoon hannah my name is john and i see youre calling about your pending claim 8675319 we can take care of it right away, hannah my name is john and i see youre calling about your pending claim 8675319 we can take care of it right away",
"but yeah this is the 4 time am contacting you and its been weeks now and i still havent received any money whats going on",
" i see your claim is ready to be paid but we need your approval of the settlement terms which we can take care of right now",
" i see your claim is ready to be paid but we need your approval of the settlement terms which we can take care of right now",
" i see your claim is ready to be paid but we need your approval of the settlement terms which we can take care of right now",
"youre right i see they did go up however because youre a valued customer i can reverse surcharges effective immediately you okay with that",
"youre right i see they did go up however because youre a valued customer i can reverse surcharges effective immediately you okay with that"
],
"dispositions": [
"Claims/Accepted",
"Claims/Rate Increase/Reversed"
],
"sentiments": [
"NEUTRAL"
],
"summaries": [
"{\"format\":\"bulletPoint\",\"bullet\":[\"Customer query is but yeah this is the 4 time am contacting you and its been weeks now and i still havent received any money whats going on. Claim number is 8675319\",\"Customer has called regarding the Claims and it has been accepted.\",\"Adding Name i see your claim is ready to be paid but we need your approval of the settlement terms which we can take care of right now\",\"Claim number is 8675319\",\"Name is john\"],\"paragraph\":null}",
"{\"format\":\"bulletPoint\",\"bullet\":[\"Agent Reasoning youre right i see they did go up however because youre a valued customer i can reverse surcharges effective immediately you okay with that\",\"Customer has called regarding the Claims. There has been a rate increase for the Customer and it has been reversed.\",\"Adding Name i see your claim is ready to be paid but we need your approval of the settlement terms which we can take care of right now\",\"Claim number is \",\"Name is \"],\"paragraph\":null}"
],
"promises": null,
"promiseEntities": null
}
],
"currentOffsets": 20,
"recordCount": 20
},
"errors": ""
}
Response Parameters
Response Parameters | Description |
|---|---|
| Customer who initiated the fetch request. |
| Id of the conversation happened during the given timeframe. |
| Transcripts of the call |
| Alerts notified during the call |
| Entities identified in the call |
| Disposition of the call |
| Sentiment of the call |
| Summary generated for the call |
| Promises identified in the call |
| Entities identified in the Promises |
| The offset value given in the request |
| Total records found for the customer in the given timeframe |
Response and Error Codes
Response and Error Code | Description |
|---|---|
200 | The GET request is processed and display the above given response. |
401 | Authentication failed |
404 | Invalid customer-id |
500 | Internal server error |