Addresses Object

Addresses Object attributes.

Attributes

Name

Type

Description

city_name

string

City name of the address.

postal_code

string

Postal code of the address.

address

string

Full address.

description

string

Description of the address.

external_reference_id

string

Optional identifier for the address in the customer’s external system. Maximum length is 100 characters.

verified

boolean

Displays if Address is verified.

created_at

Date&Time

Creation date and time of the address.

Relationships

Name

Type

Description

identity

to-one

Identity Object. Returns the identity assigned to the address.

country

to-one

Country Object. Returns the country assigned to the address.

proofs

to-many

Proofs Object. Returns the proofs assigned to the address.

area

to-one

Area Object. Returns the area assigned to the address.

city

to-one

City Object. Returns the city assigned to the address.