> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Верификация резидентства Франции: API сверки личности

> France Residential: проверка по официальным базам данных Франции через инфраструктуру Didit. Оплата за вызов от $1.49, без контрактов и минимумов.

Проверяет данные по данным переписи населения, полученным из государственных ведомств. Didit предоставляет этот сервис через `POST /v3/database-validation/`, чтобы вы могли сверить переданные данные с авторитетным источником и получить нормализованные результаты сопоставления.

## Покрытие

* **Покрытие:** \~ 85%
* **Страна:** Франция
* **ID сервиса:** `fra_residential`
* **Область данных:** Адрес
* **Категория:** Жилая

## Входные данные

| Поле | Обязательное | Пример |
| - | -: | - |
| `first_name` | Да | `John` |
| `last_name` | Да | `Doe` |
| `date_of_birth` | Да | `1990-01-01` |
| `address.street_1` | Да | `123 Sample Street` |
| `address.postal_code` | Да | `10001` |
| `address.street_2` | Нет | `Unit 4` |
| `address.city` | Нет | `Sample City` |
| `address.region` | Нет | `Sample State` |
| `vendor_data` | Нет | `user-1234` |

* **Обязательные поля:** `first_name`, `last_name`, `date_of_birth`, `address.street_1`, `address.postal_code`
* **Необязательные поля:** `address.street_2`, `address.city`, `address.region`, `vendor_data`
* **Согласие:** не требуется
* **Доступность в сценарии:** доступно в сценарии
* **Покрытие:** \~ 85%
* **Цена:** \$1.49 за успешный запрос

## Параметры тела запроса

**issuing\_state** `string` *required* (default: FRA)

Код страны ISO 3166-1 alpha-3 для этого сервиса проверки по базам данных.

Пример: `FRA`

**services** `string` *required* (default: fra\_residential)

Массив, содержащий ID этого сервиса. Фиксация сервиса ограничивает запрос этой конкретной базой данных.

Пример: `fra_residential`

**first\_name** `string` *required* (default: John)

Имя для проверки.

Пример: `John`

**last\_name** `string` *required* (default: Doe)

Фамилия для проверки.

Пример: `Doe`

**date\_of\_birth** `string` *required* (default: 1990-01-01)

Дата рождения в формате `YYYY-MM-DD`.

Пример: `1990-01-01`

**address** `object` *required* (default: \{"street\_1":"123 Sample Street","street\_2":"Unit 4","city":"Sample City","region":"Sample State","postal\_code":"10001","country":"US"})

Структурированный объект адреса места жительства. Используйте `street_1`, `street_2`, `city`, `region`, `postal_code` и `country`. Полная строка адреса в устаревшем формате по-прежнему принимается, но не рекомендуется.

Пример: `{"street_1":"123 Sample Street","street_2":"Unit 4","city":"Sample City","region":"Sample State","postal_code":"10001","country":"US"}`

**vendor\_data** `string` (default: user-1234)

Ваш стабильный идентификатор этого пользователя, например внутренний ID пользователя. Didit использует его, чтобы связывать отдельные проверки с одним и тем же конечным пользователем и снижать число ложных срабатываний при обнаружении дубликатов.

Пример: `user-1234`

## Правила ввода и примечания к валидации

* Для адресных сервисов по возможности передавайте структурированные поля адреса вместо одной строки `address`.
* `address.street_1` это адрес улицы, включая номер дома и тип улицы.
* `address.street_2` это номер квартиры, блока, корпуса, этажа или дополнительная строка адреса. Передавайте это поле, только если оно у вас есть.
* `address.city` это город, пригород, район, населённый пункт или микрорайон.
* `address.region` это штат, провинция, регион или город.
* `address.postal_code` это почтовый индекс.
* Сервисы проверки по базам данных на основе адреса требуют как минимум адрес улицы и почтовый индекс. Запросы, отклонённые до обращения к источнику, не тарифицируются.

## Как выполнить запрос

```bash cURL theme={null}
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=FRA" \
  -F "services=fra_residential" \
  -F "vendor_data=user-1234" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "date_of_birth=1990-01-01" \
  -F 'address={"street_1":"123 Sample Street","street_2":"Unit 4","city":"Sample City","region":"Sample State","postal_code":"10001","country":"US"}'
```

```python Python theme={null}
from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="FRA",
    services=["fra_residential"],
    first_name="John",
    last_name="Doe",
    date_of_birth="1990-01-01",
    address={"street_1": "123 Sample Street", "street_2": "Unit 4", "city": "Sample City", "region": "Sample State", "postal_code": "10001", "country": "US"},
    vendor_data="user-1234",
)
print(result)
```

```javascript Node.js theme={null}
import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.databaseValidation.validate({
  issuing_state: "FRA",
  services: ["fra_residential"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  address: { street_1: "123 Sample Street", street_2: "Unit 4", city: "Sample City", region: "Sample State", postal_code: "10001", country: "US" },
  vendor_data: "user-1234",
});
console.log(result);
```

