Name
- : Access to the public API
OAuth2 client credentials flow for API access
Payload to submit a new name quality job.
The first name of the entity
VictorThe last name of the entity
GoubetJob submitted to assess_name_v16
Response after submitting a new name quality job.
The job ID. Required if status <= 300.
21014abc65004d2781d2e0ef4c9fbb46The message to return
Job submitted to assess_name_v16The status of the process
SUCCESSPossible values: The status code to return
202Invalid name format or missing required fields
Authentication failed - invalid or missing OAuth 2.0 token
Payment Required
Internal server error
Service unavailable
- : Access to the public API
OAuth2 client credentials flow for API access
The unique identifier of the name job
{"summary":"Sample job ID","value":"21014abc65004d2781d2e0ef4c9fbb46"}Job succeeded.
Job is still running.
Response after retrieving the status and result of an name quality job.
A human-readable message describing the current state or outcome of the job.
Job succeeded.The status of the process
SUCCESSPossible values: The HTTP status code representing the job's current state.
200The result of the name quality job
{"data_type":"name","label":"OK","normalized_value":{"first_name":"Victor","last_name":"Goubet"},"scores":{"accuracy":0,"completeness":{"first_name":1,"last_name":1},"consistency":{"first_name":1,"last_name":0},"misspelled":{"first_name":0,"last_name":1},"reversed":0.192,"validity":{"first_name":1,"last_name":1}},"suggestions":{"first_name":[{"score":1,"value":"Victor"}],"last_name":[{"score":0.91,"value":"GOBET"},{"score":0.73,"value":"GABET"}]}}The total time taken to process the job, in seconds.
0.123Input validation failed.
Authentication failed - invalid or missing OAuth 2.0 token
Failed to retrieve job.
Job timed out.
Last updated
Was this helpful?