Create Address

POST{baseUrl}/us/api/v1/kyc/addresses

Payload

Attribute	Type	Required	Description
userId	Integer	Yes	Target user ID.
type	Enum	Yes	MAILING \| RESIDENTIAL \| BUSINESS \| …
countryId	Integer	Yes	Internal country ID.
countryCode	String	No	ISO Alpha-3 (e.g., USA).
stateId	Integer	Yes	Internal state/province ID.
stateName	String	No	State/province name.
cityId	Integer	Yes	Internal city ID.
cityName	String	No	City name.
addressLine1	String	Yes	Street/building number etc.
addressLine2	String	No	Apartment/suite/floor.
postalCode	String	No	ZIP/postal code.
longitude	String	No	Longitude (decimal).
latitude	String	No	Latitude (decimal).

Request Example

{
  "userId": 604,
  "type": "MAILING",
  "countryId": 167,
  "countryCode": "USA",
  "stateId": 3169,
  "stateName": "California",
  "cityId": 85475,
  "cityName": "Los Angeles",
  "addressLine1": "123 Main Street",
  "addressLine2": "Apt 4C",
  "postalCode": "90091",
  "longitude": "-118.2437",
  "latitude": "34.0522"
}

Response

Field	Type	Description
id	Integer	Address record ID.
userId	Integer	Owner user ID.
type	Enum	Address type.
country	Object	`{ id, name }` of country.
countryCode	String	ISO Alpha-3 code (e.g., PAK).
state	Object	`{ id, name }` of state/province.
stateName	String	State/province name.
city	Object	`{ id, name }` of city.
cityName	String	City name.
addressLine1	String	Main address line.
addressLine2	String	Additional details.
postalCode	String	ZIP/postal code.
longitude	String	Longitude.
latitude	String	Latitude.
status	Boolean	Active (`true`) or inactive (`false`).

200 — SUCCESS

{
  "data": {
    "id": 11,
    "userId": 604,
    "type": "MAILING",
    "country": { "id": 167, "name": "Pakistan" },
    "countryCode": "PAK",
    "state": { "id": 3169, "name": "Islamabad Capital Territory" },
    "stateName": "Islamabad Capital Territory",
    "city": { "id": 85475, "name": "Islamabad" },
    "cityName": "Islamabad",
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4C",
    "postalCode": "90091",
    "longitude": "-118.2437",
    "latitude": "34.0522",
    "status": false
  }
}

Update Personal Info Update Address