Name
Required scopes
This endpoint requires the following scopes:
- : Access to the public API
Authorizations
OAuth2clientCredentialsRequiredToken URL:
OAuth2 client credentials flow for API access
Body
Payload to submit a new name quality job.
first_namestringRequiredExample:
The first name of the entity
Victorlast_namestringRequiredExample:
The last name of the entity
GoubetResponses
202
Job submitted to assess_name_v16
application/json
400
Invalid name format or missing required fields
application/json
401
Authentication failed - invalid or missing OAuth 2.0 token
application/json
402
Payment Required
application/json
500
Internal server error
application/json
502
Service unavailable
application/json
post
/v1/nameRequired scopes
This endpoint requires the following scopes:
- : Access to the public API
Authorizations
OAuth2clientCredentialsRequiredToken URL:
OAuth2 client credentials flow for API access
Path parameters
job_idstringRequiredExample:
The unique identifier of the name job
{"summary":"Sample job ID","value":"21014abc65004d2781d2e0ef4c9fbb46"}Responses
200
Job succeeded.
application/json
202
Job is still running.
application/json
400
Input validation failed.
application/json
401
Authentication failed - invalid or missing OAuth 2.0 token
application/json
500
Failed to retrieve job.
application/json
504
Job timed out.
application/json
get
/v1/name/{job_id}Last updated
Was this helpful?