Address
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 address quality job.
addressany ofOptionalExample:
The address
{"city":"Paris","country":"France","postal_code":"75006","state":"Ile de France","street":"3 AVENUE VAVIN"}or
nullOptional
nameany ofOptionalExample:
The name of the entity
DelphastringOptional
nullOptional
legal_idany ofOptionalExample:
The legal ID of the entity
88052440000012stringOptional
nullOptional
linkedinany ofOptionalExample:
The LinkedIn URL of the entity
https://www.linkedin.com/company/delphainc/stringOptional
nullOptional
websiteany ofOptionalExample:
The website URL of the entity
https://delpha.io/stringOptional
nullOptional
Responses
202
Job submitted to assess_address_v16
application/json
400
Invalid address 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/addressRequired 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 address 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/address/{job_id}Last updated
Was this helpful?