RErev-io
Addresses

Get a single address by ID

Changed on

Find a single address by ID.

get/v1/Addresses/{id}

Request

Path parameters

idinteger required

Address ID to find

Response

OK

okboolean
address_idinteger

Primary identifier for this address.

customer_idinteger

Foreign identifier linking to an associated customer. Not needed for Service, Billing, or Listing addresses.

first_namestring

First name of person associated with this address. Not needed if Company_Name is filled.

middle_initialstring

Middle initial of person associated with this address.

last_namestring

Last name of person associated with this address. Not needed if Company_Name is filled.

company_namestring

Name of the company associated with this address. Not needed if First and Last Name is filled.

line_1string

First line of address. (i.e. Street Number, Street Name, Post Direction)

line_2string

Second line of address. (i.e. Apt, Unit, Floor)

citystring
state_or_provincestring

State if USA, Province for some other countries.

postal_codestring

Zip for USA (5-digit), can be longer for other countries.

postal_code_extensionstring

Zip+4 for USA

country_code'AFG' | 'ALA' | 'ALB' | 'DZA' | 'ASM' | 'AND' | 'AGO' | 'AIA' | 'ATA' | 'ATG' | 'ARG' | 'ARM' | 'ABW' | 'AUS' | 'AUT' | 'AZE' | 'BHS' | 'BHR' | 'BGD' | 'BRB' | 'BLR' | 'BEL' | 'BLZ' | 'BEN' | 'BMU' | 'BTN' | 'BOL' | 'BES' | 'BIH' | 'BWA' | 'BVT' | 'BRA' | 'IOT' | 'BRN' | 'BGR' | 'BFA' | 'BDI' | 'CPV' | 'KHM' | 'CMR' | 'CAN' | 'CYM' | 'CAF' | 'TCD' | 'CHL' | 'CHN' | 'CXR' | 'CCK' | 'COL' | 'COM' | 'COG' | 'COD' | 'COK' | 'CRI' | 'CIV' | 'HRV' | 'CUB' | 'CUW' | 'CYP' | 'CZE' | 'DNK' | 'DJI' | 'DMA' | 'DOM' | 'ECU' | 'EGY' | 'SLV' | 'GNQ' | 'ERI' | 'EST' | 'ETH' | 'FLK' | 'FRO' | 'FJI' | 'FIN' | 'FRA' | 'GUF' | 'PYF' | 'ATF' | 'GAB' | 'GMB' | 'GEO' | 'DEU' | 'GHA' | 'GIB' | 'GRC' | 'GRL' | 'GRD' | 'GLP' | 'GUM' | 'GTM' | 'GGY' | 'GIN' | 'GNB' | 'GUY' | 'HTI' | 'HMD' | 'VAT' | 'HND' | 'HKG' | 'HUN' | 'ISL' | 'IND' | 'IDN' | 'IRN' | 'IRQ' | 'IRL' | 'IMN' | 'ISR' | 'ITA' | 'JAM' | 'JPN' | 'JEY' | 'JOR' | 'KAZ' | 'KEN' | 'KIR' | 'PRK' | 'KOR' | 'XKX' | 'KWT' | 'KGZ' | 'LAO' | 'LVA' | 'LBN' | 'LSO' | 'LBR' | 'LBY' | 'LIE' | 'LTU' | 'LUX' | 'MAC' | 'MKD' | 'MDG' | 'MWI' | 'MYS' | 'MDV' | 'MLI' | 'MLT' | 'MHL' | 'MTQ' | 'MRT' | 'MUS' | 'MYT' | 'MEX' | 'FSM' | 'MDA' | 'MCO' | 'MNG' | 'MNE' | 'MSR' | 'MAR' | 'MOZ' | 'MMR' | 'NAM' | 'NRU' | 'NPL' | 'NLD' | 'NCL' | 'NZL' | 'NIC' | 'NER' | 'NGA' | 'NIU' | 'NFK' | 'MNP' | 'NOR' | 'OMN' | 'PAK' | 'PLW' | 'PSE' | 'PAN' | 'PNG' | 'PRY' | 'PER' | 'PHL' | 'PCN' | 'POL' | 'PRT' | 'PRI' | 'QAT' | 'REU' | 'ROU' | 'RUS' | 'RWA' | 'BLM' | 'SHN' | 'KNA' | 'LCA' | 'MAF' | 'SPM' | 'VCT' | 'WSM' | 'SMR' | 'STP' | 'SAU' | 'SEN' | 'SRB' | 'SYC' | 'SLE' | 'SGP' | 'SXM' | 'SVK' | 'SVN' | 'SLB' | 'SOM' | 'ZAF' | 'SGS' | 'SSD' | 'ESP' | 'LKA' | 'SDN' | 'SUR' | 'SJM' | 'SWZ' | 'SWE' | 'CHE' | 'SYR' | 'TWN' | 'TJK' | 'TZA' | 'THA' | 'TLS' | 'TGO' | 'TKL' | 'TON' | 'TTO' | 'TUN' | 'TUR' | 'TKM' | 'TCA' | 'TUV' | 'UGA' | 'UKR' | 'ARE' | 'GBR' | 'USA' | 'UMI' | 'URY' | 'UZB' | 'VUT' | 'VEN' | 'VNM' | 'VGB' | 'VIR' | 'WLF' | 'ESH' | 'YEM' | 'ZMB' | 'ZWE' | 'ANT' | 'SCG' | 'YUG'
created_datestring date-time

Created date of address

modified_datestring date-time

Modified date of address

is_provider_validatedboolean

Indicates the address has been validated with a service provider

is_USPS_validatedboolean

Indicates the address has been validated through the USPS

Changes

  • f175f5a3b11dRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type text/html for the response with the status

    • breaking

      removed the media type text/json for the response with the status

    • warning

      added the new ANT enum value to the response property for the response status (media type: application/json)

    • warning

      added the new ANT enum value to the response property for the response status (media type: text/json)

    • warning

      added the new ANT enum value to the response property for the response status (media type: text/html)

    • warning

      added the new SCG enum value to the response property for the response status (media type: application/json)

    • warning

      added the new SCG enum value to the response property for the response status (media type: text/json)

    • warning

      added the new SCG enum value to the response property for the response status (media type: text/html)

    • warning

      added the new YUG enum value to the response property for the response status (media type: application/json)

    • warning

      added the new YUG enum value to the response property for the response status (media type: text/json)

    • warning

      added the new YUG enum value to the response property for the response status (media type: text/html)