Person Enrichment

Récupérer un résultat (polling)

Poll du résultat d’un enrichissement async. Boucler tant que le statut est 202/425. Un résultat en attente de paiement est débité automatiquement sur votre crédit dès que le solde le couvre (la réponse porte alors paidWithCredit et creditDeducted). Une recharge règle aussi, de la plus ancienne à la plus récente, les recherches restées en attente de paiement.

get/search/results/{id}

Request

  • Base URL: https://api.listar.fr
  • URL: https://api.listar.fr/search/results/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

ID renvoyé par POST /search/unified.

Response

Résultat complet.

totalResultsinteger
excludedboolean

Présent et true quand la personne a exercé ses droits RGPD (effacement ou opposition) : profiles est vide et rien n’est facturé.

paidWithCreditboolean
creditDeductedinteger

Montant débité en centimes.

freeResultboolean
idstring

ID de la recherche, présent dans toutes les réponses (sync 200 comme async 202/402). Ré-interrogeable à tout moment via GET /search/results/{id} - vous pouvez donc traiter sync et async avec le même code.

searchResultIdstring

Alias historique de id (même valeur). Conservé pour compatibilité - préférez id.

Example response

{
  "query": {
    "birthYear": 1985
  },
  "totalResults": 1,
  "profiles": [
    {
      "phones": [
        {
          "number": "+33612345678",
          "isVirtual": true
        }
      ],
      "emails": [
        {
          "type": "professional"
        }
      ]
    }
  ],
  "bestPhone": {
    "number": "+33612345678",
    "isVirtual": true
  },
  "bestEmail": {
    "type": "professional"
  },
  "paidWithCredit": true,
  "creditDeducted": 60
}

Changes

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