Skip to main content

Consumer User

Manage consumer user profiles, document uploads, and verification.

Base URL: /api/v1/partner/store/user

Endpoints Overview​

MethodEndpointDescription
GET/Get Active User Info
GET/verifystore - verify patient rec code
POST/Update User Info
POST/signSign Contract Info
POST/dlPhotoUpload DL Photo
POST/recPhotoUpload Recommendation Photo
GET/assets/{assetKey}Get Asset

Get Active User Info​

GET /api/v1/partner/store/user

Retrieve the currently authenticated consumer user's profile. Requires consumer user authentication — the user is identified from the auth token, not from query parameters.

Query Parameters​

ParameterTypeRequiredDescription
cuidstringNocuid

Response​

Returns a ConsumerUser object.

FieldTypeRequiredDescription
idstringNoUnique identifier
companyIdstringNoCompany identifier
createdlongNoCreated timestamp (epoch ms)
modifiedlongNoLast modified timestamp (epoch ms)
deletedbooleanNoWhether the record is deleted
updatedbooleanNoWhether the record has been updated
emailstringNoEmail address
passwordstringNoPassword
firstNamestringNoFirst name
lastNamestringNoLast name
middleNamestringNoMiddle name
addressAddressNoAddress
doblongNoDob
birthdatestringNoBirthdate
localDobstringNoLocal Dob
primaryPhonestringNoPrimary phone number
cpnstringNoCpn
textOptInbooleanNoText Opt In
emailOptInbooleanNoEmail Opt In
medicalbooleanNoMedical (default: false)
searchTextstringNoSearch Text
anonymousbooleanNoAnonymous
marketingSourcestringNoMarketing Source
sourceCompanyIdstringNoSource Company identifier
verifyMethodstringNoVerify Method. One of: Website, Phone (default: Website)
verificationWebsitestringNoVerification Website
verificationPhonestringNoVerification Phone
doctorFirstNamestringNoDoctor First Name
doctorLastNamestringNoDoctor Last Name
doctorLicensestringNoDoctor License
dlNostringNoDl No
dlExpirationlongNoDl Expiration
localDlExpirationstringNoLocal Dl Expiration
dlStatestringNoDl State
dlPhotoConsumerAssetNoDl Photo
recPhotoConsumerAssetNoRec Photo
recNostringNoRec No
recExpirationlongNoRec Expiration
recIssueDatelongNoRec Issue timestamp (epoch ms)
notificationTypestringNoNotification Type. One of: None, Email, Text (default: Email)
consumerTypestringNoConsumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse)
verifiedbooleanNoVerified
activebooleanNoWhether active (default: true)
memberIdsstring[]NoMember Ids
memberStatusesConsumerMemberStatus[]NoMember Statuses
signedContractsSignedContract[]NoSigned Contracts
sourcestringNoSource. One of: Blaze, WooCommerce (default: Blaze)
importIdstringNoImport identifier
memberIdstringNoMember identifier
acceptedbooleanNoAccepted (default: false)
acceptedDatelongNoAccepted timestamp (epoch ms)
reasonstringNoReason
lastSyncDatelongNoLast Sync timestamp (epoch ms)
rejectedDatelongNoRejected timestamp (epoch ms)
addressesAddress[]NoAddresses
growthLoyaltyEnrolledbooleanNoGrowth Loyalty Enrolled
growthLoyaltyEnrolledUpdatedAtlongNoGrowth Loyalty Enrolled Updated At

store - verify patient rec code​

GET /api/v1/partner/store/user/verify

Verify a patient's medical recommendation code against an external verification service. Provide the recNo (recommendation/verification code) and websiteType (which verification service to use). Returns the verification status including name, recommendation expiration, and status.

Query Parameters​

ParameterTypeRequiredDescription
recNostringNorec no
websiteTypestringNowebsite type

Response​

Returns a PatientVerificationStatus object.

