Skip to main content
POST
/
v2
/
orders
/
addresses
/
validate
Validate order address
curl --request POST \
  --url https://api.snappy.com/public-api/v2/orders/addresses/validate \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "country": "US",
  "address": {
    "addressLine1": "123 Main St",
    "zipcode": "12345",
    "city": "New York",
    "state": "NY"
  }
}
'
{
  "message": "The address is correct",
  "result": "verified"
}

Documentation Index

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

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

Authorizations

​
X-Api-Key
string
header
required

Company Level Authentication

Company level authentication provides access to all resources under your company, including accounts, campaigns, gifts, and recipients.

Getting Your API Key

  1. Create an API Key: Use the POST /v2/authentication/apiKeys endpoint to generate a new API key
  2. Set Expiration: Choose from 30, 60, 90, or 180 days (default: 90 days)
  3. Optional mTLS: Enable mutual TLS for enhanced security
  4. Name Your Key: Provide a descriptive name for easy identification

Using Your API Key

Include your API key in the X-Api-Key header for every request:

X-Api-Key: YOUR_24_CHARACTER_API_KEY

API Key Management

  • Maximum Keys: Up to 3 active API keys per company
  • Rotation: Delete old keys before creating new ones when at the limit
  • Security: Keys are hashed and cannot be retrieved after creation

Enhanced Security (mTLS)

For production environments, enable mutual TLS authentication:

  1. Set enforceMtls: true when creating the API key
  2. Contact support to obtain your client certificates
  3. Use the mTLS endpoint: https://mtls-api.snappy.com/public-api

Headers

​
Request-Source
enum<string>

Source of the request

Available options:
api_native,
api_zapier,
api_salesforce,
api_ftp,
api_make
Example:

"api_native"

Query Parameters

​
companyId
string

Company ID

Pattern: ^[A-Za-z0-9]{8,}$
Example:

"12345678"

Body

application/json

Validate order address request body.

​
country
string
required

Delivery address country a 2-3 letter uppercase country code

Pattern: ^[A-Z]{2,3}$
Example:

"US"

​
address
object
required

Delivery address details.

Response

Ok

Address validation response.

​
message
string
required

Validation result message

Example:

"The address is correct"

​
result
enum<string>
required

The validation result status

Available options:
verified,
ambiguous
Example:

"verified"

Last modified on April 16, 2026