Enrichissement

Permet de lancer un enrichissement de contact (téléphone, email ou LinkedIn) et de consulter le résultat.

Notification par webhook

L'enrichissement est un processus asynchrone. Deux méthodes pour récupérer le résultat :

• Polling : interroger régulièrement GET /v1/enrichment/:id jusqu'à ce que executed soit true
• Webhook : configurer un webhook sur les événements enrichment.completed et/ou enrichment.failed pour être notifié automatiquement lorsque l'enrichissement est terminé (voir Webhooks)

Lancer un enrichissement

POST /v1/enrichment

Lance un enrichissement pour un contact. Si un enrichissement du même type est déjà en cours pour le contact, son statut est retourné sans en créer un nouveau.

Si le contact CRM n'existe pas mais qu'un contact est trouvé dans le référentiel Coefficy pour le couple email + siren, un contact CRM est automatiquement créé avant de lancer l'enrichissement.

Headers

Nom	Type	Requis	Description
x-access-token	String	oui	Clé API

Body (JSON)

Nom	Type	Requis	Description
type	String	oui	Type d'enrichissement : phone, email ou linkedin
idCrmVisitCard	int	conditionnel	Identifiant du contact CRM. Obligatoire si email et siren ne sont pas renseignés
email	String	conditionnel	Email du contact. Obligatoire (avec siren) si idCrmVisitCard n'est pas renseigné
siren	String	conditionnel	SIREN de l'entreprise. Obligatoire (avec email) si idCrmVisitCard n'est pas renseigné

TIP

Deux modes d'identification du contact :

• Par identifiant : fournir idCrmVisitCard
• Par email + siren : fournir email et siren. Si aucun contact CRM n'existe pour ce couple, il sera créé automatiquement depuis le référentiel Coefficy.

Le contact doit obligatoirement avoir un nom et un prénom pour que l'enrichissement puisse être lancé.

Réponses

200 — Enrichissement lancé

{
    "success": true,
    "code": "200",
    "message": "Enrichissement lancé",
    "parameters": {
        "idCrmVisitCard": "int|null",
        "email": "string|null",
        "siren": "string|null",
        "type": "string"
    },
    "result": {
        "idProcessAction": "int",
        "status": "<ProcessActionStatus>"
    }
}

400 — Bad Request

{
    "success": false,
    "code": "400",
    "message": "Le paramètre type est requis"
}

Retourné si :

• Le paramètre type est manquant
• Ni idCrmVisitCard ni le couple email + siren n'est renseigné
• Le type n'est pas phone, email ou linkedin
• Le contact n'a pas de nom et prénom (contact CRM existant ou référentiel)
• Aucun contact avec nom et prénom n'est trouvé dans le référentiel pour le couple email + siren

403 — Forbidden

{
    "success": false,
    "code": "403",
    "message": "Le service d'enrichissement n'est pas disponible pour ce compte"
}

Retourné si le service CRM ou le service d'enrichissement externe n'est pas activé, ou si le compte est bloqué.

Également retourné si l'utilisateur tente d'accéder à un contact CRM d'un autre compte.

404 — Not Found

{
    "success": false,
    "code": "404",
    "message": "CrmVisitCard introuvable"
}

Retourné si :

• Le idCrmVisitCard fourni n'existe pas
• Aucune entreprise n'est trouvée pour le siren fourni

---

Consulter le statut d'un enrichissement

GET /v1/enrichment/:id

Retourne le statut d'un enrichissement et son résultat si celui-ci est terminé.

Paramètres URL

Nom	Type	Requis	Description
id	int	oui	Identifiant (idProcessAction)

Headers

Nom	Type	Requis	Description
x-access-token	String	oui	Clé API

Réponses

200 — OK

{
    "success": true,
    "code": "200",
    "message": "OK",
    "parameters": {
        "idProcessAction": "int"
    },
    "result": {
        "idProcessAction": "int",
        "status": "<ProcessActionStatus>",
        "executed": "bool",
        "errored": "bool",
        "output": "<ProcessActionOutput>|null",
        "crmVisitCard": "<CrmVisitCard>|null"
    }
}

• executed : true lorsque l'enrichissement est terminé
• errored : true si l'enrichissement a échoué
• output : résultat de l'enrichissement (présent uniquement si executed est true)
• crmVisitCard : contact CRM enrichi avec les données mises à jour

400 — Bad Request

{
    "success": false,
    "code": "400",
    "message": "Le paramètre id est requis"
}

403 — Forbidden

{
    "success": false,
    "code": "403",
    "message": "L'utilisateur n'a pas accès à cet enrichissement"
}

404 — Not Found

{
    "success": false,
    "code": "404",
    "message": "Enrichissement introuvable"
}