NameDescriptionTypeAdditional information
Reference

string

Required

String length: inclusive between 1 and 12
CustomerID

string

Required

Matching regular expression pattern: \d{3}[-]\d{6}

String length: inclusive between 10 and 10
Company

Optional. Name of the company / organisation.

 string

String length: inclusive between 0 and 50
Line1

Optional. The first line of the address i.e. Flat 173

 string

String length: inclusive between 0 and 256
Line2

Optional. The second line of the address i.e. Mulberry House

 string

String length: inclusive between 0 and 50
Line3

The third line of the address

 string

String length: inclusive between 0 and 50
PostalTown

The postal town or city. i.e. London

 string

String length: inclusive between 0 and 50
Region

The county or state i.e. Dorset or California

 string

String length: inclusive between 0 and 50
PostCode

The postal or zip code.

 string

String length: inclusive between 0 and 20
CountryCode

The 2 digit country code, see api/Countries/Search

 string

Required

String length: inclusive between 2 and 2
Active

If the address is active (in use). Defaults to True if not passed.

 boolean

None.