Verificar documento
POST
/veriface/checkchave privadaprk_Serviço para validar um documento de identidade, determinar se ele pertence ao número informado, se está falsificado e extrair dados por OCR.
Autenticação
Inclua sua chave privada no cabeçalho Authorization.
Authorization: prk_xxx...
Parâmetros de consulta
| Nome | Descrição |
|---|---|
| country String | Obrigatório. País da pessoa a ser validada. Consulte a lista de documentos e países |
| type String | Obrigatório. Tipo de documento da pessoa a ser validada. Consulte a lista de documentos e países |
| identification String | Obrigatório. Número de identificação da pessoa a ser consultada. |
| image String | Obrigatório. Imagem do documento em base64 ou URL pública para acessar a imagem. A imagem deve estar no formato JPEG ou PNG. |
🧪 Exemplos de uso
- 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));
📥 Exemplos de respostas
- Validação bem-sucedida.
- Validação falhou.
{
"code": "JPJD42IDWP3Z6RXA",
"error": false,
"isFront": true,
"data": {
"bloodGroup": "O+",
"dateOfBirth": "1990-01-01",
"dateOfExpiry": "2030-01-01",
"firstIssueDate": "01 SEPT 2000 BOGOTÁ D.C. ",
"fullName": "DOE DOE JHON MICHEL",
"givenNames": "JHON MICHEL",
"height": "170 cm",
"issuingStateName": "Colombia",
"nationality": "Colombia",
"nationalityCode": "COL",
"personalNumber": "1001001010",
"placeOfBirth": "BOGOTÁ D.C. (CUNDINAMARCA)",
"sex": "M",
"surname": "DOE DOE",
"documentType": "Id Card",
"name": "JHON MICHEL DOE DOE"
}
}
{
"code": "JPJD42IDWP3Z6RXA",
"error": true,
"message": "DOCUMENT_FAKE",
"isFront": false,
"data": { }
}
⚠️ Respostas de erro
| Código | Descrição |
|---|---|
| 400 | Parâmetros ausentes como country, type, identification ou image. Formato de imagem incorreto. |
| 401 | Autenticação inválida ou ausente. |