Generate Background Check

POST /validate/background HTTP/1.1
HOST: {{api_auco}}
Authorization: {{private_key}}

Service to generate a background check for a user. The generated validation may take up to 1 minute to be ready for retrieval via the query service.

Authentication

Include your private key in the Authorization header.

Authorization: prk_xxx...

Query Parameters

Name	Description
email String	Required. Email of the process creator. This email must be registered on the Auco platform and must belong to the company.
identification String	Required. Identification number of the person to be consulted.
type String	Required. Identification document type of the person to be checked. Accepted values: NIT, CC, CE y PPT
expeditionDate String	Optional. Issue date of the identification document. Accepted format: 01/01/1995
targetWebhooks Array<String>	Optional. List of webhooks to be notified. If not defined, it will be sent to the "default" webhook.
tags Array<String>	Optional. List of tags to be sent when notifying the configured webhooks.

🧪 Usage examples

Curl

curl -X POST '{{api_auco}}/validate/background' \
  -H 'Authorization: {{private_key}}' \
  -d '{
    "email": "prueba@auco.ai",
    "type": "CC",
    "identification": "1001001010",
    "expeditionDate": "01/01/1995"
  }'

Python

import requests

response = requests.post(
  '{{api_auco}}/validate/background',
  headers={'Authorization': '{{private_key}}'},
  json={
    "email": "prueba@auco.ai",
    "type": "CC",
    "identification": "1001001010",
    "expeditionDate": "01/01/1995"
  }
)
print(response.json())

Node.js

var axios = require('axios');

axios.post('{{api_auco}}/validate/background', {
  email: "prueba@auco.ai",
  type: "CC",
  identification: "1001001010",
  expeditionDate: "01/01/1995"
}, {
  headers: { Authorization: '{{private_key}}' }
})
.then((response) => console.log(response.data))

📥 Example responses

Successful validation.

{
  "name": "NAME",
  "code": "XXXXXXXXX"
}

⚠️ Error Responses

Code	Description
400	Missing parameters such as email, type or identification. Incorrect format for expeditionDate.
401	Invalid or missing authentication.