Structured addresses

Vitesse uses a structured postal address model aligned to ISO 20022.

Use this format wherever a postal address is required, for example for recipient mailing addresses.

Address structure rules

For street information, provide either:

StreetName and BuildingNumber, or
Up to two AddressLines: Line 1 (and optionally Line 2), when structured street fields are not available
For example:
```
AddressLines: [
  "Suite 46",  
  "Floor 5"  
]
```

If you provide StreetName and BuildingNumber, you can also use address lines for additional details such as floor, unit, building name, or department.

📘
You must provide the mandatory fields listed below, whether you use structured street fields or address lines.

Structured address fields

For APIs, use the API field column.
For batch files, use the CSV header column.

If you need to provide a postal (mailing) address in a batch file, replace the RecipientAddress prefix with PostalRecipientAddress.

For example: RecipientAddressStreetName becomes PostalRecipientAddressStreetName.

📘
Fields marked with * are mandatory. Bracketed asterisks (*) are for mandatory parameters with exceptions.

API field	CSV header	Definition	Example
`StreetName`(*)	RecipientAddressStreetName(*)	The street name. Provide this field together with `BuildingNumber` unless you are using address lines instead.	Main Street
`BuildingNumber`(*)	RecipientAddressBuildingNumber(*)	The building or street number. Provide this field together with `StreetName` unless you are using address lines instead.	742
`TownName`*	RecipientAddressTownName*	The city or town.	Springfield
`PostCode`*	RecipientAddressPostCode*	The postal or ZIP code (maximum 10 characters).	62704
`CountrySubDivision`*	RecipientAddressCountrySubDivision*	The two-character US state code.	IL
`Country`*	RecipientAddressCountry*	The two-character ISO 3166-1 alpha-2 country code. For cheques, you must use `US`.	US
`AddressLines [ ]`() See Address structure* above.	RecipientAddressLine1(*)	Additional address detail (for example, floor, unit, building name, or department), or the street alternative when structured street fields are not provided.	Suite 46
	RecipientAddressLine2	Optional additional complimentary address detail. Do not provide this field when `StreetName` and `BuildingNumber` are supplied.	Floor 5
The following fields apply only to postal recipient addresses for cheque payments:
`Name`	PostalRecipientName(*)	The addressee name when the postal recipient is an individual. This value is printed as the For Attention Of name on the envelope. Provide either `Name` or `CompanyName`, not both.	Michael Thompson
`CompanyName`	PostalRecipientCompanyName(*)	The addressee name when the postal recipient is a business. This value is printed as the company name on the envelope. Provide either `Name` or `CompanyName`, not both.	Vitesse PSP Limited