Créer une fiche locataire

Il existe 2 types de profils : personne physique et personne morale. Selon le type choisi, ajoutez les informations d'identité, administratives et financières décrites pour créer le profil. Ce profil sera rattachable à un dossier de location en tant que locataire titulaire, tiers ou garant.

Bon à savoir

À ce jour il n'est pas possible de charger des documents directement via l'API GraphQL Ublo.
L'ajout de document doit se faire depuis l'interface.

Personne physique

Utilisez la mutation createPersonalProfile en fournissant un objet conforme au type PersonalProfileInput. L'objet ContactInput permet de renseigner l'identité (civilité, nom, prénom, email, téléphone). Les champs maritalStatus et nationality utilisent les énumérations MaritalStatusType et NationalityType.

mutation CreatePersonalProfile($personalProfile: PersonalProfileInput!) {
  createPersonalProfile(personalProfile: $personalProfile) {
    id
    reference
    contact {
      civility
      firstName
      lastName
      email
      mobilePhone
    }
    maritalStatus
    nationality
  }
}

Personne morale

Utilisez la mutation createMoralProfile avec un objet conforme au type MoralProfileInput. Le champ name est obligatoire. Vous pouvez renseigner l'adresse (AddressInput), le statut juridique (category : LegalStatusEnum), SIREN, SIRET, etc.

mutation CreateMoralProfile($moralProfile: MoralProfileInput!) {
  createMoralProfile(moralProfile: $moralProfile) {
    id
    name
    reference
    siren
    siret
    address {
      street
      zip
      city
      country
    }
  }
}