Paths
/v1/customers/profiles/addresses/confirmation
This API is required to confirm the customer’s address updates . This is triggered after multi factor authentication is successful.
This API is required to confirm the customer’s address updates . This is triggered after multi factor authentication is successful.
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==
128 bit random UUID generated uniquely for every request.
Content-Type that are acceptable for the response.
Client ID generated during application registration.
application/json
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Successful operation.
Partial Success.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| error | invalidControlFlowId | Control Flow Id is invalid |
| error | unAuthorized | Authorization credentials are missing or invalid |
| error | accessNotConfigured | Access is not configured for this resource |
| error | mfaRequired | MFA is required |
| error | transactionDenied | Transaction Denied |
| error | mfaRequired | MFA is required |
| Type | Code | Details |
| error | DocumentUploadRequired | Document Upload required |
| fatal | serverUnavailable | The request failed due to an internal error |
Definitions
{
"properties": {
"controlFlowId": {
"description": "Control Flow Id",
"type": "string",
"example": "6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d"
},
"identificationDocumentDetails": {
"$ref": "#/definitions/IdentificationDocumentDetails"
}
},
"required": [
"controlFlowId"
]
}
{
"properties": {
"idType": {
"description": "Type of Identification document.",
"type": "string",
"example": "VI"
},
"idNumber": {
"description": "Unique identifier of identification document. Ex: Passport Number",
"type": "string",
"example": "S42258011"
},
"idExpiryDate": {
"description": "Expiry date of identification document in ISO 8601 date format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": 1807401600000
},
"documentReferenceId": {
"description": "Reference Id to uniquely identify the transaction.This is applicable for successful transactions.",
"type": "string",
"example": 3789047384738738
}
}
}
{
"properties": {
"addressUpdateList": {
"type": "array",
"items": {
"$ref": "#/definitions/AddressUpdateDetails"
}
},
"card": {
"type": "array",
"items": {
"$ref": "#/definitions/Card"
}
},
"referenceId": {
"description": "Unique reference ID associated with the update customer address update request.",
"type": "string",
"example": 11000011100002232
}
}
}
{
"properties": {
"addressType": {
"description": "Type of the address.",
"type": "string",
"example": "HOME_ADDRESS"
},
"responseCode": {
"description": "Response code of the Address Update",
"type": "string",
"example": 4444
},
"responseMessage": {
"description": "Response Message of the Address Update",
"type": "string",
"example": "Free text"
}
}
}
{
"properties": {
"cardId": {
"description": "The card id in encrypted format",
"type": "string",
"example": "3255613852316f2b4d4d233213344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
},
"mailingIndicatorUpdResponseCode": {
"description": "Response code of the mailing indicator update.",
"type": "string",
"example": 6546
},
"mailingIndicatorUpdResponseMessage": {
"description": "Response Message of the mailing indicator update.",
"type": "string",
"example": "Free text"
}
}
}
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}