API REST de vérification d’identité OneSpan

  • Publié le Jul 15, 2025
  • 2 Minute(s) lue(s)
Prev Next

L’API REST de vérification d’identité OneSpan est organisée autour de la Transaction model. Ce modèle est entièrement défini par des schémas JSON qui peuvent être utilisés pour générer des bibliothèques côté client pour accéder à l’API.

Avec l’API REST de vérification d’identité OneSpan, les actions suivantes sont disponibles :

  • Créer et exécuter des flux de travail d’e-agreement

  • Définir et paramétrer des instances de workflow

  • Fournir et manipuler des documents

  • Interroger les informations de transaction

  • Fournir les informations personnelles des participants au processus d’accord électronique

  • Définition/attribution de rôles aux signataires

  • Fournir des métadonnées comme preuve supplémentaire

  • Récupérez les accords signés, la piste d’audit et les preuves électroniques

  • Supprimer des transactions

Le modèle JSON de vérification d’identité OneSpan définit plusieurs entités clés :

Les demandes décrites dans cette section nécessitent un jeton Web JSON (JWT) dans l’en-tête du porteur . En fonction de la demande, le JWT doit posséder le rôle correspondant :

  • Pour les demandes d’accès à une transaction, le JWT doit contenir le rôle d’accès à la transaction.

  • Pour les demandes d’accès à une session, le JWT doit contenir le rôle d’accès à la session.

  • Pour les demandes d’accès aux preuves, le JWT doit contenir le rôle d’accès aux preuves .

Pour plus d’informations, reportez-vous à la JSON Web Tokens.

Vue d’ensemble des points de terminaison d’API

Créer une transaction

PUT /api/transaction/ HTTP1.1
Host: onespan.com
Accept: application/json, text/javascript

Pour plus d’informations, reportez-vous à la Create transaction.

Obtenir l’état et les métadonnées de la transaction

GET /api/transaction/uuid: transaction_id(?withVerifications=true/false optional) 
HTTP1.1Host: onespan.com

Pour plus d’informations, reportez-vous à la Get transaction status and metadata.

Obtenir la vérification de la transaction

GET /api/transaction/uuid: transaction_id/verification HTTP/1.1
Host: onespan.com
Accept: application/json, text/javascript

Pour plus d’informations, reportez-vous à la Get transaction verification.

Obtenir des preuves

GET /api/transaction/uuid: transaction_id/document/AuditTrailDocument/pdf
Host: onespan.com
Accept: application/json, application/pdf

Pour plus d’informations, reportez-vous à la Get evidence.

Obtenir le document

GET /api/transaction/uuid: transaction_id/document/document_id/pdf HTTP/1.1
Host: onespan.com
Accept: application/json, text/javascript

Pour plus d’informations, reportez-vous à la Get document.

Annuler la transaction

PUT /api/transaction/uuid: transaction_id/event
Host: onespan.com
Accept: application/json, text/javascript

Pour plus d’informations, reportez-vous à la Cancel transaction.

Marquer la transaction pour l’effacement

POST /api/transactions/mark-for-erasure
Authorization: Bearer token
Content-Type: application/json
X-Tenant: dealflo

Pour plus d’informations, reportez-vous à la Mark transaction for erasure.

Annuler la transaction pour l’effacement

POST /api/transactions/unmark-for-erasure
Authorization: Bearer token
Content-Type: application/json
X-Tenant: dealflo

Pour plus d’informations, reportez-vous à la Unmark transaction for erasure.

Créer un jeton de création de session

POST /api/transaction/uuid: transaction_id/token HTTP /1.1
Host: onespan.com
Accept: application/json, text/javascript

Pour plus d’informations, reportez-vous à la section Create session creation token.

Générer une piste d’audit

POST /api/transactions/uuid: transaction_id/generate-audit-trail
Authorization: Bearer token

Pour plus d’informations, reportez-vous à la Generate audit trail on demand.

Télécharger le document de piste d’audit

GET /api/transactions/uuid: transaction_id/data
Authorization: Bearer token

Pour plus d’informations, reportez-vous à la Generate audit trail on demand.

Obtenir l’URL des images de vérification

GET /api/transactions/transaction_id/verifications/verification_id/verification-images
Host: onespan.com
Accept: application/json

Pour plus d’informations, reportez-vous à la Retrieve verification images.

Télécharger les données binaires de l’image

GET /api/transactions/transaction_id/data?url=sfs_url

Pour plus d’informations, reportez-vous à la Retrieve verification images.

Rapport de vérification détaillé

GET /api/transactions/id/detailed-verification-report
Authorization: Bearer tenant_access_token

Pour plus d’informations, reportez-vous à la Detailed verification report.