Address Information

Address Information

NameDescriptionTypeRequired?Additional information
addressLine1 *

Address Line 1

string

Conditional

Conditionally required: If the user's address info doesn't exist in database, and any other address fields exists in request then it requires. For existing user's address, this field can be null.

String length: between 1 and 128, inclusive

addressLine2

Address Line 2

string

No

String length: between 1 and 128, inclusive

addressLine3

Address Line 3

string

No

String length: between 1 and 128, inclusive

city *

City

string

Conditional

Conditionally required: If the user's address info doesn't exist in database, and any other address fields exists in request then it require. For existing user's address, this field can be null.

String length: between 1 and 64, inclusive

administrativeArea

Administrative Area

string

No

String length: between 1 and 64, inclusive

postalCode

Postal Code

string

No

String length: between 1 and 16, inclusive

country

Country

string

No

String length: between 1 and 64, inclusive