FieldTypeRequiredDescription
patientNamestringNoPatient Name
recommendationExpDatestringNoRecommendation Exp timestamp (epoch ms)
recommendationIssueDatestringNoRecommendation Issue timestamp (epoch ms)
recommendationStatusstringNoRecommendation Status

Update User Info​

POST /api/v1/partner/store/user

Update the authenticated consumer user's profile information. Send the full ConsumerUser object in the request body. Requires consumer user authentication.

Query Parameters​

ParameterTypeRequiredDescription
cuidstringNocuid

Request Body​

FieldTypeRequiredDescription
idstringNoUnique identifier
companyIdstringNoCompany identifier
createdlongNoCreated timestamp (epoch ms)
modifiedlongNoLast modified timestamp (epoch ms)
deletedbooleanNoWhether the record is deleted
updatedbooleanNoWhether the record has been updated
emailstringNoEmail address
passwordstringNoPassword
firstNamestringNoFirst name
lastNamestringNoLast name
middleNamestringNoMiddle name
addressAddressNoAddress
doblongNoDob
birthdatestringNoBirthdate
localDobstringNoLocal Dob
primaryPhonestringNoPrimary phone number
cpnstringNoCpn
textOptInbooleanNoText Opt In
emailOptInbooleanNoEmail Opt In
medicalbooleanNoMedical (default: false)
searchTextstringNoSearch Text
anonymousbooleanNoAnonymous
marketingSourcestringNoMarketing Source
sourceCompanyIdstringNoSource Company identifier
verifyMethodstringNoVerify Method. One of: Website, Phone (default: Website)
verificationWebsitestringNoVerification Website
verificationPhonestringNoVerification Phone
doctorFirstNamestringNoDoctor First Name
doctorLastNamestringNoDoctor Last Name
doctorLicensestringNoDoctor License
dlNostringNoDl No
dlExpirationlongNoDl Expiration
localDlExpirationstringNoLocal Dl Expiration
dlStatestringNoDl State
dlPhotoConsumerAssetNoDl Photo
recPhotoConsumerAssetNoRec Photo
recNostringNoRec No
recExpirationlongNoRec Expiration
recIssueDatelongNoRec Issue timestamp (epoch ms)
notificationTypestringNoNotification Type. One of: None, Email, Text (default: Email)
consumerTypestringNoConsumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse)
verifiedbooleanNoVerified
activebooleanNoWhether active (default: true)
memberIdsstring[]NoMember Ids
memberStatusesConsumerMemberStatus[]NoMember Statuses
signedContractsSignedContract[]NoSigned Contracts
sourcestringNoSource. One of: Blaze, WooCommerce (default: Blaze)
importIdstringNoImport identifier
memberIdstringNoMember identifier
acceptedbooleanNoAccepted (default: false)
acceptedDatelongNoAccepted timestamp (epoch ms)
reasonstringNoReason
lastSyncDatelongNoLast Sync timestamp (epoch ms)
rejectedDatelongNoRejected timestamp (epoch ms)
addressesAddress[]NoAddresses
growthLoyaltyEnrolledbooleanNoGrowth Loyalty Enrolled
growthLoyaltyEnrolledUpdatedAtlongNoGrowth Loyalty Enrolled Updated At

Response​

Returns a ConsumerUser object.

