Skip to main content
POST
/
addresses
/
validate
Validate an address
curl --request POST \
  --url https://panel.sendcloud.sc/api/v3/addresses/validate \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "address_line_1": "Stadhuisplein",
    "house_number": "50",
    "address_line_2": "Apartment 17B",
    "postal_code": "1013 AB",
    "city": "Eindhoven",
    "po_box": "<string>",
    "state_province_code": "IT-RM",
    "country_code": "NL"
  },
  "carrier_code": "trunkrs",
  "validation_methods": [
    "here"
  ]
}
'
{
  "input_address_is_valid": true,
  "results": [
    {
      "address": {
        "address_line_1": "Stadhuisplein",
        "house_number": "50",
        "address_line_2": "Apartment 17B",
        "postal_code": "1013 AB",
        "city": "Eindhoven",
        "po_box": "<string>",
        "state_province_code": "IT-RM",
        "country_code": "NL"
      },
      "recommended": true,
      "analysis": {
        "validation_result": {
          "is_valid": true,
          "reasons": [
            "<string>"
          ]
        },
        "changed_attributes": [
          "<string>"
        ]
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://sendcloud.dev/llms.txt

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

This address validation endpoint allows you to validate shipping addresses before using them. By validating addresses in advance, you can ensure that the shipping information is accurate and complete, reducing the risk of delivery issues and improving overall shipping efficiency. Providing the carrier helps to tailor the address validation process according to specific carrier requirements. Using additional validation methods can further enhance the accuracy of the address verification. The default Sendcloud validation, will always be applied, has in 2 steps:
  1. checks the address against the carrier limits (e.g. maximum length of the address line, existence of the postal code for the country, etc.). see also Carrier address limits.
  2. optimizes (washes) the address to fit within the carrier limits. (e.g. deduplication of address lines, abbreviations, etc.)

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Headers

​
Sendcloud-Partner-Id
string

If you are an official Sendcloud Tech Partner, you can provide this additional request header for the system to recognize you. Sendcloud Partner UUID is provided to Sendcloud partners. The token is not required but if the header is set, the system will try to validate it. An unknown UUID will cause the 404 return, whilst an invalid one will return 400.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

Address Washer Request object model

​
address
Raw address · object
required

Raw address object

​
carrier_code
string
required

The code of the carrier to be used for the address validation. Only carriers available to your account can be used.

Example:

"trunkrs"

​
validation_methods
enum<string>[]

An array of optional address validation methods to be applied The default Sendcloud validation will always be applied.

Available options:
here
Example:
["here"]

Response

Address validation successful

Address Washer Response object model

​
input_address_is_valid
boolean

Indicates if the input address is valid.

​
results
object[]

The results of the address validation.