Vérifier un document
POST
/veriface/checkclé privéeprk_Service permettant de valider un document d'identité, de déterminer s'il correspond au numéro fourni, s'il est falsifié, et d'extraire les données par OCR.
Authentification
Incluez votre clé privée dans l'en-tête Authorization.
Authorization: prk_xxx...
Paramètres de requête
| Nom | Description |
|---|---|
| country String | Obligatoire. Pays de la personne à valider. Consultez la liste des documents et des pays |
| type String | Obligatoire. Type de document de la personne à valider. Consultez la liste des documents et des pays |
| identification String | Obligatoire. Numéro d'identification de la personne à consulter. |
| image String | Obligatoire. Image du document en base64 ou URL publique permettant d'accéder à l'image. L'image doit être au format JPEG ou PNG. |
🧪 Exemples d'utilisation
- 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));
📥 Exemples de réponses
- Validation réussie.
- Validation échouée.
{
"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": { }
}
⚠️ Réponses d'erreur
| Code | Description |
|---|---|
| 400 | Paramètres manquants tels que country, type, identification ou image. Format d'image incorrect. |
| 401 | Authentification invalide ou absente. |