Check document
POST /veriface/check HTTP/1.1
HOST: {{api_auco}}
Authorization: {{private_key}}
Service to validate an identity document, determine whether it belongs to the number provided, whether it is falsified and extract data using OCR.
Authentication
Include your private key in the Authorization
header.
Authorization: prk_xxx...
Query parameters
Name | Description |
---|---|
country String | Required. Country of the person to be validated. Check list of documents and countries |
type String | Required. Type of document of the person to be validated. Check list of documents and countries |
identification String | Required. Identification number of the person to be consulted. |
image String | Required. Image of the document in base64 or the public URL to access the image. The image must be in JPEG or PNG format. |
📥 Example responses
- Successful validation.
- Failed validation.
{
"error": false,
"similarity": 89.46871185302734,
"code": "JPJD42IDWP3Z6RXA"
}
{
"error": true,
"similarity": 49.4231344,
"code": "JPJD42IDWP3Z6RXA"
}
🧪 Usage examples
- Curl
- Python
- Node.js
curl -X POST '{{api_auco}}/veriface/check' \
-H 'Authorization: {{private_key}}' \
-d '{
"country": "CO",
"type": "CC",
"identification": "1001001010",
"image": "https://url.com/document.jpg"
}'
import requests
response = requests.post(
'{{api_auco}}/veriface/check',
headers={'Authorization': '{{private_key}}'},
json={
"country": "CO",
"type": "CC",
"identification": "1001001010",
"image": "https://url.com/document.jpg"
}
)
print(response.json())
const axios = require('axios');
axios.post('{{api_auco}}/veriface/check', {
country: "CO",
type: "CC",
identification: "1001001010",
image: "https://url.com/document.jpg"
}, {
headers: { Authorization: '{{private_key}}' }
})
.then((response) => console.log(response.data));
⚠️ Error Responses
Code | Description |
---|---|
400 | Missing parameters like country , type , identification or image . Incorrect image format. |
401 | Invalid or missing authentication. |