Identity fields
The fields POST /v1/clients, PATCH /v1/clients/{id} and the parties of POST /v1/cases take, on one page. Every field is optional at creation except the name; a check needs a few more.
What a check needs
Section titled “What a check needs”Creating a client checks only the format. Launching its check also needs enough to tell two people apart; otherwise it answers incomplete_identity with the missing fields in missing[].
| Client | Needed for a check |
|---|---|
| Person | first_name, last_name, birth_date, at least one of nationalities |
| French company | name, siren, registration_country |
Countries
Section titled “Countries”Always an ISO 3166-1 alpha-2 code: FR, DE, MA. LexOpti upper-cases it (fr becomes FR) and refuses a name such as France with validation_failed. Screening compares these codes with the nationalities of sanctions lists and of politically exposed persons (PEP): a country name would never match.
A person
Section titled “A person”| Field | Format | Example |
|---|---|---|
first_name |
Required, as on the identity document | Camille |
last_name |
Required, as on the identity document | Durand |
usage_name |
The name used day to day, such as a married name | Martin |
birth_date |
YYYY-MM-DD |
1980-02-01 |
birth_city |
Text | Lyon |
birth_country |
Country code | FR |
nationalities |
Country codes, 10 at most | ["FR"] |
A company
Section titled “A company”| Field | Format | Example |
|---|---|---|
name |
Required, the registered name | Atelier Durand |
siren |
9 digits, no spaces | 552100554 |
siret |
14 digits, no spaces | 55210055400013 |
legal_form |
Usually the abbreviation | SAS |
registration_country |
Country code | FR |
rcs |
As on the Kbis | Paris B 552 100 554 |
An address
Section titled “An address”| Field | Format | Example |
|---|---|---|
line |
Number, street and any complement | 12 rue de la Paix |
postal_code |
Text | 75002 |
city |
Text | Paris |
country |
Country code, a person’s only (a company’s is registration_country) |
FR |
Text fields are trimmed and hold 255 characters at most.
Example
Section titled “Example”A person ready to screen:
{ "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" }}Common mistakes
Section titled “Common mistakes”"France"instead of"FR": refused withvalidation_failed, which names the field.- A date as
01/02/1980: send1980-02-01. - A SIREN or SIRET with spaces: send the digits only.
- A client created without birth date or nationality, then screened: the check answers
incomplete_identity. Complete it withPATCH /v1/clients/{id}, then launch the check again (errors).