Skip to main content

Query AucoFace process

GET /veriface HTTP/1.1
HOST: {{api_auco}}
Authorization: {{public_key}}

Service to query the status and results of a previously created AucoFace process.

Authentication

Include your public key in the Authorization header.

Authorization: puk_xxx...

Query parameters

NameDescription
code
String
Required.
AucoFace process code to query.
This code is obtained when creating the process via the /veriface endpoint.

Response structure

The response contains AucoFace process information organized in different sections:

Main process fields

FieldTypeDescription
emailStringEmail of the process creator
createdAtStringProcess creation date in Date JSON format
platformStringPlatform used: whatsapp, web
statusStringCurrent process status see process statuses
emailValidatedStringEmail of who approved or rejected the manual validation
nameStringFull name of the person to validate
userEmailStringEmail of the person to validate
phoneStringPhone number of the person to validate with country code
countryStringCountry of the person to validate.
Check list of documents and countries
identificationTypeStringType of document of the person to validate.
Check list of documents and countries
identificationNumberStringIdentity document number of the person to validate
ocrDataObjectData extracted from document via OCR.
See OCR Data for some data that can be obtained.
attemptsArrayList of validation attempts performed
customObjectAdditional information added during process creation

Process statuses

StatusDescription
INPROGRESSProcess in progress, user is performing validation
BLOCKEDUser exceeded maximum attempts, requires manual validation on the platform
APPROVEDValidation completed successfully, documents and biometrics are valid
INVALIDATEDProcess completed, but validation was not successful
EXPIREDProcess expired without completing within time limit

Attempt information (Array attempts)

Each attempt may contain all or part of the following information:

FieldDescription
identificationCardFrontTemporary URL of the front document image
identificationCardBackTemporary URL of the back document image
photoTemporary URL of the face photograph
similarityBiometric similarity percentage (0-100)
identificationCardDataData extracted from document via OCR
dateTimestamp of the attempt
successfullBoolean indicating if the attempt was successful
errorMessagesArray of errors in case of failure

OCR Data (ocrData)

Information extracted from the identity document:

  • Personal data: fullName, givenNames, surname, documentNumber
  • Demographic information: dateOfBirth, sex, bloodGroup, height
  • Document data: documentType, firstIssueDate, placeOfIssue
  • Location: issuingStateName, placeOfBirth
Temporary URLs

Image URLs (identificationCardFront, identificationCardBack, photo) are temporary AWS S3 links with a validity of 5 minutes. After this time, it will be necessary to perform a new query to get updated URLs.

Data availability
  • The ocrData field is available only when it was possible to extract information from the document
  • The attempts array may contain multiple attempts if the user performed several validations
  • OCR data may vary according to document type, country and image quality

📥 Example responses

{
"email": "prueba@auco.ai",
"createdAt": "2025-05-29T14:53:04.074Z",
"platform": "whatsapp",
"status": "APPROVED",
"name": "Juan Pérez",
"userEmail": "juan.perez@gmail.com",
"phone": "+573003003030",
"country": "CO",
"identificationType": "CC",
"identificationNumber": "1001001010",
"attempts": [
{
"identificationCardFront": "https://amazon.url/file/signed-url",
"identificationCardBack": "https://amazon.url/file/signed-url",
"photo": "https://amazon.url/file/signed-url",
"similarity": 91.31532287597656,
"identificationCardData": {
"documentNumber": "1001001010",
"fullName": "PÉREZ JUAN",
"givenNames": "JUAN",
"issuingStateName": "Colombia",
"surname": "PÉREZ",
"documentType": "Id Card",
"name": "JUAN PÉREZ"
},
"date": "2025-05-29T17:16:51.839Z",
"successfull": true
}
],
"ocrData": {
"bloodGroup": "O+",
"dateOfBirth": "1990-05-15",
"firstIssueDate": "2015-03-20",
"height": "175 cm",
"issuingStateName": "Colombia",
"placeOfBirth": "BOGOTÁ (CUNDINAMARCA)",
"sex": "M",
"documentType": "Id Card",
"placeOfIssue": "BOGOTÁ",
"documentNumber": "1001001010",
"fullName": "PÉREZ JUAN",
"givenNames": "JUAN",
"surname": "PÉREZ",
"name": "JUAN PÉREZ"
}
}

🧪 Usage examples

curl -X GET '{{api_auco}}/veriface?code=VERIFACE_CODE' \
-H 'Authorization: {{public_key}}'

⚠️ Error Responses

CodeDescription
400Invalid or malformed process code.
401Invalid or missing authentication.