> ## 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 de vérification auprès du bureau de crédit américain

> Bureau de crédit américain : consultation de la base de données officielle des États-Unis via Didit. Paiement à l'appel dès $0.25, sans contrat ni minimum.

Service agrégé de données d'en-tête de crédit et d'autres services. Didit expose ce service via `POST /v3/database-validation/`, afin que vous puissiez vérifier les données soumises auprès de la source faisant autorité et recevoir des résultats de correspondance normalisés.

## Couverture

* **Couverture :** \~ 90 %
* **Pays :** États-Unis
* **Identifiant du service :** `usa_states_credit_bureau`
* **Domaine de données :** Financier
* **Catégorie :** CreditBureau

## Entrées

| Champ | Requis | Exemple |
| - | -: | - |
| `first_name` | Oui | `John` |
| `last_name` | Oui | `Doe` |
| `date_of_birth` | Non | `1990-01-01` |
| `address.street_1` | Non | `123 Sample Street` |
| `address.street_2` | Non | `Unit 4` |
| `address.city` | Non | `Sample City` |
| `address.region` | Non | `Sample State` |
| `address.postal_code` | Non | `10001` |
| `phone` | Non | `+15550101000` |
| `ssn` | Non | `123456789` |
| `email` | Non | `john.doe@example.com` |
| `vendor_data` | Non | `user-1234` |

* **Entrées obligatoires :** `first_name`, `last_name`
* **Entrées facultatives :** `date_of_birth`, `address.street_1`, `address.street_2`, `address.city`, `address.region`, `address.postal_code`, `phone`, `ssn`, `email`, `vendor_data`
* **Consentement :** non requis
* **Disponibilité dans le workflow :** disponible dans le workflow
* **Couverture :** \~ 90 %
* **Prix :** \$0.25 par requête réussie

## Paramètres du corps de la requête

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

Code pays ISO 3166-1 alpha-3 pour ce service de base de données.

Exemple : `USA`

**services** `string` *required* (default: usa\_states\_credit\_bureau)

Tableau contenant cet identifiant de service. Épingler le service permet de limiter la requête à cette base de données précise.

Exemple : `usa_states_credit_bureau`

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

Prénom à valider.

Exemple : `John`

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

Nom de famille à valider.

Exemple : `Doe`

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

Date de naissance au format `YYYY-MM-DD`.

Exemple : `1990-01-01`

**address** `object`

Objet d'adresse résidentielle structuré. Utilisez `street_1`, `street_2`, `city`, `region`, `postal_code` et `country`. Une chaîne d'adresse complète au format historique reste acceptée, mais n'est pas recommandée.

Exemple : `{"street_1":"123 Sample Street","street_2":"Unit 4","city":"Sample City","region":"Sample State","postal_code":"10001","country":"US"}`

**phone** `string`

Numéro de téléphone au format international.

Exemple : `+15550101000`

**ssn** `string`

Valeur `ssn` requise par ce service de base de données.

Exemple : `123456789`

**email** `string`

Adresse e-mail.

Exemple : `john.doe@example.com`

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

Votre référence utilisateur stable pour cette personne, par exemple votre identifiant interne. Didit l'utilise pour relier les vérifications autonomes au même utilisateur final et réduire le bruit de détection des doublons.

Exemple : `user-1234`

## Règles de saisie et notes de validation

