BLAZE Developer API: ConsumerAuthResult

Methods

post - Consumer Login

Resource

{
    "accessToken": "string",
    "assetAccessToken": "string",
    "expirationTime": "int64",
    "loginTime": "int64",
    "sessionId": "string",
    "user": {
        "accepted": "boolean",
        "acceptedDate": "int64",
        "active": "boolean",
        "address": {
            "address": "string",
            "addressLine2": "string",
            "city": "string",
            "companyId": "string",
            "country": "string",
            "created": "int64",
            "deleted": "boolean",
            "id": "string",
            "latitude": "number",
            "longitude": "number",
            "modified": "int64",
            "state": "string",
            "updated": "boolean",
            "zipCode": "string"
        },
        "addresses": [
            {
                "address": "string",
                "addressLine2": "string",
                "city": "string",
                "companyId": "string",
                "country": "string",
                "created": "int64",
                "deleted": "boolean",
                "id": "string",
                "latitude": "number",
                "longitude": "number",
                "modified": "int64",
                "state": "string",
                "updated": "boolean",
                "zipCode": "string"
            }
        ],
        "companyId": "string",
        "consumerType": "string",
        "cpn": "string",
        "created": "int64",
        "deleted": "boolean",
        "dlExpiration": "int64",
        "dlNo": "string",
        "dlPhoto": {
            "active": "boolean",
            "assetType": "string",
            "created": "int64",
            "deleted": "boolean",
            "documentId": "string",
            "id": "string",
            "key": "string",
            "modified": "int64",
            "name": "string",
            "type": "string",
            "updated": "boolean"
        },
        "dlState": "string",
        "dob": "int64",
        "doctorFirstName": "string",
        "doctorLastName": "string",
        "doctorLicense": "string",
        "email": "string",
        "emailOptIn": "boolean",
        "firstName": "string",
        "id": "string",
        "importId": "string",
        "lastName": "string",
        "lastSyncDate": "int64",
        "marketingSource": "string",
        "medical": "boolean",
        "memberId": "string",
        "memberIds": [
            "string"
        ],
        "memberStatuses": [
            {
                "accepted": "boolean",
                "acceptedDate": "int64",
                "companyId": "string",
                "consumerId": "string",
                "created": "int64",
                "deleted": "boolean",
                "dirty": "boolean",
                "id": "string",
                "lastSyncDate": "int64",
                "memberId": "string",
                "modified": "int64",
                "reason": "string",
                "shopId": "string",
                "updated": "boolean"
            }
        ],
        "middleName": "string",
        "modified": "int64",
        "notificationType": "string",
        "password": "string",
        "primaryPhone": "string",
        "reason": "string",
        "recExpiration": "int64",
        "recIssueDate": "int64",
        "recNo": "string",
        "recPhoto": {
            "active": "boolean",
            "assetType": "string",
            "created": "int64",
            "deleted": "boolean",
            "documentId": "string",
            "id": "string",
            "key": "string",
            "modified": "int64",
            "name": "string",
            "type": "string",
            "updated": "boolean"
        },
        "rejectedDate": "int64",
        "searchText": "string",
        "sex": "string",
        "signedContracts": [
            {
                "companyId": "string",
                "consumerId": "string",
                "contractId": "string",
                "created": "int64",
                "deleted": "boolean",
                "dirty": "boolean",
                "employeeName": "string",
                "employeeSignaturePhoto": {
                    "active": "boolean",
                    "assetType": "string",
                    "companyId": "string",
                    "created": "int64",
                    "deleted": "boolean",
                    "id": "string",
                    "key": "string",
                    "largeURL": "string",
                    "largeX2URL": "string",
                    "mediumURL": "string",
                    "modified": "int64",
                    "name": "string",
                    "origURL": "string",
                    "priority": "int32",
                    "publicURL": "string",
                    "secured": "boolean",
                    "thumbURL": "string",
                    "type": "string",
                    "updated": "boolean"
                },
                "id": "string",
                "memberName": "string",
                "membershipId": "string",
                "modified": "int64",
                "shopId": "string",
                "signaturePhoto": {
                    "active": "boolean",
                    "assetType": "string",
                    "companyId": "string",
                    "created": "int64",
                    "deleted": "boolean",
                    "id": "string",
                    "key": "string",
                    "largeURL": "string",
                    "largeX2URL": "string",
                    "mediumURL": "string",
                    "modified": "int64",
                    "name": "string",
                    "origURL": "string",
                    "priority": "int32",
                    "publicURL": "string",
                    "secured": "boolean",
                    "thumbURL": "string",
                    "type": "string",
                    "updated": "boolean"
                },
                "signedDate": "int64",
                "signedDigitally": "boolean",
                "updated": "boolean",
                "witnessName": "string",
                "witnessSignaturePhoto": {
                    "active": "boolean",
                    "assetType": "string",
                    "companyId": "string",
                    "created": "int64",
                    "deleted": "boolean",
                    "id": "string",
                    "key": "string",
                    "largeURL": "string",
                    "largeX2URL": "string",
                    "mediumURL": "string",
                    "modified": "int64",
                    "name": "string",
                    "origURL": "string",
                    "priority": "int32",
                    "publicURL": "string",
                    "secured": "boolean",
                    "thumbURL": "string",
                    "type": "string",
                    "updated": "boolean"
                }
            }
        ],
        "source": "string",
        "sourceCompanyId": "string",
        "textOptIn": "boolean",
        "updated": "boolean",
        "verificationPhone": "string",
        "verificationWebsite": "string",
        "verified": "boolean",
        "verifyMethod": "string"
    }
}

