BeCLM - Documentation APIs
Breadcrumbs

Formats des données attendues

Entité Personne

Donnée

Format

Description

Utilisé pour

Exemple

firstName

string


personnes physiques

Jean

lastName

string

Nom de famille pour une personne physique

Raison sociale pour une personne morale

personnes physiques

personnes morales

DUPONT

maidenName

string


personnes physiques


nationality

string

Nom du pays en français ou code numérique du pays (cf. https://www.iso.org/obp/ui/fr/#search)

personnes physiques

FRANCE

civility

MR | MRS | SOC

Civilité de la personne. Elle peut être utiliser pour déterminer le type de personne contrôlée.

  • MR | MRS : Personne physique

    • MR = Monsieur

    • MRS = Madame

  • SOC : Personne morale

personnes physiques

personnes morales

MR

personType

string

Type de personne : vous permet de taguer certaines personnes pour pouvoir les rechercher plus facilement

personnes physiques

personnes morales

Prospect

siren

Int

9 caractères


personnes morales

123456789

legalForm

string

Forme juridique

personnes morales


orias

string

Identifiant ORIAS pour pouvoir contrôler la personne

personnes morales



Données de naissance (birth)

Donnée

Format

Description

Utilisé pour

Exemple

date

date - iso8601

Date de naissance pour une personne physique

Date de création pour une personne morael

personnes physiques

personnes morales

1980-03-21

place

string

Ville de naissance ou de création

personnes physiques

Bordeaux

department

string

Département / région de naissance

personnes physiques

Gironde

country

string

Pays de naissance

Nom du pays en français ou code numérique du pays (cf. https://www.iso.org/obp/ui/fr/#search)

personnes physiques

FRANCE


Adresse postale

Donnée

Format

Description

Utilisé pour

Exemple

address

date - iso8601

Numéro et rue de l’adresse de résidence

personnes physiques

personnes morales

14 Rue des Cerisiers

zipCode

string

Code postal

personnes physiques

personnes morales

33000

city

string

Ville de résidence

personnes physiques

personnes morales

Bordeaux

country

string

Pays de résidence

Nom du pays en français ou code numérique du pays (cf. https://www.iso.org/obp/ui/fr/#search)

personnes physiques

personnes morales

FRANCE


Entité Document

Donnée

Format

Description

Exemple

id

string

Identifiant technique du document


externalRef

string

Référence externe de la personne à laquelle est lié le document


path

string

Chemin d’accès au document


name

string

Nom du document


completenessStatus

Enum : [ MISSING, OUTDATED, TO_CHECK, UP_TO_DATE, NOT_SUITABLE, IN_PROGRESS ]

Statut de complétude

2024-07-30T08:23:42.876Z

conformityStatus

Enum : [ MISSING, OUTDATED, TO_CHECK, UP_TO_DATE, NOT_SUITABLE, IN_PROGRESS ]

Statut de conformité

2024-07-30T08:23:42.876Z

upToDateDate

datetime - iso8601

Date de mise à jour


expirationDate

datetime - iso8601

Date d’expiration du document


blobIds

List <String>

Identifiants techniques des blobs


statusComment

string

Commentaire du document