Skip to main content
POST
/
v3
/
database-validation
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=BRA" \
  -F "services=bra_national_id" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "address=123 Sample Street, Sample City, 10001" \
  -F "tax_number=11111111111"

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "BRA",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "bra_national_id",
      "service_name": "Brazil National ID (Receita Federal)",
      "source_data": {
        "address": "123 Sample Street",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe"
      },
      "validation": {
        "address": "full_match",
        "full_name": "full_match",
        "identification_number": "full_match"
      }
    }
  ]
}

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.

Verifies input data against Receita Federal. 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: ~ 98%
  • Country: Brazil
  • Service ID: bra_national_id
  • Data domain: Identity
  • Category: NationalIDRegistry

​
Inputs

FieldRequiredExample
first_nameYesJohn
last_nameYesDoe
addressYes123 Sample Street, Sample City, 10001
tax_numberYes11111111111
date_of_birthNo1990-01-01
  • Required inputs: first_name, last_name, address, tax_number
  • Optional inputs: date_of_birth
  • Consent: Not required
  • Workflow availability: Available in workflow
  • Coverage: ~ 98%
  • Price: $0.69 per successful query

​
Body parameters

​
issuing_state
string
required
ISO 3166-1 alpha-3 country code for this database service.Example: BRA
​
services
string
required
Array containing this service ID. Pinning the service keeps the request scoped to this exact database.Example: bra_national_id
​
first_name
string
required
Given name to validate.Example: John
​
last_name
string
required
Family name to validate.Example: Doe
​
address
string
required
Complete address string. Didit can split this into structured address elements when possible.Example: 123 Sample Street, Sample City, 10001
​
tax_number
string
required
Tax or fiscal identification number.Example: 11111111111
​
date_of_birth
string
Date of birth in YYYY-MM-DD format.Example: 1990-01-01

​
Input rules & validation notes

  • address is required 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.
  • address_element_1 is the street address, including street number and street type.
  • address_element_2 is optional unit, building, floor, or extra address line. Didit only sends it when you provide it explicitly.
  • address_element_3 is suburb, district, locality, or neighborhood.
  • address_element_4 is city, town, state, province, or region.
  • address_element_5 is postcode or postal code. postal_code is accepted as an alias.
  • Address-based database services need at least address_element_1 plus one searchable component such as address_element_3, address_element_4, or address_element_5; requests rejected before source lookup are not charged.
  • Brazilian CPF (exactly 11 digits)
  • tax_number must contain digits only; remove spaces, hyphens, and punctuation before sending the request.
  • tax_number must be exactly 11 characters long.

​
How to call it

curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=BRA" \
  -F "services=bra_national_id" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "address=123 Sample Street, Sample City, 10001" \
  -F "tax_number=11111111111"

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "BRA",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "bra_national_id",
      "service_name": "Brazil National ID (Receita Federal)",
      "source_data": {
        "address": "123 Sample Street",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe"
      },
      "validation": {
        "address": "full_match",
        "full_name": "full_match",
        "identification_number": "full_match"
      }
    }
  ]
}

​
Returned data

The exact fields surfaced in source_data depend on what the registry returns. The generated example for bra_national_id currently documents this normalized shape:
  • address
  • date_of_birth
  • first_name
  • identification_number
  • last_name

​
Pricing & SLAs

Brazil National ID (Receita Federal) queries are billed only when Didit receives a conclusive result from the validation source.
  • Per-call price: $0.69 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