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

• Provide address information when creating the Connect session to skip this step.
• The address is used to identify available providers, tariffs, and programmes.
• If omitted, Connect will prompt the customer to enter it.

• 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": ""
    }
  }
}

​

Actions

Following actons are supported when responding to Connect on this route:

Action	Result
BACK	Returns previous page. If unavailable, returns callback_url.
CLOSE	Returns callback_url you specified when creating the Connect token.

​

Errors

When you POST your response to Connect, the following validation errors may be returned:

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.