Contacts and Leads

Check If Contact Exists

Get contact by email, cpf, cnpj or phone_number

get/v1/contact/exists

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/contact/exists
  • Auth: API key in header X-Imobzi-Secret

Query parameters

emailstring nullable
phone_numberstring nullable
cpfstring nullable
cnpjstring nullable
contact_typestring nullable

Response

Successful Response

has_permissionboolean nullable

Example response

{
  "contact": {
    "properties": [
      {
        "field_values": [
          {
            "field_id": "guarantor",
            "type": "boolean",
            "value": "True"
          },
          {
            "field_id": "bail",
            "type": "boolean",
            "value": "False"
          },
          {
            "field_id": "surety_bond",
            "type": "boolean",
            "value": "False"
          },
          {
            "field_id": "bond_application",
            "type": "boolean",
            "value": "True"
          },
          {
            "field_id": "credpago_guarantee",
            "type": "boolean",
            "value": "True"
          },
          {
            "field_id": "iptu",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "condominium",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "water",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "gas",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "light",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "cleaning_fee",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "value_to_fire_insurance",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "approx_fire_insurance_value",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "high_standard",
            "type": "boolean",
            "value": "True"
          },
          {
            "field_id": "with_plaque",
            "type": "boolean",
            "value": "True"
          },
          {
            "field_id": "exclusivity",
            "type": "boolean",
            "value": "False"
          },
          {
            "field_id": "private",
            "type": "boolean",
            "value": "False"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.