Query Background Check Validation
GET /validate/background HTTP/1.1
HOST: {{api_auco}}
Authorization: {{public_key}}
Service to query a background check validation.
Authentication
Include your public key in the Authorization
header.
Authorization: puk_xxx...
Query Parameters
Name | Description |
---|---|
code String | Required. Process code to query. |
🧪 Usage examples
- Curl
- Python
- Node.js
curl -X GET '{{api_auco}}/validate/background' \
-H 'Authorization: {{public_key}}'
--data-urlencode 'code=XXXXXXXXX'
import requests
response = requests.get(
"{{api_auco}}/validate/background",
headers={"Authorization": "{{public_key}}"},
params={"code": "XXXXXXXXX"}
)
print(response.json())
const axios = require('axios');
axios
.get('{{api_auco}}/validate/background', {
headers: { Authorization: '{{public_key}}' },
params: { code: 'XXXXXXXXX' },
})
.then((response) => console.log(response.data));
📥 Example responses
info
The ready property indicates whether the validation process has been completed or if the document is not yet ready. If the document is ready, the url property will be provided with the signed URL for downloading the document. Signed URLs are valid for 2 minutes before they expire.
- Ready validation.
- Pending validation.
{
"code": "XXXXXXXXX",
"name": "1001001010",
"email": "prueba@auco.ai",
"data": {
"name": "NAME NAME LAST NAME",
"type": "CC",
"identification": "1001001010",
"expeditionDate": "01/01/1995"
},
"ready": true,
"url": "https://amazon.url/file/signed-url"
}
{
"code": "XXXXXXXXX",
"name": "1001001010",
"email": "prueba@auco.ai",
"data": {
"name": "NAME NAME LAST NAME",
"type": "CC",
"identification": "1001001010",
"expeditionDate": "01/01/1995"
},
"ready": false
}
⚠️ Error Responses
Code | Description |
---|---|
400 | Missing parameters code . Process not found VALIDATION_NOT_FOUND . |
401 | Invalid or missing authentication. |