Avec les points de terminaison d’API décrits dans cet article, vous pouvez récupérer les images de documents d’identité et les images de selfie qui ont été capturées pour une transaction terminée donnée qui a réussi la vérification.
La récupération des images de vérification implique les étapes suivantes :
Obtenir l’ID de vérification
Obtenez l’ID de vérification d’une transaction en fonction de l’ID de la transaction. L’ID de vérification est ensuite utilisé pour obtenir les URL de l’image.
Pour plus d’informations sur la syntaxe, les codes d’état et pour obtenir un exemple de demande, reportez-vous à la Get transaction status and metadata.
Dans la réponse, la propriété vhub-verification_id dans le tableau verifications avec status="SUCCESS » est l’ID de vérification requis. Seules les images de cette vérification peuvent être récupérées.
{
"id": "84f29725-7b57-4baa-a290-3be937f95ce6",
...
"verifications": [
{
"id": "document_id_authentication",
"revision_id": "3dc47509-a2c3-41ff-aa5b-2f1cfa95b321",
"name": "doc_id",
...
"status": "SUCCESS",
"timestamp": 1657216749097,
"vhub_workflow_id": "3e16826f-fb30-4cfb-bc7d-ac96545e0e93",
"vhub_transaction_id": "4254041b-1228-44c0-8455-627553987636",
"vhub_verification_id": "3e16826f-fb30-4cfb-bc7d-ac96545e0111",
"vhub_transaction_status": "COMPLETED",
...
}]
}
Obtenir l’URL des images de vérification
Obtenez l’URL des images de vérification en fonction de l’ID de transaction et de l’ID de vérification.
Syntaxe
GET /api/transactions/transaction_id/verifications/verification_id/verification-images
transaction_id est l’ID de transaction de l’orchestrateur.
verification_id s’agit de l’vhub_verification_id obtenue à l’étape précédente (voir Obtenir l’ID de vérification).
Exemple de réponse
Les URL SFS de verified_images seront utilisées pour télécharger les images de vérification (voir Télécharger les données binaires de l’image).
{
"transaction_id": "EdafBFdc-7cCB-D7b0-8591-c9e6a73Da1a8",
"verification_id": "4fddd4cD-D547-914C-6EFd-f7f5dcc73D83",
"verified_images": [
{
"image_submitted_document_front": "sfs://my_db/default/onespanidv/transaction/0fcde1ce-7649-
48f1-948c-000324280bar/session/0eb54e2b-67gc-4161-ba08-
630d425201b0/verifications/doc_id/driver-license-front/3.png"
},
{
"image_submitted_document_back": "sfs://my_db/default/onespanidv/transaction/0fcde1ce-7649-
48f1-948c-000324280bar/session/0eb54e2b-67gc-4161-ba08-
630d425201b0/verifications/doc_id/driver-license-back/3.png"
},
{
"image_submitted_selfie1": "sfs://my_db/default/onespanidv/transaction/0fcde1ce-7649-
48f1-948c-000324280bar/session/0eb54e2b-67gc-4161-ba08-
630d425201b0/verifications/doc_id/face_capture/1.png"
},
{
"image_submitted_selfie2": "sfs://my_db/default/onespanidv/transaction/0fcde1ce-7649-
48f1-948c-000324280bar/session/0eb54e2b-67gc-4161-ba08-
630d425201b0/verifications/doc_id/face_capture/2.png"
}
]
}
Codes d’état
Code d’état | Nom | Description | Commentaire |
---|---|---|---|
200 | D’ACCORD | Aucune erreur. | |
400 | Mauvaise demande | Les données de transaction ne sont pas valides. | Peut se produire si l’une des situations suivantes s’applique :
|
404 | Introuvable | La ressource demandée n’a pas été trouvée. | Peut se produire si l’une des situations suivantes s’applique :
|
500 | Erreur de serveur interne | Le serveur a rencontré une condition inattendue qui l’a empêché de terminer la requête. | Peut se produire si l’une des situations suivantes s’applique :
|
Télécharger les données binaires de l’image
Utilisez la ou les URL que vous avez obtenues à l’étape précédente (voir Obtenir l’URL des images de vérification) pour télécharger les images de vérification.
Syntaxe
GET /api/transactions/transaction_id/data?url=sfs_url
transaction_id est l’ID de transaction de l’orchestrateur.
sfs_url est l’URL de l’image.
Exemple de demande
/api/transactions/transaction_id/data?url=sfs://my_db/default/onespanidv/transaction/0fcde1ce-7649-48f1-948c-000324280bar/session/0eb54e2b-67gc-4161-ba08-630d425201b0/verifications/doc_id/driver-license-front/3.png
Codes d’état
Code d’état | Nom | Description | Commentaire |
---|---|---|---|
200 | D’ACCORD | Aucune erreur. | Le fichier attendu est renvoyé. |
400 | Mauvaise demande | Les données de transaction ne sont pas valides. | Erreur de validation. Les URL SFS non valides peuvent être causées par des caractères de traversée de chemin arrière. |
401 | Non autorisée | Jeton non valide. | |
404 | Introuvable | La ressource demandée n’a pas été trouvée. | Le fichier n’existe pas dans le système. |
500 | Erreur de serveur interne | Erreur de serveur ou d’application. |