Validate an address
Validates an address with an external provider. The address validation is performed using a location bias towards the site's location. The result may or may not be corrected by the external provider.
path Parameters
| SiteSlug required | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ The Slipstream slug that uniquely identifies a physical practice Example: s8n6EzC |
Request Body schema: application/jsonrequired
The address validation request
The address validation response
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
- Payload
- curl
- Ruby
- C#
- Node.js
{- "Id": "{064a5f0e-0b0e-4e1e-8e1e-0e0e0e0e0e0e}",
- "Address": {
- "AddressLine1": "123 Main St",
- "AddressLine2": "Apt 4",
- "Locality": "San Francisco",
- "Region": "CA",
- "PostalCode": "94107",
- "Country": "USA"
}
}- 200
- 400
- 401
- 403
- 404
- 422
- 429
- 4XX
- 5XX
{- "Id": "string",
- "Addresses": [
- {
- "AddressLine1": "123 Main St",
- "AddressLine2": "Apt 4",
- "Locality": "San Francisco",
- "Region": "CA",
- "PostalCode": "94107",
- "Country": "USA",
- "Coordinates": {
- "Latitude": 37.7749,
- "Longitude": -122.4194
}, - "Timezone": {
- "Name": "America/Los_Angeles",
- "StdAbbreviation": "PST",
- "StdOffsetSeconds": -28800,
- "DstAbbreviation": "PDT",
- "DstOffsetSeconds": -25200
}, - "Formatted": "123 Main St, Springfield, IL 62701, USA"
}
], - "Status": "Unknown"
}Validate a batch of addresses
Validate one or more addresses in a single call. The batch process is asynchronous, requiring the caller to fetch the batch results in a subsequent fetch call with the batch ID.
path Parameters
| SiteSlug required | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ The Slipstream slug that uniquely identifies a physical practice Example: s8n6EzC |
Request Body schema: application/jsonrequired
The batch of one or more addresses to validate
Batch validation of addresses is not yet complete
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
- Payload
- curl
- Ruby
- C#
- Node.js
[- {
- "Id": "{064a5f0e-0b0e-4e1e-8e1e-0e0e0e0e0e0e}",
- "Address": {
- "AddressLine1": "123 Main St",
- "AddressLine2": "Apt 4",
- "Locality": "San Francisco",
- "Region": "CA",
- "PostalCode": "94107",
- "Country": "USA"
}
}
]- 400
- 401
- 403
- 404
- 422
- 429
- 4XX
- 5XX
{- "title": "The Name field is required.",
- "detail": "The Name field is required.",
- "status": 400,
- "traceId": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00"
}Get the results of a batch address validation request
Gets the completed batch result from the external provider.
path Parameters
| SiteSlug required | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ The Slipstream slug that uniquely identifies a physical practice Example: s8n6EzC |
The completed address validation batch response
Batch validation of addresses is not yet complete
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
- curl
- Ruby
- C#
- Node.js
- 200
- 400
- 401
- 403
- 404
- 422
- 429
- 4XX
- 5XX
{- "id": "string",
- "addresses": [
- {
- "Id": "string",
- "Addresses": [
- {
- "AddressLine1": "123 Main St",
- "AddressLine2": "Apt 4",
- "Locality": "San Francisco",
- "Region": "CA",
- "PostalCode": "94107",
- "Country": "USA",
- "Coordinates": {
- "Latitude": 37.7749,
- "Longitude": -122.4194
}, - "Timezone": {
- "Name": "America/Los_Angeles",
- "StdAbbreviation": "PST",
- "StdOffsetSeconds": -28800,
- "DstAbbreviation": "PDT",
- "DstOffsetSeconds": -25200
}, - "Formatted": "123 Main St, Springfield, IL 62701, USA"
}
], - "Status": "Unknown"
}
]
}