FieldTypeRequiredDescription
idstringNoUnique identifier
companyIdstringNoCompany identifier
createdlongNoCreated timestamp (epoch ms)
modifiedlongNoLast modified timestamp (epoch ms)
deletedbooleanNoWhether the record is deleted
updatedbooleanNoWhether the record has been updated
emailstringNoEmail address
passwordstringNoPassword
firstNamestringNoFirst name
lastNamestringNoLast name
middleNamestringNoMiddle name
addressAddressNoAddress
doblongNoDob
birthdatestringNoBirthdate
localDobstringNoLocal Dob
primaryPhonestringNoPrimary phone number
cpnstringNoCpn
textOptInbooleanNoText Opt In
emailOptInbooleanNoEmail Opt In
medicalbooleanNoMedical (default: false)
searchTextstringNoSearch Text
anonymousbooleanNoAnonymous
marketingSourcestringNoMarketing Source
sourceCompanyIdstringNoSource Company identifier
verifyMethodstringNoVerify Method. One of: Website, Phone (default: Website)
verificationWebsitestringNoVerification Website
verificationPhonestringNoVerification Phone
doctorFirstNamestringNoDoctor First Name
doctorLastNamestringNoDoctor Last Name
doctorLicensestringNoDoctor License
dlNostringNoDl No
dlExpirationlongNoDl Expiration
localDlExpirationstringNoLocal Dl Expiration
dlStatestringNoDl State
dlPhotoConsumerAssetNoDl Photo
recPhotoConsumerAssetNoRec Photo
recNostringNoRec No
recExpirationlongNoRec Expiration
recIssueDatelongNoRec Issue timestamp (epoch ms)
notificationTypestringNoNotification Type. One of: None, Email, Text (default: Email)
consumerTypestringNoConsumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse)
verifiedbooleanNoVerified
activebooleanNoWhether active (default: true)
memberIdsstring[]NoMember Ids
memberStatusesConsumerMemberStatus[]NoMember Statuses
signedContractsSignedContract[]NoSigned Contracts
sourcestringNoSource. One of: Blaze, WooCommerce (default: Blaze)
importIdstringNoImport identifier
memberIdstringNoMember identifier
acceptedbooleanNoAccepted (default: false)
acceptedDatelongNoAccepted timestamp (epoch ms)
reasonstringNoReason
lastSyncDatelongNoLast Sync timestamp (epoch ms)
rejectedDatelongNoRejected timestamp (epoch ms)
addressesAddress[]NoAddresses
growthLoyaltyEnrolledbooleanNoGrowth Loyalty Enrolled
growthLoyaltyEnrolledUpdatedAtlongNoGrowth Loyalty Enrolled Updated At

Sign Contract Info​

POST /api/v1/partner/store/user/sign

Record that the consumer user has signed a contract or agreement. Send a ContractSignRequest in the request body. Requires consumer user authentication.

Query Parameters​

ParameterTypeRequiredDescription
cuidstringNocuid

Request Body​

FieldTypeRequiredDescription
contractIdstringYesContract identifier

Response​

Returns a ConsumerUser object.

FieldTypeRequiredDescription
idstringNoUnique identifier
companyIdstringNoCompany identifier
createdlongNoCreated timestamp (epoch ms)
modifiedlongNoLast modified timestamp (epoch ms)
deletedbooleanNoWhether the record is deleted
updatedbooleanNoWhether the record has been updated
emailstringNoEmail address
passwordstringNoPassword
firstNamestringNoFirst name
lastNamestringNoLast name
middleNamestringNoMiddle name
addressAddressNoAddress
doblongNoDob
birthdatestringNoBirthdate
localDobstringNoLocal Dob
primaryPhonestringNoPrimary phone number
cpnstringNoCpn
textOptInbooleanNoText Opt In
emailOptInbooleanNoEmail Opt In
medicalbooleanNoMedical (default: false)
searchTextstringNoSearch Text
anonymousbooleanNoAnonymous
marketingSourcestringNoMarketing Source
sourceCompanyIdstringNoSource Company identifier
verifyMethodstringNoVerify Method. One of: Website, Phone (default: Website)
verificationWebsitestringNoVerification Website
verificationPhonestringNoVerification Phone
doctorFirstNamestringNoDoctor First Name
doctorLastNamestringNoDoctor Last Name
doctorLicensestringNoDoctor License
dlNostringNoDl No
dlExpirationlongNoDl Expiration
localDlExpirationstringNoLocal Dl Expiration
dlStatestringNoDl State
dlPhotoConsumerAssetNoDl Photo
recPhotoConsumerAssetNoRec Photo
recNostringNoRec No
recExpirationlongNoRec Expiration
recIssueDatelongNoRec Issue timestamp (epoch ms)
notificationTypestringNoNotification Type. One of: None, Email, Text (default: Email)
consumerTypestringNoConsumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse)
verifiedbooleanNoVerified
activebooleanNoWhether active (default: true)
memberIdsstring[]NoMember Ids
memberStatusesConsumerMemberStatus[]NoMember Statuses
signedContractsSignedContract[]NoSigned Contracts
sourcestringNoSource. One of: Blaze, WooCommerce (default: Blaze)
importIdstringNoImport identifier
memberIdstringNoMember identifier
acceptedbooleanNoAccepted (default: false)
acceptedDatelongNoAccepted timestamp (epoch ms)
reasonstringNoReason
lastSyncDatelongNoLast Sync timestamp (epoch ms)
rejectedDatelongNoRejected timestamp (epoch ms)
addressesAddress[]NoAddresses
growthLoyaltyEnrolledbooleanNoGrowth Loyalty Enrolled
growthLoyaltyEnrolledUpdatedAtlongNoGrowth Loyalty Enrolled Updated At