Properties

Name	Type	Description	Additional
accessToken	string		Optional
assetAccessToken	string		Optional
expirationTime	int64		Optional
loginTime	int64		Optional
sessionId	string		Optional
user	object	ConsumerUser	Optional
user.accepted	boolean		Optional
user.acceptedDate	int64		Optional
user.active	boolean		Optional
user.address	object	Address	Optional
user.address.address	string		Optional
user.address.addressLine2	string		Optional
user.address.city	string		Optional
user.address.companyId	string		Optional
user.address.country	string		Optional
user.address.created	int64		Optional
user.address.deleted	boolean		Optional
user.address.id	string		Optional
user.address.latitude	number		Optional
user.address.longitude	number		Optional
user.address.modified	int64		Optional
user.address.state	string		Optional
user.address.updated	boolean		Optional
user.address.zipCode	string		Optional
user.addresses[]	array		Optional
user.addresses[].address	string		Optional
user.addresses[].addressLine2	string		Optional
user.addresses[].city	string		Optional
user.addresses[].companyId	string		Optional
user.addresses[].country	string		Optional
user.addresses[].created	int64		Optional
user.addresses[].deleted	boolean		Optional
user.addresses[].id	string		Optional
user.addresses[].latitude	number		Optional
user.addresses[].longitude	number		Optional
user.addresses[].modified	int64		Optional
user.addresses[].state	string		Optional
user.addresses[].updated	boolean		Optional
user.addresses[].zipCode	string		Optional
user.companyId	string		Optional
user.consumerType	string	Possible values are: `Other` `AdultUse` `MedicinalState` `MedicinalThirdParty`	Optional
user.cpn	string		Optional
user.created	int64		Optional
user.deleted	boolean		Optional
user.dlExpiration	int64		Optional
user.dlNo	string		Optional
user.dlPhoto	object	ConsumerAsset	Optional
user.dlPhoto.active	boolean		Optional
user.dlPhoto.assetType	string	Possible values are: `Photo` `Document` `Kml`	Optional
user.dlPhoto.created	int64		Optional
user.dlPhoto.deleted	boolean		Optional
user.dlPhoto.documentId	string		Optional
user.dlPhoto.id	string		Optional
user.dlPhoto.key	string		Optional
user.dlPhoto.modified	int64		Optional
user.dlPhoto.name	string		Optional
user.dlPhoto.type	string	Possible values are: `Photo` `Document` `Kml`	Optional
user.dlPhoto.updated	boolean		Optional
user.dlState	string		Optional
user.dob	int64		Optional
user.doctorFirstName	string		Optional
user.doctorLastName	string		Optional
user.doctorLicense	string		Optional
user.email	string		Optional
user.emailOptIn	boolean		Optional
user.firstName	string		Optional
user.id	string		Optional
user.importId	string		Optional
user.lastName	string		Optional
user.lastSyncDate	int64		Optional
user.marketingSource	string		Optional
user.medical	boolean		Optional
user.memberId	string		Optional
user.memberIds[]	array of string		Optional
user.memberStatuses[]	array		Optional
user.memberStatuses[].accepted	boolean		Optional
user.memberStatuses[].acceptedDate	int64		Optional
user.memberStatuses[].companyId	string		Optional
user.memberStatuses[].consumerId	string		Optional
user.memberStatuses[].created	int64		Optional
user.memberStatuses[].deleted	boolean		Optional
user.memberStatuses[].dirty	boolean		Optional
user.memberStatuses[].id	string		Optional
user.memberStatuses[].lastSyncDate	int64		Optional
user.memberStatuses[].memberId	string		Optional
user.memberStatuses[].modified	int64		Optional
user.memberStatuses[].reason	string		Optional
user.memberStatuses[].shopId	string		Optional
user.memberStatuses[].updated	boolean		Optional
user.middleName	string		Optional
user.modified	int64		Optional
user.notificationType	string	Possible values are: `None` `Email` `Text`	Optional
user.password	string		Optional
user.primaryPhone	string		Optional
user.reason	string		Optional
user.recExpiration	int64		Optional
user.recIssueDate	int64		Optional
user.recNo	string		Optional
user.recPhoto	object	ConsumerAsset	Optional
user.recPhoto.active	boolean		Optional
user.recPhoto.assetType	string	Possible values are: `Photo` `Document` `Kml`	Optional
user.recPhoto.created	int64		Optional
user.recPhoto.deleted	boolean		Optional
user.recPhoto.documentId	string		Optional
user.recPhoto.id	string		Optional
user.recPhoto.key	string		Optional
user.recPhoto.modified	int64		Optional
user.recPhoto.name	string		Optional
user.recPhoto.type	string	Possible values are: `Photo` `Document` `Kml`	Optional
user.recPhoto.updated	boolean		Optional
user.rejectedDate	int64		Optional
user.searchText	string		Optional
user.sex	string	Possible values are: `MALE` `FEMALE` `OTHER`	Optional
user.signedContracts[]	array		Optional
user.signedContracts[].companyId	string		Optional
user.signedContracts[].consumerId	string		Optional
user.signedContracts[].contractId	string		Optional
user.signedContracts[].created	int64		Optional
user.signedContracts[].deleted	boolean		Optional
user.signedContracts[].dirty	boolean		Optional
user.signedContracts[].employeeName	string		Optional
user.signedContracts[].employeeSignaturePhoto	object	CompanyAsset	Optional
user.signedContracts[].employeeSignaturePhoto.active	boolean		Optional
user.signedContracts[].employeeSignaturePhoto.assetType	string	Possible values are: `Photo` `Document` `Kml`	Optional
user.signedContracts[].employeeSignaturePhoto.companyId	string		Optional
user.signedContracts[].employeeSignaturePhoto.created	int64		Optional
user.signedContracts[].employeeSignaturePhoto.deleted	boolean		Optional
user.signedContracts[].employeeSignaturePhoto.id	string		Optional
user.signedContracts[].employeeSignaturePhoto.key	string		Optional
user.signedContracts[].employeeSignaturePhoto.largeURL	string		Optional
user.signedContracts[].employeeSignaturePhoto.largeX2URL	string		Optional
user.signedContracts[].employeeSignaturePhoto.mediumURL	string		Optional
user.signedContracts[].employeeSignaturePhoto.modified	int64		Optional
user.signedContracts[].employeeSignaturePhoto.name	string		Optional
user.signedContracts[].employeeSignaturePhoto.origURL	string		Optional
user.signedContracts[].employeeSignaturePhoto.priority	int32		Optional
user.signedContracts[].employeeSignaturePhoto.publicURL	string		Optional
user.signedContracts[].employeeSignaturePhoto.secured	boolean		Optional
user.signedContracts[].employeeSignaturePhoto.thumbURL	string		Optional
user.signedContracts[].employeeSignaturePhoto.type	string	Possible values are: `Photo` `Document` `Kml`	Optional
user.signedContracts[].employeeSignaturePhoto.updated	boolean		Optional
user.signedContracts[].id	string		Optional
user.signedContracts[].memberName	string		Optional
user.signedContracts[].membershipId	string		Optional
user.signedContracts[].modified	int64		Optional
user.signedContracts[].shopId	string		Optional
user.signedContracts[].signaturePhoto	object	CompanyAsset	Optional
user.signedContracts[].signaturePhoto.active	boolean		Optional
user.signedContracts[].signaturePhoto.assetType	string	Possible values are: `Photo` `Document` `Kml`	Optional
user.signedContracts[].signaturePhoto.companyId	string		Optional
user.signedContracts[].signaturePhoto.created	int64		Optional
user.signedContracts[].signaturePhoto.deleted	boolean		Optional
user.signedContracts[].signaturePhoto.id	string		Optional
user.signedContracts[].signaturePhoto.key	string		Optional
user.signedContracts[].signaturePhoto.largeURL	string		Optional
user.signedContracts[].signaturePhoto.largeX2URL	string		Optional
user.signedContracts[].signaturePhoto.mediumURL	string		Optional
user.signedContracts[].signaturePhoto.modified	int64		Optional
user.signedContracts[].signaturePhoto.name	string		Optional
user.signedContracts[].signaturePhoto.origURL	string		Optional
user.signedContracts[].signaturePhoto.priority	int32		Optional
user.signedContracts[].signaturePhoto.publicURL	string		Optional
user.signedContracts[].signaturePhoto.secured	boolean		Optional
user.signedContracts[].signaturePhoto.thumbURL	string		Optional
user.signedContracts[].signaturePhoto.type	string	Possible values are: `Photo` `Document` `Kml`	Optional
user.signedContracts[].signaturePhoto.updated	boolean		Optional
user.signedContracts[].signedDate	int64		Optional
user.signedContracts[].signedDigitally	boolean		Optional
user.signedContracts[].updated	boolean		Optional
user.signedContracts[].witnessName	string		Optional
user.signedContracts[].witnessSignaturePhoto	object	CompanyAsset	Optional
user.signedContracts[].witnessSignaturePhoto.active	boolean		Optional
user.signedContracts[].witnessSignaturePhoto.assetType	string	Possible values are: `Photo` `Document` `Kml`	Optional
user.signedContracts[].witnessSignaturePhoto.companyId	string		Optional
user.signedContracts[].witnessSignaturePhoto.created	int64		Optional
user.signedContracts[].witnessSignaturePhoto.deleted	boolean		Optional
user.signedContracts[].witnessSignaturePhoto.id	string		Optional
user.signedContracts[].witnessSignaturePhoto.key	string		Optional
user.signedContracts[].witnessSignaturePhoto.largeURL	string		Optional
user.signedContracts[].witnessSignaturePhoto.largeX2URL	string		Optional
user.signedContracts[].witnessSignaturePhoto.mediumURL	string		Optional
user.signedContracts[].witnessSignaturePhoto.modified	int64		Optional
user.signedContracts[].witnessSignaturePhoto.name	string		Optional
user.signedContracts[].witnessSignaturePhoto.origURL	string		Optional
user.signedContracts[].witnessSignaturePhoto.priority	int32		Optional
user.signedContracts[].witnessSignaturePhoto.publicURL	string		Optional
user.signedContracts[].witnessSignaturePhoto.secured	boolean		Optional
user.signedContracts[].witnessSignaturePhoto.thumbURL	string		Optional
user.signedContracts[].witnessSignaturePhoto.type	string	Possible values are: `Photo` `Document` `Kml`	Optional
user.signedContracts[].witnessSignaturePhoto.updated	boolean		Optional
user.source	string	Possible values are: `Blaze` `WooCommerce`	Optional
user.sourceCompanyId	string		Optional
user.textOptIn	boolean		Optional
user.updated	boolean		Optional
user.verificationPhone	string		Optional
user.verificationWebsite	string		Optional
user.verified	boolean		Optional
user.verifyMethod	string	Possible values are: `Website` `Phone`	Optional

ConsumerAuthResult resource

Methods

Resource

Properties