Skip to content
Last updated

Card Address Validation

To create a card order, make sure to follow country-specific address fields and validation. If your country is not listed below, use the Other countries format.

For virtual cards, the address field will be used as a billing address. It will be used for AVS checks in countries where it is required.

For physical cards, the address field will be used as a delivery address. It will be used to deliver your card and for AVS checks in countries where it is required.

We do not support PO BOX addresses.

Supported countries:

  • Brazil — uses different address fields (addressNumber, address, district, complement)
  • Australia — requires state field with specific state codes
  • Other countries — default format using firstLine, secondLine, thirdLine

Brazil

Address fields

FieldTypeMax lengthRequiredDescription
addressNumberString6YesCard holder's address number
addressString100YesCard holder's address
districtString80YesCard holder's district
complementString28NoCard holder's complement
postCodeString8YesCard holder's postal code
cityString30YesCard holder's city
stateString10YesCard holder's state (see state codes below)
countryString2YesBR

State codes

CodeState
ACAcre
ALAlagoas
APAmapá
AMAmazonas
BABahia
CECeará
DFDistrito Federal
ESEspírito Santo
GOGoiás
MAMaranhão
MTMato Grosso
MSMato Grosso do Sul
MGMinas Gerais
PAPará
PBParaíba
PRParaná
PEPernambuco
PIPiauí
RJRio de Janeiro
RNRio Grande do Norte
RSRio Grande do Sul
RORondônia
RRRoraima
SCSanta Catarina
SPSão Paulo
SESergipe
TOTocantins

Example address

{
    "address": {
        "addressNumber": "134",
        "address": "Rua Moacir da Silva Mota",
        "district": "Tancredo Neves",
        "complement": null,
        "state": "RR",
        "city": "Boa Vista",
        "postCode": "69313488",
        "country": "BR"
    }
}

Validation

Field validation is performed on the following criteria:

  • value is required
  • value length
  • valid postCode for a country
  • valid state

Use the validate address endpoint to check your address before creating a card order.

Australia

Address fields

FieldTypeMax lengthRequiredDescription
firstLineString30YesCard holder's address
secondLineString30NoCard holder's address
thirdLineString30NoCard holder's address
postCodeString10YesCard holder's postal code
cityString30YesCard holder's city
stateString30YesCard holder's state (see state codes below)
countryString2YesAU

State codes

CodeState
ACTAustralian Capital Territory
NSWNew South Wales
NTNorthern Territory
QLDQueensland
SASouth Australia
TASTasmania
VICVictoria
WAWestern Australia

Example address

{
    "address": {
        "firstLine": "72 Botany Rd",
        "secondLine": "New South Wales",
        "thirdLine": null,
        "postCode": "2017",
        "city": "Sydney",
        "state": "NSW",
        "country": "AU"
    }
}

Validation

Field validation is performed on the following criteria:

  • value is required
  • value length
  • valid postCode for a country
  • valid state

Use the validate address endpoint to check your address before creating a card order.

Other countries

Address fields

FieldTypeMax lengthRequiredDescription
firstLineString30YesCard holder's address
secondLineString30NoCard holder's address
thirdLineString30NoCard holder's address
postCodeString10YesCard holder's postal code
cityString30YesCard holder's city
stateString30NoCard holder's state
countryString2YesISO 3166-1 alpha-2 country code

Example address

{
    "address": {
        "firstLine": "1 Paya Lebar Link",
        "secondLine": "#13-06 PLQ 2",
        "thirdLine": "Paya Lebar Quarter",
        "postCode": "408533",
        "city": "Singapore",
        "state": null,
        "country": "SG"
    }
}

Validation

Field validation is performed on the following criteria:

  • value is required
  • value length
  • valid postCode for a country

Use the validate address endpoint to check your address before creating a card order.

Validation response

The validate address endpoint returns a collection of errors on fields that did not pass the format validation. A successful address validation will return an empty errors collection.

{
    "errors": [
        {
            "field": "city",
            "message": "Required Field"
        },
        {
            "field": "postCode",
            "message": "Please enter a valid postcode"
        },
        {
            "field": "firstLine",
            "message": "Must be less than 30 characters"
        }
    ]
}