All requests must first be Authorized and must use the HTTP PUT method over HTTPS.
This call allows you to update/add details of a consumer that is assigned to your account in DigitalHub.
https://api.vision-net.ie/cws/2.3/digital_hub/consumer/{{consumerId}}
URI parameters
Parameter | Type | Description |
---|---|---|
consumerId | Integer | Pk of a consumer you get in https://api.vision-net.ie/cws/2.3/digital_hub/consumer/list |
Simplest PUT Request Format in JSON
Full PUT Request Format in JSON
Parameters Details
Parameter | Type | Description |
---|---|---|
consumerId | String | (Required) Client reference number, must be an existing customer in DigitalHub |
refno | String | Client reference number |
firstName | String | First name of the customer |
lastName | String | Surname of the customer |
dateOfBirth | Date | Date of birth of the customer - format dd-MM-yyyy |
placeOfBirth | String | Country of the birth |
countryISOCode | String | Country ISO code for full country data. Code can be found here |
nationalityISOCode | String | Country ISO code for nationality of the consumer. Code can be found here |
currentCountyId | int | Current county ID number for the current county of the customer. ID can be found here |
previousCountyId | int | Previous county ID number for the current county of the customer. ID can be found here |
address | String | Address of the customer |
phone | String | Phone number of the customer |
String | Email of the customer | |
acceptStatus | Enum | Available values: ACCEPT, REJECT, REFER. Based on your business needs, you can store ACCEPT, REJECT or REFER in this field for due diligence or other purposes |
activeStatus | Enum | Available values: ACTIVE, INACTIVE. Based on your business needs, you can store ACTIVE or INACTIVE in this field. It could be used to filter out clients who no longer use your services for example |
parameterPK | int | PK for existing parameter type. Code can be found here |
parameterName | String | Parameter name for existing parameter type. Code can be found here |
parameterTypeCode | String | Parameter type code for existing parameter type. Code can be found here |
parameterDescription | String | Parameter description for existing parameter type. Code can be found here |
parameterValuePK | String | Parameter value pk if You want to edit an existing parameter assigned for the customer |
parameterValue | String | Parameter value |