Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Name

Names are at the heart of every contact record—yet they're often incomplete, misspelled, or reversed. Delpha's Name Validator helps you detect, normalize, and correct person names to ensure consistent, high-quality identity data across your systems.

Each input is evaluated through several smart checks:

  • Completeness: Measures whether both first name and last name are present, returning individual scores for each.

  • Validity: Confirms if the given names exist in trusted linguistic databases.

  • Consistency: Compares the original input to its normalized form (capitalization, spacing, hyphenation, etc.).

  • Misspelled: Detects potential typos and suggests the closest valid alternatives.

  • Reversed: Identifies when first name and last name appear swapped based on statistical likelihoods.

The API returns a normalized version of the name, along with these detailed quality indicators. When needed, it also proposes gentle corrections—like fixing a misspelling or switching first and last names—always preserving the user's intended identity.

With Name Validator, your contact data stays clean, standardized, and ready for reliable engagement.

Submit name for finding and validation

post

Submit an name for finding and validation. Returns a job ID for tracking the process.

Required scopes
This endpoint requires the following scopes:
  • : Access to the public API
Authorizations
OAuth2clientCredentialsRequired

OAuth2 client credentials flow for API access

Token URL:
Body

Payload to submit a new name quality job.

first_namestringRequired

The first name of the entity

Example: Victor
last_namestringRequired

The last name of the entity

Example: Goubet
Responses
202

Job submitted to assess_name_v16

application/json

Response after submitting a new name quality job.

job_idstring · nullableOptional

The job ID. Required if status <= 300.

Example: 21014abc65004d2781d2e0ef4c9fbb46
messagestringRequired

The message to return

Example: Job submitted to assess_name_v16
statusstring · enumRequired

The status of the process

Example: SUCCESSPossible values:
status_codeintegerRequired

The status code to return

Example: 202
post/v1/name
POST /v1/name HTTP/1.1
Host: api.delpha.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "first_name": "Victor",
  "last_name": "Goubet"
}
{
  "job_id": "21014abc65004d2781d2e0ef4c9fbb46",
  "message": "Job submitted to assess_name_v16",
  "status": "SUCCESS",
  "status_code": 202
}

Get name finder and validator job status

get

Retrieve the result and status of a previously submitted name finder and validator job.

Required scopes
This endpoint requires the following scopes:
  • : Access to the public API
Authorizations
OAuth2clientCredentialsRequired

OAuth2 client credentials flow for API access

Token URL:
Path parameters
job_idstringRequired

The unique identifier of the name job

Example: {"summary":"Sample job ID","value":"21014abc65004d2781d2e0ef4c9fbb46"}
Responses
200

Job succeeded.

application/json

Response after retrieving the status and result of an name quality job.

messagestringRequired

A human-readable message describing the current state or outcome of the job.

Example: Job succeeded.
statusstring · enumRequired

The status of the process

Example: SUCCESSPossible values:
status_codeintegerRequired

The HTTP status code representing the job's current state.

Example: 200
process_timenumber · nullableOptional

The total time taken to process the job, in seconds.

Example: 0.123
get/v1/name/{job_id}
GET /v1/name/{job_id} HTTP/1.1
Host: api.delpha.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "message": "Job succeeded.",
  "status": "SUCCESS",
  "status_code": 200,
  "result": {
    "data_type": "name",
    "normalized_value": {
      "first_name": "Victor",
      "last_name": "Goubet"
    },
    "label": "OK",
    "scores": {
      "accuracy": 0,
      "reversed": 0.192,
      "misspelled": {
        "first_name": 0,
        "last_name": 1
      },
      "consistency": {
        "first_name": 1,
        "last_name": 0
      },
      "validity": {
        "first_name": 1,
        "last_name": 1
      },
      "completeness": {
        "first_name": 1,
        "last_name": 1
      }
    },
    "suggestions": {
      "first_name": [
        {
          "value": "Victor",
          "score": 1
        }
      ],
      "last_name": [
        {
          "value": "GOBET",
          "score": 0.91
        },
        {
          "value": "GABET",
          "score": 0.73
        }
      ]
    }
  },
  "process_time": 0.123
}

Submit a batch of name items

post

Submit 1..100 name items for asynchronous batch processing as ONE job (never a per-item fan-out). Returns a job_id immediately (202); poll GET /v1/name/batch/{job_id} for status and results. Each item is validated identically to the single-route POST /v1/name payload; a payload with 0 items or more than 100 is rejected with 422.

Required scopes
This endpoint requires the following scopes:
  • : Access to the public API
Authorizations
OAuth2clientCredentialsRequired

OAuth2 client credentials flow for API access

Token URL:
Body

Batch envelope for POST /v1/name/batch: {"items": [...]} (1..100 items, 422 beyond); each item is shaped exactly like the single-route POST /v1/name payload (reused here by $ref as NameSubmitInput).

