Edit Customer Address
The fields and formats needed for the EditCustomerAddress conversation are listed in this section.
Brokers have a way to modify a customer's address information with the EditCustomerAddress request. The request is verified, and any inaccuracies are returned for correction.
Method | POST |
url | /editcustomeraddress |
Request example
{
"clientCode": "CC",
"shopCode": "XXXX",
"EditCustomerAddressRequestType":{
"BrokerReference": "3607\/009",
"accountNumber":"910000016970",
"address": {
"houseNumber": "2",
"houseName":"Test Name",
"streetName": "Avenue Court",
"addressLineOne":"Test line 1",
"postCode": "LS17 7RY",
"postTowm":"LEEDS",
"county":"yorkshire"
}
}
}
Response example
{
"data": {
"editCustomerAddressResponseType": {
"responseStatus": 1,
"responseStatusText": "Success"
},
"errors": null
},
"validationErrors": [],
"error": -1,
"error_description": null,
"successful": true
}
Fields
EditCustomerAddressRequestType
Node | Required | Type | Max Length | Notes |
---|---|---|---|---|
BrokerReference | Mandatory | String | 25 | This is a unique reference provided by the broker to identify the applicant. The broker can use this reference to identify and locate the applicant on the BNPP PF system. |
AccountNumber | Mandatory | String | 15 | This is the reference BNPP PF has assigned to the applicant as part of the new application process. It is used to locate the account and apply the transaction. It is mandatory to provide the AccountNumber and BrokerReference for EditCustomerAddressRequest. |
Address | Mandatory | Address | See Structure of Address. |
Address
Node | Required | Type | Max Length | Notes |
---|---|---|---|---|
HouseName | Optional | String | 35 | This is the applicant’s house name. If it is missing, HouseNumber is required. |
HouseNumber | Optional | String | 35 | This is the applicant’s house number. If it is missing, HouseName is required. |
Street Name | Mandatory | String | 35 | This is the applicant’s street name. |
Townland | Optional | String | 50 | This is the applicant’s townland. |
PostTown | Optional | String | 30 | This is the applicant’s post town. |
County | Optional | String | 35 | This is the applicant’s county. |
PostCode | Mandatory | String | 10 | This is the applicant’s postcode. |
AddressLineOne | Optional | String | 200 | This is a concatenated field comprising of the applicant’s HouseNumber, HouseName, StreetName Each one separated by a comma separated delimiter. Three address fields should be present (if either house number or house name is not present it should be blank) Eg: 17, ,Main Street ,Harmony Villa, Main Street 17,Harmony Villa ,Main Street |
EditCustomerAddressResponseType
Node | Required | Type | Max Length | Notes |
---|---|---|---|---|
ResponseStatus | Mandatory | Enum | This is the status of a response See ResponseStatus in Option Values |
Updated over 1 year ago