Address Validation

Address validation

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.

Securityapi_key or azure_auth
Request
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/json
required

The address validation request

Id
string or null <uuid>

The unique identifier for the address

object (StreetAddress)

Information about a street address.

Responses
200

The address validation response

400

Malformed Request (ProblemDetails)

401

Unauthorized - Provide proof of identity (ProblemDetails)

403

Forbidden - Insufficient permissions (ProblemDetails)

404

Not Found - Could not find a matching entity (ProblemDetails)

422

Unprocessable - Request was well formed but could not be actioned (ProblemDetails)

429

Too many requests - Chill out (ProblemDetails)

4XX

User Error (ProblemDetails)

5XX

Server Error (ProblemDetails)

post/sites/{SiteSlug}/address/validate
Request samples
application/json
{
  • "Id": "{064a5f0e-0b0e-4e1e-8e1e-0e0e0e0e0e0e}",
  • "Address": {
    }
}
Response samples
application/json
{
  • "Id": "string",
  • "Addresses": [
    ],
  • "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.

Securityapi_key or azure_auth
Request
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/json
required

The batch of one or more addresses to validate

Array
Id
string or null <uuid>

The unique identifier for the address

object (StreetAddress)

Information about a street address.

Responses
202

Batch validation of addresses is not yet complete

400

Malformed Request (ProblemDetails)

401

Unauthorized - Provide proof of identity (ProblemDetails)

403

Forbidden - Insufficient permissions (ProblemDetails)

404

Not Found - Could not find a matching entity (ProblemDetails)

422

Unprocessable - Request was well formed but could not be actioned (ProblemDetails)

429

Too many requests - Chill out (ProblemDetails)

4XX

User Error (ProblemDetails)

5XX

Server Error (ProblemDetails)

post/sites/{SiteSlug}/address/batch
Request samples
application/json
[
  • {
    }
]
Response samples
application/problem+json
{
  • "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.

Securityapi_key or azure_auth
Request
path Parameters
SiteSlug
required
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The Slipstream slug that uniquely identifies a physical practice

Example: s8n6EzC
query Parameters
Id
required
string

The batch Id of the address validation batch to retrieve

Example: Id=24563C3BA517414405E35D4D97199C26
Responses
200

The completed address validation batch response

204

Batch validation of addresses is not yet complete

400

Malformed Request (ProblemDetails)

401

Unauthorized - Provide proof of identity (ProblemDetails)

403

Forbidden - Insufficient permissions (ProblemDetails)

404

Not Found - Could not find a matching entity (ProblemDetails)

422

Unprocessable - Request was well formed but could not be actioned (ProblemDetails)

429

Too many requests - Chill out (ProblemDetails)

4XX

User Error (ProblemDetails)

5XX

Server Error (ProblemDetails)

get/sites/{SiteSlug}/address/batch
Request samples
Response samples
application/json
{
  • "id": "string",
  • "addresses": [
    ]
}