Upload DL Photo​

POST /api/v1/partner/store/user/dlPhoto

Upload a driver's license photo for the authenticated consumer. Send the file as multipart/form-data. Requires consumer user authentication.

Query Parameters​

ParameterTypeRequiredDescription
cuidstringNocuid

Request​

This endpoint accepts multipart/form-data.

FieldTypeDescription
namestringname
filefinalfile

Response​

Returns a ConsumerUser object.

FieldTypeRequiredDescription
idstringNoUnique identifier
companyIdstringNoCompany identifier
createdlongNoCreated timestamp (epoch ms)
modifiedlongNoLast modified timestamp (epoch ms)
deletedbooleanNoWhether the record is deleted
updatedbooleanNoWhether the record has been updated
emailstringNoEmail address
passwordstringNoPassword
firstNamestringNoFirst name
lastNamestringNoLast name
middleNamestringNoMiddle name
addressAddressNoAddress
doblongNoDob
birthdatestringNoBirthdate
localDobstringNoLocal Dob
primaryPhonestringNoPrimary phone number
cpnstringNoCpn
textOptInbooleanNoText Opt In
emailOptInbooleanNoEmail Opt In
medicalbooleanNoMedical (default: false)
searchTextstringNoSearch Text
anonymousbooleanNoAnonymous
marketingSourcestringNoMarketing Source
sourceCompanyIdstringNoSource Company identifier
verifyMethodstringNoVerify Method. One of: Website, Phone (default: Website)
verificationWebsitestringNoVerification Website
verificationPhonestringNoVerification Phone
doctorFirstNamestringNoDoctor First Name
doctorLastNamestringNoDoctor Last Name
doctorLicensestringNoDoctor License
dlNostringNoDl No
dlExpirationlongNoDl Expiration
localDlExpirationstringNoLocal Dl Expiration
dlStatestringNoDl State
dlPhotoConsumerAssetNoDl Photo
recPhotoConsumerAssetNoRec Photo
recNostringNoRec No
recExpirationlongNoRec Expiration
recIssueDatelongNoRec Issue timestamp (epoch ms)
notificationTypestringNoNotification Type. One of: None, Email, Text (default: Email)
consumerTypestringNoConsumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse)
verifiedbooleanNoVerified
activebooleanNoWhether active (default: true)
memberIdsstring[]NoMember Ids
memberStatusesConsumerMemberStatus[]NoMember Statuses
signedContractsSignedContract[]NoSigned Contracts
sourcestringNoSource. One of: Blaze, WooCommerce (default: Blaze)
importIdstringNoImport identifier
memberIdstringNoMember identifier
acceptedbooleanNoAccepted (default: false)
acceptedDatelongNoAccepted timestamp (epoch ms)
reasonstringNoReason
lastSyncDatelongNoLast Sync timestamp (epoch ms)
rejectedDatelongNoRejected timestamp (epoch ms)
addressesAddress[]NoAddresses
growthLoyaltyEnrolledbooleanNoGrowth Loyalty Enrolled
growthLoyaltyEnrolledUpdatedAtlongNoGrowth Loyalty Enrolled Updated At

