Home🔒 DocumentationAPI Reference🔒 Changelog
FIX APIAPI Status

Address

This document has two types:

  1. ADDRESS_INFO: Details corresponding to the User
  2. JOINT_ADDRESS_INFO: Details corresponding to the Joint account holder linked to this User

When creating Joint accounts on the platform, both of these documents should be provided on the User object.

Attribute

Type

Description

Required

type

string

Type of user document. Default to "ADDRESS_INFO"

✅

data

object

Document object that contains all data for the "ADDRESS_INFO" user document

✅

data.street1

string

Street address

✅

data.street2

string

Street address, continued

❌

data.city

string

City

✅

data.province

string

For U.S., use USPS postal abbreviations, outside of U.S. use the standard province/territory name

✅

data.postalCode

string

Postal code

✅

data.country

string

Country which user resides. Follows the ISO 3166-1 alpha-3 standard. Use List All Countries

✅

{
  "type": "ADDRESS_INFO",
  "data": {
    "street1": "123 Main St",
    "street2": "Apt. 201",
    "city": "Sugartown",
    "province": "TX",
    "postalCode": "41992",
    "country": "USA"
  }
}

📘

Sanitizing Address Data

It is good practice to have address data standardized across all users for better searching and improved account monitoring functionality. To accomplish this DriveWealth recommends integrating with a mapping vendor such as the Google Place Autocomplete API for the collection of standardized data. Utilizing this API will also provide a better user experience due to the pre-population of address data.