Name Screening
The Name Screening API validates whether a submitted name has a plausible personal-name format and checks the full value plus each individual name part against the active blocked-term database.
Send either a single
Send either a single
full_name value or a first_name and last_name pair.Endpoint
POST
https://api.provero.io/api/fraud-check/name
Headers
Authorization: Bearer REPLACE_WITH_API_TOKEN
Content-Type: application/json
Accept: application/json
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
full_name
|
string |
No | The full name to screen, including first, middle, and last names where available. |
first_name
|
string |
No | The first name to use when you prefer split-name input. Must be sent together with last_name. |
last_name
|
string |
No | The last name to use when you prefer split-name input. Must be sent together with first_name. |
Request Body example (JSON)
{
"full_name": "John Doe",
"first_name": "string",
"last_name": "string"
}
Code Examples
import requests
full_name = "John Doe"
url = "https://api.provero.io/api/fraud-check/name"
payload = {"full_name": full_name}
headers = {
"Authorization": "Bearer REPLACE_WITH_API_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
response = requests.post(url, headers=headers, json=payload)
print(response.status_code)
print(response.text)
<?php
$fullName = "John Doe";
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.provero.io/api/fraud-check/name",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POSTFIELDS => json_encode([
"full_name" => $fullName
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer REPLACE_WITH_API_TOKEN",
"Content-Type: application/json",
"Accept: application/json"
],
]);
$response = curl_exec($curl);
if (curl_errno($curl)) {
echo 'Error:' . curl_error($curl);
}
curl_close($curl);
echo $response;
$fullName = "John Doe";
$response = Http::withToken('REPLACE_WITH_API_TOKEN')
->acceptJson()
->post('https://api.provero.io/api/fraud-check/name', [
'full_name' => $fullName,
]);
return $response->json();
const fullName = "John Doe";
fetch("https://api.provero.io/api/fraud-check/name", {
method: "POST",
headers: {
"Authorization": "Bearer REPLACE_WITH_API_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({ full_name: fullName })
})
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.error("Error:", error));
full_name="John Doe"
curl -X POST https://api.provero.io/api/fraud-check/name \
-H "Authorization: Bearer REPLACE_WITH_API_TOKEN" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d "{\"full_name\": \"$full_name\"}"
Response Examples
Success
{
"fullName": "John Doe",
"type": "full_name",
"isValid": true,
"isProfane": false,
"riskLevel": "LOW",
"notes": "Name passed heuristic screening."
}
Validation Error - Missing Name
{
"message": "The full_name field is required when first_name and last_name are not provided.",
"errors": {
"full_name": [
"The full_name field is required when first_name and last_name are not provided."
]
}
}
Payment Required - Insufficient Balance
{
"message": "Insufficient balance for validation request.",
"service": "name",
"required_amount": "0.0060000000",
"current_balance": "0.0000000000"
}
Response Body
Success structure
| Field Name | Type | Example | Always Present | Description |
|---|---|---|---|---|
fullName |
string |
John Doe | Yes | The validated full name. |
type |
string |
full_name | Yes | The screening mode used for the submitted name. |
isValid |
boolean |
true | Yes | Whether the name passed format and blocked-term screening. |
isProfane |
boolean |
false | Yes | Indicates whether the name contains any profanity. |
riskLevel |
string |
LOW | Yes | A risk rating of the name (LOW, MEDIUM, HIGH, UNKNOWN). |
notes |
string |
Name passed heuristic screening. | No | Additional metadata or validation observations. |
Error structure
| Field Name | Type | Example | Always Present | Description |
|---|---|---|---|---|
message |
string |
The full_name field is required when first_name and last_name are not provided. | No | Top-level error message returned on validation failure or insufficient balance. |
errors |
object |
{"full_name": ["The full_name field is required when first_name and last_name are not provided."]} | No | Object containing input validation errors. |
service |
string |
name | No | Service alias returned with a 402 insufficient-balance response. |
required_amount |
string |
0.0060000000 | No | Credit amount required to process the validation request. |
current_balance |
string |
0.0000000000 | No | Current available balance at the time the request was rejected. |