Aller au contenu

Champs d’identité

Les champs que prennent POST /v1/clients, PATCH /v1/clients/{id} et les parties de POST /v1/cases, sur une seule page. À la création, tout est facultatif sauf le nom ; une analyse en exige un peu plus.

Créer un client ne vérifie que le format. Lancer son analyse exige aussi de quoi distinguer deux personnes ; sinon elle répond incomplete_identity, avec les champs manquants dans missing[].

Client Exigé pour une analyse
Personne first_name, last_name, birth_date, au moins une des nationalities
Société française name, siren, registration_country

Toujours un code ISO 3166-1 alpha-2 : FR, DE, MA. LexOpti le met en majuscules (fr devient FR) et refuse un nom comme France avec validation_failed. L’analyse compare ces codes aux nationalités des listes de sanctions et des personnes politiquement exposées (PPE) : un nom de pays ne correspondrait jamais.

Champ Format Exemple
first_name Obligatoire, comme sur la pièce d’identité Camille
last_name Obligatoire, comme sur la pièce d’identité Durand
usage_name Le nom d’usage, par exemple un nom d’épouse Martin
birth_date AAAA-MM-JJ 1980-02-01
birth_city Texte Lyon
birth_country Code pays FR
nationalities Codes pays, 10 au plus ["FR"]
Champ Format Exemple
name Obligatoire, la dénomination sociale Atelier Durand
siren 9 chiffres, sans espaces 552100554
siret 14 chiffres, sans espaces 55210055400013
legal_form En général l’abréviation SAS
registration_country Code pays FR
rcs Comme sur le Kbis Paris B 552 100 554
Champ Format Exemple
line Numéro, voie et complément éventuel 12 rue de la Paix
postal_code Texte 75002
city Texte Paris
country Code pays, pour une personne seulement (celui d’une société est registration_country) FR

Les champs texte sont débarrassés de leurs espaces de début et de fin, et font 255 caractères au plus.

Une personne prête à être analysée :

{
"type": "person",
"person": {
"first_name": "Camille",
"last_name": "Durand",
"birth_date": "1980-02-01",
"nationalities": ["FR"]
},
"address": {
"line": "12 rue de la Paix",
"postal_code": "75002",
"city": "Paris",
"country": "FR"
}
}
  • "France" au lieu de "FR" : refusé avec validation_failed, qui nomme le champ.
  • Une date écrite 01/02/1980 : envoyez 1980-02-01.
  • Un SIREN ou un SIRET avec des espaces : envoyez les chiffres seuls.
  • Un client créé sans date de naissance ni nationalité, puis analysé : l’analyse répond incomplete_identity. Complétez-le avec PATCH /v1/clients/{id}, puis relancez l’analyse (erreurs).