Key

Type

Description

Required

address_alias

string

This is a nickname that can be attached to the address object. While a required field, it can be left blank if desired.

true

street_address_1

string

This is line 1 of a street address. Post office boxes are not accepted in this field.

true

street_address_2

string

This is line 2 of a street address (optional). This may include suite or apartment numbers (though, if desired, you can put these in line 1).

false

city

string

Name of the city where the person being verified is a current resident.

true

state

string

Name of state where verified person is a current resident. (As of writing, this is a required field as the only accepted country is the US, but this may be expected to change in future versions.)

true

country

string

Two-letter country code. (As of writing, the only acceptable value is US.)

true

postal_code

string

In the US, this can be the 5-digit ZIP code or ZIP+4 code.

true

  

Referenced in Message Types:

  • entity_msg

Did this page help you?