Generate

POST/validate/backgroundprivate keyprk_

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 organization.
identification String	Required. Identification number of the person to be consulted.
type String	Required. Identification document type of the person to be checked. See Accepted document types.
name String	Conditional. Full name of the person to be checked. Required depending on type (see table).
expeditionDate String	Conditional. Issue date of the identification document. Required depending on type (see table). 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.
custom Object	Optional. Free-form object that is stored alongside the process and forwarded in webhook notifications.

Accepted document types

The type value determines which additional fields are required.

type	Document	Additional required fields
CC	Citizenship ID	—
CE	Foreigner ID	—
NIT	NIT	—
PPT	Temporary Protection Permit	expeditionDate
PP	Passport	name
INT	International	name

Auco verifies the document before the check

With type set to CC, CE, PPT or NIT, Auco verifies that the document exists before running the background check. If it does not exist, the check is neither run nor charged. See more

🧪 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))

Passport (PP)

curl -X POST '{{api_auco}}/validate/background' \
  -H 'Authorization: {{private_key}}' \
  -d '{
    "email": "prueba@auco.ai",
    "type": "PP",
    "identification": "AB123456",
    "name": "FULL NAME"
  }'

International (INT)

curl -X POST '{{api_auco}}/validate/background' \
  -H 'Authorization: {{private_key}}' \
  -d '{
    "email": "prueba@auco.ai",
    "type": "INT",
    "identification": "AB123456",
    "name": "FULL NAME"
  }'

📥 Example responses

Successful validation.

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

⚠️ Error Responses

Code	Description
400	Missing parameters such as email, type or identification. Missing name when type is PP or INT, or expeditionDate when type is PPT. Incorrect format for expeditionDate. The document does not exist or its holder is registered as deceased: IDENTITY_NOT_FOUND, IDENTITY_DECEASED or, with NIT, COMPANY_NOT_FOUND. See more
401	Invalid or missing authentication.