Upload Recommendation Photo​

POST /api/v1/partner/store/user/recPhoto

Upload a medical recommendation photo for the authenticated consumer. Send the file as multipart/form-data. Requires consumer user authentication.

Query Parameters​

ParameterTypeRequiredDescription
cuidstringNocuid

Request​

This endpoint accepts multipart/form-data.

FieldTypeDescription
namestringname
filefinalfile

Response​

Returns a ConsumerUser object.

FieldTypeRequiredDescription
idstringNoUnique identifier
companyIdstringNoCompany identifier
createdlongNoCreated timestamp (epoch ms)
modifiedlongNoLast modified timestamp (epoch ms)
deletedbooleanNoWhether the record is deleted
updatedbooleanNoWhether the record has been updated
emailstringNoEmail address
passwordstringNoPassword
firstNamestringNoFirst name
lastNamestringNoLast name
middleNamestringNoMiddle name
addressAddressNoAddress
doblongNoDob
birthdatestringNoBirthdate
localDobstringNoLocal Dob
primaryPhonestringNoPrimary phone number
cpnstringNoCpn
textOptInbooleanNoText Opt In
emailOptInbooleanNoEmail Opt In
medicalbooleanNoMedical (default: false)
searchTextstringNoSearch Text
anonymousbooleanNoAnonymous
marketingSourcestringNoMarketing Source
sourceCompanyIdstringNoSource Company identifier
verifyMethodstringNoVerify Method. One of: Website, Phone (default: Website)
verificationWebsitestringNoVerification Website
verificationPhonestringNoVerification Phone
doctorFirstNamestringNoDoctor First Name
doctorLastNamestringNoDoctor Last Name
doctorLicensestringNoDoctor License
dlNostringNoDl No
dlExpirationlongNoDl Expiration
localDlExpirationstringNoLocal Dl Expiration
dlStatestringNoDl State
dlPhotoConsumerAssetNoDl Photo
recPhotoConsumerAssetNoRec Photo
recNostringNoRec No
recExpirationlongNoRec Expiration
recIssueDatelongNoRec Issue timestamp (epoch ms)
notificationTypestringNoNotification Type. One of: None, Email, Text (default: Email)
consumerTypestringNoConsumer Type. One of: Other, AdultUse, MedicinalState, MedicinalThirdParty (default: AdultUse)
verifiedbooleanNoVerified
activebooleanNoWhether active (default: true)
memberIdsstring[]NoMember Ids
memberStatusesConsumerMemberStatus[]NoMember Statuses
signedContractsSignedContract[]NoSigned Contracts
sourcestringNoSource. One of: Blaze, WooCommerce (default: Blaze)
importIdstringNoImport identifier
memberIdstringNoMember identifier
acceptedbooleanNoAccepted (default: false)
acceptedDatelongNoAccepted timestamp (epoch ms)
reasonstringNoReason
lastSyncDatelongNoLast Sync timestamp (epoch ms)
rejectedDatelongNoRejected timestamp (epoch ms)
addressesAddress[]NoAddresses
growthLoyaltyEnrolledbooleanNoGrowth Loyalty Enrolled
growthLoyaltyEnrolledUpdatedAtlongNoGrowth Loyalty Enrolled Updated At

Get Asset​

GET /api/v1/partner/store/user/assets/{assetKey}

Retrieve a consumer asset (image or document) by its key. Returns the binary file stream directly (not JSON). The response is cacheable for 30 days.

Path Parameters​

ParameterTypeDescription
assetKeystringThe asset key

Query Parameters​

ParameterTypeRequiredDescription
cuidstringNocuid