Mentis Technologies REST API Documentation
The Mentis Technologies API allows for integration with its AI-driven compliance and
automation solutions. The welcome call endpoint facilitates the creation of a welcome call
record, with specific handling for co-buyer information if applicable.
API Key:
Endpoint: welcome call
• URL: [Link]
• Method: POST
• Description: Creates a welcome call record with optional co-buyer
information.
Request Headers
• Content-Type: application/json
• Authorization: Bearer token (the auth parameter in the body should match
the provided token)
Request Parameters:
Key Type Required Description
Authentication token for accessing the
auth text Yes
API.
customerFirstName text Yes First name of the primary customer.
customerLastName text Yes Last name of the primary customer.
customerPhone text Yes Phone number of the primary customer.
customerEmail text Yes Email address of the primary customer.
geographic
customerAddress Yes Address of the primary customer.
address
contractPrice number No Total contract price for the project.
Language preference for the welcome
chosenLanguage text Yes
call.
projectID text Yes Unique identifier for the project.
Indicates if a text message should be
sendText yes/no Yes
sent (yes or no).
Specifies if there is a co-buyer
CoBuyer yes/no Yes
(yes or no).
First name of the co-buyer (only
CoBuyerFirstName text No
required if CoBuyer is yes).
Last name of the co-buyer (only
CoBuyerLastName text No
required if CoBuyer is yes).
Phone number of the co-buyer (only
CoBuyerPhone text No
required if CoBuyer is yes).
Email address of the co-buyer (only
CoBuyerEmail text No
required if CoBuyer is yes).
geographic Address of the co-buyer (only required
CoBuyerAddress No
address if CoBuyer is yes).
tag1 to tag16 text No Optional tags for custom information.
Optional date fields for specifying
date1 to date4 date No
custom dates.
Disclosure text Yes Disclosure form unique ID
Sends the salesperson a copy of the
addEmail Text No
customer’s initial login link.
Sample Request: coBuyer = no
{
"auth": "8099a68b-0307-4223-98c6-e4726a76483c",
"customerFirstName": "Christopher",
"customerLastName": "Trocola",
"customerPhone": "5209759575",
"customerEmail": "chris+00005@[Link]",
"customerAddress": "12000 E Ryscott Cr, Vail, AZ 85641",
"contractPrice": 375128,
"chosenLanguage": "English",
"projectID": "A24-1982830",
"sendText": "yes",
"CoBuyer": "no",
"date1": "2024-10-18T13:45:00Z"
}
Response
● Status: 200 OK
● Content-Type: application/json
Sample Response
{
"status": "success",
"response": {
"Welcome Call": {
"_id": "1729297101395x923797809868520800",
"Modified Date": 1729297101719,
"Created Date": 1729297101401,
"Created By": "non_authenticated_user_mentisnativo_test",
"customer_name_text": "Christopher Trocola",
"customer_adress_text": "12000 Ryscott Cir, Vail, AZ 85641,
USA",
"customer_email_text": "chris+00005@[Link]",
"customerphoneqa_text": "5209759575",
"company_custom_company": "1681357552100x468750872683504100",
"completed__boolean": false,
"contractnumber_text": "A24-1982830",
"contractprice1_number": 375128,
"customerfirstname_text": "Christopher",
"customerlastname_text": "Trocola",
"q1_boolean": false,
"changeorder_boolean": false,
"idverified__boolean": false,
"declined_boolean": false,
"isqatest__boolean": false,
"downpayment_number": 0,
"federalincentive_number": 0,
"enterstateincentive_number": 0,
"city_text": "Vail",
"zip_number": 85641,
"inpectionspayment_number": 0,
"customer_user": "1729297101500x148247669233915650",
"companytocharge_list_custom_company": [
"1681357552100x468750872683504100"
],
"access_list_custom_company": [
"1681357552100x468750872683504100"
],
"chosen_option_language0": "English",
"temppassword_text": "?0<fDQ9u",
"resent_date": 1729297101284,
"api__boolean": true,
"unlockcreatetime_date": 1729297221284,
"allowaccess_boolean": true,
"sendtext_boolean": true,
"resend_date": 1729383501284,
"_customtag17date__date": 1729259100000,
"secondaryfullname_text": " ",
"cobuyer_boolean": false,
"secondary_boolean": false,
"showsecondary_boolean": false,
"state_text": "Arizona"
},
"Customer": {
"_id": "1729297101500x148247669233915650",
"Modified Date": 1729297101607,
"Created Date": 1729297101501,
"first_name_text": "Christopher",
"full_name_text": "Christopher Trocola",
"is_notification_on_boolean": true,
"last_name_text": "Trocola",
"role_text": "Homeowner",
"staylogin_boolean": true,
"user_signed_up": true,
"authentication": {
"email": {
"email": "chris+00005@[Link]",
"email_confirmed": null
}
},
"certified_boolean": false,
"phone_text": "5209759575",
"address_geographic_address": {
"address": "12000 Ryscott Cir, Vail, AZ 85641, USA",
"lat": 32.0677489,
"lng": -110.7361931
},
"is_advertiser__boolean": false,
"is_realtor__boolean": false,
"directtoinstaller_boolean": false,
"examrestricted_boolean": false,
"qafile_custom_quality_assurance":
"1729297101395x923797809868520800",
"aiallowed_boolean": false,
"chosenlanguage_option_language0": "English",
"setupcomplete_boolean": false,
"passwordvisible_text": "?0<fDQ9u",
"allqafile_list_custom_quality_assurance": [
"1729297101395x923797809868520800"
],
"permission_option_user_permission": "Admin",
"subscription_option_ai_welcome_call": "Starter"
}
}
}
Sample Request: coBuyer = yes
{
auth:8099a68b-0307-4223-98c6-e4726a76483c
chosenLanguage:English
customerLastName:Trocola
customerFirstName:Christopher
customerPhone:5209759575
customerEmail:chris+00004@[Link]
customerAddress:12000 E Ryscott Cr, Vail, Az 85641
projectID:A24-1982830
contractPrice:375128
sendText:yes
CoBuyer:yes
CoBuyerFirstName:Brian
CoBuyerLastName:Johnston
CoBuyerAddress:6700 E Speedway Blvd, Tucson, Az 85710
CoBuyerPhone:9255503060
CoBuyerEmail:brian+00004@[Link]
date1:2024-10-18T13:45:00Z
}
Response
● Status: 200 OK
● Content-Type: application/json
Sample Response
{
"status": "success",
"response": {
"Welcome Call": {
"_id": "1729297027347x173606036283182600",
"Modified Date": 1729297027683,
"Created Date": 1729297027353,
"Created By": "non_authenticated_user_mentisnativo_test",
"customer_name_text": "Christopher Trocola",
"customer_adress_text": "12000 Ryscott Cir, Vail, AZ 85641,
USA",
"customer_email_text": "chris+00004@[Link]",
"customerphoneqa_text": "5209759575",
"company_custom_company": "1681357552100x468750872683504100",
"completed__boolean": false,
"contractnumber_text": "A24-1982830",
"contractprice1_number": 375128,
"customerfirstname_text": "Christopher",
"customerlastname_text": "Trocola",
"q1_boolean": false,
"changeorder_boolean": false,
"idverified__boolean": false,
"declined_boolean": false,
"isqatest__boolean": false,
"downpayment_number": 0,
"federalincentive_number": 0,
"enterstateincentive_number": 0,
"city_text": "Vail",
"zip_number": 85641,
"inpectionspayment_number": 0,
"customer_user": "1729297027448x750415186656673000",
"companytocharge_list_custom_company": [
"1681357552100x468750872683504100"
],
"access_list_custom_company": [
"1681357552100x468750872683504100"
],
"chosen_option_language0": "English",
"resent_date": 1729297026435,
"api__boolean": true,
"unlockcreatetime_date": 1729297146435,
"allowaccess_boolean": true,
"sendtext_boolean": true,
"resend_date": 1729383426435,
"_customtag17date__date": 1729259100000,
"secondaryphone_text": "9255503060",
"secondaryaddress_geographic_address": {
"address": "6700 E Speedway Blvd, Tucson, AZ 85710, USA",
"lat": 32.2350247,
"lng": -110.8494008
},
"secondaryemail_text": "brian+00004@[Link]",
"secondayfirstname_text": "Brian",
"secondarylastname_text": "Johnston",
"secondaryfullname_text": "Brian Johnston",
"cobuyer_boolean": false,
"secondary_boolean": true,
"customer2_user": "1729297026625x136269691806920160",
"showsecondary_boolean": true,
"state_text": "Vail"
},
"Customer": {
"_id": "1729297027448x750415186656673000",
"Modified Date": 1729297027597,
"Created Date": 1729297027448,
"first_name_text": "Brian",
"full_name_text": "Brian Johnston",
"is_notification_on_boolean": true,
"last_name_text": "Johnston",
"role_text": "Homeowner",
"staylogin_boolean": true,
"user_signed_up": true,
"authentication": {
"email": {
"email": "brian+00004@[Link]",
"email_confirmed": null
}
},
"certified_boolean": false,
"phone_text": "9255503060",
"address_geographic_address": {
"address": "6700 E Speedway Blvd, Tucson, AZ 85710, USA",
"lat": 32.2350247,
"lng": -110.8494008
},
"is_advertiser__boolean": false,
"is_realtor__boolean": false,
"directtoinstaller_boolean": false,
"examrestricted_boolean": false,
"qafile_custom_quality_assurance":
"1729297027347x173606036283182600",
"aiallowed_boolean": false,
"chosenlanguage_option_language0": "English",
"setupcomplete_boolean": false,
"passwordvisible_text": "_kyX72<H",
"allqafile_list_custom_quality_assurance": [
"1729297027347x173606036283182600"
],
"permission_option_user_permission": "Admin",
"subscription_option_ai_welcome_call": "Starter",
"iscobuyer_boolean": true
}
}
}
Notes:
• Ensure CoBuyer field is set correctly to avoid sending unnecessary co-
buyer information.
• All date fields should be in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
• auth is required for validating access to the API.
• Optional fields like tags and date can be omitted if not used.
Notes on Tags (tag1 to tag16) and Dates (date1 to date4)
• Customization and Flexibility: The tag1 to tag16 and date1 to date4 fields are
designed to be fully customizable by the company. These fields allow you to create
names that align with your internal processes, making it easy to map the welcome-
call data into your existing system.
• Integration with Mentis Portal: When you create a welcome call within the Mentis
Portal, these tags and dates can be named according to your preference, reflecting
specific stages, events, or data points in your process. This approach enables your front-
end system to seamlessly align with Mentis, offering a tailored user experience for your
team.
• Example Usage: For instance, a company could
use tag1 as "VerificationComplete" and date1 as "VerificationDate", based on their
workflow. This ensures that when data is sent to or received from the Mentis system, it
integrates smoothly with your pre-defined stages.
• Recommendation: It is recommended to use consistent naming conventions for these
tags and dates across your applications to ensure smooth data handling and reduce
potential confusion during integration.
Resend QA (Endpoint)
● Endpoint: [Link]
● Method: POST
● Description: Resend email and text message.
Request Parameters:
Key Type Required Description
Authentication token for accessing the
auth text Yes
API.
Quality Assurance Unique ID
QualityAssurance text Yes
Sample Request
{
"auth": "8099a68b-0307-4223-98c6-e4726a76483c",
"QualityAssurance": "1709512288576x680686651264991200"
}
Response
● Status: 200 OK
● Content-Type: application/json
Sample Response
{
"status": "success",
"response": {}
}
Completed Session (Endpoint)
● Endpoint: [Link]
● Method: POST
● Description: Completes a QA session.
Request Body
Key Type Description
QASession text QA Session Unique ID
QualityAssurance text Quality Assurance Unique ID
Sample Request
{
"QASession": "1716879914092x348124293217648640",
"QualityAssurance": "1709512288576x680686651264991200"
}
Response
● Status: 200 OK
● Content-Type: application/json
Sample Response
{
"status": "",
"response": {
"QASession": {
"Modified Date": 0,
"Created Date": 0,
"Created By": "",
"qafacial_list_custom_quality_assurance_facial_recognition":
[""],
"qafile_custom_quality_assurance": "",
"sessionid_text": "",
"video_list_custom_video": [""],
"name_text": "",
"completed_boolean": true
},
"QualityAssurance": {
"_id": "",
"Modified Date": 0,
"Created Date": 0,
"Created By": "",
"customer_name_text": "",
"customer_adress_text": "",
"customer_email_text": "",
"customerphoneqa_text": ""
}
}
}
Manual Review
● Endpoint: [Link]
● Method: POST
● Description: Submits a manual review for a QA session.
Request Body
Key Type Required Key
ManualReviewApproved text yes Boolean
ManualReviewDeclined text yes Boolean
QualityAssurance text yes Quality Assurance Unique ID
Sample Request
{
"ManualReviewApproved": "yes",
"ManualReviewDeclined": "no",
"QualityAssurance": "1709512288576x680686651264991200"
}
Response
● Status: 200 OK
● Content-Type: application/json
Sample Response
{
"status": "success",
"response": {
"QA Session": {},
"Questions": []
}
}
Start Time
● Endpoint: [Link]
● Method: POST
● Description: Logs the start time of a QA session.
Request Body: Form-Data
Key Type Description
QAuniqueID text Unique ID of the QA session
Sample Request
{
"QAuniqueID": "1709512288576x680686651264991200"
}
Response
● Status: 200 OK
● Content-Type: application/json
Sample Response
{
"status": "success",
"response": {
"startTime": "05/29/2024 10:49 am"
}
}
Get List of Quality Assurance
● Endpoint: [Link]
● Method: Post
● Description: Get List of Quality Assurance
● IMPORTANT: If uniqueID is not provided, the response may include a complete list
containing data from all welcome calls.
Key Type Required Description
auth text Yes Authentication token for accessing the API.
uniqueID text No Unique ID of the QA session
Sample Response
{
"status": "success",
"response": {
"q": [
{
"Modified Date": 1716886459479,
"Created Date": 1685196144703,
"Created By": "1684585063727x893310569441785100",
"customer_name_text": "Sting",
"customer_adress_text": "Sting",
"customer_email_text": "[Link]@[Link]",
"customerphoneqa_text": "3192829983",
"completed__boolean": false,
"driverlicensenumber_text": "09as8duf[90",
"idexipriatondate_date": 203218182000000,
"idtype_option_idtype": "Passport",
"stateissued_option_states": "Arkansas",
"stoppedtime_date": 1693111867356,
"starttime_date": 1716886459430,
"_id": "1685196142756x450702343211581440"
},
{
"Modified Date": 1685196347885,
"Created Date": 1685196347838,
"Created By": "1684585063727x893310569441785100",
"customer_name_text": "SodaStereo",
"customer_adress_text": "SodaStereo",
"customer_email_text": "[Link]@[Link]",
"customerphoneqa_text": "9809237893",
"_id": "1685196347269x413403896307253250"
}
]
}
}
Data to Send (Webhook)
Endpoint: ?
Provide us the endpoint with credentials to send you data upon completion.
Sample
{
"QA_uniqueID": "1685196142756x450702343211581440", //Quality Assurance Unique
ID
"Completed": "yes",//Boolean
"Manual_Review": "yes",//Boolean,
"declinedReason "reason for declined",/String,
"Questions": ["a. Rate of payment escalation: [Escalator] Date of first
escalation: [Escalator Start Date].
b. The estimated timeline for the installation of the distributed generation system
is [Installation Completion Date].
c. The per kilowatt-hour rate of electricity for the first year of the agreement
is: [kWh Rate].
"Declined"or:"Agreed" ], //List of Strings
"Video_Url": "[Link]
[Link]/recordingStream/jMApLAHrRbKm/a00f1a94d144c7a406b32f863d425fca_jMApL
AHrRbKm_0.mp4",
"screenshare": "[Link]
[Link]/recordingStream/jMApLAHrRbKm/a00f1a94d144c7a406b32f863d425fca_jMApL
AHrRbKm_0.mp4",
"disclosurepdf": "[Link]
/jMApLAHrRbKm/a00f1a94d144c7a406b32f863d425fca_jMApLAHrRbKm_0.mp4",
"reason": "I decided not to move forward because the price did not match the
contract.",//String
"IDimage": ""[Link]
/jMApLAHrRbKm/a00f1a94d144c7a406b32f863d425fca_jMApLAHrRbKm_0.mp4"",//String
}
Resend QA
● Endpoint: [Link]
● Method: POST
● Description: Submits a manual review for a QA session.
Request Body
Key Type Description
customerFirstName text Customer First Name
customerLastName text Customer Last Name
customerAddress text Street Address
City text City
State text State
zipCode text Zip Code
customerPhone text Customer Phone, no country code 5202219005
customerEmail text Customer Email
QualityAssurance text Unique ID of the Quality Assurance
Customer Text Unique ID of the Customer
Response
● Status: 200 OK
● Content-Type: application/json
Sample Response
{
"status": "success",
"response": {
"Finance Quality Assurance": {
"_id": "1720654596995x230343707407417340",
"declined_boolean": false,
"Modified Date": 1720851945312,
"Created Date": 1720654597428,
"Created By": "1691900651207x424056939506108200",
"customer_adress_text": "6700 E Speedway Blvd",
"customer_email_text": "craig+1@[Link]",
"customer_name_text": " ",
"customerphoneqa_text": "6507665563",
"salespersonname_text": "Brian Johnston",
"installerid_text": "51643",
"completed__boolean": false,
"salesperson_list_user": [
"1691890964148x148060356966955420"
],
"company_custom_company": "1691900650347x698801298746638300",
"dealerlicense_text": "7190422",
"dealer_list_custom_company": [
"1691895926453x956202659492921300"
],
"paymenttype_option_paymenttype": "Finance",
"financecompany_list_custom_company": [
"1693952543034x909200078654927000"
],
"contractprice1_number": 25000,
"systemsize_number": 9000,
"installer_list_custom_company": [
"1691900650347x698801298746638300"
],
"contractnumber_text": "OP4XM23",
"starttime_date": 1720726820684,
"q1_boolean": false,
"idverificationfile_file":
"//[Link]/f1720719645714x285096525919459780
/driver%[Link]",
"changeorder_boolean": false,
"idverified__boolean": false,
"isqatest__boolean": false,
"dealernametext_text": "Mentis Dealer",
"installernametext_text": "Mentis Installer",
"financecompanynametext_text": "EnFin",
"repfirstname_text": "Brian",
"replastname_text": "Johnston",
"salespersonnametext_text": "Brian Johnston",
"facecompare_boolean": false,
"salescompanyuniqueid_custom_company":
"1691895926453x956202659492921300",
"downpayment_number": 0,
"estimatedcompletion_date": 1727672400000,
"completionpayment_number": 25000,
"rebateoffered_text": "No additional rebates.",
"federalincentive_number": 7500,
"enterstateincentive_number": 0,
"installstate_option_states": "Texas",
"cert_custom_certification": "1691895470299x701500099526393900",
"city_text": "Austin",
"firstyearproduction_number": 12547,
"leaseannualpayment_number": 121.54,
"inpectionspayment_number": 0,
"sessionid_text": "1720654596995x230343707407417340_lITSgiemYVEq",
"session_list_custom_qa_session": [
"1720726820678x892736813523009500"
],
"productfinance_custom_finance_product":
"1708547995052x128307605356412930",
"apr_number": 8.99,
"sitesurvey_list_custom_site_survey": [
"1720654596995x859572332370329600"
],
"customer_user": "1720654597535x580088771697499000",
"installstep_custom_install_steps": "1704170398299x424585550013399000",
"language_option_language": "Jenny (english)",
"disclosures_custom_disclosure_forms1":
"1713288464982x729308487134478300",
"companytocharge_list_custom_company": [
"1691900650347x698801298746638300"
],
"cancellationemail_text": "cancellationtest@[Link]",
"warranty_custom_warranty": "1701661116638x397297666971926500",
"endofleasedetails_text": "End of contract details go here",
"term_option_term": "25 Years",
"noachapr_number": 0.5,
"ipaddress1_text": "[Link]",
"access_list_custom_company": [
"1691900650347x698801298746638300",
"1691895926453x956202659492921300",
"1693952543034x909200078654927000"
],
"chosen_option_language0": "English",
"prepaymentoptions_text": "No pre-payment penalties",
"detailsspanish_text": "Préstamo EnFin a 25 años al 8,99%",
"endofcontractdetails_text": "Los detalles de fin de contrato van
aquí",
"prepaymentdetailsspanish_text": "Sin multas por pago anticipado",
"productdetails_text": "EnFin 25-Year 8.99% Loan",
"temppassword_text": "D#a79iC{",
"monthlypaymentamount_number": 121.54,
"api__boolean": false,
"idpassed_boolean": true,
"customerfirstname_text": null,
"customerlastname_text": null,
"zip_number": null
},
"Customer": {
"_id": "1720654597535x580088771697499000",
"Modified Date": 1720851945326,
"Created Date": 1720654597535,
"full_name_text": " ",
"is_notification_on_boolean": true,
"role_text": "Homeowner",
"staylogin_boolean": true,
"user_signed_up": true,
"authentication": {
"email": {
"email": "craig+1@[Link]",
"email_confirmed": null
}
},
"certified_boolean": false,
"cert_custom_certification": "1720732658296x741640120138989600",
"phone_text": "6507665563",
"address_geographic_address": {
"address": "6700 E Speedway Blvd, Tucson, AZ 85710, USA",
"lat": 32.2350247,
"lng": -110.8494008
},
"is_advertiser__boolean": false,
"is_realtor__boolean": false,
"directtoinstaller_boolean": false,
"examrestricted_boolean": false,
"installedstate_option_states": "Texas",
"qafile_custom_quality_assurance": "1720654596995x230343707407417340",
"installstats_option_install_status": "Submitted",
"aiallowed_boolean": false,
"ip_address1_text": "103.r..3r3",
"chosenlanguage_option_language0": "English",
"setupcomplete_boolean": false,
"allqafile_list_custom_quality_assurance": [
"1720654596995x230343707407417340"
],
"passwordvisible_text": "D#a79iC{"
}
}
}
API endpoint
[Link]
Yes Authorized? No
Yes Request OK? No
Invalid or missing Something's wrong API key invalid or
Cached? Request malformed query parameter rate limit reached
Yes No (temporary issue)
Within
freshness
No
lifetime?
Revalidated Return code
with server?
No Store in cache Return code 400 Return code 422 5xx Return code 403
Yes
Yes
Remedy error and Try again or contact Remedy error and
Return code 2xx support
try again try again
Request
complete
Send customer Email
Send 'Start Time' Customer opens
data to company Start Call process Yes
text/email/
No
Send reminders
Call 'Complete'? No
every 24 hours
Yes
Terms
'Accepted'?
No Return Data Terminator
Yes
Manual
Review No
Requied?
Yes
Accept Review Yes
No