Aller au contenu principal

Rechercher une entreprise dans le Directory français — SANDBOX uniquement

Cette fonction des Partner APIs est réservée au parcours historique MANUAL en SANDBOX. Avant de créer la racine juridique ou l'établissement dans ce parcours, le partenaire peut valider un SIREN, un SIRET ou un nom d'entreprise via le Directory français du tenant.

QUAL et PROD

Cette API Partner Directory n'est pas le mécanisme utilisé en QUAL ou en PROD. Dans ces environnements, la mise en service de l'entreprise passe par le workflow d'onboarding de la Tenant Public API.

➡️ Onboarding de la Tenant Public API

Requête​

GET https://partners-api.sandbox.mybcs.fr/v1/tenants/{tenantSlug}/directory/french
Authorization: Bearer <access_token>
User-Agent: BCSolutions

Paramètres :

tenantSlug=acme-fr
q=name:"732829320"
limit=10
offset=

Paramètre tenantSlug​

tenantSlug est obligatoire.

Paramètre q​

Le paramètre q est obligatoire. Il permet de sélectionner le mode de recherche.

Recherche par nom :

q=name:"Acme Corporation"

Recherche par SIREN :

q=siren:"123456789"

Recherche par SIRET :

q=siret:"12345678901234"

Pagination​

Le paramètre limit précise le nombre de valeurs récupérées.

  • valeur par défaut : 25 lorsqu'il n'est pas renseigné ;
  • valeur maximale : 100.

Le paramètre offset permet de naviguer dans les pages de résultats.

Le client peut poursuivre les appels jusqu'à ce qu'il n'y ait plus de résultats à récupérer.

Réponse​

La réponse contient une liste d'items avec notamment :

  • businessEntityId ;
  • name ;
  • country ;
  • scope ;
  • identifierScheme ;
  • identifierValue.

Un bloc meta contient les informations de pagination : offset, limit et count.