Address Input

Documentation Index

Fetch the complete documentation index at: https://docs.flatpeak.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Developer notes

• Skip this step if possible: Include postal address information in create-connect-token request to streamline the flow.
• Purpose: The postal address defines the location context for tariff discovery and connection.
• Impact: If you do not pre-populate the address, the Connect API will prompt the customer to enter it during the flow.

• Preview
• Code

Consider adding an address lookup service such as Google Place Autocomplete for a better customer experience and to avoid server-side errors when the customer types an invalid address.

Connect response

Your POST to Connect (data)

Your POST to Connect (action)

{
  "connect_token": "cot_6587fa4362341be5b524de3b",
  "route": "postal_address_input",
  "live_mode": false,
  "data": {
    "postal_address": {
      "address_line1": "",
      "address_line2": "",
      "city": "",
      "state": "",
      "post_code": "",
      "country_code": ""
    }
  }
}

When you POST the response, Connect may return any of these validation errors:

Error Code	Error Description
address_line1_missing	Address line 1 is required.
city_missing	City name is required.
post_code_missing	Post code is required.
country_code_missing	Country code is required.
country_code_invalid	Country code must be in two-letter ISO 3166-1 alpha-2 format.
geo_location_not_found	Unable to resolve Geo location, provide complete address.
data_json_invalid	Data does not conform to the JSON schema.