Natixis – Transmission de demandes de crédit immobilier
-
Vue d'ensemble
Consommer l'API
La description des services proposés ci-après n’est que purement fonctionnelle. Les aspects techniques sont répertoriés dans la rubrique « Cas d’usage » > « Transmettre un dossier de financement » qui sont plus détaillées.
Pré-requis
- Le partenaire doit signer une convention de partenariat avec l’établissement, ou la banque
- L’éditeur doit délivrer un certificat qu’il aura demandé et obtenu préalablement à une autorité de certification reconnue ; lors de la demande de GO-LIVE (validation technique faite par BPCE-IT).
- Le partenaire doit obtenir ses identifiants de connexion BPCE, à partir de l’Extranet Partenaires
Cinématique globale de consommation de l’API
Création d’une application
L’API « Transmission de demandes de crédit immobilier » (ou API « Injection de données ») est privée : vous devez vous inscrire sur le portail en créant un compte professionnel (sélectionnez « développements professionnels » dans la liste proposée).
La création de votre compte professionnel fait l’objet d’une validation par l’équipe Portail 89C3 (délai J+1 ouvré)
Vous devez, à partir du menu « Application », créer votre application concernant l’API « Injection de données » :
A la validation, vous arrivez sur l’onglet de gestion des identifiants de l’application :
Il faut générer l’identifiant OAuth (la clé d’APIs est inutile pour votre cas) en cliquant sur le bouton « Générer », il vous permet de récupérer l’IDClient et de préciser l’URL de redirection (qui doit être fournie par le partenaire) :
Vous devez fournir l’URL de redirection :
Vous devez identifier la clé secrète en cliquant sur le symbole identifié dans l’écran portail , onglet authentification, ligne identifiants OAuth :
Demande de GoLive
Vous devez saisir une demande de GoLive (formulaire) pour consommer l’API « Transmission de demandes de crédit immobilier ».
Depuis le portail, sur notre application, vous devez cliquer sur le bouton « Demander GoLive » et vous devez remplir le formulaire demandé.
Saisie du Formulaire de demande de GoLive
Vous devez saisir des informations concernant votre entreprise et votre application.
Vous devez également télécharger la clé de votre certificat (.pem) et la joindre dans le formulaire.
Etapes de validation obligatoires suite à la demande de mise en production :
- Demande GoLive
- Validation technique (validation du certificat)
- Validation juridique (contrôle des contrats juridiques signés entre le partenaire et l’établissement/banque)
- Validation API Owner
- Etape finale
- Accès live
Récupérer votre jeton
Cinématique de récupération du jeton
1. Vous devez, dans un premier temps, récupérer l’authorization code (étape 3 du diagramme), via l’URL :
2. Les paramètres à renseigner sont décrits ci-dessous.
PARAMÈTRES | SANDBOX | LIVE |
URL AS | https://www.as-sandbox.api.89c3.com/api/oauth/v2/authorize | https://www.as-live.api.89c3.com/api/oauth/v2/authorize |
client_id | A récupérer lors de la création de l’application consommatrice sur le portail | A récupérer lors de la création de l’application consommatrice sur le portail |
login-hint | En attente provisionning ICG (mail) | En attente provisionning ICG (mail) |
scope | manageHomeLoanPrescriber | manageHomeLoanPrescriber |
response_type | code | code |
redirect_uri | https://fqdnduconsommateur/callback | https://fqdnduconsommateur/callback |
state | Donnée interne du consommateur | Donnée interne du consommateur |
cdetab | 16188 | / |
typ_app | template | / |
typ_srv | PARTENAIRES | / |
enseigne | BPCE | / |
typ_sp | out-band | / |
typ_act | auth | / |
display | page | / |
3. Vous récupérerez à l’étape 8 (authentification ICG) la page index.html qu’il faudra intégrer dans un conteneur web de votre application.
4. La saisie du mot de passe (étape 9) permettra de récupérer l’authorization code. Pour rappel, la saisie de l’identifiant BPCE est un pré-requis.
5. Après l’étape 14 (récupération de l’authorization code), vous devez démarrer la procédure de récupération de l’access-token.
Vous devez tout d’abord récupérer l’access token via l’URL : https://www.as-ex-hml-89c3api.qpa.bpce.fr/api/oauth/v2/token?grant_type=authorizationCode&redirect_uri=http://www.google.fr&code=123456789&client_id=3a1022ab-7dc6-45c0-9df1-2f051a7398d5
Les paramètres à renseigner sont les suivants :
PARAMÈTRES | SANDBOX | LIVE |
URL AS | https://www.as-sandbox.api.89c3.com/api/oauth/v2/token | https://www.as-live.api.89c3.com/api/oauth/v2/token |
client_id | authorizationCode | authorizationCode |
grant_type | En attente provisionning ICG (mail) | En attente provisionning ICG (mail) |
redirect_uri | https://fqdnduconsommateur/callback | https://fqdnduconsommateur/callback |
client_id | A récupérer lors de la création de l’application consommatrice sur le portail | A récupérer lors de la création de l’application consommatrice sur le portail |
Rafraîchir votre jeton
Au bout de 90 jours votre refresh_token arrive à expiration. Pour en récupérer un nouveau, vous devrez reprendre cette cinématique »Récupérer votre jeton » et passer, de facto, par une nouvelle étape d’authentification forte du client auprès de son établissement bancaire.
- Authentification du partenaire à partir d’ICG : le partenaire devra s’authentifier sur une IHM de saisie à partir d’une adresse mail ; cet écran s’activera automatiquement depuis les logiciels ALTO, Courtier WEB, CAFPI, etc.
Catégories
-
Vue d'ensemble
-
Cas d'usage
-
Comment tester l'API
Transmettre un dossier de financement
Contexte
Le partenaire reçoit son client et saisit les informations du projet dans son logiciel
- Process actuel : le partenaire doit transmettre manuellement la carcasse du dossier à l’établissement bancaire par mail et/ou par courrier
- Process futur : la carcasse est transmise à l’établissement bancaire et intégré au SI automatiquement
- Le partenaire reçoit instantanément un retour de prise en charge du dossier
Ce service permet de :
- Recevoir un flux de données comprenant les données client et prospect, les données du financement, le plan de financement, l’objet du bien…
- Contrôler les données nécessaires à l’injection dans le Système d’Information des Caisses d’Epargne et des Banques Populaires.
- Calculer un financement sur la base des éléments fournis en amont, transmettre un avis de faisabilité à partir Pré-score, dans certains cas ce service calculera une Contre-proposition ; il permet aussi de contrôler les homonymies ; créer un client/prospect.
Le dossier ainsi contrôlé sera intégré à l’outil d’instruction Mycredimmo (Caisse d’Epargne) et VCI (Banques Populaires). Il y aura en fin de processus un retour par notification vers le partenaire et le conseiller.
Paramètres obligatoires, facultatifs et conditionnés du Body requis pour l’appel de ce service
Informations générales de la demande
NIVEAU | MÉTHODE | PARAMÈTRE | TYPE | DESCRIPTION | O / F | EXEMPLES / VALEURS | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
0 | initiate | O | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1 | 0 | initiate | Object | O | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1.1 | 1 | initiateCharacteristics | characteristics | Object | Cette structure doit contenir toutes les données fonctionnelles décrivant l’interaction, nécessaires à sa réalisation ou issues de son traitement. | O | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1.1.1 | 1.1 | bankId | String | Caractérise le Code Banque de France de l’établissement bancaire | O |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1.1.2 | 1.1 | homeLoanPrescriberId | Identifiant | Identifiant du dossier de crédit immobilier | F | Information restituée en sortie | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1.1.3 | 1.1 | prescriberHomeLoanFolderId | String | Référence du dossier chez le partenaire | F | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1.1.4 | 1.1 | prescriberFileComments | String | Commentaires dossier partenaire | F | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1.1.5 | 1.1 | currencyFolder | TypologieCourte | Devise du dossier | O | Valeur : ‘EUR’, ‘Euros’ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1.1.6 | 1.1 | creationDate | String | Date de saisie de la demande par le partenaire | O | Format « AAAA-MM-JJ » | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1.1.7 | 1.1 | notificationPrescriberIndicator | Boolean | Indicateur précisant si le partenaire souhaite être notifié par mail | F | Si non renseigné, le partenaire recevra des notifications par mail |
Informations sur le partenaire
NIVEAU | MÉTHODE | PARAMÈTRE | TYPE | DESCRIPTION | O / F | EXEMPLES / VALEURS | |
1.1.8 | 1.1 | initiateCapiProduct | capiProduct | Object | Chargé d’Affaire Prescription Immobilière (CAPI) en charge de la négociation du dossier avec le partenaire | F | Ce bloc permet d’affecter les notifications à un conseiller en particulier |
1.1.8.1 | 1.1.8 | mail du Chargé d’Affaire Prescription Immobilière (CAPI) en charge de la négociation du dossier avec le partenaire | F | ||||
1.1.8.2 | 1.1.8 | name | String | Nom du CAPI | F | ||
1.1.8.3 | 1.1.8 | firstName | String | Prénom du CAPI | F | ||
1.1.9 | 1.1 | Entité : nom de l’objet RestLabPrescriber | prescriber | Object | Information relative au partenaire | O | |
1.1.9.1 | 1.1.9 | prescriberId | String | Identifiant du prescripteur | F | ||
1.1.9.2 | 1.1.9 | SIRET | String | Numéro de SIRET du partenaire | O | ||
1.1.9.3 | 1.1.9 | Entité : nom de l’objet RestLabPrescriberAdvisor | prescriberAdvisor | Object | Informations relatives au conseiller partenaire qui a instruit le dossier | F | |
1.1.9.3.1 | 1.1.9.3 | useName | String | Nom du conseiller partenaire | F | ||
1.1.9.3.2 | 1.1.9.3 | firstName | String | Prénom du conseiller partenaire | F | ||
1.1.9.3.3 | 1.1.9.3 | phone | Phone | Téléphone du conseiller partenaire | F | ||
1.1.9.3.4 | 1.1.9.3 | Email du conseiller partenaire | F | ||||
1.1.9.4 | 1.1.9 | PostalCode | String | Code postal du partenaire | O |
Informations sur le projet
NIVEAU | MÉTHODE | PARAMÈTRE | TYPE | DESCRIPTION | O / F | EXEMPLES / VALEURS | |
1.1.10 | 1.1 | Entité : nom de l’objet RestLabRealty | realty | Object | Projet immobilier | O | |
1.1.10.1 | 1.1.10 | homeLoanProjectType | TypologieCourte | Nature du Projet | O | Valeurs : ‘0’, ‘achat de bien’ ‘1’, ‘terrain nu’ ‘2’, ‘construction’ ‘3’, ‘rachat de crédit’ ‘4’, ‘travaux seuls’ |
|
1.1.10.2 | 1.1.10 | homeLoanSearchStageCode | TypologieCourte | Etat de la recherche | F | Valeurs : ‘0’, ‘Je commence à réfléchir’ ‘1’, ‘j’ai trouvé le bien à financer’ ‘2’, ‘j’ai fait une offre’ |
|
1.1.10.3 | 1.1.10 | Entité : nom de l’objet RestLabProperty | property | Object | Bien financé | O | |
1.1.10.3.1 | 1.1.10.3 | propertyType | TypologieCourte | Type de bien | C | Valeurs : ‘0’, ‘Maison’ ‘1’, ‘Appartement’ ‘2’, ‘Terrain avec construction’ ‘3’, ‘Terrain sans construction’ ‘4’, ‘Immeuble’ ‘5’, ‘Garage’ ‘6’, ‘Parking’ ‘7’, ‘Bateau à usage d’habitation’ ‘8’, ‘Péniche à usage d’habitation’Obligatoire si homeLoanProjectType = ‘0’ , ‘1’, ‘2’, ‘4’ Règles : |
|
1.1.10.3.2 | 1.1.10.3 | propertyCondition | TypologieCourte | Etat du bien | C | Valeurs : ‘0’, ‘ancien’ ‘1’, ‘neuf’ Obligatoire si propertyType = ‘0’ ou ‘1’ Ne pas renseigner sinon |
|
1.1.10.3.3 | 1.1.10.3 | newPropertyCode | TypologieCourte | Décrit le type de bien neuf | C | Valeurs : ‘1’, ‘clefs en main’ ‘2’, ‘sur plan (VEFA)’ Si neuf, obligatoire Ne pas renseigner sinon |
|
1.1.10.3.4 | 1.1.10.3 | propertyUseType | TypologieCourte | Usage du bien | O | Valeurs : ‘0’, ‘En propre à usage de Résidence Principale’ ‘1’, ‘En propre à usage de Résidence Secondaire’ ‘2’, ‘En propre à usage Professionnel ou Mixte’ ‘3’, ‘Locatif à usage de Résidence Principale’ ‘4’, ‘Locatif à usage de Résidence Secondaire’ ‘5’, ‘Locatif à usage Professionnel ou Mixte’ ‘6’, ‘Locatif’ ‘7’, ‘En propre non exploité’ ‘X’, ‘Indéterminé’ ‘Z’, ‘Autre’ |
|
1.1.10.3.5 | 1.1.10.3 | notarySignDate | Date | Date de la signature chez le notaire (acte de vente définitif) | F | ||
1.1.10.3.6 | 1.1.10.3 | address | Adresse | Adresse du bien | C | Cf Objet adress ci-dessous Une ligne peut être vide si pas de complément d’adresse par exemple, mais on positionnera néanmoins une chaîne vide dans location La ligne d’adresse 6 (CP + Ville) ainsi que le codePostal et le countryIso2 sont obligatoires et ne doivent pas comporter les caractères « <« , « > » sauf en cas de rachat de crédit (homeLoanProjectType = ‘3’) |
|
1.1.10.3.7 | 1.1.10.3 | town | String | Code INSEE de la ville du bien | F | ||
1.1.10.3.8 | 1.1.10.3 | townLabel | String | Libellé ville | C | Pour la gestion des villes étrangères Obligatoire si CountryIso2 est différent de « FR » | |
1.1.10.3.9 | 1.1.10.3 | livingSpace | Number | Surface habitable du bien | C | Obligatoire si propertyType= ‘0’, ‘1’ ou ‘2’ Si renseigné >0 |
|
1.1.10.3.10 | 1.1.10.3 | groundSurface | Number | Surface du terrain | C | Obligatoire si propertyType= ‘2’ ou ‘3’ Si renseigné >0 |
|
1.1.10.3.11 | 1.1.10.3 | additionnalSurfaces | Number | Surfaces annexes | F | ||
1.1.10.3.12 | 1.1.10.3 | livingSpaceCreated | Number | Surface habitable créée | F | ||
1.1.10.3.13 | 1.1.10.3 | estimatedValue | Montant | Estimation de la valeur du bien | F | ||
1.1.10.3.14 | 1.1.10.3 | groundAcquisitionDate | Date | Date d’acquisition du terrain | F | Cas d’une construction seule | |
1.1.10.3.15 | 1.1.10.3 | energyPerformance | TypologieCourte | Performance énergétique du bien | F | Valeurs : ‘A’, ‘ ‘B’, ’51 à 90 Kwh/m3/an’ ‘C’, ’91 à 150 Kwh/m3/an’ ‘D’, ‘151 à 230 Kwh/m3/an’ ‘E’, ‘231 à 330 Kwh/m3/an’ ‘F’, ‘331 à 120 Kwh/m3/an’ ‘G’, ‘> 450 Kwh/m3/an’ ‘H’, ‘Très Haute performance’ ‘L’, ‘PSLA Métropole Dérogatoire (DFA<01/01/2012)’ ‘M’, ‘RTAA ou RTG DOM exclusivement’ ‘N’, ‘Autre’ ‘O’, ‘BBC 2005 et dépôt PC avant le 01/01/2013’ ‘P’, ‘HPE Rénovation’ ‘Q’, ‘BBC Rénovation’ ‘R’, ‘RT 2012’ ‘S’, ‘PSLA DOM Dérogatoire (DFA<01/01/2012)’ ‘V’, ‘Rénovation : 2 attestations de performance’ ‘Y’, ‘Logement ancien de type monument historique’ ‘Z’, ‘Logement ancien sans DPE (sans chauffage)’ |
|
1.1.10.3.16 | 1.1.10.3 | housingRoomCount | Integer | Performance énergétique du bien | F | ||
1.1.10.3.17 | 1.1.10.3 | housingCount | Integer | Nombre de logements du bien | F | ||
1.1.10.3.18 | 1.1.10.3 | startConstructionDate | Date | Date de début de la construction | F | ||
1.1.10.3.19 | 1.1.10.3 | endConstructionDate | Date | Date de fin de la construction | C | Obligatoire si présence d’un prêt réglementé | |
1.1.10.3.20 | 1.1.10.3 | Entité : nom de l’objet RestLabCostProperty | costProperty | Object | Coût de l’objet | C | Obligatoire si projet différent de rachat de crédit (homeLoanProjectType = ‘3’), dans ce cas, les coûts sont détaillés dans les crédits en cours |
1.1.10.3.20.1 | 1.1.10.3.20 | totalCost | Montant | Montant total | O | Le montant total correspond à la somme des coûts listés dans CostPropertyItems | |
1.1.10.3.20.2 | 1.1.10.3.20 | Entité : nom de l’objet RestLabCostPropertyItems | costPropertyItems | Array | Liste des coûts de l’objet | F | |
1.1.10.3.20.2.1 | 1.1.10.3.20.2 | costType | TypologieCourte | Type de coût | O | Valeurs : ‘1’, ‘Montant de l’acquisition’ ‘2’, ‘Coût de la construction’ ‘3’, ‘Coût des Travaux’ ‘4’, ‘Montant du terrain’ ‘5’, ‘Valeur du mobilier’ ‘6’, ‘Montant des frais de négociation’ ‘7’, ‘Montant des frais de notaire’Règles de cohérence selon le bien financé :
|
|
1.1.10.3.20.2.2 | 1.1.10.3.20.2 | costAmount | Montant | Montant du coût | C | Obligatoire si achat d’un logement + travaux |
Objet Adresse
NIVEAU | NOM | TYPE | DESCRIPTION | O / F | EXEMPLES / VALEURS |
1 | address | Address | Objet représentant une adresse | ||
1.1 | location | List | Adresse selon la norme AFNOR NF Z 10-011 | O | Ligne 1 : Identité du destinataire (Civilité, Titre ou Qualité + Prénom et Nom Ligne 2 : La ligne 2 permet d’indiquer le point de remise ou un complément d’identification du destinataire (N° APP ou BAL-ETAGE-COULOIR-ESC) Ligne 3 : La ligne 3 permet d’indiquer le point de remise (ENTREE-BATIMENT-IMMEUBLERESIDENCE) Ligne 4 : La ligne 4 permet d’identifier la voie de destination (NUMERO-LIBELLE DE LA VOIE) Ligne 5 : Pour une adresse française : La ligne 5 permet d’identifier la destination (LIEU DIT ou SERVICE PARTICULIER DE DISTRIBUTION) Pour une adresse étrangère : La ligne 5 permet d’identifier la destination (CODE POSTAL et LOCALITE DE DESTINATION) Ligne 6 : Pour une adresse française : La ligne 6 permet d’identifier la destination (CODE POSTAL et LOCALITE DE DESTINATION ou CODE CEDEX et LIBELLE CEDEX) Pour une adresse étrangère : La ligne 6 permet d’identifier la destination (PAYS DE DESTINATION) |
1.1 | postalCode | String | Code postal de la ville : Identifie le bureau distributeur du courrier | O | |
1.1 | countryIso2 | String | Identifie un pays selon la nomenclature AFNOR conforme à l’ISO 3166-1988 alpha-2 | O | Exemple pour France : « FR » Cf. Annexe 1 |
Informations sur le bien revendu
NIVEAU | MÉTHODE | PARAMÈTRE | TYPE | DESCRIPTION | O / F | EXEMPLES / VALEURS | |
1.1.11 | 1.1 | Entité : nom de l’objet RestLabResaleProperty | resaleProperty | Object | Revente du bien | F | L’alimentation de se bloque conditionnera le positionnement d’un prêt relais |
1.1.11.1 | 1.1 | propertyType | TypologieCourte | Type de bien | O | Valeurs : ‘0’, ‘Maison’ ‘1’, ‘Appartement’ ‘2’, ‘Terrain avec construction’ ‘3’, ‘Terrain sans construction’ ‘4’, ‘Immeuble’ ‘5’, ‘Garage’ ‘6’, ‘Parking’ ‘7’, ‘Bateau à usage d’habitation’ ‘8’, ‘Péniche à usage d’habitation’ |
|
1.1.11.2 | propertyCondition | TypologieCourte | Etat du bien | C | Valeurs : ‘0’, ‘ancien’ ‘1’, ‘neuf’Obligatoire si propertyType = ‘0’ ou ‘1’ |
||
1.1.11.3 | 1.1.11 | outstandingCapital | Montant | Montant du CRD du bien revendu | O | ||
1.1.11.4 | 1.1.11 | outstandingDate | Date | Date du CRD | F | ||
1.1.11.5 | 1.1.11 | address | Adresse | Adresse du bien vendu | O | Cf Objet Adress – La ligne d’adresse 6 (CP + Ville) ainsi que le codePostal et le countryIso2 sont obligatoires et ne doivent pas comporter les caractères « <« , « > » | |
1.1.11.6 | 1.1.11 | townLabel | String | Libellé de la commune (cas d’une adresse hors France) | F | ||
1.1.11.7 | 1.1.11 | acquisitionAmount | Montant | Montant d’acquisition du bien revendu (montant auquel le bien a été acheté à l’origine) | F | ||
1.1.11.8 | 1.1.11 | acquisitionDate | Date | Date d’acquisition du bien revendu | F | ||
1.1.11.9 | 1.1.11 | propertyAcquisitionMode | TypologieCourte | Mode d’acquisition du bien revendu | F | Valeurs : ‘1’, ‘achat’ ‘2’, ‘donation’ ‘3’, ‘héritage’ |
|
1.1.11.10 | 1.1.11 | estimatedAmount | Montant | Montant de l’estimation du bien revendu | O | Permet de calculer le montant du prêt relais | |
1.1.11.11 | 1.1.11 | estimatedDate | Date | Date de l’estimation du bien revendu | F |
Informations sur les intervenants du dossier
NIVEAU | MÉTHODE | PARAMÈTRE | TYPE | DESCRIPTION | O / F | EXEMPLES / VALEURS | |
1.1.12 | 1.1 | Entité : nom de l’objet RestLabContributors | contributors | Array | Intervenant sur le dossier | O | |
1.1.12.1 | 1.1.12 | Entité : nom de l’objet RestLabContributor | contributor | Object | Intervenant sur le dossier (emprunteurs, garant, …) | O | |
1.1.12.1.1 | 1.1.12.1 | borrowerRole | TypologieCourte | Rôle de la personne (emprunteur, garant) | O | Valeurs : ‘1’, ’emprunteur principal’ ‘2’, ‘co-emprunteur’ |
|
1.1.12.1.1.1 | 1.1.12.1.1 | affectationType | TypologieCourte | Entité à qui la charge est reliée. Permet d’associer une personne à un type et de faire référence à ce type d’affectation au lieu de l’identifiant personne.La valeur 0 permet d’affecter un objet à toutes les personnes d’un dossier (exemple : affectation d’une charge à toutes les personnes d’un dossier de crédit immobilier) |
O | Valeurs : ‘0’, ‘toutes les personnes’ ‘1’, ‘personne 1’ ‘2’, ‘personne 2’ |
|
1.1.12.1.2 | 1.1.12.1 | civility | TypologieCourte | Civilité permet d’associer une personne à un type et de faire référence à ce type d’affectation au lieu de l’identifiant personne.La valeur 0 permet d’affecter un objet à toutes les personnes d’un dossier (exemple : affectation d’une charge à toutes les personnes d’un dossier de crédit immobilier) |
O | Valeurs : ‘1’, ‘Monsieur’ ‘2’, ‘Mademoiselle’ ‘3’, ‘Madame’ |
|
1.1.12.1.3 | 1.1.12.1 | familyName | String | Nom de naissance (patronymique) | O | ||
1.1.12.1.4 | 1.1.12.1 | useName | String | Nom d’usage (marital) | F | ||
1.1.12.1.5 | 1.1.12.1 | firstName | String | Prénom | O | ||
1.1.12.1.6 | 1.1.12.1 | birthDate | Date | Date de naissance | O | ||
1.1.12.1.7 | 1.1.12.1 | birthLocalityLabel | String | Libellé ville de naissance | O | ||
1.1.12.1.8 | 1.1.12.1 | birthLocality | String | Code INSEE du lieu de naissance | F | ||
1.1.12.1.9 | 1.1.12.1 | postalCode | String | Code postal | F | ||
1.1.12.1.10 | 1.1.12.1 | Country iso2 | TypologieCourte | Pays de naissance | F | ISO 3166-1 alpha-2 Valeurs : ‘AD’, ‘ANDORRE’ ‘AE’, ‘EMIRATS ARABES UNIS’ ‘AF’, ‘AFGHANISTAN’ … ‘ZA’, ‘AFRIQUE DU SUD’ ‘ZM’, ‘ZAMBIE’ ‘ZW’, ‘ZIMBABWE’ (cf Annexe1) |
|
1.1.12.1.11 | 1.1.12.1 | nationality | TypologieCourte | Nationalité | O | ISO 3166-1 Valeurs : ‘AD’, ‘Andorrane’ ‘AE’, ‘Emirienne’ ‘AF’, ‘Afghane’ … ‘ZA’, ‘Sud-africaine’ ‘ZM’, ‘Zambienne’ ‘ZW’, ‘Zimbabweenne’ (cf Annexe 1) |
|
1.1.12.1.12 | 1.1.12.1 | familySituation | TypologieCourte | Situation familiale | O | Valeurs : ‘0’, ‘Célibataire’ ‘1’, ‘Marié’ ‘2’, ‘Concubin’ ‘3’, ‘Séparé ou en instance de séparation (suite à jugement)’ ‘4’, ‘Veuf’ ‘5’, ‘Divorcé’ ‘6’, ‘Pacsé’ ‘X’, ‘Indéterminé’ |
|
1.1.12.1.13 | 1.1.12.1 | housingCondition | TypologieCourte | Condition de logment | O | Valeurs : ‘1’, ‘Propriétaire’ ‘3’, ‘Locataire non meublé’ ‘4’, ‘Locataire meublé’ ‘5’, ‘Logé par l’employeur’ ‘6’, ‘Logé en famille’ ‘7’, ‘Logé à titre gratuit’ ‘8’, ‘Hôtel’ ‘9’, ‘Autre’ ‘x’, ‘Indéterminé’ |
|
1.1.12.1.14 | 1.1.12.1 | frenchTaxResident | Boolean | Résident fiscal français (indicateur) | O | ||
1.1.12.1.15 | 1.1.12.1 | matrimonialRegime | TypologieCourte | Régime matrimonial | F | Valeurs : ‘0’,’Communauté légale’ ‘1’,’Communauté réduite aux acquêts’ ‘2’,’Communauté universelle’ ‘3’,’Séparation de biens’ ‘4’,’Communauté des meubles et acquêts’ ‘5’,’Régime de participations aux acquêts’ ‘X’,’Indéterminé’ ‘Z’,’Autres régimes’ |
|
1.1.12.1.16 | 1.1.12.1 | legalCapacity | TypologieCourte | Code capacité juridique | O | Valeurs : ’00’,’Mineur sous mesure d’aide à la gestion du budget familial’ ’01’,’Mineur émancipé’ ’02’,’Mineur sous administration légale pure et simple’ ’03’,’Mineur ss administration légale ss cont. judiciaire’ ’04’,’Mineur ss tutelle complète (tuteur + subrogé tut.+ juge)’ ’05’,’Mineur sous tutelle d’état’ ’06’,’Mineur sous administration ad hoc’ ’07’,’Majeur capable’ ’08’,’Majeur sous sauvegarde de justice’ ’09’,’Majeur sous sauvegarde de justice mandat donné’ ’10’,’Majeur sous sauvegarde de justice mandat spécial’ ’11’,’Majeur sous curatelle simple (art 508)’ ’12’,’Majeur sous curatelle renforcée (art 512)’ ’13’,’Majeur sous gérance de tutelle’ ’14’,’Majeur avec habilitation familiale’ ’15’,’Majeur sous tutelle’ ’16’,’Majeur sous mesure d’accompagnement social personnalisé’ ’17’,’Majeur sous mesure d’accompagnement judiciaire’ ’18’,’Majeur sous mesure d’aide à la gestion du budget familial’ ’19’,’Majeur sous mandat de protection future simple’ ’20’,’Majeur sous mandat de protection future étendu’ ‘XX’,’Indéterminé’ |
|
1.1.12.1.17 | 1.1.12.1 | housingDate | Date | Date d’occupation du logement actuel | F |
Informations sur les moyens de communication
NIVEAU | MÉTHODE | PARAMÈTRE | TYPE | DESCRIPTION | O / F | |
1.1.12.1.18 | 1.1.12.1 | Entité : nom de l’objet RestLabCommunicationMean | communicationMean | Object | Moyen de communication | O |
1.1.12.1.18.1 | 1.1.12.1.18 | postalAdress | Adresse | Adresse du prospect | O | |
1.1.12.1.18.2 | 1.1.12.1.18 | townLabel | String | Ville | F | |
1.1.12.1.18.3 | 1.1.12.1.18 | town | String | Code INSEE de la ville | F | |
1.1.12.1.18.4 | 1.1.12.1.18 | Adresse email | O | |||
1.1.12.1.18.5 | 1.1.12.1.18 | cellPhone | Phone | Numéro de téléphone portable | O | |
1.1.12.1.18.6 | 1.1.12.1.18 | optInIndicator | Boolean | Opt-in | O | |
1.1.12.1.18.7 | 1.1.12.1.18 | optInDate | Date | Date de modification de l’opt-in | F | |
1.1.12.1.18.7 | 1.1.12.1.18 | phoneNumber | Phone | Numéro de téléphone fixe | F |
Informations sur les données employeur
NIVEAU | MÉTHODE | PARAMÈTRE | TYPE | DESCRIPTION | O / F | EXEMPLES / VALEURS | |
1.1.12.1.19 | 1.1.12.1 | Entité : nom de l’objet RestLabEmployerData | employerData | Object | Données employeur | F | |
1.1.12.1.19.1 | 1.1.12.1.19 | professionalCategory | TypologieCourte | Code catégorie socio-professionnelle | O | Valeurs : ’11’, ‘Agriculteurs sur petite exploitation’ ’12’, ‘Agriculteurs sur moyenne exploitation’ ’13’, ‘Agriculteurs sur grande exploitation’ ’21’, ‘Artisans’ ’22’, ‘Commerçants et assimilés’ ’23’, ‘Chefs d’entreprise de 10 salariés ou plus’ ’31’, ‘Professions libérales’ … ’81’, ‘Chômeurs n’ayant jamais travaillé’ ’83’, ‘Militaires du contingent’ ’84’, ‘Elèves, étudiants’ ’85’, ‘Personnes diverses sans activité professionnelle de moins de 60 ans (sauf retraités)’ ’86’, ‘Personnes diverses sans activité professionnelle de 60 ans et plus (sauf retraités)’ |
|
1.1.12.1.19.2 | 1.1.12.1.19 | employementContract | TypologieCourte | Type de contrat de travail | O | Valeurs : ‘CDD’, ‘CDD’ ‘CDI’, ‘CDI’ ‘INT’, ‘Interim’ ‘AUT’, ‘Autre’ ‘XXX’, ‘Indéterminé’ |
|
1.1.12.1.19.3 | 1.1.12.1.19 | hiringDate | Date | Date début contrat travail | C | Obligatoire sauf si activitySector = ‘0’, ‘Sans Objet’ | |
1.1.12.1.19.4 | 1.1.12.1.19 | activitySector | TypologieCourte | Secteur d’emploi | O | Valeurs : ‘0’, ‘Sans Objet’ ‘1’, ‘Indépendant sans salarié’ ‘2’, ‘Employeur’ ‘3’, ‘Aide familiale (ou femme au foyer)’ ‘4’, ‘Salarié Ent.du secteur privé’ ‘5’, ‘Salarié de l’état’ ‘6’, ‘Salarié collect.locales,hopitaux’ ‘7’, ‘Salarié de la sécurité sociale’ ‘8’, ‘Salarié entrep.publique,nationales’ |
Console Try-it
Principe
En vous connectant sur le portail, vous pouvez :
- faire appel à l’API souhaitée via un formulaire dans lequel vous sélectionnez votre application et le jeton d’accès
- puis vous saisissez les paramètres de la méthode que vous souhaitez tester (soit headers, soit body), ceux mentionnés par une étoile étant obligatoires
Une fois les paramètres saisis, vous pouvez lancer l’exécution de la requête : vous obtiendrez soit un résultat, soit une erreur.
Après récupération de l’identifiant OAuth, aller sur l’onglet « Documentation » du produit « Injection de données ».
Sélectionner la ligne accountsGet dans le totem de gauche pour accéder au module TRY-IT.
Ouvrir le chevron TRY-IT et renseigner les zones suivantes :
- Application (ouvrir la liste déroulante) et sélectionner l’application que vous avez ajouté précédemment :
- Le client OAuth (sélectionner la clé) :
- Ressource owner (liste déroulante) :
- Saisir la signature (dans notre exemple « XX »)
- Saisir X-Request-ID (XX)
- Cliquer sur le bouton « Exécuter »
Catégories
-
Cas d'usage
-
Comment tester l'API