Skip to main content
POST
Aggregated service of credit header data and other services. Didit exposes this service through POST /v3/database-validation/ so you can verify the submitted data against the authoritative source and receive normalized match results.

​
Coverage

  • Coverage: ~ 90%
  • Country: United States
  • Service ID: usa_states_credit_bureau
  • Data domain: Financial
  • Category: CreditBureau

​
Inputs

  • Required inputs: first_name, last_name
  • Optional inputs: date_of_birth, address.street_1, address.street_2, address.city, address.region, address.postal_code, phone, ssn, email, vendor_data
  • Consent: Not required
  • Workflow availability: Available in workflow
  • Coverage: ~ 90%
  • Price: $0.15 per successful query

​
Body parameters

​
string
default:"USA"
required
ISO 3166-1 alpha-3 country code for this database service.Example: USA
​
string
default:"usa_states_credit_bureau"
required
Array containing this service ID. Pinning the service keeps the request scoped to this exact database.Example: usa_states_credit_bureau
​
string
default:"John"
required
Given name to validate.Example: John
​
string
default:"Doe"
required
Family name to validate.Example: Doe
​
string
default:"1990-01-01"
Date of birth in YYYY-MM-DD format.Example: 1990-01-01
​
object
Structured residential address object. Use street_1, street_2, city, region, postal_code, and country. A complete legacy address string is still accepted but not recommended.Example: {"street_1":"123 Sample Street","street_2":"Unit 4","city":"Sample City","region":"Sample State","postal_code":"10001","country":"US"}
​
string
default:"+15550101000"
Phone number in international format.Example: +15550101000
​
string
default:"123456789"
ssn value required by this database service.Example: 123456789
​
string
default:"john.doe@example.com"
Email address.Example: john.doe@example.com
​
string
default:"user-1234"
Your stable user reference for this person, such as your internal user ID. Didit uses it to link standalone checks to the same end user and reduce duplicate-detection noise.Example: user-1234

​
Input rules & validation notes

  • address is optional for this service. You can send one complete address string and Didit will split it into structured address elements when possible, or you can send the structured fields explicitly.
  • US Social Security Number or ITIN - full 9 digits (dashes optional) or only the last 4 digits
  • ssn must match (?:\d{9}|\d{3}-\d{2}-\d{4}|\d{4}).
  • For ssn, send either the full 9-digit SSN/ITIN (dashes optional) or only its last 4 digits.
  • Beyond the required first_name and last_name, include at least one more field from date_of_birth, address, phone, ssn, or email. A name-only request is rejected before the provider lookup (and not charged); date_of_birth gives the most reliable match.
  • For address services, send structured address fields instead of a single address string when possible.
  • address.street_1 is the street address, including street number and street type.
  • address.street_2 is apartment, unit, building, floor, or extra address line. Send it only when you have it.
  • address.city is city, suburb, district, locality, or neighborhood.
  • address.region is state, province, region, or town.
  • address.postal_code is postcode or postal code.
  • Address-based database services require at least street address and postal code; requests rejected before source lookup are not charged.

​
How to call it

​
Returned data

The exact fields surfaced in source_data depend on what the registry returns. The generated example for usa_states_credit_bureau currently documents this normalized shape:
  • address
  • address_match_score
  • city
  • date_of_birth
  • first_name
  • full_name
  • last_name
  • name_match_score
  • postal_code
  • state
  • street

​
Pricing & SLAs

United States of America - United States Credit Bureau queries are billed only when Didit receives a conclusive result from the validation source.
  • Per-call price: $0.15 USD.
  • Billing: per successful query. You are not charged when the registry is unreachable, when required fields are missing, or when the request is rejected before reaching the source.
  • Latency: typical p95 < 2 s.
  • Availability: 99.9% per quarter on Didit’s side; downstream source availability varies by country and dataset.

​
Continue reading