API Resources
Clearbox makes it easy and efficient by providing web API services using XML-based Representational State Transfer (REST) style communications that are compatible with most web applications. Clearbox API is designed for use by HTTP protocol clients.
Users may opt to return the following information in XML:
Click on category headings to view fields.Personal Profile Data:
- Prefix
- First Name
- Middle Name
- Last Name
- Suffix
- AKA
- DOB
- Address
- Address 2
- City
- State
- Zip
- Phone
- Fax
- Mobile
- Website
- Gender
- Marital Status
- Ethnicity
- Race
- About
- Photo
Company Profile Data:
- Name
- Administrator
- Administrator Email
- Order Contact
- Order Contact Email
- Website
- Address
- Address 2
- City
- State
- Zip
- County
- Office Phone
- Toll Phone
- Office Fax
- Established
- # of Staff Appraisers
- # of Support Staff
- # of independent
- Contractors
- Type
- Minority
- Insurance
- Insurance Amount
- Insurance Policy
- Insurance Expires
- About
License Data:
- State
- Number
- First Name
- Middle Name
- Last Name
- Suffix
- Effective Date
- Expiration Date
- Issue Date
- Type
- Status
- Company
- Address
- City
- State
- Zip
- County
- County Code
- Phone
- AQB
- License File
Geos/ Fees:
- County
- State
- Product and Fee
- Samples
Education:
- Level of Education
- Year
- Place of Education
Continuing Education:
- CE Type
- CE Provider
- CE Title
- CE Date
- CE Hours
- CE Certificate
Credentials:
- Current Employer
- Start Date
- Previous Employer Name
- Previous Employer Start/End Dates
- Year Started Appraising
- Languages Spoken
- Available For Fee Work
- FHA Approved / ID
- VH Approved / ID
- Business Specialties’
- Consult Residential
- Consult Commercial
- MLS’ Subscribed
- Associations
X-FILE:
- ASC Action
- State Action
- Other Action
- Fine
- Amount
- Start Date
- End Date
- Source
- Content
- Searched
- URL
- Documentation
Sample Output:
Array
(
[request_status] => Array
(
[request_status_code] => Success
[request_status_license] =>
[request_status_state] =>
[request_status_select_lookup] =>
[request_status_version] => 1.1
)
[xfile_info] => Array
(
[xfile_info_status] => Match Found
[xfiles] => Array
(
[xfile] => Array
(
[asc_action] =>
[state_action] =>
[other_action] =>
[fine] =>
[amount] =>
[start_date] =>
[end_date] =>
[source] =>
[content] =>
[searched] =>
[url] =>
[document] =>
)
)
)
[select_info] => Array
(
[select_info_status] => Match Found
[personal_info] => Array
(
[personal_info_status] => Match Found
[prefix] =>
[first_name] =>
[middle_name] =>
[last_name] =>
[suffix] =>
[aka] =>
[dob] =>
[address] =>
[address2] =>
[city] =>
[state] =>
[zip] =>
[phone] =>
[fax] =>
[mobile] =>
[website] =>
[gender] =>
[marital_status] =>
[ethnicity] =>
[race] =>
[about] =>
[photo] =>
)
[company_info] => Array
(
[company_info_status] => Match Found
[companies] => Array
(
[company] => Array
(
[name] =>
[administrator] =>
[administrator_email] =>
[order_contact] =>
[order_contact_email] =>
[website] =>
[address] =>
[address2] =>
[city] =>
[state] =>
[zip] =>
[county] =>
[office_phone] =>
[toll_phone] =>
[office_fax] =>
[established] =>
[staff_appraiser_count] =>
[staff_support_count] =>
[independent_contractor_count] =>
[type] =>
[minority] =>
[insurance] =>
[insurance_amount] =>
[insurance_policy] =>
[insurance_expires] =>
[about] =>
)
)
)
[license_info] => Array
(
[license_info_status] => Match Found
[licenses] => Array
(
[license] => Array
(
[0] => Array
(
[lic_state] =>
[number] =>
[first_name] =>
[middle_name] =>
[last_name] =>
[suffix] =>
[effective_date] =>
[expiration_date] =>
[issue_date] =>
[type] =>
[status] =>
[company] =>
[address] =>
[city] =>
[state] =>
[zip] =>
[county] =>
[county_code] =>
[phone] =>
[aqb] =>
[license_file] =>
)
)
)
)
[geo_info] => Array
(
[geo_info_status] => Match Found
[geos] => Array
(
[geo] => Array
(
[0] => Array
(
[county] =>
[state] =>
[fee_1073_condo] =>
[sample_1073_condo] =>
[fee_1075_condo_drive_by] =>
[sample_1075_condo_drive_by] =>
[fee_2090_cooperative_unit] =>
[sample_2090_cooperative_unit] =>
[fee_desk_review] =>
[sample_desk_review] =>
[fee_desktop_valuation] =>
[sample_desktop_valuation] =>
[fee_1073_fha_condo] =>
[sample_1073_fha_condo] =>
[fee_1004_fha_single_family] =>
[sample_1004_fha_single_family] =>
[fee_1004d_inspection] =>
[sample_1004d_inspection] =>
[fee_1004d_inspection_and_update] =>
[sample_1004d_inspection_and_update] =>
[fee_land] =>
[sample_land] =>
[fee_1004c_manufactured_homes] =>
[sample_1004c_manufactured_homes] =>
[fee_1025_multi_family] =>
[sample_1025_multi_family] =>
[fee_2000a_multi_family_appraisal_review] =>
[sample_2000a_multi_family_appraisal_review] =>
[fee_216_operating_income_statement] =>
[sample_216_operating_income_statement] =>
[fee_erc_relocation_appraisal] =>
[sample_erc_relocation_appraisal] =>
[fee_1007_rent_schedule] =>
[sample_1007_rent_schedule] =>
[fee_2000_single_family_appraisal_review] =>
[sample_2000_single_family_appraisal_review] =>
[fee_2055_single_family_drive_by] =>
[sample_2055_single_family_drive_by] =>
[fee_1004_urar] =>
[sample_1004_urar] =>
)
)
)
)
[education_info] => Array
(
[education_info_status] => Match Found
[level_of_education] =>
[year_of_education] =>
[place_of_education] =>
)
[continuing_education_info] => Array
(
[continuing_education_info_status] => Match Found
[courses] => Array
(
[course] => Array
(
[type] =>
[provider] =>
[course_title] =>
[date] =>
[hours] =>
[certificate] =>
)
)
)
[credential_info] => Array
(
[credential_info_status] => Match Found
[current_employer] =>
[current_employer_start_date] =>
[previous_employer_info] => Array
(
[previous_employer_info_status] => Match Found
[previous_employers] => Array
(
[previous_employer] => Array
(
[0] => Array
(
[previous_employer_name] =>
[previous_employer_start_date] =>
[previous_employer_end_date] =>
)
)
)
)
[year_started_appraising] =>
[languages_spoken] =>
[available_for_free_work] =>
[fha_approved] =>
[fha_id] =>
[va_approved] =>
[va_id] =>
[business_specialties] => Array
(
[residential] =>
[land] =>
[commercial] =>
[industrial] =>
[agricultural] =>
[public] =>
[recreational] =>
[special] =>
)
[consult_residential] =>
[consult_commercial] =>
[mls_info] => Array
(
[mls_info_status] => Match Found
[mlss] = Array
(
[mls] =>
)
)
[associations] => Array
(
[american_society_of_appraisers] =>
[american_society_of_appraisers_designations] =>
[american_society_of_farm_managers_and_rural_appraisers] =>
[american_society_of_farm_managers_and_rural_appraisers_designations] =>
[appraisal_institute] =>
[appraisal_institute_designations] =>
[collateral_risk_network] =>
[international_association_of_assessing_officers] =>
[international_association_of_assessing_officers_designations] =>
[international_right_of_way_association] =>
[international_right_of_way_association_designations] =>
[massachusetts_board_of_real_estate_appraisers] =>
[massachusetts_board_of_real_estate_appraisers_designations] =>
[national_association_of_independent_fee_appraisers] =>
[national_association_of_independent_fee_appraisers_designations] =>
[national_association_of_master_appraisers] =>
[national_association_of_master_appraisers_designations] =>
[national_association_of_realtors] =>
[national_association_of_realtors_designations] =>
[other_associations] =>
)
)
)
)