```go Go theme={null}
ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.DatabaseValidation.Validate(ctx, didit.DatabaseValidationValidateParams{
	IssuingState: "FRA",
	Services:     didit.Some([]string{"fra_residential"}),
	FirstName:    didit.String("John"),
	LastName:     didit.String("Doe"),
	DateOfBirth:  didit.String("1990-01-01"),
	Address:      didit.Some[any](map[string]any{"street_1": "123 Sample Street", "street_2": "Unit 4", "city": "Sample City", "region": "Sample State", "postal_code": "10001", "country": "US"}),
	VendorData:   didit.String("user-1234"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
import java.time.LocalDate;
import java.util.List;
import me.didit.Didit;
import me.didit.types.DatabaseValidationValidateParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.databaseValidation().validate(DatabaseValidationValidateParams.builder()
        .issuingState("FRA")
        .services(List.of("fra_residential"))
        .firstName("John")
        .lastName("Doe")
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .address(DatabaseValidationValidateParams.Address.ofVariant1(DatabaseValidationValidateParams.Address.Variant1.builder()
                .street1("123 Sample Street")
                .street2("Unit 4")
                .city("Sample City")
                .region("Sample State")
                .postalCode("10001")
                .country("US")
                .build()))
        .vendorData("user-1234")
        .build());
System.out.println(result);
```

```php PHP theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->databaseValidation->validate([
    'issuing_state' => 'FRA',
    'services' => ['fra_residential'],
    'first_name' => 'John',
    'last_name' => 'Doe',
    'date_of_birth' => '1990-01-01',
    'address' => ['street_1' => '123 Sample Street', 'street_2' => 'Unit 4', 'city' => 'Sample City', 'region' => 'Sample State', 'postal_code' => '10001', 'country' => 'US'],
    'vendor_data' => 'user-1234',
]);
print_r($result->toArray());
```

```ruby Ruby theme={null}
require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.database_validation.validate(
  issuing_state: "FRA",
  services: ["fra_residential"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  address: { street_1: "123 Sample Street", street_2: "Unit 4", city: "Sample City", region: "Sample State", postal_code: "10001", country: "US" },
  vendor_data: "user-1234"
)
puts result.to_h
```

```csharp .NET theme={null}
using System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.DatabaseValidation.ValidateAsync(new DatabaseValidationValidateParams
{
    IssuingState = "FRA",
    Services = new string[] { "fra_residential" },
    FirstName = "John",
    LastName = "Doe",
    DateOfBirth = "1990-01-01",
    Address = new Dictionary<string, object> { ["street_1"] = "123 Sample Street", ["street_2"] = "Unit 4", ["city"] = "Sample City", ["region"] = "Sample State", ["postal_code"] = "10001", ["country"] = "US" },
    VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Каждый успешный вызов возвращает HTTP `200`. Поле **`outcome_code`** показывает, что произошло на самом деле: например, отличает реальное несовпадение биометрии (`BIOMETRIC_NO_MATCH`) от селфи, которое не удалось прочитать (`BIOMETRIC_IMAGE_UNUSABLE`). Показанный `status` это статус функции по умолчанию; ваши настроенные [действия при частичном совпадении и при отсутствии совпадения](https://docs.didit.me/ru/core-technology/database-validation/database-validation-warnings.md) могут его переопределить.

**`MATCH`**: реестр подтвердил личность, и все проверенные поля совпали.

```json 200 OK — MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "FRA",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "fra_residential",
      "service_name": "France Residential",
      "source_data": {
        "address": "123 Sample Street",
        "address_match_score": "1.000",
        "city": "Sample City",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "full_name": "John Doe",
        "last_name": "Doe",
        "name_match_score": "1.000",
        "postal_code": "10001",
        "street": "sample_value"
      },
      "validation": {
        "address": "full_match",
        "date_of_birth": "full_match",
        "full_name": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`**: одно или несколько полей, которые сравнивает этот сервис, совпали не полностью. В этом примере `full_name` не совпало, тогда как `address` и `date_of_birth` совпали.

```json 200 OK — PARTIAL_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "FRA",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "fra_residential",
      "service_name": "France Residential",
      "source_data": {
        "address": "123 Sample Street",
        "address_match_score": "1.000",
        "city": "Sample City",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "full_name": "John Doe",
        "last_name": "Doe",
        "name_match_score": "1.000",
        "postal_code": "10001",
        "street": "sample_value"
      },
      "validation": {
        "address": "full_match",
        "date_of_birth": "full_match",
        "full_name": "no_match"
      }
    }
  ]
}
```

**`NO_MATCH`**: реестр не вернул совпадений для переданных данных.

```json 200 OK — NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "FRA",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "fra_residential",
      "service_name": "France Residential",
      "source_data": {
        "address": "NO_MATCH",
        "date_of_birth": "NO_MATCH",
        "full_name": "NO_MATCH"
      },
      "validation": {
        "address": "no_match",
        "date_of_birth": "no_match",
        "full_name": "no_match"
      }
    }
  ]
}
```

## Возвращаемые данные

Точный набор полей в `source_data` зависит от того, что возвращает реестр. Сгенерированный пример для `fra_residential` сейчас описывает такую нормализованную структуру:

* `address`
* `address_match_score`
* `city`
* `date_of_birth`
* `first_name`
* `full_name`
* `last_name`
* `name_match_score`
* `postal_code`
* `street`

## Цены и SLA

Запросы France Residential оплачиваются только тогда, когда Didit получает окончательный результат от источника проверки.

* **Цена за запрос:** \$1.49 USD.
* **Тарификация:** за успешный запрос. Вам не начисляется плата, если реестр недоступен, если обязательные поля не заполнены или если запрос отклонён до отправки в источник.
* **Задержка:** типичное значение p95 \< 2 с.
* **Доступность:** 99.9% за квартал со стороны Didit; доступность внешних источников данных зависит от страны и набора данных.

## Продолжить чтение

* [Обзор проверки по базам данных во Франции](https://docs.didit.me/api-reference/database-validation/france.md)
* [Обзор проверки по базам данных](https://docs.didit.me/ru/core-technology/database-validation/overview.md)
* [Коды результатов](https://docs.didit.me/ru/core-technology/database-validation/database-validation-outcome-codes.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.