customer/v1/complaint
[POST] /customer/v1/complaint
Allow customers to create a complaint
Effective complaint management is crucial for a comprehensive compliance program. Complaints provide insights to enhance customer satisfaction, program delivery, and service quality, while aiding examiners in assessing consumer compliance and risk. This system allows customers to submit concerns directly through the client's application, creating a case in a secure database. This ensures clear and effective complaint management that meets examiner standards.
This endpoint allows customers to submit concerns regarding experiences within the client's application on the Avenu platform. A submission should include details of the concern as well as the complainants information and relevant identifiers for the issues presented. The Content Type for the request is multipart/form-data
with TEXT jsonData
and FILE files
required. The value for files
is optional. Avenu accepts the following file formats; it is up to client discretion what format they will request or allow. File Format: PNG, JPG, JPEG, PDF
Example [POST] Request jsonData
jsonData
{{avenu_base_url}}customer/v1/complaint
{
"productType": "",
"serviceType": "",
"customerComplainingAbout": "",
"detailsOfIssue": "",
"dateEventOccurred": "",
"deviceIdentity": {
"deviceId" : "",
"deviceType" : "",
"deviceName" : "",
"deviceOperatingSystem" : "",
"deviceIPAddress" : "",
"deviceLocation" : "",
"deviceLongitude" : "",
"deviceLatitude" : "",
"deviceUser" : "",
"deviceIMEINumber" : "",
"deviceTorEnabled" : "",
"deviceFirstSeen" : "",
"deviceLastSeen" : ""
}
}
JSON object Parameters
Parameter | Format | Length Restriction | Required? | Explanation |
---|---|---|---|---|
"productType" | String | Must be one of the following strings, we recommend auto filling this Checking Account | Y | The product type for the complaint (Checking Account) |
"serviceType" | String | Must be one of the following strings, we recommend creating a picklist ACH Debit Card Peer to Peer Payment | N | The service type for the complaint. (ACH, Debit Card, Peer to Peer Payment) |
"customerComplainingAbout" | String | Must be one of the following strings, we recommend creating a picklist Opening an account Managing an account Closing an account Problem with fees or penalties Problem caused by funds being low Deposit and withdrawals Problem using debit card or ATM card Funds not handled or disbursed as instructed Banking errors Problem accessing account Problem making or receiving payments | Y | What the customer complaint is about |
"detailsOfIssue" | String (long) | 3,200 | Y | Details of Issue |
"dateEventOccurred" | String | String, ISO 8601 YYYY-MM-DD | Y | Date Only |
"deviceId" | String | 100 | N | The user's unique device identifier. |
"deviceType" | String | 50 | N | The type of the user's device |
"deviceName" | String | 100 | N | The name given to the user's device. |
"deviceOperatingSystem" | String | 100 | N | The OS of the user's device. |
"deviceIPAddress" | String | 15 | N | Current IP Address for the device. |
"deviceLocation" | String | 100 | N | Current location for the device. |
"deviceLongitude" | String | 50 | N | Device's location longitude. |
"deviceLatitude" | String | 50 | N | Device's location latitude. |
"deviceUser" | String | 50 | N | The name of the user of the device. |
"deviceIMEINumber" | String | 15 | N | Mobile device unique equipment identifier. |
"deviceTorEnabled" | Boolean | 1 | N | Device is/is not using Tor browser. |
"deviceFirstSeen" | String, ISO 8601 YYYY-MM-DD | 10 | N | Date the device was first used to access Avenu. |
"deviceLastSeen" | String, ISO 8601 YYYY-MM-DD | 10 | N | Date the device was last used to access Avenu |
Example Response
{
"customerID": "",
"customerName": "",
"complaintID": "This will be Avenu UUID of the complaint",
"productType": "",
"customerComplainingAbout": "",
"detailsOfIssue": "",
"dateComplaintRecieved": ""
}
Response Parameters
Parameter | Format | Explanation |
---|---|---|
"customerID" | String | Customer's identification number |
"customerName" | String | Customer's first and last name |
"complaintID" | String | Avenu provided UUID of the complaint |
"productType" | String | The product type for the complaint (ACH, Debit Card, Peer to Peer Payment) |
"customerComplainingAbout" | String | What the customer complaint is about |
"detailsOfIssue" | String | Details of Issue |
"dateComplaintReceived" | String, ISO 8601 YYYY-MM-DD | Date Only |
Error Codes
For Required, Size, and Format restrictions an error code may be returned for each field. Errors related to the endpoint fields will be returned as an AP error with a description. Only one error code is returned per field each time in that order. For example, if firstName
is >50 characters and has special characters, only the size restriction error code and message will be sent back first as:
{
"code": "CA3107",
"message": "firstName: Invalid Length"
}
Category | Response Code | Response Error Message |
---|---|---|
Required | CA3000 | {Field Name} : Missing Required Field |
Size | CA3107 | {Field Name} : Invalid Length |
Format | CA3107 | {Field Name} : Invalid Format |
Required | CA3104 | Invalid Data |
Complaints | AP3002 | {Field Name} : Invalid Data |
Complaints | AP9000 | File Type Is Not Valid (attachment is incorrect type) |
Complaints | AP9001 | File Size Is Too Large (attachment is too large) |
Complaints | AP9002 | Unexpected Erorr While Processing File Please Contact Support |
Complaints | AP9003 | File Name Already Exists |
Complaints | XH3007 | Invalid Data (submitted an incorrect serviceType) |
Webhook Notifications
Please reference the Webhooks page for information on Complaint webhook notifications.
Updated 8 days ago