Patient Lookup

Retrieve information about a consumer by its id. Currently supports medical patient lookup in states that support dynamic purchase limits.

SecurityApiKeyAuth and CustomAuth
Request
path Parameters
state
required
string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "il" "wa" "ma" "md" "mi" "wv" "co" "ok" "oh"
query Parameters
license_number
required
string

Reference (entity_ID) for the license. This is the business license number issued by the state.

Example: license_number=ABC-1234
consumer_id
required
string

Customers Patient ID.

Example: consumer_id=ABCD-PAT-019876
header Parameters
x-api-key
required
string

Trace API key header

Example: b123x21wbHlkYXBpa2V5
Authorization
required
string

Company and user credentials authentication

Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5
Responses
200

OK

400

Bad Request

get/{state}/v1/sales/consumer/lookup
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}