* `address` est facultatif pour ce service. Vous pouvez envoyer une chaîne `address` complète, que Didit découpera en éléments d'adresse structurés si possible, ou envoyer explicitement les champs structurés.
* Numéro de sécurité sociale américain ou ITIN : 9 chiffres complets (tirets facultatifs) ou uniquement les 4 derniers chiffres
* `ssn` doit correspondre à `(?:\d{9}|\d{3}-\d{2}-\d{4}|\d{4})`.
* Pour `ssn`, envoyez soit le numéro SSN/ITIN complet à 9 chiffres (tirets facultatifs), soit uniquement ses 4 derniers chiffres.
* Outre les champs obligatoires `first_name` et `last_name`, incluez au moins un champ supplémentaire parmi `date_of_birth`, `address`, `phone`, `ssn` ou `email`. Une demande ne contenant que le nom est rejetée avant la recherche auprès du fournisseur (et n'est pas facturée) ; `date_of_birth` offre la correspondance la plus fiable.
* Pour les services fondés sur l'adresse, envoyez si possible les champs d'adresse structurés plutôt qu'une seule chaîne `address`.
* `address.street_1` correspond à l'adresse de rue, y compris le numéro et le type de voie.
* `address.street_2` correspond à l'appartement, à l'unité, au bâtiment, à l'étage ou à toute ligne d'adresse supplémentaire. Ne l'envoyez que si vous en disposez.
* `address.city` correspond à la ville, à la banlieue, au district, à la localité ou au quartier.
* `address.region` correspond à l'État, à la province, à la région ou à la ville.
* `address.postal_code` correspond au code postal.
* Les services de base de données fondés sur l'adresse exigent au minimum l'adresse de rue et le code postal ; les demandes rejetées avant la recherche auprès de la source ne sont pas facturées.

## Comment l'appeler

```bash cURL theme={null}
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=USA" \
  -F "services=usa_states_credit_bureau" \
  -F "vendor_data=user-1234" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "date_of_birth=1990-01-01"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="USA",
    services=["usa_states_credit_bureau"],
    first_name="John",
    last_name="Doe",
    date_of_birth="1990-01-01",
    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: "USA",
  services: ["usa_states_credit_bureau"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  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: "USA",
	Services:     didit.Some([]string{"usa_states_credit_bureau"}),
	FirstName:    didit.String("John"),
	LastName:     didit.String("Doe"),
	DateOfBirth:  didit.String("1990-01-01"),
	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("USA")
        .services(List.of("usa_states_credit_bureau"))
        .firstName("John")
        .lastName("Doe")
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .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' => 'USA',
    'services' => ['usa_states_credit_bureau'],
    'first_name' => 'John',
    'last_name' => 'Doe',
    'date_of_birth' => '1990-01-01',
    '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: "USA",
  services: ["usa_states_credit_bureau"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  vendor_data: "user-1234"
)
puts result.to_h
```

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

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

var result = await client.DatabaseValidation.ValidateAsync(new DatabaseValidationValidateParams
{
    IssuingState = "USA",
    Services = new string[] { "usa_states_credit_bureau" },
    FirstName = "John",
    LastName = "Doe",
    DateOfBirth = "1990-01-01",
    VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Chaque appel réussi renvoie un code HTTP `200`. Le champ **`outcome_code`** vous indique ce qui s'est réellement passé, en distinguant par exemple une véritable non-correspondance biométrique (`BIOMETRIC_NO_MATCH`) d'un selfie qui n'a pas pu être lu (`BIOMETRIC_IMAGE_UNUSABLE`). Le `status` affiché correspond au statut par défaut de la fonctionnalité ; vos [actions Correspondance partielle / Aucune correspondance](https://docs.didit.me/fr/core-technology/database-validation/database-validation-warnings.md) configurées peuvent le remplacer.

**`MATCH`** : Le registre a confirmé l'identité et tous les champs vérifiés correspondent.

```json 200 OK — MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "USA",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "usa_states_credit_bureau",
      "service_name": "United States of America - United States Credit Bureau",
      "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",
        "state": "Sample State",
        "street": "sample_value",
        "verifications": {
          "full_name": true
        }
      },
      "validation": {
        "full_name": "full_match"
      }
    }
  ]
}
```

**`NO_MATCH`** : Le registre n'a renvoyé aucune correspondance pour les données soumises.

```json 200 OK — NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "USA",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "usa_states_credit_bureau",
      "service_name": "United States of America - United States Credit Bureau",
      "source_data": {
        "full_name": "NO_MATCH"
      },
      "validation": {
        "full_name": "no_match"
      }
    }
  ]
}
```

## Données renvoyées

Les champs exacts présents dans `source_data` dépendent de ce que renvoie le registre. L'exemple généré pour `usa_states_credit_bureau` documente actuellement cette structure normalisée :

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

## Tarifs et SLA

Les requêtes United States of America - United States Credit Bureau ne sont facturées que lorsque Didit reçoit un résultat concluant de la source de validation.

* **Prix par appel :** \$0.25 USD.
* **Facturation :** par requête réussie. Vous n'êtes pas facturé lorsque le registre est injoignable, lorsque des champs obligatoires sont manquants ou lorsque la requête est rejetée avant d'atteindre la source.
* **Latence :** p95 habituel \< 2 s.
* **Disponibilité :** 99.9% par trimestre côté Didit ; la disponibilité des sources en aval varie selon le pays et le jeu de données.

## Pour aller plus loin

* [Vue d'ensemble de la Validation en base de données aux États-Unis](https://docs.didit.me/api-reference/database-validation/united-states.md)
* [Vue d'ensemble de la Validation en base de données](https://docs.didit.me/fr/core-technology/database-validation/overview.md)
* [Codes de résultat](https://docs.didit.me/fr/core-technology/database-validation/database-validation-outcome-codes.md)


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