Add an Address to a Profile

POST /customervault/v1/profiles/profile_id/addresses

See our full API documentation for a complete description of the parameters required for the address creation request.

In the previous example you created a profile for a customer. As a result, the API returned a profile ID representing that profile.

The Customer Vault API allows you to add multiple addresses to your customer's profile. To add an address to the profile, you must use that profile ID and make a POST request to the addresses endpoint of the relevant profile.

Element Type Required? Description
city

string
length<=40

Yes This is the customer's city.
country string
length=2
Yes This is the customer's country.
defaultShippingAddressIndicator boolean No This is a flag marking this address as the default shipping address.
nickName

string
length<=50

No This is an alias for this address defined by the customer e.g., "home address".
phone string
length<=40
No This is the recipient's phone number.
recipientName string
length<=255
No This is the name of the recipient at this address, if it is different from the name in the profile.
state string
length<=40
No This is the customer's state/province/region.
street string
length<=50
Yes This The first line of the customer's address.
street2 string
length<=50
No This is the second line of the customer's address.
zip string
length<=10
Yes This is the customer's zip code.

You can look up the Profile and associated Address using a GET request as follows:

GET /customervault/v1/profiles/profile_id?fields=cards,addresses

The fields parameter is a comma-separated list of subcomponents to return. See the API Reference Section for more details.

Did you find this page useful?