Skip to main content
Version: 4.18.1

Add Address

Add Address API will add the address for the requested user.

Resource Informations

Requires authentication?Yes
Rate limited?No


Request headers

AuthorizationBearer token

HTTP request URL

POST https://{hostname}/auth/realms/{tenantId}/address/{userName}/add

Digitanium support for this API will be provided on request.


API requests must be made over https. Calls made over plain http will fail.


No parameters fields are required.

Request body(*Required)

Field NameTypeDescription
firstNameStringfirstName of the user.
lastNameStringlastName of the user.
addressTypeStringDefine the place of the address.
addressTitleStringDefine the title given to the respective address.
cityStringDefine the city given for the address.
cityCodeStringDefine the cityCode given for the location.
townStringDefine the town the address is located.
townCodeStringDefine the townCode the address is located.
districtStringDefine the district the address is located.
districtCodeStringDefine the districtCode the address is located.
addressDetailsStringDescribe the details related to the address.
*postalCodeStringDefine the postalCode of the given address.
directionsStringProvide the direction for the address.
defaultAddressBooleanThe configured default address will be taken, if true.

Sample Request

"firstName" : "mark",
"lastName" : "jay",
"addressType" : "Home",
"addressTitle" : "Home address",
"city" : "scotland",
"cityCode" : "625531",
"town" : "hometown",
"townCode" : "625521",
"district" : "glasgow",
"districtCode" : "123456",
"addressDetails" : "addressDetails",
"postalCode" : "654321",
"directions" : "",
"defaultAddress" : true


Field NameTypeDescription
messageStringMessage explains result of the API call. Refer Response status Information for details.
statusStringThe status of the API call. Refer Response status Information for details.
subSystemIntegersubSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

"message": "Address added successfully",
"status": "Success",
"subSystem": 5

Response Status Information

Status CodeStatusMessage
200OKAddress added successfully
400BAD_REQUESTMandatory data is missing
401UnauthorizedHTTP 401 Unauthorized
404USER_NOT_FOUNDUser does not exist