Responses
202

Batch submitted

application/json

Response after submitting a batch quality job.

job_idstring · nullableOptional

The job ID. Required if status <= 300.

Example: 21014abc65004d2781d2e0ef4c9fbb46
item_countinteger · nullableOptional

Number of items accepted in the batch (present on success).

Example: 100
messagestringRequired

The message to return

Example: Batch submitted
statusstring · enumRequired

The status of the process

Example: SUCCESSPossible values:
status_codeintegerRequired

The status code to return

Example: 202
post/v1/name/batch
POST /v1/name/batch HTTP/1.1
Host: api.delpha.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "items": [
    {
      "first_name": "Victor",
      "last_name": "Goubet"
    }
  ]
}
{
  "job_id": "21014abc65004d2781d2e0ef4c9fbb46",
  "item_count": 100,
  "message": "Batch submitted",
  "status": "SUCCESS",
  "status_code": 202
}

Get name batch job status

get

Poll a batch of name items submitted via POST /v1/name/batch. 202 while running (with item_count/processed_count progress); 200 once SUCCEEDED (with counts, a presigned result_url, and result_data inlined when <=1MB); 409 if the credit reservation expired before delivery (resubmit); 500 if the job failed; 504 past the 24h ceiling (batch jobs run on Batch/Vertex timescales, hours not minutes).

Required scopes
This endpoint requires the following scopes:
  • : Access to the public API
Authorizations
OAuth2clientCredentialsRequired

OAuth2 client credentials flow for API access

Token URL:
Path parameters
job_idstringRequired

The unique identifier of the name batch job.

Example: {"summary":"Sample job ID","value":"21014abc65004d2781d2e0ef4c9fbb46"}
Responses
200

97/100 items succeeded

application/json

Response for GET /v1/name/batch/{job_id}. Each result_data.items[] entry is keyed to its request item by dispatch_key ({"record_id": "<job_id>#<index>"}). On success its result is the SAME object GET /v1/name/{job_id} returns for a single item. On failure it carries an error string instead of result.

messagestringRequired

A human-readable message describing the current state or outcome of the job.

Example: 97/100 items succeeded
statusstring · enumRequired

The status of the process

Example: SUCCESSPossible values:
status_codeintegerRequired

The HTTP status code representing the job's current state.

Example: 200
result_urlstring · nullableOptional

Presigned URL (1h expiry) to download the full batch result JSON from S3.

Example: https://delpha-api-batch-dev.s3.amazonaws.com/batch-results/<job_id>.json?...
item_countinteger · nullableOptional

Total number of items in the batch (present while the job is running).

processed_countinteger · nullableOptional

Number of items processed so far (present while the job is running; may be absent early in the job's lifecycle).

process_timenumber · nullableOptional

The total time taken to process the job, in seconds.

Example: 12.3
get/v1/name/batch/{job_id}
GET /v1/name/batch/{job_id} HTTP/1.1
Host: api.delpha.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "message": "97/100 items succeeded",
  "status": "SUCCESS",
  "status_code": 200,
  "counts": {
    "total": 100,
    "succeeded": 97,
    "failed": 3
  },
  "result_url": "https://delpha-api-batch-dev.s3.amazonaws.com/batch-results/<job_id>.json?...",
  "result_data": {
    "job_id": "21014abc65004d2781d2e0ef4c9fbb46",
    "usecase": "name",
    "counts": {
      "total": 2,
      "succeeded": 1,
      "failed": 1
    },
    "items": [
      {
        "dispatch_key": {
          "record_id": "21014abc65004d2781d2e0ef4c9fbb46#0"
        },
        "result": {
          "data_type": "name",
          "normalized_value": {
            "first_name": "Victor",
            "last_name": "Goubet"
          },
          "label": "OK",
          "scores": {
            "accuracy": 0,
            "reversed": 0.192,
            "misspelled": {
              "first_name": 0,
              "last_name": 1
            },
            "consistency": {
              "first_name": 1,
              "last_name": 0
            },
            "validity": {
              "first_name": 1,
              "last_name": 1
            },
            "completeness": {
              "first_name": 1,
              "last_name": 1
            }
          },
          "suggestions": {
            "first_name": [
              {
                "value": "Victor",
                "score": 1
              }
            ],
            "last_name": [
              {
                "value": "GOBET",
                "score": 0.91
              },
              {
                "value": "GABET",
                "score": 0.73
              }
            ]
          }
        }
      },
      {
        "dispatch_key": {
          "record_id": "21014abc65004d2781d2e0ef4c9fbb46#1"
        },
        "error": "Processing failed for this item."
      }
    ]
  },
  "item_count": null,
  "processed_count": null,
  "process_time": 12.3
}
PreviousPhone
NextLegal ID

Last updated

Was this helpful?