Legal ID
- : Access to the public API
OAuth2 client credentials flow for API access
Payload to submit a new legal ID quality job.
The name of the entity
DelphaThe legal ID
88052440000012The type of legal ID
FRA - SIRETPossible values: The website URL
https://delpha.io/Job submitted to assess_legal_id_v16
Response after submitting a new legal ID quality job.
The job ID. Required if status <= 300.
21014abc65004d2781d2e0ef4c9fbb46The message to return
Job submitted to assess_legal_id_v16The status of the process
SUCCESSPossible values: The status code to return
202Invalid legal ID format or missing required fields
Authentication failed - invalid or missing OAuth 2.0 token
Payment Required
Internal server error
Service unavailable
POST /v1/legal-id HTTP/1.1
Host: api.delpha.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 224
{
"name": "Delpha",
"legal_id": "88052440000012",
"legal_id_type": "FRA - SIRET",
"address": {
"city": "Paris",
"country": "France",
"postal_code": "75006",
"state": "Ile de France",
"street": "3 AVENUE VAVIN"
},
"website": "https://delpha.io/"
}{
"job_id": "21014abc65004d2781d2e0ef4c9fbb46",
"message": "Job submitted to assess_legal_id_v16",
"status": "SUCCESS",
"status_code": 202
}- : Access to the public API
OAuth2 client credentials flow for API access
The unique identifier of the legal ID job
{"summary":"Sample job ID","value":"21014abc65004d2781d2e0ef4c9fbb46"}Job succeeded.
Response after retrieving the status and result of an legal ID 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 total time taken to process the job, in seconds.
0.123Job is still running.
Input validation failed.
Authentication failed - invalid or missing OAuth 2.0 token
Failed to retrieve job.
Job timed out.
GET /v1/legal-id/{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": "legal_id",
"normalized_value": "88052440000012",
"label": "OK",
"legal_id_type": "FRA - SIRET",
"scores": {
"validity": 1,
"completeness": 1,
"accuracy": 1,
"consistency": 1
},
"match": {
"score": 1,
"account_name": "DELPHA",
"industry": {
"value": "5112",
"description": "Software Publishers",
"type": null
},
"website": {
"url": "https://delpha.io/"
},
"address": {
"place_name": "Wojo",
"street_number": "3",
"street": "AV VAVIN",
"full_street": "3 AV VAVIN",
"city": "PARIS 6",
"state": "",
"postal_code": "75006",
"country": "FRANCE",
"country_code": "FR",
"location": "3 AV VAVIN, PARIS 6, 75006, FRANCE"
},
"annual_revenue": {
"value": "20700000.0",
"time": "2022",
"range": "10-50"
},
"employees_nb": {
"value": null,
"min": 6,
"max": 9,
"range": "1-10"
},
"source": "https://annuaire-entreprises.data.gouv.fr/entreprise/88052440000012/",
"company_type": {
"value": "PME",
"legal_type": "SAS, société par actions simplifiée",
"legal_id_type_label": null,
"legal_type_code": "5710"
},
"date": {
"creation_date": "2020-03-11",
"closing_date": null,
"birth_date": null
},
"legal_id_type": "FRA - SIRET",
"legal_id": "88052440000012"
},
"suggestions": [
{
"score": 1,
"account_name": "DELPHA",
"industry": {
"value": "5112",
"description": "Software Publishers",
"type": null
},
"website": {
"url": "https://delpha.io/"
},
"address": {
"place_name": "Wojo",
"street_number": "3",
"street": "AV VAVIN",
"full_street": "3 AV VAVIN",
"city": "PARIS 6",
"state": "",
"postal_code": "75006",
"country": "FRANCE",
"country_code": "FR",
"location": "3 AV VAVIN, PARIS 6, 75006, FRANCE"
},
"annual_revenue": {
"value": "20700000.0",
"time": "2022",
"range": "10-50"
},
"employees_nb": {
"value": null,
"min": 6,
"max": 9,
"range": "1-10"
},
"source": "https://annuaire-entreprises.data.gouv.fr/entreprise/88052440000012/",
"company_type": {
"value": "PME",
"legal_type": "SAS, société par actions simplifiée",
"legal_id_type_label": null,
"legal_type_code": "5710"
},
"date": {
"creation_date": "2020-03-11",
"closing_date": null,
"birth_date": null
},
"legal_id_type": "FRA - SIRET",
"legal_id": "88052440000012"
}
]
},
"process_time": 0.123
}- : Access to the public API
OAuth2 client credentials flow for API access
Batch envelope for POST /v1/legal-id/batch: {"items": [...]} (1..100 items, 422 beyond); each item is shaped exactly like the single-route POST /v1/legal-id payload (reused here by $ref as LegalIDSubmitInput).
Batch submitted
Response after submitting a batch quality job.
The job ID. Required if status <= 300.
21014abc65004d2781d2e0ef4c9fbb46Number of items accepted in the batch (present on success).
100The message to return
Batch submittedThe status of the process
SUCCESSPossible values: The status code to return
202Authentication failed - invalid or missing OAuth 2.0 token
Payment Required
Invalid batch payload or size (1..100)
Internal server error
Service unavailable
POST /v1/legal-id/batch HTTP/1.1
Host: api.delpha.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236
{
"items": [
{
"name": "Delpha",
"legal_id": "88052440000012",
"legal_id_type": "FRA - SIRET",
"address": {
"city": "Paris",
"country": "France",
"postal_code": "75006",
"state": "Ile de France",
"street": "3 AVENUE VAVIN"
},
"website": "https://delpha.io/"
}
]
}{
"job_id": "21014abc65004d2781d2e0ef4c9fbb46",
"item_count": 100,
"message": "Batch submitted",
"status": "SUCCESS",
"status_code": 202
}- : Access to the public API
OAuth2 client credentials flow for API access
The unique identifier of the legal ID batch job.
{"summary":"Sample job ID","value":"21014abc65004d2781d2e0ef4c9fbb46"}97/100 items succeeded
Response for GET /v1/legal-id/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/legal-id/{job_id} returns for a single item. On failure it carries an error string instead of result.
A human-readable message describing the current state or outcome of the job.
97/100 items succeededThe status of the process
SUCCESSPossible values: The HTTP status code representing the job's current state.
200Presigned URL (1h expiry) to download the full batch result JSON from S3.
https://delpha-api-batch-dev.s3.amazonaws.com/batch-results/<job_id>.json?...Total number of items in the batch (present while the job is running).
Number of items processed so far (present while the job is running; may be absent early in the job's lifecycle).
The total time taken to process the job, in seconds.
12.3Job is still running.
Missing job_id in path parameters
Authentication failed - invalid or missing OAuth 2.0 token
No job found for job_id: ...
Reservation expired; please resubmit the job.
Job failed.
Job timed out.
GET /v1/legal-id/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": "legal-id",
"counts": {
"total": 2,
"succeeded": 1,
"failed": 1
},
"items": [
{
"dispatch_key": {
"record_id": "21014abc65004d2781d2e0ef4c9fbb46#0"
},
"result": {
"data_type": "legal_id",
"normalized_value": "88052440000012",
"label": "OK",
"legal_id_type": "FRA - SIRET",
"scores": {
"validity": 1,
"completeness": 1,
"accuracy": 1,
"consistency": 1
},
"match": {
"score": 1,
"account_name": "DELPHA",
"industry": {
"value": "5112",
"description": "Software Publishers",
"type": null
},
"website": {
"url": "https://delpha.io/"
},
"address": {
"place_name": "Wojo",
"street_number": "3",
"street": "AV VAVIN",
"full_street": "3 AV VAVIN",
"city": "PARIS 6",
"state": "",
"postal_code": "75006",
"country": "FRANCE",
"country_code": "FR",
"location": "3 AV VAVIN, PARIS 6, 75006, FRANCE"
},
"annual_revenue": {
"value": "20700000.0",
"time": "2022",
"range": "10-50"
},
"employees_nb": {
"value": null,
"min": 6,
"max": 9,
"range": "1-10"
},
"source": "https://annuaire-entreprises.data.gouv.fr/entreprise/88052440000012/",
"company_type": {
"value": "PME",
"legal_type": "SAS, société par actions simplifiée",
"legal_id_type_label": null,
"legal_type_code": "5710"
},
"date": {
"creation_date": "2020-03-11",
"closing_date": null,
"birth_date": null
},
"legal_id_type": "FRA - SIRET",
"legal_id": "88052440000012"
},
"suggestions": [
{
"score": 1,
"account_name": "DELPHA",
"industry": {
"value": "5112",
"description": "Software Publishers",
"type": null
},
"website": {
"url": "https://delpha.io/"
},
"address": {
"place_name": "Wojo",
"street_number": "3",
"street": "AV VAVIN",
"full_street": "3 AV VAVIN",
"city": "PARIS 6",
"state": "",
"postal_code": "75006",
"country": "FRANCE",
"country_code": "FR",
"location": "3 AV VAVIN, PARIS 6, 75006, FRANCE"
},
"annual_revenue": {
"value": "20700000.0",
"time": "2022",
"range": "10-50"
},
"employees_nb": {
"value": null,
"min": 6,
"max": 9,
"range": "1-10"
},
"source": "https://annuaire-entreprises.data.gouv.fr/entreprise/88052440000012/",
"company_type": {
"value": "PME",
"legal_type": "SAS, société par actions simplifiée",
"legal_id_type_label": null,
"legal_type_code": "5710"
},
"date": {
"creation_date": "2020-03-11",
"closing_date": null,
"birth_date": null
},
"legal_id_type": "FRA - SIRET",
"legal_id": "88052440000012"
}
]
}
},
{
"dispatch_key": {
"record_id": "21014abc65004d2781d2e0ef4c9fbb46#1"
},
"error": "Processing failed for this item."
}
]
},
"item_count": null,
"processed_count": null,
"process_time": 12.3
}Last updated
Was this helpful?