Address Validation - BestRx APIs

INFO

This endpoint is used to validate a address and return a list of suggested address.

Request

Header Params

Content-Type

string

optional

Example:

application/json

Body Params application/json

store

object

optional

bestrx_pharmacy_id

string

required

Unique GUID representing the Pharmacy ID of the BestRx Client

Example:

ef0a4740-0be9-44f7-b89d-9e66eeba0b9a

delivery_provider_acct_no

string

optional

Account Number that the BestRx Client has with the Delivery/Shipping Provider

Example:

98989898

name

string

required

Name of the Pharmacy

Example:

BestRx Pharmacy

address

object

optional

Object with Address Details

phone

string

required

Phone Number of the Pharmacy

Example:

6308939210

fax

string

required

Fax Number of the Pharmacy

Example:

6303393171

string

required

Email Address of the Pharmacy

Example:

pharmacy@bestrx.com

ncpdp

string

required

NCPDP Number of the Pharmacy

Example:

1234567

npi

string

required

NPI Number of the Pharmacy

Example:

1234567890

dea

string

required

DEA Number of the Pharmacy

Example:

BR1234563

address_to_validate

object

optional

Object to Validate Address Details

address_line_1

string

required

Street Address Line 1

Example:

908 ATLANTIC AVE APT A APT A

address_line_2

string | null

required

Street Address Line 2

city

string

required

City

Example:

HOFFMAN ESTATES

state

string

required

State

Example:

zip_code

string

required

Zip Code

Example:

60169

Example

{
    "store": {
        "bestrx_pharmacy_id": "ef0a4740-0be9-44f7-b89d-9e66eeba0b9a",
        "delivery_provider_acct_no": "98989898",
        "name": "BestRx Pharmacy",
        "address": {
            "address_line_1": "2625 Butterfield Rd",
            "address_line_2": "Suite 200S",
            "city": "Oak Brook",
            "state": "IL",
            "zip_code": "60523"
        },
        "phone": "6308939210",
        "fax": "6303393171",
        "email": "pharmacy@bestrx.com",
        "ncpdp": "1234567",
        "npi": "1234567890",
        "dea": "BR1234563"
    },
    "address_to_validate": {
        "address_line_1": "908 ATLANTIC AVE APT A APT A",
        "address_line_2": "",
        "city": "HOFFMAN ESTATES",
        "state": "IL",
        "zip_code": "60169"
    }
}

Responses

🟢200OK

application/json

Body

data

object

optional

suggested_address

array [object {5}]

optional

List Object with suggested Address

messages

array [object {3}]

optional

message_code

string

optional

Example:

DIS0001

message

string

optional

Example:

Invalid Address

message_type

enum<integer>

optional

Allowed values:

0123-1

request_is_valid

boolean

optional

Example:

true

Example

{
    "data": {
        "suggested_address": [
            {
                "address_line_1": "908 ATLANTIC AVE APT A APT A",
                "address_line_2": "",
                "city": "HOFFMAN ESTATES",
                "state": "IL",
                "zip_code": "60169"
            }
        ]
    },
    "messages": [],
    "request_is_valid": "true"
}